shanghaikid / milvus-sdk-node

test-repo

Milvus2-sdk-node

This is node sdk for Milvus.

Compatibility

The following collection shows Milvus versions and recommended @zilliz/milvus2-sdk-node versions:

Milvus version	Recommended @zilliz/milvus2-sdk-node version
2.0.0	2.0.0
2.0.1	2.0.0, 2.0.1

Dependencies

Milvus: v2+

Node: v12+

Installation

   npm install @zilliz/milvus2-sdk-node

API Support

Name	Async	Description
createCollection	false	Create collection in milvus
hasCollection	false	Check collection exist or not
showCollections	false	List all collections
describeCollection	false	Get collection detail, like name ,schema
getCollectionStatistics	false	Get collection statistics like row count
loadCollection	true	Load data into cache
releaseCollection	true	Release data from cache
dropCollection	false	Drop collection from milvus
createPartition	false	Create partition in one collection
hasPartition	false	Check partition exist or not
showPartitions	false	List all partitions for one collection
getPartitionStatistics	false	Get partition statistics like row_count
loadPartitions	true	Load data into cache
releasePartitions	true	Release data from cache
dropPartition	false	Drop partition from milvus
createIndex	true	Creat index on vector field
describeIndex	false	Get index info
getIndexState	false	Get index build state
getIndexBuildProgress	false	Get index building progress
dropIndex	true	Drop index
insert	false	Insert data into milvus
search	false	Vector similarity search
flush	true	Flush Data
flushSync	false	Flush Data Sync
query	false	Get data by expr
compact	true	Do compaction for the collection
getCompactionState	true	Get compaction states by compact id

How to dev

1. yarn install
2. Fetch milvus proto
   1. git submodule init (if this is your first time)
   2. git submodule update --remote
3. Add feature in milvus folder.
4. Run test yarn test -- test/Your-test-for-your-feature.spec.ts

Example

1. Hello World
2. How to operate collection
3. How to insert data
4. Vector similarity search on float field
5. Vector similarity search on binary field