Milvus v2.x SDK Toolkits Status

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

Proto API	Implemented	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
collection	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
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
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
	mkts_from_hybridts	Yes	Yes
	mkts_from_unixtime	Yes	Yes
	mkts_from_datetime	Yes	Yes
	hybridts_to_datetime	Yes	Yes
	hybridts_to_unixtime	Yes	Yes

Go SDK

RPC interface status

Proto API	Implemented	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	No	No
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	No	Yes	internal use, not exposed
GetPersistentSegmentInfo	No	Yes	internal use, not exposed
GetQuerySegmentInfo	No	Yes	internal use, not exposed
GetMetrics	No	No
LoadBalance	No	No
GetCompactionState	Yes	Yes
ManualCompaction	Yes	Yes
GetCompactionStateWithPlans	Yes	Yes

Java SDK

RPC interface status

Proto API	Implemented	Test Covered	Note
CreateCollection	Yes	Yes	createCollection()
DropCollection	Yes	Yes	dropCollection()
HasCollection	Yes	Yes	hasCollection()
LoadCollection	Yes	Yes	loadCollection()
ReleaseCollection	Yes	Yes	releaseCollection()
DescribeCollection	Yes	Yes	describeCollection()
GetCollectionStatistics	Yes	Yes	getCollectionStatistics()
ShowCollections	Yes	Yes	showCollections()
CreatePartition	Yes	Yes	createPartition()
DropPartition	Yes	Yes	dropPartition()
HasPartition	Yes	Yes	hasPartition()
LoadPartitions	Yes	Yes	loadPartitions()
ReleasePartitions	Yes	Yes	releasePartitions()
GetPartitionStatistics	Yes	Yes	getPartitionStatistics()
ShowPartitions	Yes	Yes	showPartitions()
CreateAlias	Yes	Yes	createAlias()
DropAlias	Yes	Yes	dropAlias()
AlterAlias	Yes	Yes	alterAlias()
CreateIndex	Yes	Yes	createIndex()
DescribeIndex	Yes	Yes	describeIndex()
GetIndexState	Yes	Yes	getIndexState()
GetIndexBuildProgress	Yes	Yes	getIndexBuildProgress()
DropIndex	Yes	Yes	dropIndex()
Insert	Yes	Yes	insert()
Delete	Yes	Yes	delete()
Search	Yes	Yes	search()
Flush	Yes	Yes	internal use, not exposed
Query	Yes	Yes	query()
CalcDistance	Yes	Yes	calcDistance() only support float vectors, cannot support binary vectors
GetFlushState	Yes	Yes	getFlushState()
GetPersistentSegmentInfo	Yes	Yes	getPersistentSegmentInfo()
GetQuerySegmentInfo	Yes	Yes	getQuerySegmentInfo()
GetMetrics	Yes	Yes	getMetrics()
LoadBalance	Yes	Yes	loadBalance()
GetCompactionState	Yes	Yes	getCompactionState()
ManualCompaction	Yes	Yes	manualCompaction()
GetCompactionStateWithPlans	Yes	Yes	getCompactionStateWithPlans()

Node SDK

RPC interface status

Proto API	Implemented	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	Method is ready, not shown in the document yet.
DropAlias	Yes	Yes	Method is ready, not shown in the document yet.
AlterAlias	Yes	Yes	Method is ready, not shown in the document yet.
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	calcDistance() Method is ready, not shown in the document yet. only support float vectors, cannot support binary vectors
GetFlushState	Yes	Yes
GetPersistentSegmentInfo	Yes	Yes	No separate interface exposed. Use GetPersistentSegmentInfo method in flushSync method.
GetQuerySegmentInfo	Yes	Yes
GetMetrics	Yes	Yes	Method is ready, not shown in the document yet.
LoadBalance	Yes	Yes
GetCompactionState	Yes	Yes
ManualCompaction	Yes	Yes
GetCompactionStateWithPlans	Yes	Yes

C++ SDK

RPC interface status

Proto API	Implemented	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	GetCompactionPlans