Constructor
new Milvus(connectionObject, configs)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
connectionObject |
Object
|
|
configs |
Map
|
|
Extends
Methods
(async, static) bootstrapCollection(milvusDb) → {Promise.<Object>}
- Description:
- Bootstraps milvus collection. Waits for collection to be created and loads the collection (if its currently unloaded).
- Source:
Example
const mdx = require("@nvidia-mdx/web-api-core");
const milvus = new mdx.Utils.Milvus({url: "milvus-url"},databaseConfigMap);
let result = await mdx.Utils.Milvus.bootstrapCollection(milvus);
Parameters:
| Name |
Type |
Description |
milvusDb |
Database
|
|
Returns:
A success message is returned
-
Type
-
Promise.<Object>
(static) getPartitionsFromTimestamps(milvusDb, fromTimestamp, toTimestamp) → {Set.<string>}
- Description:
- returns a set of milvus partitions that may be present for a given time range based on a partitioning strategy.
- Source:
Example
const mdx = require("@nvidia-mdx/web-api-core");
const milvus = new mdx.Utils.Milvus({url: "milvus-url"},databaseConfigMap);
let partitionsInATimeRange = mdx.Utils.Milvus.getPartitionsFromTimestamps(milvus,"2023-01-12T11:20:10.000Z","2023-01-12T14:20:10.000Z");
Parameters:
| Name |
Type |
Description |
milvusDb |
Database
|
|
fromTimestamp |
string
|
|
toTimestamp |
string
|
|
Returns:
A set of partitions that may be present in milvus for a given time range is returned
-
Type
-
Set.<string>
(async, static) getPartitionsOfCollection(milvusDb, inputopt) → {Promise.<Set.<string>>}
- Description:
- returns a set of partitions that belong to a milvus collection
- Source:
Example
const mdx = require("@nvidia-mdx/web-api-core");
const milvus = new mdx.Utils.Milvus({url: "milvus-url"},databaseConfigMap);
let partitionsOfCollection = await mdx.Utils.Milvus.getPartitionsOfCollection(milvus);
Parameters:
| Name |
Type |
Attributes |
Default |
Description |
milvusDb |
Database
|
|
|
|
input |
Object
|
<optional>
|
{}
|
Input object.
Properties
| Name |
Type |
Attributes |
Default |
Description |
excludeDefault |
boolean
|
<optional>
|
true
|
If set to true, _default partition will be excluded from the result |
|
Returns:
A set of partitions that belong to a milvus collection is returned
-
Type
-
Promise.<Set.<string>>
(async, static) getSearchResults(milvusDb, queryObject) → {Array.<Object>}
- Description:
- returns milvus search results
- Source:
Example
const mdx = require("@nvidia-mdx/web-api-core");
const milvus = new mdx.Utils.Milvus({url: "milvus-url"},databaseConfigMap);
let results = await mdx.Utils.Milvus.getSearchResults(milvus,queryObject);
Parameters:
| Name |
Type |
Description |
milvusDb |
Database
|
|
queryObject |
Object
|
|
Returns:
- An array containing similar behaviors (search result) is returned
-
Type
-
Array.<Object>
(async, static) isReady(url) → {Promise.<boolean>}
- Description:
- Checks if status of milvus connection is READY
- Source:
Example
const mdx = require("@nvidia-mdx/web-api-core");
let isMilvusReady = await mdx.Utils.Milvus.isReady("milvus-url");
Parameters:
| Name |
Type |
Description |
url |
string
|
milvus url |
Returns:
returns if status of milvus connection is READY
-
Type
-
Promise.<boolean>
(static) milvusCronJob(milvusDb) → {CronJob}
- Description:
- returns a cron job that runs at midnight (machine time). The cron job manages the partition retention of milvus collection.
- Source:
Example
const mdx = require("@nvidia-mdx/web-api-core");
const milvus = new mdx.Utils.Milvus({url: "milvus-url"},databaseConfigMap);
let milvusCronJob = mdx.Utils.Milvus.milvusCronJob(milvus);
Parameters:
| Name |
Type |
Description |
milvusDb |
Database
|
|
Returns:
The cron job is returned
-
Type
-
CronJob