Brief
For Milvus v2.x, all SDK toolkits are based on the same gRPC proto. To make the work transparent to the community, we list the status of each SDK on this page.
So far we have Python SDK(pymilvus), Java SDK, Go SDK, Node SDK, C++ SDK(developing), not all SDK are implemented in same way, we hope users can easily know the difference from the list.
PyMilvus
RPC interface status:
| API | Available | Test Covered | Note |
|---|---|---|---|
| CreateCollection | Yes | Yes | create_collection |
| DropCollection | Yes | Yes | drop_collection |
| HasCollection | Yes | Yes | has_collection |
| LoadCollection | Yes | Yes | load_collection |
| ReleaseCollection | Yes | Yes | release_collection |
| DescribeCollection | Yes | Yes | describe_collection |
| GetCollectionStatistics | Yes | Yes | get_collection_stats |
| ShowCollections | Yes | Yes | list_collections |
| CreatePartition | Yes | Yes | create_partition |
| DropPartition | Yes | Yes | drop_partition |
| HasPartition | Yes | Yes | has_partition |
| LoadPartitions | Yes | Yes | load_partitions |
| ReleasePartitions | Yes | Yes | release_partitions |
| GetPartitionStatistics | Yes | Yes | get_partition_stats |
| ShowPartitions | Yes | Yes | list_partitions |
| CreateAlias | Yes | Yes | create_alias |
| DropAlias | Yes | Yes | drop_alias |
| AlterAlias | Yes | Yes | alter_alias |
| CreateIndex | Yes | Yes | create_index |
| DescribeIndex | Yes | Yes | describe_index |
| GetIndexState | Yes | Yes | get_index_state |
| GetIndexBuildProgress | Yes | Yes | get_index_build_progress |
| DropIndex | Yes | Yes | drop_index |
| Insert | Yes | Yes | insert |
| Delete | Yes | Yes | delete |
| Search | Yes | Yes | search |
| Flush | Yes | Yes | flush |
| Query | Yes | Yes | query |
| CalcDistance | Yes | Yes | calc_distance |
| GetFlushState | Yes | Yes | get_flush_state |
| GetPersistentSegmentInfo | Yes | Yes | get_persistent_segment_infos |
| GetQuerySegmentInfo | Yes | Yes | get_query_segment_info |
| GetMetrics | No | No | |
| LoadBalance | Yes | Yes | load_balance |
| GetCompactionState | Yes | Yes | get_compaction_state |
| ManualCompaction | Yes | Yes | compact |
| GetCompactionStateWithPlans | Yes | Yes | get_compaction_plans |
ORM classes status:
| Class | Methods/Properties | Available | Test Covered | Note |
|---|---|---|---|---|
| num_entities | Yes | Yes | |
| drop | Yes | Yes | ||
| load | Yes | Yes | ||
| release | Yes | Yes | ||
| insert | Yes | Yes | ||
| delete | Yes | Yes | ||
| search | Yes | Yes | ||
| query | Yes | Yes | ||
| partitions | Yes | Yes | ||
| create_partition | Yes | Yes | ||
| has_partition | Yes | Yes | ||
| drop_partition | Yes | Yes | ||
| indexes | Yes | Yes | ||
| create_index | Yes | Yes | ||
| has_index | Yes | Yes | ||
| drop_index | Yes | Yes | ||
compact | Yes | Yes | ||
get_compaction_state | Yes | Yes | ||
get_compaction_plans | Yes | Yes |
| Class | Methods/Properties | Available | Test Covered | Note |
|---|---|---|---|---|
partition | num_entities | Yes | Yes | |
drop | Yes | Yes | ||
load | Yes | Yes | ||
release | Yes | Yes | ||
insert | Yes | Yes | ||
delete | Yes | Yes | ||
search | Yes | Yes | ||
query | Yes | Yes |
| Class | Methods/Properties | Available | Test Covered | Note |
|---|---|---|---|---|
| index | drop | Yes | Yes |
| Class | Methods/Properties | Available | Test Covered | Note |
|---|---|---|---|---|
utility | loading_progress | Yes | Yes | |
index_building_progress | Yes | Yes | ||
has_collection | Yes | Yes | ||
has_partition | Yes | Yes | ||
drop_collection | Yes | Yes | ||
list_collections | Yes | Yes | ||
calc_distance | Yes | Yes | ||
load_balance | Yes | Yes | ||
get_query_segment_info | Yes | Yes | ||
create_alias | Yes | Yes | ||
drop_alias | Yes | Yes | ||
alter_alias | Yes | Yes | ||
list_aliases | Yes | Yes |
Go SDK
RPC interface status:
| API | Available | Test Covered | Note |
|---|---|---|---|
| CreateCollection | |||
| DropCollection | |||
| HasCollection | |||
| LoadCollection | |||
| ReleaseCollection | |||
| DescribeCollection | |||
| GetCollectionStatistics | |||
| ShowCollections | |||
| CreatePartition | |||
| DropPartition | |||
| HasPartition | |||
| LoadPartitions | |||
| ReleasePartitions | |||
| GetPartitionStatistics | |||
| ShowPartitions | |||
| CreateAlias | |||
| DropAlias | |||
| AlterAlias | |||
| CreateIndex | |||
| DescribeIndex | |||
| GetIndexState | |||
| GetIndexBuildProgress | |||
| DropIndex | |||
| Insert | |||
| Delete | |||
| Search | |||
| Flush | |||
| Query | |||
| CalcDistance | |||
| GetFlushState | |||
| GetPersistentSegmentInfo | |||
| GetQuerySegmentInfo | |||
| GetMetrics | |||
| LoadBalance | |||
| GetCompactionState | |||
| ManualCompaction | |||
| GetCompactionStateWithPlans |
Java SDK
RPC interface status:
| API | Available | Test Covered | Note |
|---|---|---|---|
| CreateCollection | Yes | Yes | |
| DropCollection | Yes | Yes | |
| HasCollection | Yes | Yes | |
| LoadCollection | Yes | Yes | |
| ReleaseCollection | Yes | Yes | |
| DescribeCollection | Yes | Yes | |
| GetCollectionStatistics | Yes | Yes | |
| ShowCollections | Yes | Yes | |
| CreatePartition | Yes | Yes | |
| DropPartition | Yes | Yes | |
| HasPartition | Yes | Yes | |
| LoadPartitions | Yes | Yes | |
| ReleasePartitions | Yes | Yes | |
| GetPartitionStatistics | Yes | Yes | |
| ShowPartitions | Yes | Yes | |
| CreateAlias | Yes | Yes | |
| DropAlias | Yes | Yes | |
| AlterAlias | Yes | Yes | |
| CreateIndex | Yes | Yes | |
| DescribeIndex | Yes | Yes | |
| GetIndexState | Yes | Yes | |
| GetIndexBuildProgress | Yes | Yes | |
| DropIndex | Yes | Yes | |
| Insert | Yes | Yes | |
| Delete | Yes | Yes | |
| Search | Yes | Yes | |
| Flush | Yes | Yes | |
| Query | Yes | Yes | |
| CalcDistance | Yes | Yes | |
| GetFlushState | Yes | Yes | |
| GetPersistentSegmentInfo | Yes | Yes | |
| GetQuerySegmentInfo | Yes | Yes | |
| GetMetrics | Yes | Yes | |
| LoadBalance | Yes | Yes | |
| GetCompactionState | Yes | Yes | |
| ManualCompaction | Yes | Yes | |
| GetCompactionStateWithPlans | Yes | Yes |
Node SDK
RPC interface status:
| API | Available | Test Covered | Note |
|---|---|---|---|
| CreateCollection | |||
| DropCollection | |||
| HasCollection | |||
| LoadCollection | |||
| ReleaseCollection | |||
| DescribeCollection | |||
| GetCollectionStatistics | |||
| ShowCollections | |||
| CreatePartition | |||
| DropPartition | |||
| HasPartition | |||
| LoadPartitions | |||
| ReleasePartitions | |||
| GetPartitionStatistics | |||
| ShowPartitions | |||
| CreateAlias | |||
| DropAlias | |||
| AlterAlias | |||
| CreateIndex | |||
| DescribeIndex | |||
| GetIndexState | |||
| GetIndexBuildProgress | |||
| DropIndex | |||
| Insert | |||
| Delete | |||
| Search | |||
| Flush | |||
| Query | |||
| CalcDistance | |||
| GetFlushState | |||
| GetPersistentSegmentInfo | |||
| GetQuerySegmentInfo | |||
| GetMetrics | |||
| LoadBalance | |||
| GetCompactionState | |||
| ManualCompaction | |||
| GetCompactionStateWithPlans |
C++ SDK
RPC interface status:
| API | Available | Test Covered | Note |
|---|---|---|---|
| CreateCollection | Yes | Yes | |
| DropCollection | Yes | Yes | |
| HasCollection | Yes | Yes | |
| LoadCollection | |||
| ReleaseCollection | |||
| DescribeCollection | |||
| GetCollectionStatistics | |||
| ShowCollections | |||
| CreatePartition | Yes | Yes | |
| DropPartition | |||
| HasPartition | Yes | Yes | |
| LoadPartitions | Yes | Yes | |
| ReleasePartitions | Yes | Yes | |
| GetPartitionStatistics | |||
| ShowPartitions | Yes | Yes | |
| CreateAlias | |||
| DropAlias | |||
| AlterAlias | |||
| CreateIndex | Yes | Yes | |
| DescribeIndex | |||
| GetIndexState | |||
| GetIndexBuildProgress | |||
| DropIndex | |||
| Insert | |||
| Delete | Yes | Yes | |
| Search | |||
| Flush | Yes | Yes | |
| Query | Yes | Yes | |
| CalcDistance | |||
| GetFlushState | Yes | Yes | |
| GetPersistentSegmentInfo | |||
| GetQuerySegmentInfo | |||
| GetMetrics | |||
| LoadBalance | |||
| GetCompactionState | |||
| ManualCompaction | |||
| GetCompactionStateWithPlans |