package milvus.proto.milvus
Get desktop application:
View/edit binary Protocol Buffers messages
service MilvusService
milvus.proto:18rpc CreateCollection (, )
milvus.proto:19message
milvus.proto:185* Create collection in milvus
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The unique collection name in milvus.(Required)
bytes schema = 4
The serialized `schema.CollectionSchema`(Required)
int32 shards_num = 5
Once set, no modification is allowed (Optional) https://github.com/milvus-io/milvus/issues/6690
common.ConsistencyLevel consistency_level = 6
The consistency level that the collection used, modification is not supported now.
repeated properties = 7
int64 num_partitions = 8
num of default physical partitions, only used in partition key mode and changes are not supported
rpc DropCollection (, )
milvus.proto:20message
milvus.proto:210* Drop collection in milvus, also will drop data in collection.
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The unique collection name in milvus.(Required)
rpc HasCollection (, )
milvus.proto:21message
milvus.proto:244* Check collection exist in milvus or not.
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The collection name you want to check.
uint64 time_stamp = 4
If time_stamp is not zero, will return true when time_stamp >= created collection timestamp, otherwise will return false.
rpc LoadCollection (, )
milvus.proto:22message
milvus.proto:321* Load collection data into query nodes, then you can do vector search on this collection.
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The collection name you want to load
int32 replica_number = 4
The replica number to load, default by 1
repeated string resource_groups = 5
create replica used resource group
bool refresh = 6
Whether to enable refresh mode.
rpc ReleaseCollection (, )
milvus.proto:23message
milvus.proto:343* Release collection data from query nodes, then you can't do vector search on this collection.
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The collection name you want to release
rpc DescribeCollection (, )
milvus.proto:24message
milvus.proto:268* Get collection meta datas like: schema, collectionID, shards number ...
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The collection name you want to describe, you can pass collection_name or collectionID
int64 collectionID = 4
The collection ID you want to describe
uint64 time_stamp = 5
If time_stamp is not zero, will describe collection success when time_stamp >= created collection timestamp, otherwise will throw error.
message
milvus.proto:288* DescribeCollection Response
optional status = 1
Contain error_code and reason
optional schema = 2
The schema param when you created collection.
int64 collectionID = 3
The collection id
repeated string virtual_channel_names = 4
System design related, users should not perceive
repeated string physical_channel_names = 5
System design related, users should not perceive
uint64 created_timestamp = 6
Hybrid timestamp in milvus
uint64 created_utc_timestamp = 7
The utc timestamp calculated by created_timestamp
int32 shards_num = 8
The shards number you set.
repeated string aliases = 9
The aliases of this collection
repeated start_positions = 10
The message ID/posititon when collection is created
common.ConsistencyLevel consistency_level = 11
The consistency level that the collection used, modification is not supported now.
string collection_name = 12
The collection name
repeated properties = 13
string db_name = 14
int64 num_partitions = 15
message
milvus.proto:391* Get collection statistics like row_count.
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The collection name you want get statistics
message
milvus.proto:407* Will return collection statistics in stats field like [{key:"row_count",value:"1"}]
optional status = 1
Contain error_code and reason
repeated stats = 2
Collection statistics data
rpc ShowCollections (, )
milvus.proto:26message
milvus.proto:428List collections
optional base = 1
Not useful for now
string db_name = 2
uint64 time_stamp = 3
Not useful for now
ShowType type = 4
Decide return Loaded collections or All collections(Optional)
repeated string collection_names = 5
When type is InMemory, will return these collection's inMemory_percentages.(Optional) Deprecated: use GetLoadingProgress rpc instead
message
milvus.proto:449Return basic collection infos.
optional status = 1
Contain error_code and reason
repeated string collection_names = 2
Collection name array
repeated int64 collection_ids = 3
Collection Id array
repeated uint64 created_timestamps = 4
Hybrid timestamps in milvus
repeated uint64 created_utc_timestamps = 5
The utc timestamp calculated by created_timestamp
repeated int64 inMemory_percentages = 6
Load percentage on querynode when type is InMemory Deprecated: use GetLoadingProgress rpc instead
repeated bool query_service_available = 7
Indicate whether query service is available
rpc AlterCollection (, )
milvus.proto:27message
milvus.proto:226* Alter collection in milvus
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The unique collection name in milvus.(Required)
int64 collectionID = 4
repeated properties = 5
rpc CreatePartition (, )
milvus.proto:29message
milvus.proto:470Create partition in created collection.
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The collection name in milvus
string partition_name = 4
The partition name you want to create.
rpc DropPartition (, )
milvus.proto:30message
milvus.proto:483Drop partition in created collection.
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The collection name in milvus
string partition_name = 4
The partition name you want to drop
rpc HasPartition (, )
milvus.proto:31message
milvus.proto:496Check if partition exist in collection or not.
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The collection name in milvus
string partition_name = 4
The partition name you want to check
rpc LoadPartitions (, )
milvus.proto:32message
milvus.proto:510Load specific partitions data of one collection into query nodes Then you can get these data as result when you do vector search on this collection.
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The collection name in milvus
repeated string partition_names = 4
The partition names you want to load
int32 replica_number = 5
The replicas number you would load, 1 by default
repeated string resource_groups = 6
create replica used resource group
bool refresh = 7
Whether to enable refresh mode.
rpc ReleasePartitions (, )
milvus.proto:33message
milvus.proto:530Release specific partitions data of one collection from query nodes. Then you can not get these data as result when you do vector search on this collection.
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The collection name in milvus
repeated string partition_names = 4
The partition names you want to release
message
milvus.proto:543Get partition statistics like row_count.
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The collection name in milvus
string partition_name = 4
The partition name you want to collect statistics
message
milvus.proto:553optional status = 1
repeated stats = 2
rpc ShowPartitions (, )
milvus.proto:35message
milvus.proto:561List all partitions for particular collection
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The collection name you want to describe, you can pass collection_name or collectionID
int64 collectionID = 4
The collection id in milvus
repeated string partition_names = 5
When type is InMemory, will return these patitions's inMemory_percentages.(Optional)
ShowType type = 6
Decide return Loaded partitions or All partitions(Optional) Deprecated: use GetLoadingProgress rpc instead
message
milvus.proto:580List all partitions for particular collection response. The returned datas are all rows, we can format to columns by therir index.
optional status = 1
Contain error_code and reason
repeated string partition_names = 2
All partition names for this collection
repeated int64 partitionIDs = 3
All partition ids for this collection
repeated uint64 created_timestamps = 4
All hybrid timestamps
repeated uint64 created_utc_timestamps = 5
All utc timestamps calculated by created_timestamps
repeated int64 inMemory_percentages = 6
Load percentage on querynode Deprecated: use GetLoadingProgress rpc instead
rpc GetLoadingProgress (, )
milvus.proto:37message
milvus.proto:1432optional base = 1
Not useful for now
string collection_name = 2
repeated string partition_names = 3
string db_name = 4
message
milvus.proto:1445optional status = 1
int64 progress = 2
int64 refresh_progress = 3
rpc GetLoadState (, )
milvus.proto:38message
milvus.proto:1451optional base = 1
Not useful for now
string collection_name = 2
repeated string partition_names = 3
string db_name = 4
message
milvus.proto:1464optional status = 1
common.LoadState state = 2
rpc CreateAlias (, )
milvus.proto:40message
milvus.proto:128optional base = 1
string db_name = 2
string collection_name = 3
string alias = 4
rpc DropAlias (, )
milvus.proto:41message
milvus.proto:135optional base = 1
string db_name = 2
string alias = 3
rpc AlterAlias (, )
milvus.proto:42message
milvus.proto:141optional base = 1
string db_name = 2
string collection_name = 3
string alias = 4
rpc DescribeAlias (, )
milvus.proto:43message
milvus.proto:148optional base = 1
string db_name = 2
string alias = 3
message
milvus.proto:157Describe alias response
optional status = 1
Response status
string db_name = 2
string alias = 3
string collection = 4
rpc ListAliases (, )
milvus.proto:44message
milvus.proto:165optional base = 1
string db_name = 2
string collection_name = 3
message
milvus.proto:174List aliases response
optional status = 1
Response status
string db_name = 2
string collection_name = 3
repeated string aliases = 4
rpc CreateIndex (, )
milvus.proto:46message
milvus.proto:624Create index for vector datas
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The particular collection name you want to create index.
string field_name = 4
The vector field name in this particular collection
repeated extra_params = 5
Support keys: index_type,metric_type, params. Different index_type may has different params.
string index_name = 6
Version before 2.0.2 doesn't contain index_name, we use default index name.
rpc DescribeIndex (, )
milvus.proto:47message
milvus.proto:647Get created index information. Current release of Milvus only supports showing latest built index.
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The particular collection name in Milvus
string field_name = 4
The vector field name in this particular collection
string index_name = 5
No need to set up for now @2021.06.30
uint64 timestamp = 6
message
milvus.proto:689Describe index response
optional status = 1
Response status
repeated index_descriptions = 2
All index informations, for now only return tha latest index you created for the collection.
rpc GetIndexStatistics (, )
milvus.proto:48message
milvus.proto:1605optional base = 1
Not useful for now
string db_name = 2
Not useful for now
string collection_name = 3
The particular collection name in Milvus
string index_name = 4
The index name in this particular collection
uint64 timestamp = 5
message
milvus.proto:1622optional status = 1
Response status
repeated index_descriptions = 2
All index information.
rpc GetIndexState (, )
milvus.proto:50Deprecated: use DescribeIndex instead
message
milvus.proto:722optional base = 1
must
string db_name = 2
string collection_name = 3
must
string field_name = 4
string index_name = 5
No need to set up for now @2021.06.30
message
milvus.proto:735optional status = 1
common.IndexState state = 2
string fail_reason = 3
rpc GetIndexBuildProgress (, )
milvus.proto:52Deprecated: use DescribeIndex instead
message
milvus.proto:699Get index building progress
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The collection name in milvus
string field_name = 4
The vector field name in this collection
string index_name = 5
Not useful for now
message
milvus.proto:716optional status = 1
int64 indexed_rows = 2
int64 total_rows = 3
rpc DropIndex (, )
milvus.proto:53message
milvus.proto:741optional base = 1
must
string db_name = 2
string collection_name = 3
must
string field_name = 4
Deprecated: not be used in the milvus
string index_name = 5
rpc Insert (, )
milvus.proto:55message
milvus.proto:755optional base = 1
string db_name = 2
string collection_name = 3
string partition_name = 4
repeated fields_data = 5
repeated uint32 hash_keys = 6
uint32 num_rows = 7
rpc Delete (, )
milvus.proto:56message
milvus.proto:797optional base = 1
string db_name = 2
string collection_name = 3
string partition_name = 4
string expr = 5
repeated uint32 hash_keys = 6
rpc Upsert (, )
milvus.proto:57message
milvus.proto:770optional base = 1
string db_name = 2
string collection_name = 3
string partition_name = 4
repeated fields_data = 5
repeated uint32 hash_keys = 6
uint32 num_rows = 7
rpc Search (, )
milvus.proto:58message
milvus.proto:812optional base = 1
must
string db_name = 2
string collection_name = 3
must
repeated string partition_names = 4
must
string dsl = 5
must
bytes placeholder_group = 6
serialized `PlaceholderGroup`
must
common.DslType dsl_type = 7
must
repeated string output_fields = 8
repeated search_params = 9
must
uint64 travel_timestamp = 10
uint64 guarantee_timestamp = 11
guarantee_timestamp
int64 nq = 12
bool not_return_all_meta = 13
common.ConsistencyLevel consistency_level = 14
bool use_default_consistency = 15
bool search_by_primary_keys = 16
message
milvus.proto:843optional status = 1
optional results = 2
string collection_name = 3
rpc Flush (, )
milvus.proto:59message
milvus.proto:849optional base = 1
string db_name = 2
repeated string collection_names = 3
message
milvus.proto:860optional status = 1
string db_name = 2
map<string, > coll_segIDs = 3
map<string, > flush_coll_segIDs = 4
map<string, int64> coll_seal_times = 5
rpc Query (, )
milvus.proto:60message
milvus.proto:868optional base = 1
string db_name = 2
string collection_name = 3
string expr = 4
repeated string output_fields = 5
repeated string partition_names = 6
uint64 travel_timestamp = 7
uint64 guarantee_timestamp = 8
guarantee_timestamp
repeated query_params = 9
optional
bool not_return_all_meta = 10
common.ConsistencyLevel consistency_level = 11
bool use_default_consistency = 12
message
milvus.proto:888optional status = 1
repeated fields_data = 2
string collection_name = 3
repeated string output_fields = 4
rpc CalcDistance (, )
milvus.proto:61message
milvus.proto:909optional base = 1
optional op_left = 2
vectors on the left of operator
optional op_right = 3
vectors on the right of operator
repeated params = 4
"metric":"L2"/"IP"/"HAMMIN"/"TANIMOTO"
message
milvus.proto:916optional status = 1
oneof array
num(op_left)*num(op_right) distance values, "HAMMIN" return integer distance
int_dist = 2
float_dist = 3
rpc FlushAll (, )
milvus.proto:62message
milvus.proto:925(message has no fields)
message
milvus.proto:933optional status = 1
uint64 flush_all_ts = 2
rpc GetFlushState (, )
milvus.proto:64message
milvus.proto:1086repeated int64 segmentIDs = 1
message
milvus.proto:1090optional status = 1
bool flushed = 2
rpc GetFlushAllState (, )
milvus.proto:65message
milvus.proto:1095optional base = 1
uint64 flush_all_ts = 2
message
milvus.proto:1100optional status = 1
bool flushed = 2
message
milvus.proto:946optional base = 1
must
string dbName = 2
string collectionName = 3
must
message
milvus.proto:952optional status = 1
repeated infos = 2
rpc GetQuerySegmentInfo (, )
milvus.proto:67message
milvus.proto:971optional base = 1
must
string dbName = 2
string collectionName = 3
must
message
milvus.proto:977optional status = 1
repeated infos = 2
rpc GetReplicas (, )
milvus.proto:68message
milvus.proto:1152optional base = 1
int64 collectionID = 2
bool with_shard_nodes = 3
string collection_name = 4
string db_name = 5
message
milvus.proto:1160optional status = 1
repeated replicas = 2
rpc Dummy (, )
milvus.proto:70message
milvus.proto:982string request_type = 1
message
milvus.proto:986string response = 1
rpc RegisterLink (, )
milvus.proto:73TODO: remove
rpc GetMetrics (, )
milvus.proto:76https://wiki.lfaidata.foundation/display/MIL/MEP+8+--+Add+metrics+for+proxy
message
milvus.proto:998optional base = 1
string request = 2
request is of jsonic format
message
milvus.proto:1003optional status = 1
string response = 2
response is of jsonic format
string component_name = 3
metrics from which component
rpc GetComponentStates (, )
milvus.proto:77message
milvus.proto:1022(message has no fields)
message
milvus.proto:1016optional state = 1
repeated subcomponent_states = 2
optional status = 3
rpc LoadBalance (, )
milvus.proto:79message
milvus.proto:1028Do load balancing operation from src_nodeID to dst_nodeID.
optional base = 1
int64 src_nodeID = 2
repeated int64 dst_nodeIDs = 3
repeated int64 sealed_segmentIDs = 4
string collectionName = 5
string db_name = 6
rpc GetCompactionState (, )
milvus.proto:80message
milvus.proto:1058int64 compactionID = 1
message
milvus.proto:1062optional status = 1
common.CompactionState state = 2
int64 executingPlanNo = 3
int64 timeoutPlanNo = 4
int64 completedPlanNo = 5
int64 failedPlanNo = 6
rpc ManualCompaction (, )
milvus.proto:81message
milvus.proto:1042int64 collectionID = 1
uint64 timetravel = 2
message
milvus.proto:1052optional status = 1
int64 compactionID = 2
int32 compactionPlanCount = 3
message
milvus.proto:1071int64 compactionID = 1
message
milvus.proto:1075optional status = 1
common.CompactionState state = 2
repeated mergeInfos = 3
rpc Import (, )
milvus.proto:85https://wiki.lfaidata.foundation/display/MIL/MEP+24+--+Support+bulk+load
message
milvus.proto:1105string collection_name = 1
target collection
string partition_name = 2
target partition
repeated string channel_names = 3
channel names for the collection
bool row_based = 4
the file is row-based or column-based
repeated string files = 5
file paths to be imported
repeated options = 6
import options, bucket, etc.
string db_name = 7
message
milvus.proto:1120optional status = 1
repeated int64 tasks = 2
id array of import tasks
rpc GetImportState (, )
milvus.proto:86message
milvus.proto:1125int64 task = 1
id of an import task
rpc ListImportTasks (, )
milvus.proto:87message
milvus.proto:1141string collection_name = 1
target collection, list all tasks if the name is empty
int64 limit = 2
maximum number of tasks returned, list all tasks if the value is 0
string db_name = 3
message
milvus.proto:1147optional status = 1
repeated tasks = 2
list of all import tasks
rpc CreateCredential (, )
milvus.proto:90https://wiki.lfaidata.foundation/display/MIL/MEP+27+--+Support+Basic+Authentication
message
milvus.proto:1191optional base = 1
Not useful for now
string username = 2
username
string password = 3
ciphertext password
uint64 created_utc_timestamps = 4
create time
uint64 modified_utc_timestamps = 5
modify time
rpc UpdateCredential (, )
milvus.proto:91message
milvus.proto:1209optional base = 1
Not useful for now
string username = 2
username
string oldPassword = 3
old password
string newPassword = 4
new password
uint64 created_utc_timestamps = 5
create time
uint64 modified_utc_timestamps = 6
modify time
rpc DeleteCredential (, )
milvus.proto:92message
milvus.proto:1229optional base = 1
Not useful for now
string username = 2
Not useful for now
rpc ListCredUsers (, )
milvus.proto:93message
milvus.proto:1248optional base = 1
Not useful for now
message
milvus.proto:1241optional status = 1
Contain error_code and reason
repeated string usernames = 2
username array
rpc CreateRole (, )
milvus.proto:96https://wiki.lfaidata.foundation/display/MIL/MEP+29+--+Support+Role-Based+Access+Control
message
milvus.proto:1267optional base = 1
Not useful for now
optional entity = 2
role
rpc DropRole (, )
milvus.proto:97message
milvus.proto:1279optional base = 1
Not useful for now
string role_name = 2
role name
rpc OperateUserRole (, )
milvus.proto:98message
milvus.proto:1296optional base = 1
Not useful for now
string username = 2
username
string role_name = 3
role name
OperateUserRoleType type = 4
operation type
rpc SelectRole (, )
milvus.proto:99message
milvus.proto:1312optional base = 1
Not useful for now
optional role = 2
role
bool include_user_info = 3
include user info
message
milvus.proto:1331optional status = 1
Not useful for now
repeated results = 2
role result array
rpc SelectUser (, )
milvus.proto:100message
milvus.proto:1338optional base = 1
Not useful for now
optional user = 2
user
bool include_role_info = 3
include user info
message
milvus.proto:1357optional status = 1
Not useful for now
repeated results = 2
user result array
rpc OperatePrivilege (, )
milvus.proto:101message
milvus.proto:1418optional base = 1
Not useful for now
optional entity = 2
grant
OperatePrivilegeType type = 3
operation type
rpc SelectGrant (, )
milvus.proto:102message
milvus.proto:1394optional base = 1
Not useful for now
optional entity = 2
grant
message
milvus.proto:1406optional status = 1
Not useful for now
repeated entities = 2
grant info array
rpc GetVersion (, )
milvus.proto:104message
milvus.proto:1477(message has no fields)
message
milvus.proto:1480optional status = 1
string version = 2
rpc CheckHealth (, )
milvus.proto:105message
milvus.proto:1493(message has no fields)
message
milvus.proto:1496optional status = 1
bool isHealthy = 2
repeated string reasons = 3
repeated QuotaState quota_states = 4
rpc CreateResourceGroup (, )
milvus.proto:107message
milvus.proto:1503optional base = 1
string resource_group = 2
rpc DropResourceGroup (, )
milvus.proto:108message
milvus.proto:1513optional base = 1
string resource_group = 2
rpc TransferNode (, )
milvus.proto:109message
milvus.proto:1524transfer `nodeNum` nodes from `source_resource_group` to `target_resource_group`
optional base = 1
string source_resource_group = 2
string target_resource_group = 3
int32 num_node = 4
rpc TransferReplica (, )
milvus.proto:110message
milvus.proto:1537transfer `replicaNum` replicas in `collectionID` from `source_resource_group` to `target_resource_group`
optional base = 1
string source_resource_group = 2
string target_resource_group = 3
string collection_name = 4
int64 num_replica = 5
string db_name = 6
rpc ListResourceGroups (, )
milvus.proto:111message
milvus.proto:1551optional base = 1
message
milvus.proto:1560optional status = 1
repeated string resource_groups = 2
message
milvus.proto:1565optional base = 1
string resource_group = 2
message
milvus.proto:1575optional status = 1
optional resource_group = 2
rpc RenameCollection (, )
milvus.proto:114message
milvus.proto:1592optional base = 1
string db_name = 2
string oldName = 3
string newName = 4
string newDBName = 5
rpc ListIndexedSegment (, )
milvus.proto:116rpc Connect (, )
milvus.proto:119message
milvus.proto:1629optional base = 1
optional client_info = 2
message
milvus.proto:1634optional status = 1
optional server_info = 2
int64 identifier = 3
rpc AllocTimestamp (, )
milvus.proto:121message
milvus.proto:1640optional base = 1
message
milvus.proto:1644optional status = 1
uint64 timestamp = 2
rpc CreateDatabase (, )
milvus.proto:123message
milvus.proto:1649optional base = 1
string db_name = 2
rpc DropDatabase (, )
milvus.proto:124message
milvus.proto:1659optional base = 1
string db_name = 2
rpc ListDatabases (, )
milvus.proto:125message
milvus.proto:1669optional base = 1
message
milvus.proto:1678optional status = 1
repeated string db_names = 2
repeated uint64 created_timestamp = 3
service ProxyService
milvus.proto:1185rpc RegisterLink (, )
milvus.proto:1186
message
milvus.proto:255Used as response type in: MilvusService.HasCollection, MilvusService.HasPartition
optional status = 1
bool value = 2
message
milvus.proto:1081Used in:
repeated int64 sources = 1
int64 target = 2
message
milvus.proto:1009Used in:
int64 nodeID = 1
string role = 2
common.StateCode state_code = 3
repeated extra_info = 4
message
milvus.proto:596optional base = 1
int64 collectionID = 2
int64 segmentID = 3
message
milvus.proto:602optional status = 1
int64 indexID = 2
int64 buildID = 3
bool enable_index = 4
int64 fieldID = 5
message
milvus.proto:1129Used as response type in: MilvusService.GetImportState
Used as field type in:
optional status = 1
common.ImportState state = 2
is this import task finished or not
int64 row_count = 3
if the task is finished, this value is how many rows are imported. if the task is not finished, this value is how many rows are parsed. return 0 if failed.
repeated int64 id_list = 4
auto generated ids if the primary key is autoid
repeated infos = 5
more information about the task, progress percent, file path, failed reason, etc.
int64 id = 6
id of an import task
int64 collection_id = 7
collection ID of the import task.
repeated int64 segment_ids = 8
a list of segment IDs created by the import task.
int64 create_ts = 9
timestamp when the import task is created.
message
milvus.proto:360* Get statistics like row_count. WARNING: This API is experimental and not useful for now.
optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The collection name you want get statistics
repeated string partition_names = 4
The partition names you want get statistics, empty for all partitions
uint64 guarantee_timestamp = 5
Not useful for now, reserved for future
message
milvus.proto:381* Will return statistics in stats field like [{key:"row_count",value:"1"}] WARNING: This API is experimental and not useful for now.
optional status = 1
Contain error_code and reason
repeated stats = 2
Collection statistics data
message
milvus.proto:1381Used in: , ,
optional role = 1
role
optional object = 2
object
string object_name = 3
object name
optional grantor = 4
privilege
string db_name = 5
db name
message
milvus.proto:1377repeated entities = 1
message
milvus.proto:1372Used in: ,
optional user = 1
optional privilege = 2
message
milvus.proto:837repeated int64 IDs = 1
repeated bytes row_data = 2
repeated float scores = 3
message
milvus.proto:668Index informations
Used in: ,
string index_name = 1
Index name
int64 indexID = 2
Index id
repeated params = 3
Will return index_type, metric_type, params(like nlist).
string field_name = 4
The vector field name
int64 indexed_rows = 5
index build progress
int64 total_rows = 6
common.IndexState state = 7
index state
string index_state_fail_reason = 8
int64 pending_index_rows = 9
message
milvus.proto:1469string version = 1
message
milvus.proto:785Used as response type in: MilvusService.Delete, MilvusService.Insert, MilvusService.Upsert
optional status = 1
optional IDs = 2
required for insert, delete, upsert
repeated uint32 succ_index = 3
error indexes indicate
repeated uint32 err_index = 4
error indexes indicate
bool acknowledged = 5
int64 insert_cnt = 6
int64 delete_cnt = 7
int64 upsert_cnt = 8
uint64 timestamp = 9
message
milvus.proto:1364Used in:
string name = 1
Used in:
Grant = 0
Revoke = 1
Used in:
AddUserToRole = 0
RemoveUserFromRole = 1
message
milvus.proto:938Used in:
int64 segmentID = 1
int64 collectionID = 2
int64 partitionID = 3
int64 num_rows = 4
common.SegmentState state = 5
message
milvus.proto:1368Used in:
string name = 1
message
milvus.proto:957Used in:
int64 segmentID = 1
int64 collectionID = 2
int64 partitionID = 3
int64 mem_size = 4
int64 num_rows = 5
string index_name = 6
int64 indexID = 7
int64 nodeID = 8
deprecated, check node_ids(NodeIds) field
common.SegmentState state = 9
repeated int64 nodeIds = 10
Used in:
Unknown = 0
ReadLimited = 2
WriteLimited = 3
DenyToRead = 4
DenyToWrite = 5
message
milvus.proto:990Used as request type in: MilvusService.RegisterLink, ProxyService.RegisterLink
(message has no fields)
message
milvus.proto:993Used as response type in: MilvusService.RegisterLink, ProxyService.RegisterLink
optional address = 1
optional status = 2
message
milvus.proto:1165ReplicaGroup
Used in:
int64 replicaID = 1
int64 collectionID = 2
repeated int64 partition_ids = 3
empty indicates to load collection
repeated shard_replicas = 4
repeated int64 node_ids = 5
include leaders
string resource_group_name = 6
map<string, int32> num_outbound_node = 7
outbound access rg -> node num
message
milvus.proto:1580Used in:
string name = 1
int32 capacity = 2
int32 num_available_node = 3
map<string, int32> num_loaded_replica = 4
collection name -> loaded replica num
map<string, int32> num_outgoing_node = 5
collection name -> accessed other rg's node num
map<string, int32> num_incoming_node = 6
collection name -> be accessed node num by other rg
message
milvus.proto:1259https://wiki.lfaidata.foundation/display/MIL/MEP+29+--+Support+Role-Based+Access+Control
Used in: , , , ,
string name = 1
message
milvus.proto:1326Used in:
optional role = 1
repeated users = 2
message
milvus.proto:1176Used in:
int64 leaderID = 1
string leader_addr = 2
IP:port
string dm_channel_name = 3
repeated int64 node_ids = 4
optional, DO NOT save it in meta, set it only for GetReplicas() if with_shard_nodes is true
message
milvus.proto:610optional base = 1
int64 collectionID = 2
int64 partitionID = 3
message
milvus.proto:616optional status = 1
repeated int64 segmentIDs = 2
Deprecated: use GetLoadingProgress rpc instead
Used in: ,
All = 0
Will return all collections
InMemory = 1
Will return loaded collections with their inMemory_percentages
message
milvus.proto:260optional status = 1
string value = 2
message
milvus.proto:1263Used in: , , ,
string name = 1
message
milvus.proto:1352Used in:
optional user = 1
repeated roles = 2
message
milvus.proto:895Used in:
string collection_name = 1
string field_name = 2
optional id_array = 3
repeated string partition_names = 4
message
milvus.proto:902Used in:
oneof array
id_array = 1
vector ids
data_array = 2
vectors data