Merge pull request #980 from milvus-io/node

update docs
milvus-io · Dec 23, 2024 · 85ecf62 · 85ecf62
2 parents 4f01d2f + 4ea9828
commit 85ecf62
Show file tree

Hide file tree

Showing 62 changed files with 561 additions and 26 deletions.
diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Collections/alterAlias.md b/API_Reference/milvus-sdk-node/v2.4.x/Collections/alterAlias.md
@@ -11,6 +11,7 @@ alterAlias(data): Promise<ResStatus>
 ```javascript
 milvusClient.alterAlias({
    alias: string,
+   db_name: string
    collection_name: string,
    timeout?: number
  })
@@ -44,6 +45,10 @@ milvusClient.alterAlias({
 
     </div>
 
+- **db_name** (*str*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*str*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Collections/createAlias.md b/API_Reference/milvus-sdk-node/v2.4.x/Collections/createAlias.md
@@ -11,6 +11,7 @@ createAlias(data): Promise<ResStatus>
 ```javascript
 milvusClient.createAlias({
    alias: string,
+   db_name: string,
    collection_name: string,
    timeout?: number
  })
@@ -44,6 +45,10 @@ milvusClient.createAlias({
 
     </div>
 
+- **db_name** (*str*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*str*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Collections/createCollection.md b/API_Reference/milvus-sdk-node/v2.4.x/Collections/createCollection.md
@@ -16,6 +16,7 @@ Using this request body, you can create a collection by simply setting the colle
 
 ```javascript
 milvusClient.createCollection({
+    db_name: string;
     collection_name: string;
     dimension: number;
     auto_id?: boolean;
@@ -34,6 +35,10 @@ milvusClient.createCollection({
 
 **PARAMETERS:**
 
+- **db_name** (*string*) -
+
+    The name of the database in which the collection is to be created.
+
 - **collection_name** (*string*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Collections/describeAlias.md b/API_Reference/milvus-sdk-node/v2.4.x/Collections/describeAlias.md
@@ -10,13 +10,18 @@ describeAlias(data): Promise<DescribeAliasResponse>
 
 ```javascript
 milvusClient.describeAlias({
+    db_name: string,
     alias: string,
     collection_name: string
 })
 ```
 
 **PARAMETERS:**
 
+- **db_name** (*str*) -
+
+    The name of the database that holds the target collection.
+
 - **alias** (*str*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Collections/describeCollection.md b/API_Reference/milvus-sdk-node/v2.4.x/Collections/describeCollection.md
@@ -10,12 +10,17 @@ describeCollection(data): Promise<DescribeCollectionResponse>
 
 ```javascript
 milvusClient.describeCollection({ 
+    db_name: string,
     collection_name: string 
 })
 ```
 
 **PARAMETERS:**
 
+- **db_name** (*string*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*string*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Collections/dropAlias.md b/API_Reference/milvus-sdk-node/v2.4.x/Collections/dropAlias.md
@@ -11,6 +11,8 @@ dropAlias(data): Promise<ResStatus>
 ```javascript
 milvusClient.dropAlias({
    alias: string,
+   db_name: string,
+   collection_name: string,
    timeout?: number
  })
 ```
@@ -25,6 +27,14 @@ milvusClient.dropAlias({
 
     Before this operation, ensure that the alias exists. Otherwise, exceptions will occur.
 
+- **db_name** (*string*) -
+
+    The name of the database that holds the specified collection.
+
+- **collection_name** (*string*) -
+
+    The name of the collection that the alias binds to.
+
 - **timeout** (*number*)  
 
     The timeout duration for this operation. 

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Collections/dropCollection.md b/API_Reference/milvus-sdk-node/v2.4.x/Collections/dropCollection.md
@@ -10,13 +10,18 @@ dropCollection(data): Promise<ResStatus>
 
 ```javascript
 milvusClient.dropCollection({ 
+    db_name: string,
     collection_name: string,
     timeout?: number
 })
 ```
 
 **PARAMETERS:**
 
+- **db_name** (*string*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*string*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Collections/getCollectionStatistics.md b/API_Reference/milvus-sdk-node/v2.4.x/Collections/getCollectionStatistics.md
@@ -10,13 +10,18 @@ getCollectionStatistics(data): Promise<StatisticsResponse>
 
 ```javascript
 milvusClient.getCollectionStatistics({ 
+    db_name: string,
     collection_name: string,
     timeout?: number 
 })
 ```
 
 **PARAMETERS:**
 
+- **db_name** (*string*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*string*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Collections/hasCollection.md b/API_Reference/milvus-sdk-node/v2.4.x/Collections/hasCollection.md
@@ -10,13 +10,18 @@ hasCollection(data): Promise<BoolResponse>
 
 ```javascript
 milvusClient.hasCollection({ 
+    db_name: string,
     collection_name: string,
     timeout?: number
 })
 ```
 
 **PARAMETERS:**
 
+- **db_name** (*str*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*str*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Collections/listAliases.md b/API_Reference/milvus-sdk-node/v2.4.x/Collections/listAliases.md
@@ -12,13 +12,18 @@ This method has the following alternatives.
 
 ```javascript
 listAliases({
+    db_name: string
     collection_name: string
     timeout?: number
 })
 ```
 
 **PARAMETERS:**
 
+- **db_name** (*string*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*string*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Collections/renameCollection.md b/API_Reference/milvus-sdk-node/v2.4.x/Collections/renameCollection.md
@@ -10,6 +10,7 @@ renameCollection(data): Promise<ResStatus>
 
 ```javascript
 milvusClient.renameCollection({
+   db_name: string,
    collection_name: string,
    new_collection_name: string,
    timeout?: number
@@ -18,6 +19,10 @@ milvusClient.renameCollection({
 
 **PARAMETERS:**
 
+- **db_name** (*string*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*string*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Management/createIndex.md b/API_Reference/milvus-sdk-node/v2.4.x/Management/createIndex.md
@@ -11,6 +11,7 @@ createIndex(data): Promise<ResStatus>
 ```javascript
 milvusClient.createIndex([
     {
+       db_name: string,
        collection_name: string,
        field_name: string,
        index_name?: string,
@@ -24,6 +25,10 @@ milvusClient.createIndex([
 
 **PARAMETERS:**
 
+- **db_name** (*string*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*string*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Management/describeIndex.md b/API_Reference/milvus-sdk-node/v2.4.x/Management/describeIndex.md
@@ -10,6 +10,7 @@ describeIndex(data): Promise<DescribeIndexResponse>
 
 ```javascript
  milvusClient.describeIndex({ 
+     db_name: string,
      collection_name: string,
      field_name?: string,
      index_name?: string,
@@ -19,6 +20,10 @@ describeIndex(data): Promise<DescribeIndexResponse>
 
 **PARAMETERS:**
 
+- **db_name** (*string*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*string*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Management/dropIndex.md b/API_Reference/milvus-sdk-node/v2.4.x/Management/dropIndex.md
@@ -10,6 +10,7 @@ dropIndex(data): Promise<ResStatus>
 
 ```javascript
 milvusClient.dropPartition({
+    db_name: string,
     collection_name: string,
     field_name?: string,
     index_name?: string,
@@ -19,6 +20,10 @@ milvusClient.dropPartition({
 
 **PARAMETERS:**
 
+- **db_name** (*string*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*string*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Management/getLoadState.md b/API_Reference/milvus-sdk-node/v2.4.x/Management/getLoadState.md
@@ -10,6 +10,7 @@ getLoadState(data): Promise<GetLoadStateResponse>
 
 ```javascript
 milvusClient.getLoadState({
+   db_name: string,
    collection_name: string,
    partition_names?: string[],
    timeout?: number
@@ -18,6 +19,10 @@ milvusClient.getLoadState({
 
 **PARAMETERS:**
 
+- **db_name** (*string*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*string*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Management/loadCollection.md b/API_Reference/milvus-sdk-node/v2.4.x/Management/loadCollection.md
@@ -10,6 +10,7 @@ loadCollection(data): Promise<ResStatus>
 
 ```javascript
 milvusClient.loadCollection({ 
+    db_name: string,
     collection_name: string,
     refresh?: boolean,
     replica_number?: number,
@@ -20,6 +21,10 @@ milvusClient.loadCollection({
 
 **PARAMETERS:**
 
+- **db_name** (*string*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*string*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Management/releaseCollection.md b/API_Reference/milvus-sdk-node/v2.4.x/Management/releaseCollection.md
@@ -10,13 +10,18 @@ releaseCollection(data): Promise<ResStatus>
 
 ```javascript
 milvusClient.releaseCollection({ 
+    db_name: string,
     collection_name: 'my_collection',
     timeout?: number 
 })
 ```
 
 **PARAMETERS:**
 
+- **db_name** (*string*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*str*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Partitions/createPartition.md b/API_Reference/milvus-sdk-node/v2.4.x/Partitions/createPartition.md
@@ -10,6 +10,7 @@ createPartition(data): Promise<ResStatus>
 
 ```javascript
 milvusClient.createPartition({
+    db_name: string,
     collection_name: string,
     partition_name: string,
     timeout?: number
@@ -18,6 +19,10 @@ milvusClient.createPartition({
 
 **PARAMETERS:**
 
+- **db_name** (*string*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*string*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Partitions/dropPartition.md b/API_Reference/milvus-sdk-node/v2.4.x/Partitions/dropPartition.md
@@ -10,6 +10,7 @@ dropPartition(data): Promise<ResStatus>
 
 ```javascript
 milvusClient.dropPartition({
+    db_name: string,
     collection_name: string,
     partition_name: string,
     timeout?: number
@@ -18,6 +19,10 @@ milvusClient.dropPartition({
 
 **PARAMETERS:**
 
+- **db_name** (*string*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*string*) -
 
     **[REQUIRED]**

diff --git a/API_Reference/milvus-sdk-node/v2.4.x/Partitions/getPartitionStatistics.md b/API_Reference/milvus-sdk-node/v2.4.x/Partitions/getPartitionStatistics.md
@@ -10,6 +10,7 @@ getPartitionStatistics(data): Promise<StatisticsResponse>
 
 ```javascript
 milvusClient.getPartitionStatistics({
+    db_name: string,
     collection_name: string,
     partition_name: string,
     timeout?: number
@@ -18,6 +19,10 @@ milvusClient.getPartitionStatistics({
 
 **PARAMETERS:**
 
+- **db_name** (*string*) -
+
+    The name of the database that holds the target collection.
+
 - **collection_name** (*string*) -
 
     **[REQUIRED]**