Skip to content

Commit 4ea9828

Browse files
update docs
Signed-off-by: AnthonyTsu1984 <[email protected]>
1 parent 4f01d2f commit 4ea9828

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+561
-26
lines changed

API_Reference/milvus-sdk-node/v2.4.x/Collections/alterAlias.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ alterAlias(data): Promise<ResStatus>
1111
```javascript
1212
milvusClient.alterAlias({
1313
alias: string,
14+
db_name: string
1415
collection_name: string,
1516
timeout?: number
1617
})
@@ -44,6 +45,10 @@ milvusClient.alterAlias({
4445

4546
</div>
4647

48+
- **db_name** (*str*) -
49+
50+
The name of the database that holds the target collection.
51+
4752
- **collection_name** (*str*) -
4853

4954
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Collections/createAlias.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ createAlias(data): Promise<ResStatus>
1111
```javascript
1212
milvusClient.createAlias({
1313
alias: string,
14+
db_name: string,
1415
collection_name: string,
1516
timeout?: number
1617
})
@@ -44,6 +45,10 @@ milvusClient.createAlias({
4445

4546
</div>
4647

48+
- **db_name** (*str*) -
49+
50+
The name of the database that holds the target collection.
51+
4752
- **collection_name** (*str*) -
4853

4954
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Collections/createCollection.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Using this request body, you can create a collection by simply setting the colle
1616

1717
```javascript
1818
milvusClient.createCollection({
19+
db_name: string;
1920
collection_name: string;
2021
dimension: number;
2122
auto_id?: boolean;
@@ -34,6 +35,10 @@ milvusClient.createCollection({
3435

3536
**PARAMETERS:**
3637

38+
- **db_name** (*string*) -
39+
40+
The name of the database in which the collection is to be created.
41+
3742
- **collection_name** (*string*) -
3843

3944
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Collections/describeAlias.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,18 @@ describeAlias(data): Promise<DescribeAliasResponse>
1010

1111
```javascript
1212
milvusClient.describeAlias({
13+
db_name: string,
1314
alias: string,
1415
collection_name: string
1516
})
1617
```
1718

1819
**PARAMETERS:**
1920

21+
- **db_name** (*str*) -
22+
23+
The name of the database that holds the target collection.
24+
2025
- **alias** (*str*) -
2126

2227
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Collections/describeCollection.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,17 @@ describeCollection(data): Promise<DescribeCollectionResponse>
1010

1111
```javascript
1212
milvusClient.describeCollection({
13+
db_name: string,
1314
collection_name: string
1415
})
1516
```
1617

1718
**PARAMETERS:**
1819

20+
- **db_name** (*string*) -
21+
22+
The name of the database that holds the target collection.
23+
1924
- **collection_name** (*string*) -
2025

2126
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Collections/dropAlias.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ dropAlias(data): Promise<ResStatus>
1111
```javascript
1212
milvusClient.dropAlias({
1313
alias: string,
14+
db_name: string,
15+
collection_name: string,
1416
timeout?: number
1517
})
1618
```
@@ -25,6 +27,14 @@ milvusClient.dropAlias({
2527

2628
Before this operation, ensure that the alias exists. Otherwise, exceptions will occur.
2729

30+
- **db_name** (*string*) -
31+
32+
The name of the database that holds the specified collection.
33+
34+
- **collection_name** (*string*) -
35+
36+
The name of the collection that the alias binds to.
37+
2838
- **timeout** (*number*)
2939

3040
The timeout duration for this operation.

API_Reference/milvus-sdk-node/v2.4.x/Collections/dropCollection.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,18 @@ dropCollection(data): Promise<ResStatus>
1010

1111
```javascript
1212
milvusClient.dropCollection({
13+
db_name: string,
1314
collection_name: string,
1415
timeout?: number
1516
})
1617
```
1718

1819
**PARAMETERS:**
1920

21+
- **db_name** (*string*) -
22+
23+
The name of the database that holds the target collection.
24+
2025
- **collection_name** (*string*) -
2126

2227
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Collections/getCollectionStatistics.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,18 @@ getCollectionStatistics(data): Promise<StatisticsResponse>
1010

1111
```javascript
1212
milvusClient.getCollectionStatistics({
13+
db_name: string,
1314
collection_name: string,
1415
timeout?: number
1516
})
1617
```
1718

1819
**PARAMETERS:**
1920

21+
- **db_name** (*string*) -
22+
23+
The name of the database that holds the target collection.
24+
2025
- **collection_name** (*string*) -
2126

2227
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Collections/hasCollection.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,18 @@ hasCollection(data): Promise<BoolResponse>
1010

1111
```javascript
1212
milvusClient.hasCollection({
13+
db_name: string,
1314
collection_name: string,
1415
timeout?: number
1516
})
1617
```
1718

1819
**PARAMETERS:**
1920

21+
- **db_name** (*str*) -
22+
23+
The name of the database that holds the target collection.
24+
2025
- **collection_name** (*str*) -
2126

2227
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Collections/listAliases.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,18 @@ This method has the following alternatives.
1212

1313
```javascript
1414
listAliases({
15+
db_name: string
1516
collection_name: string
1617
timeout?: number
1718
})
1819
```
1920

2021
**PARAMETERS:**
2122

23+
- **db_name** (*string*) -
24+
25+
The name of the database that holds the target collection.
26+
2227
- **collection_name** (*string*) -
2328

2429
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Collections/renameCollection.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ renameCollection(data): Promise<ResStatus>
1010

1111
```javascript
1212
milvusClient.renameCollection({
13+
db_name: string,
1314
collection_name: string,
1415
new_collection_name: string,
1516
timeout?: number
@@ -18,6 +19,10 @@ milvusClient.renameCollection({
1819

1920
**PARAMETERS:**
2021

22+
- **db_name** (*string*) -
23+
24+
The name of the database that holds the target collection.
25+
2126
- **collection_name** (*string*) -
2227

2328
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Management/createIndex.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ createIndex(data): Promise<ResStatus>
1111
```javascript
1212
milvusClient.createIndex([
1313
{
14+
db_name: string,
1415
collection_name: string,
1516
field_name: string,
1617
index_name?: string,
@@ -24,6 +25,10 @@ milvusClient.createIndex([
2425

2526
**PARAMETERS:**
2627

28+
- **db_name** (*string*) -
29+
30+
The name of the database that holds the target collection.
31+
2732
- **collection_name** (*string*) -
2833

2934
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Management/describeIndex.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ describeIndex(data): Promise<DescribeIndexResponse>
1010

1111
```javascript
1212
milvusClient.describeIndex({
13+
db_name: string,
1314
collection_name: string,
1415
field_name?: string,
1516
index_name?: string,
@@ -19,6 +20,10 @@ describeIndex(data): Promise<DescribeIndexResponse>
1920

2021
**PARAMETERS:**
2122

23+
- **db_name** (*string*) -
24+
25+
The name of the database that holds the target collection.
26+
2227
- **collection_name** (*string*) -
2328

2429
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Management/dropIndex.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ dropIndex(data): Promise<ResStatus>
1010

1111
```javascript
1212
milvusClient.dropPartition({
13+
db_name: string,
1314
collection_name: string,
1415
field_name?: string,
1516
index_name?: string,
@@ -19,6 +20,10 @@ milvusClient.dropPartition({
1920

2021
**PARAMETERS:**
2122

23+
- **db_name** (*string*) -
24+
25+
The name of the database that holds the target collection.
26+
2227
- **collection_name** (*string*) -
2328

2429
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Management/getLoadState.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ getLoadState(data): Promise<GetLoadStateResponse>
1010

1111
```javascript
1212
milvusClient.getLoadState({
13+
db_name: string,
1314
collection_name: string,
1415
partition_names?: string[],
1516
timeout?: number
@@ -18,6 +19,10 @@ milvusClient.getLoadState({
1819

1920
**PARAMETERS:**
2021

22+
- **db_name** (*string*) -
23+
24+
The name of the database that holds the target collection.
25+
2126
- **collection_name** (*string*) -
2227

2328
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Management/loadCollection.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ loadCollection(data): Promise<ResStatus>
1010

1111
```javascript
1212
milvusClient.loadCollection({
13+
db_name: string,
1314
collection_name: string,
1415
refresh?: boolean,
1516
replica_number?: number,
@@ -20,6 +21,10 @@ milvusClient.loadCollection({
2021

2122
**PARAMETERS:**
2223

24+
- **db_name** (*string*) -
25+
26+
The name of the database that holds the target collection.
27+
2328
- **collection_name** (*string*) -
2429

2530
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Management/releaseCollection.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,18 @@ releaseCollection(data): Promise<ResStatus>
1010

1111
```javascript
1212
milvusClient.releaseCollection({
13+
db_name: string,
1314
collection_name: 'my_collection',
1415
timeout?: number
1516
})
1617
```
1718

1819
**PARAMETERS:**
1920

21+
- **db_name** (*string*) -
22+
23+
The name of the database that holds the target collection.
24+
2025
- **collection_name** (*str*) -
2126

2227
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Partitions/createPartition.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ createPartition(data): Promise<ResStatus>
1010

1111
```javascript
1212
milvusClient.createPartition({
13+
db_name: string,
1314
collection_name: string,
1415
partition_name: string,
1516
timeout?: number
@@ -18,6 +19,10 @@ milvusClient.createPartition({
1819

1920
**PARAMETERS:**
2021

22+
- **db_name** (*string*) -
23+
24+
The name of the database that holds the target collection.
25+
2126
- **collection_name** (*string*) -
2227

2328
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Partitions/dropPartition.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ dropPartition(data): Promise<ResStatus>
1010

1111
```javascript
1212
milvusClient.dropPartition({
13+
db_name: string,
1314
collection_name: string,
1415
partition_name: string,
1516
timeout?: number
@@ -18,6 +19,10 @@ milvusClient.dropPartition({
1819

1920
**PARAMETERS:**
2021

22+
- **db_name** (*string*) -
23+
24+
The name of the database that holds the target collection.
25+
2126
- **collection_name** (*string*) -
2227

2328
**[REQUIRED]**

API_Reference/milvus-sdk-node/v2.4.x/Partitions/getPartitionStatistics.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ getPartitionStatistics(data): Promise<StatisticsResponse>
1010

1111
```javascript
1212
milvusClient.getPartitionStatistics({
13+
db_name: string,
1314
collection_name: string,
1415
partition_name: string,
1516
timeout?: number
@@ -18,6 +19,10 @@ milvusClient.getPartitionStatistics({
1819

1920
**PARAMETERS:**
2021

22+
- **db_name** (*string*) -
23+
24+
The name of the database that holds the target collection.
25+
2126
- **collection_name** (*string*) -
2227

2328
**[REQUIRED]**

0 commit comments

Comments
 (0)