package milvus.proto.milvus
Get desktop application:
View/edit binary Protocol Buffers messages
Client Telemetry Service
rpc ClientHeartbeat (, )
milvus.proto:242message
milvus.proto:3027Client Heartbeat
optional client_info = 1
int64 report_timestamp = 2
repeated metrics = 3
repeated command_replies = 4
string config_hash = 5
int64 last_command_timestamp = 6
message
milvus.proto:3036optional status = 1
int64 server_timestamp = 2
repeated commands = 3
rpc DeleteClientCommand (, )
milvus.proto:245message
milvus.proto:3079Delete Client Command
string command_id = 1
message
milvus.proto:3083optional status = 1
rpc GetClientTelemetry (, )
milvus.proto:243message
milvus.proto:3043Get Client Telemetry
string database = 1
string client_id = 2
bool include_metrics = 3
message
milvus.proto:3057optional status = 1
repeated clients = 2
optional aggregated = 3
rpc PushClientCommand (, )
milvus.proto:244message
milvus.proto:3064Push Client Command
string command_type = 1
bytes payload = 2
string target_client_id = 3
string target_database = 4
int64 ttl_seconds = 5
bool persistent = 6
message
milvus.proto:3073optional status = 1
string command_id = 2
service MilvusService
milvus.proto:20rpc AddCollectionField (, )
milvus.proto:78message
milvus.proto:1025optional base = 1
string db_name = 2
string collection_name = 3
int64 collectionID = 4
bytes schema = 5
The serialized `schema.FieldSchema`
rpc AddCollectionFunction (, )
milvus.proto:32message
milvus.proto:1052optional base = 1
string db_name = 2
string collection_name = 3
int64 collectionID = 4
optional functionSchema = 5
message
milvus.proto:1039optional base = 1
string db_name = 2
string collection_name = 3
int64 collectionID = 4
optional struct_array_field_schema = 5
rpc AddFileResource (, )
milvus.proto:163message
milvus.proto:2460optional base = 1
string name = 2
string path = 3
rpc AddUserTags (, )
milvus.proto:168Row Level Security (RLS) APIs
message
milvus.proto:2507User Tag Management
optional base = 1
string user_name = 2
map<string, string> tags = 3
rpc AllocTimestamp (, )
milvus.proto:141message
milvus.proto:2305optional base = 1
message
milvus.proto:2309optional status = 1
uint64 timestamp = 2
rpc AlterAlias (, )
milvus.proto:50message
milvus.proto:273optional base = 1
string db_name = 2
string collection_name = 3
string alias = 4
rpc AlterCollection (, )
milvus.proto:30message
milvus.proto:376* 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
repeated string delete_keys = 6
rpc AlterCollectionField (, )
milvus.proto:31message
milvus.proto:392optional base = 1
Not useful for now
string db_name = 2
string collection_name = 3
The unique collection name in milvus.(Required)
string field_name = 4
repeated properties = 5
repeated string delete_keys = 6
message
milvus.proto:1065optional base = 1
string db_name = 2
string collection_name = 3
int64 collectionID = 4
string function_name = 5
optional functionSchema = 6
message
milvus.proto:2956optional base = 1
string db_name = 2
string collection_name = 3
int64 collectionID = 4
optional action = 5
message
milvus.proto:3004optional alter_status = 1
rpc AlterDatabase (, )
milvus.proto:146message
milvus.proto:2346optional base = 1
string db_name = 2
string db_id = 3
repeated properties = 4
repeated string delete_keys = 5
rpc AlterIndex (, )
milvus.proto:55message
milvus.proto:877Alter index
optional base = 1
string db_name = 2
string collection_name = 3
string index_name = 4
repeated extra_params = 5
repeated string delete_keys = 6
rpc AlterRole (, )
milvus.proto:114message
milvus.proto:1774optional base = 1
Not useful for now
string role_name = 2
role name
string description = 3
role description
rpc BackupRBAC (, )
milvus.proto:154message
milvus.proto:2055optional base = 1
Not useful for now
message
milvus.proto:2065optional status = 1
optional RBAC_meta = 2
message
milvus.proto:490string db_name = 1
repeated string collection_name = 2
The collection name you want to describe, you can pass collection_name or collectionID
repeated int64 collectionID = 3
The collection ID you want to describe
message
milvus.proto:503optional status = 1
Contain error_code and reason
repeated responses = 2
rpc BatchUpdateManifest (, )
milvus.proto:232message
milvus.proto:3008optional base = 1
string db_name = 2
string collection_name = 3
repeated string field_names = 4
work as hint for now
repeated items = 5
rpc CalcDistance (, )
milvus.proto:75message
milvus.proto:1310optional 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:1317optional status = 1
oneof array
num(op_left)*num(op_right) distance values, "HAMMIN" return integer distance
int_dist = 2
float_dist = 3
rpc CheckHealth (, )
milvus.proto:124message
milvus.proto:2143(message has no fields)
message
milvus.proto:2146optional status = 1
bool isHealthy = 2
repeated string reasons = 3
repeated QuotaState quota_states = 4
message
milvus.proto:2726optional base = 1
string analyzer_params = 2
string query_text = 3
repeated string data_texts = 4
message
milvus.proto:2733optional status = 1
repeated bool is_match = 2
repeated int64 slops = 3
rpc Connect (, )
milvus.proto:139message
milvus.proto:2294optional base = 1
optional client_info = 2
message
milvus.proto:2299optional status = 1
optional server_info = 2
int64 identifier = 3
rpc CreateAlias (, )
milvus.proto:48message
milvus.proto:248optional base = 1
string db_name = 2
string collection_name = 3
string alias = 4
rpc CreateCollection (, )
milvus.proto:21message
milvus.proto:335* 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 CreateCredential (, )
milvus.proto:107https://wiki.lfaidata.foundation/display/MIL/MEP+27+--+Support+Basic+Authentication
message
milvus.proto:1683optional 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
optional string description = 6
rpc CreateDatabase (, )
milvus.proto:143message
milvus.proto:2314optional base = 1
string db_name = 2
repeated properties = 3
rpc CreateIndex (, )
milvus.proto:54message
milvus.proto:855Create 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 CreatePartition (, )
milvus.proto:37message
milvus.proto:665Create 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 CreatePrivilegeGroup (, )
milvus.proto:157message
milvus.proto:1802optional base = 1
Not useful for now
string group_name = 2
group name
rpc CreateReplicateStream (stream , stream )
milvus.proto:204CreateReplicateStream establishes a replication stream on the target Milvus cluster. Semantics: - Sets up a continuous data stream that receives replicated messages (DDL, insert, delete, etc.) from the source cluster via CDC. - Once established, the target cluster persists incoming messages into its WAL (Write-Ahead Log) ensuring durability and consistency.
message
milvus.proto:2668oneof request
replicate_message = 1
message
milvus.proto:2678oneof response
replicate_confirmed_message_info = 1
rpc CreateResourceGroup (, )
milvus.proto:126message
milvus.proto:2153optional base = 1
string resource_group = 2
optional config = 3
rpc CreateRole (, )
milvus.proto:113https://wiki.lfaidata.foundation/display/MIL/MEP+29+--+Support+Role-Based+Access+Control
message
milvus.proto:1762optional base = 1
Not useful for now
optional entity = 2
role
rpc CreateRowPolicy (, )
milvus.proto:173message
milvus.proto:2565Row Policy Management
optional base = 1
string db_name = 2
string collection_name = 3
string policy_name = 4
repeated RowPolicyAction actions = 5
actions this policy controls
repeated string roles = 6
role names that this policy applies to
string using_expr = 7
expression for filtering data during queries
string check_expr = 8
expression for validating data during mutations
string description = 9
optional description
rpc CreateSnapshot (, )
milvus.proto:220snapshot related
message
milvus.proto:2742Snapshot Management
optional base = 1
string name = 2
user-defined snapshot name
string description = 3
user-defined snapshot description
string db_name = 4
db name
string collection_name = 5
collection name
int64 compaction_protection_seconds = 6
duration in seconds to protect referenced segments from compaction, 0 = no protection
rpc Delete (, )
milvus.proto:69message
milvus.proto:1127optional base = 1
string db_name = 2
string collection_name = 3
string partition_name = 4
string expr = 5
repeated uint32 hash_keys = 6
common.ConsistencyLevel consistency_level = 7
map<string, > expr_template_values = 8
optional string namespace = 9
rpc DeleteCredential (, )
milvus.proto:109message
milvus.proto:1723optional base = 1
Not useful for now
string username = 2
Not useful for now
rpc DeleteUserTags (, )
milvus.proto:169message
milvus.proto:2519optional base = 1
string user_name = 2
repeated string tag_keys = 3
rpc DescribeAlias (, )
milvus.proto:51message
milvus.proto:286optional base = 1
string db_name = 2
string alias = 3
message
milvus.proto:301Describe alias response
optional status = 1
Response status
string db_name = 2
string alias = 3
string collection = 4
rpc DescribeCollection (, )
milvus.proto:26message
milvus.proto:435* 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.
rpc DescribeDatabase (, )
milvus.proto:147message
milvus.proto:2359optional base = 1
string db_name = 2
message
milvus.proto:2369optional status = 1
string db_name = 2
int64 dbID = 3
uint64 created_timestamp = 4
repeated properties = 5
rpc DescribeIndex (, )
milvus.proto:56message
milvus.proto:896Get 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:942Describe 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.
message
milvus.proto:2226optional base = 1
string resource_group = 2
message
milvus.proto:2236optional status = 1
optional resource_group = 2
rpc DescribeSnapshot (, )
milvus.proto:223message
milvus.proto:2788optional base = 1
string name = 2
snapshot name
string db_name = 3
db name
string collection_name = 4
collection name
message
milvus.proto:2801optional status = 1
string name = 2
user-defined snapshot name
string description = 3
user-defined snapshot description
string collection_name = 4
collection name
repeated string partition_names = 5
the partition names in the snapshot.
int64 create_ts = 6
create timestamp, all stream data before this timestamp will be flushed to segment list.
string s3_location = 7
s3 location of the snapshot meta file if snapshot is exported to s3.
rpc DropAlias (, )
milvus.proto:49message
milvus.proto:261optional base = 1
string db_name = 2
string alias = 3
rpc DropCollection (, )
milvus.proto:22message
milvus.proto:360* 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)
message
milvus.proto:1079optional base = 1
string db_name = 2
string collection_name = 3
int64 collectionID = 4
string function_name = 5
rpc DropDatabase (, )
milvus.proto:144message
milvus.proto:2325optional base = 1
string db_name = 2
rpc DropIndex (, )
milvus.proto:66message
milvus.proto:994optional 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 DropPartition (, )
milvus.proto:38message
milvus.proto:683Drop 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 DropPrivilegeGroup (, )
milvus.proto:158message
milvus.proto:1814optional base = 1
Not useful for now
string group_name = 2
group name
rpc DropResourceGroup (, )
milvus.proto:127message
milvus.proto:2174optional base = 1
string resource_group = 2
rpc DropRole (, )
milvus.proto:115message
milvus.proto:1788optional base = 1
Not useful for now
string role_name = 2
role name
bool force_drop = 3
force to drop the role even if there is permission binding
rpc DropRowPolicy (, )
milvus.proto:174message
milvus.proto:2583optional base = 1
string db_name = 2
string collection_name = 3
string policy_name = 4
rpc DropSnapshot (, )
milvus.proto:221message
milvus.proto:2757optional base = 1
string name = 2
snapshot name
string db_name = 3
db name
string collection_name = 4
collection name
rpc Dummy (, )
milvus.proto:87message
milvus.proto:1440string request_type = 1
message
milvus.proto:1444string response = 1
rpc DumpMessages (, stream )
milvus.proto:215DumpMessages streams messages from a WAL range for data salvage. Semantics: - Reads messages starting from start_message_id position (inclusive). - Use start_timetick/end_timetick to filter messages by timetick range. - Only returns non-system messages (filters out TimeTick, CreateSegment, Flush, RollbackTxn). - Streams messages until end_timetick is reached or context is cancelled. - Typically used after force failover to recover unsynchronized messages from the old primary cluster using the salvage checkpoint.
message
milvus.proto:2689DumpMessagesRequest is used to dump messages from a WAL range for data salvage. Usage: After force failover, use GetReplicateInfo to get the salvage_checkpoint, then call DumpMessages with the checkpoint's message_id and timetick to retrieve unsynchronized messages from the old primary cluster.
string pchannel = 1
Physical channel name to dump from (required)
optional start_message_id = 2
Start position in WAL (required) - typically from salvage_checkpoint.message_id
uint64 start_timetick = 3
Start timetick filter (optional) - only dump messages with timetick >= start_timetick, typically from salvage_checkpoint.time_tick
uint64 end_timetick = 4
End timetick filter (optional) - only dump messages with timetick <= end_timetick, 0 means no limit (stream until cancelled)
bool include_start_message = 5
If true, dump starts from start_message_id inclusively; otherwise starts after it.
message
milvus.proto:2699DumpMessagesResponse streams messages from the WAL. Each response contains either an error status or a message (never both).
oneof response
status = 1
Error status (only sent when an error occurs)
message = 2
A dumped message (filtered to exclude system messages)
rpc ExportSnapshot (, )
milvus.proto:226message
milvus.proto:2857export a snapshot and all referenced files to a self-contained external bundle
optional base = 1
string name = 2
source snapshot name
string db_name = 3
source db name (where the snapshot lives)
string collection_name = 4
source collection name (where the snapshot lives)
string target_s3_path = 5
target root path for the exported snapshot bundle
string external_spec = 6
Optional external storage spec JSON for the external snapshot storage. Snapshot APIs consume the extfs section for provider, endpoint, region, SSL, IAM, and credential settings.
message
milvus.proto:2875optional status = 1
string snapshot_metadata_uri = 2
rpc Flush (, )
milvus.proto:73message
milvus.proto:1231optional base = 1
string db_name = 2
repeated string collection_names = 3
message
milvus.proto:1242optional status = 1
string db_name = 2
map<string, > coll_segIDs = 3
map<string, > flush_coll_segIDs = 4
map<string, int64> coll_seal_times = 5
physical time for backup tool
map<string, uint64> coll_flush_ts = 6
hybrid ts for geting flush tate
map<string, > channel_cps = 7
rpc FlushAll (, )
milvus.proto:76message
milvus.proto:1337optional base = 1
string db_name = 2
repeated flush_targets = 3
message
milvus.proto:1355optional status = 1
uint64 flush_all_ts = 2
repeated flush_results = 3
map<string, > flush_all_msgs = 4
pchannel -> FlushAllMsg
optional cluster_info = 5
message
milvus.proto:589* 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:605* 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 GetCompactionState (, )
milvus.proto:97message
milvus.proto:1524int64 compactionID = 1
message
milvus.proto:1528optional status = 1
common.CompactionState state = 2
int64 executingPlanNo = 3
int64 timeoutPlanNo = 4
int64 completedPlanNo = 5
int64 failedPlanNo = 6
message
milvus.proto:1537int64 compactionID = 1
message
milvus.proto:1541optional status = 1
common.CompactionState state = 2
repeated mergeInfos = 3
rpc GetComponentStates (, )
milvus.proto:94message
milvus.proto:1480(message has no fields)
message
milvus.proto:1474optional state = 1
repeated subcomponent_states = 2
optional status = 3
rpc GetFlushAllState (, )
milvus.proto:82message
milvus.proto:1569optional base = 1
uint64 flush_all_ts = 2
string db_name = 3
repeated flush_targets = 4
map<string, uint64> flush_all_tss = 5
pchannel -> flush all ts
message
milvus.proto:1577optional status = 1
bool flushed = 2
True if all data in the cluster are flushed
repeated flush_states = 3
Detailed flush state for each database Provides per-database and per-collection flush status information
rpc GetFlushState (, )
milvus.proto:81message
milvus.proto:1552repeated int64 segmentIDs = 1
uint64 flush_ts = 2
string db_name = 3
string collection_name = 4
message
milvus.proto:1564optional status = 1
bool flushed = 2
rpc GetImportState (, )
milvus.proto:103message
milvus.proto:1617int64 task = 1
id of an import task
rpc GetIndexBuildProgress (, )
milvus.proto:63Deprecated: use DescribeIndex instead
message
milvus.proto:952Get 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:969optional status = 1
int64 indexed_rows = 2
int64 total_rows = 3
rpc GetIndexState (, )
milvus.proto:59Deprecated: use DescribeIndex instead
message
milvus.proto:975optional 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:988optional status = 1
common.IndexState state = 2
string fail_reason = 3
rpc GetIndexStatistics (, )
milvus.proto:57message
milvus.proto:2270optional 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:2287optional status = 1
Response status
repeated index_descriptions = 2
All index information.
rpc GetLoadState (, )
milvus.proto:46message
milvus.proto:2100optional base = 1
Not useful for now
string collection_name = 2
repeated string partition_names = 3
string db_name = 4
message
milvus.proto:2113optional status = 1
common.LoadState state = 2
rpc GetLoadingProgress (, )
milvus.proto:45message
milvus.proto:2081optional base = 1
Not useful for now
string collection_name = 2
repeated string partition_names = 3
string db_name = 4
message
milvus.proto:2094optional status = 1
int64 progress = 2
int64 refresh_progress = 3
rpc GetMetrics (, )
milvus.proto:93https://wiki.lfaidata.foundation/display/MIL/MEP+8+--+Add+metrics+for+proxy
message
milvus.proto:1456optional base = 1
string request = 2
request is of jsonic format
message
milvus.proto:1461optional status = 1
string response = 2
response is of jsonic format
string component_name = 3
metrics from which component
message
milvus.proto:769Get 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:779optional status = 1
repeated stats = 2
message
milvus.proto:1401optional base = 1
must
string dbName = 2
string collectionName = 3
must
message
milvus.proto:1407optional status = 1
repeated infos = 2
rpc GetQuerySegmentInfo (, )
milvus.proto:84message
milvus.proto:1429optional base = 1
must
string dbName = 2
string collectionName = 3
must
message
milvus.proto:1435optional status = 1
repeated infos = 2
message
milvus.proto:3114optional base = 1
int64 job_id = 2
Job ID from RefreshExternalCollection response
message
milvus.proto:3131optional status = 1
optional job_info = 2
rpc GetReplicas (, )
milvus.proto:85message
milvus.proto:1644optional base = 1
int64 collectionID = 2
bool with_shard_nodes = 3
string collection_name = 4
string db_name = 5
message
milvus.proto:1652optional status = 1
repeated replicas = 2
GetReplicateConfiguration retrieves the current cross-cluster replication topology. Sensitive fields (like connection tokens) are redacted in the response.
message
milvus.proto:2637(message has no fields)
message
milvus.proto:2645optional status = 1
optional configuration = 2
rpc GetReplicateInfo (, )
milvus.proto:195GetReplicateInfo retrieves replication-related metadata of specified channel from a target Milvus cluster.
message
milvus.proto:2650string source_cluster_id = 1
string target_pchannel = 2
message
milvus.proto:2655optional checkpoint = 1
optional salvage_checkpoint = 2
salvage_checkpoint is captured during force promote. It represents the last synced position from the old primary. Data salvage tools can use this to dump unsynchronized messages from the old primary.
message
milvus.proto:2900optional base = 1
int64 job_id = 2
restore job ID
message
milvus.proto:2905optional status = 1
optional info = 2
rpc GetUserTags (, )
milvus.proto:170message
milvus.proto:2531optional base = 1
string user_name = 2
message
milvus.proto:2542optional status = 1
map<string, string> tags = 2
rpc GetVersion (, )
milvus.proto:123message
milvus.proto:2126(message has no fields)
message
milvus.proto:2129optional status = 1
string version = 2
rpc HasCollection (, )
milvus.proto:23message
milvus.proto:411* 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 HasPartition (, )
milvus.proto:39message
milvus.proto:701Check 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 HybridSearch (, )
milvus.proto:72message
milvus.proto:1205optional base = 1
must
string db_name = 2
string collection_name = 3
must
repeated string partition_names = 4
must
repeated requests = 5
repeated rank_params = 6
must
uint64 travel_timestamp = 7
uint64 guarantee_timestamp = 8
guarantee_timestamp
bool not_return_all_meta = 9
repeated string output_fields = 10
common.ConsistencyLevel consistency_level = 11
bool use_default_consistency = 12
optional function_score = 13
Mutually exclusive with function_chains. Milvus returns invalid argument if both are set.
optional string namespace = 14
repeated function_chains = 15
Function chains for top-level hybrid fusion/rerank. Mutually exclusive with function_score. Milvus returns invalid argument if both are set.
rpc Import (, )
milvus.proto:102https://wiki.lfaidata.foundation/display/MIL/MEP+24+--+Support+bulk+load
message
milvus.proto:1596string 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
target database
bytes clustering_info = 8
serialized `schema.ClusteringInfo`
message
milvus.proto:1612optional status = 1
repeated int64 tasks = 2
id array of import tasks
rpc Insert (, )
milvus.proto:68message
milvus.proto:1008optional 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
uint64 schema_timestamp = 8
optional string namespace = 9
rpc ListAliases (, )
milvus.proto:52message
milvus.proto:309optional base = 1
string db_name = 2
string collection_name = 3
message
milvus.proto:324List aliases response
optional status = 1
Response status
string db_name = 2
string collection_name = 3
repeated string aliases = 4
rpc ListCredUsers (, )
milvus.proto:110message
milvus.proto:1742optional base = 1
Not useful for now
message
milvus.proto:1735optional status = 1
Contain error_code and reason
repeated string usernames = 2
username array
rpc ListDatabases (, )
milvus.proto:145message
milvus.proto:2335optional base = 1
message
milvus.proto:2339optional status = 1
repeated string db_names = 2
repeated uint64 created_timestamp = 3
repeated int64 db_ids = 4
rpc ListFileResources (, )
milvus.proto:165message
milvus.proto:2481optional base = 1
message
milvus.proto:2490optional status = 1
repeated resources = 2
rpc ListImportTasks (, )
milvus.proto:104message
milvus.proto:1633string 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:1639optional status = 1
repeated tasks = 2
list of all import tasks
rpc ListIndexedSegment (, )
milvus.proto:136rpc ListPrivilegeGroups (, )
milvus.proto:159message
milvus.proto:1826optional base = 1
Not useful for now
message
milvus.proto:1836optional status = 1
repeated privilege_groups = 2
message
milvus.proto:3136optional base = 1
string db_name = 2
Database name
string collection_name = 3
Collection name (optional, if empty lists all)
message
milvus.proto:3142optional status = 1
repeated jobs = 2
rpc ListResourceGroups (, )
milvus.proto:131message
milvus.proto:2212optional base = 1
message
milvus.proto:2221optional status = 1
repeated string resource_groups = 2
message
milvus.proto:2910optional base = 1
string db_name = 2
string collection_name = 3
message
milvus.proto:2921optional status = 1
repeated jobs = 2
rpc ListRowPolicies (, )
milvus.proto:175message
milvus.proto:2596optional base = 1
string db_name = 2
string collection_name = 3
message
milvus.proto:2618optional status = 1
repeated policies = 2
string db_name = 3
string collection_name = 4
rpc ListSnapshots (, )
milvus.proto:222message
milvus.proto:2770optional base = 1
string db_name = 2
db name
string collection_name = 3
collection name, if collection_name is empty, it will list all snapshots.
message
milvus.proto:2783return all snapshots for the given collection Note: list snapshots is not a privilege check operation
optional status = 1
repeated string snapshots = 2
rpc ListUsersWithTag (, )
milvus.proto:171message
milvus.proto:2547optional base = 1
string tag_key = 2
string tag_value = 3
message
milvus.proto:2559optional status = 1
repeated string user_names = 2
rpc LoadBalance (, )
milvus.proto:96message
milvus.proto:1486Do 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 LoadCollection (, )
milvus.proto:24message
milvus.proto:513* 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.
repeated string load_fields = 7
Field Partial Load fields list
bool skip_load_dynamic_field = 8
Field Partial load skip load dynamic fields
map<string, string> load_params = 9
Additional parameters for load
rpc LoadPartitions (, )
milvus.proto:40message
milvus.proto:720Load 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.
repeated string load_fields = 8
Field Partial Load fields list
bool skip_load_dynamic_field = 9
Field Partial load skip load dynamic fields
map<string, string> load_params = 10
Additional parameters for load
rpc ManualCompaction (, )
milvus.proto:98message
milvus.proto:1500int64 collectionID = 1
uint64 timetravel = 2
bool majorCompaction = 3
string collection_name = 4
string db_name = 5
int64 partition_id = 6
string channel = 7
repeated int64 segment_ids = 8
bool l0Compaction = 9
int64 target_size = 10
message
milvus.proto:1518optional status = 1
int64 compactionID = 2
int32 compactionPlanCount = 3
rpc OperatePrivilege (, )
milvus.proto:119message
milvus.proto:2001optional base = 1
Not useful for now
optional entity = 2
grant
OperatePrivilegeType type = 3
operation type
string version = 4
version
message
milvus.proto:1841optional base = 1
Not useful for now
string group_name = 2
group name
repeated privileges = 3
privileges
OperatePrivilegeGroupType type = 4
operation type
rpc OperatePrivilegeV2 (, )
milvus.proto:120message
milvus.proto:2018optional base = 1
Not useful for now
optional role = 2
role
optional grantor = 3
privilege
OperatePrivilegeType type = 4
operation type
string db_name = 5
db name
string collection_name = 6
collection name
rpc OperateUserRole (, )
milvus.proto:116message
milvus.proto:1867optional base = 1
Not useful for now
string username = 2
username
string role_name = 3
role name
OperateUserRoleType type = 4
operation type
rpc PinSnapshotData (, )
milvus.proto:229message
milvus.proto:2926optional base = 1
string name = 2
snapshot name
string db_name = 3
database name
string collection_name = 4
collection name
int64 ttl_seconds = 5
optional: 0 = no expiry, >0 = auto-expire in seconds
message
milvus.proto:2940optional status = 1
int64 pin_id = 2
allocated pin ID for Unpin
rpc Query (, )
milvus.proto:74message
milvus.proto:1252optional 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
map<string, > expr_template_values = 13
optional string namespace = 14
message
milvus.proto:1278optional status = 1
repeated fields_data = 2
string collection_name = 3
repeated string output_fields = 4
uint64 session_ts = 5
for session-like operation like iterator
string primary_field_name = 6
repeated element_indices = 7
External Collection APIs
message
milvus.proto:3095optional base = 1
string db_name = 2
Database name
string collection_name = 3
Collection name (required)
string external_source = 4
Optional: new external source path
string external_spec = 5
Optional: new external spec configuration
message
milvus.proto:3109optional status = 1
int64 job_id = 2
Unique job identifier for tracking
rpc RegisterLink (, )
milvus.proto:90TODO: remove
rpc ReleaseCollection (, )
milvus.proto:25message
milvus.proto:541* 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 ReleasePartitions (, )
milvus.proto:41message
milvus.proto:751Release 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
rpc RemoveFileResource (, )
milvus.proto:164message
milvus.proto:2471optional base = 1
string name = 2
rpc RenameCollection (, )
milvus.proto:134message
milvus.proto:2257optional base = 1
string db_name = 2
string oldName = 3
string newName = 4
string newDBName = 5
rpc ReplicateMessage (, )
milvus.proto:150Deprecated CDC API
message
milvus.proto:2377optional base = 1
string channel_name = 2
uint64 BeginTs = 3
uint64 EndTs = 4
repeated bytes Msgs = 5
repeated StartPositions = 6
repeated EndPositions = 7
message
milvus.proto:2388optional status = 1
string position = 2
message
milvus.proto:2834restore an external snapshot by metadata URI to a new collection
optional base = 1
string db_name = 2
target db name (where to restore to)
string target_collection_name = 3
target collection name (must not exist)
string snapshot_metadata_uri = 4
external snapshot metadata URI
string external_spec = 5
Optional external storage spec JSON for the external snapshot storage. Snapshot APIs consume the extfs section for provider, endpoint, region, SSL, IAM, and credential settings.
message
milvus.proto:2851optional status = 1
int64 job_id = 2
rpc RestoreRBAC (, )
milvus.proto:155message
milvus.proto:2070optional base = 1
Not useful for now
optional RBAC_meta = 2
rpc RestoreSnapshot (, )
milvus.proto:224message
milvus.proto:2812restore a snapshot to a new collection
optional base = 1
string name = 2
snapshot name
string db_name = 3
source db name (where the snapshot lives)
string collection_name = 4
source collection name (where the snapshot lives)
bool rewrite_data = 5
if true, use import to rewrite data to collection
string target_db_name = 6
target db name (where to restore to)
string target_collection_name = 7
target collection name (must not exist)
message
milvus.proto:2828optional status = 1
int64 job_id = 2
rpc RunAnalyzer (, )
milvus.proto:162message
milvus.proto:2424optional base = 1
string analyzer_params = 2
repeated bytes placeholder = 3
bool with_detail = 4
bool with_hash = 5
string db_name = 6
string collection_name = 7
string field_name = 8
repeated string analyzer_names = 9
message
milvus.proto:2449optional status = 1
repeated results = 2
rpc Search (, )
milvus.proto:71rpc SelectGrant (, )
milvus.proto:121message
milvus.proto:1977optional base = 1
Not useful for now
optional entity = 2
grant
message
milvus.proto:1989optional status = 1
Not useful for now
repeated entities = 2
grant info array
rpc SelectRole (, )
milvus.proto:117message
milvus.proto:1888optional base = 1
Not useful for now
optional role = 2
role
bool include_user_info = 3
include user info
message
milvus.proto:1907optional status = 1
Not useful for now
repeated results = 2
role result array
rpc SelectUser (, )
milvus.proto:118message
milvus.proto:1914optional base = 1
Not useful for now
optional user = 2
user
bool include_role_info = 3
include user info
message
milvus.proto:1934optional status = 1
Not useful for now
repeated results = 2
user result array
rpc ShowCollections (, )
milvus.proto:29message
milvus.proto:627List 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:643Return 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
repeated int32 shards_num = 8
rpc ShowPartitions (, )
milvus.proto:43message
milvus.proto:787List 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:811List 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 TransferNode (, )
milvus.proto:129message
milvus.proto:2185transfer `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:130message
milvus.proto:2198transfer `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 TruncateCollection (, )
milvus.proto:35message
milvus.proto:2709Truncate 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)
message
milvus.proto:2722optional status = 1
rpc UnpinSnapshotData (, )
milvus.proto:230message
milvus.proto:2945optional base = 1
int64 pin_id = 2
pin ID from PinSnapshotData response
rpc UpdateCredential (, )
milvus.proto:108message
milvus.proto:1702optional 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
optional string description = 7
CDC v2 APIs UpdateReplicateConfiguration applies a full replacement of the current replication configuration across Milvus clusters. Semantics: - The provided ReplicateConfiguration completely replaces any existing configuration persisted in the metadata store. - Passing an empty ReplicateConfiguration is treated as a "clear" operation, effectively removing all replication configuration. - The RPC is expected to be idempotent: submitting the same configuration multiple times must not cause side effects.
message
milvus.proto:2625optional replicate_configuration = 1
bool force_promote = 2
If true, the current cluster will be promoted to primary forcefully. This is intended for failover scenarios.
rpc UpdateResourceGroups (, )
milvus.proto:128message
milvus.proto:2164optional base = 1
map<string, > resource_groups = 2
rpc Upsert (, )
milvus.proto:70message
milvus.proto:1092optional 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
uint64 schema_timestamp = 8
bool partial_update = 9
optional string namespace = 10
repeated field_ops = 11
field_ops carries per-field FieldPartialUpdateOp directives describing how each FieldData should be merged during a partial upsert. Ops are matched to fields_data entries by field_name. A non-REPLACE op implies partial_update=true regardless of the partial_update flag.
service ProxyService
milvus.proto:1677rpc RegisterLink (, )
milvus.proto:1678
message
milvus.proto:2994Action to perform on the collection schema
Used in:
oneof op
add_request = 1
drop_request = 2
message
milvus.proto:2977Add fields and functions request
Used in:
repeated field_infos = 1
repeated func_schema = 2
bool do_physical_backfill = 3
message
milvus.proto:2984Drop field or function request
Used in:
oneof identifier
string field_name = 1
int64 field_id = 2
string function_name = 3
bool drop_function_output_fields = 4
message
milvus.proto:2968The serialized `schema.FieldSchema`
Used in:
optional field_schema = 1
string index_name = 2
Version before 2.0.2 doesn't contain index_name, we use default index name.
repeated extra_params = 3
Support keys: index_type,metric_type, params. Different index_type may has different params.
message
milvus.proto:2445Used in:
repeated tokens = 1
message
milvus.proto:2436Used in:
string token = 1
int64 start_offset = 2
int64 end_offset = 3
int64 position = 4
int64 position_length = 5
uint32 hash = 6
message
milvus.proto:3021Used in:
int64 segment_id = 1
int64 manifest_version = 2
message
milvus.proto:422Used as response type in: MilvusService.HasCollection, MilvusService.HasPartition
optional status = 1
bool value = 2
message
milvus.proto:3049Used in:
optional client_info = 1
int64 last_heartbeat_time = 2
string status = 3
repeated string databases = 4
repeated metrics = 5
message
milvus.proto:1349Used in:
string cluster_id = 1
string cchannel = 2
repeated string pchannels = 3
message
milvus.proto:1547Used in:
repeated int64 sources = 1
int64 target = 2
message
milvus.proto:1467Used in:
int64 nodeID = 1
string role = 2
common.StateCode state_code = 3
repeated extra_info = 4
message
milvus.proto:455* DescribeCollection Response
Used as response type in: MilvusService.DescribeCollection
Used as field type in:
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
int64 db_id = 16
uint64 request_time = 17
uint64 update_timestamp = 18
string update_timestamp_str = 19
message
milvus.proto:827optional base = 1
int64 collectionID = 2
int64 segmentID = 3
message
milvus.proto:833optional status = 1
int64 indexID = 2
int64 buildID = 3
bool enable_index = 4
int64 fieldID = 5
message
milvus.proto:1274Used in:
optional indices = 1
message
milvus.proto:2454Used in:
int64 id = 1
string name = 2
string path = 3
message
milvus.proto:1365Deprecated Flush result for a single flush target
Used in:
string db_name = 1
Database name containing the collections
repeated collection_results = 2
List of collections that were actually processed for this target If the target had empty collection_names (flush all), this shows all collections in the database If the target specified collection_names, this shows only those collections
message
milvus.proto:1588Deprecated
Used in:
string db_name = 1
Database name for this flush state report
map<string, bool> collection_flush_states = 2
Collection-level flush state mapping Key: collection name, Value: true if collection is fully flushed
message
milvus.proto:1329Deprecated, FlushAll semantics changed to flushing the entire cluster. Specific collection to flush with database context This message allows targeting specific collections within a database for flush operations
Used in: ,
string db_name = 1
Database name to target for flush operation
repeated string collection_names = 2
Collection names within this database to flush If empty, flush all collections in this database
message
milvus.proto:1375Used in:
string collection_name = 1
Collection name
optional segment_ids = 2
Segment IDs
optional flush_segment_ids = 3
Segment IDs that were actually flushed
int64 seal_time = 4
Seal time (physical time for backup tools)
uint64 flush_ts = 5
Flush timestamp (hybrid timestamp for getting flush state)
map<string, > channel_cps = 6
channel name to checkpoint position
message
milvus.proto:2405string db_name = 1
message
milvus.proto:1621Used 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:558* 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:579* 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:1958Used 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:1954repeated entities = 1
message
milvus.proto:1949Used in: , ,
optional user = 1
optional privilege = 2
message
milvus.proto:1192repeated int64 IDs = 1
repeated bytes row_data = 2
repeated float scores = 3
message
milvus.proto:2394string db_name = 1
string collection_name = 2
string partition_name = 3
message
milvus.proto:917Index 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
int32 min_index_version = 10
minimal index version for current index
int32 max_index_version = 11
maximum index version for current index
message
milvus.proto:2414string db_name = 3
string collection_name = 1
message
milvus.proto:2118string version = 1
message
milvus.proto:1115Used 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:1941Used in:
string name = 1
Used in:
AddPrivilegesToGroup = 0
RemovePrivilegesFromGroup = 1
Used in: ,
Grant = 0
Revoke = 1
Used in:
AddUserToRole = 0
RemoveUserFromRole = 1
message
milvus.proto:1390Used in:
int64 segmentID = 1
int64 collectionID = 2
int64 partitionID = 3
int64 num_rows = 4
common.SegmentState state = 5
common.SegmentLevel level = 6
bool is_sorted = 7
int64 storage_version = 8
message
milvus.proto:1945Used in: , ,
string name = 1
message
milvus.proto:1883Used in: ,
string group_name = 1
repeated privileges = 2
Cluster = 0
Database = 1
Collection = 2
message
milvus.proto:1288uint64 session_ts = 1
oneof cursor_pk
string str_pk = 2
int64 int_pk = 3
message
milvus.proto:1412Used 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
common.SegmentLevel level = 11
bool is_sorted = 12
int64 storage_version = 13
Used in:
Unknown = 0
ReadLimited = 2
WriteLimited = 3
DenyToRead = 4
DenyToWrite = 5
DenyToDDL = 6
message
milvus.proto:2044Used in: ,
repeated users = 1
user
repeated roles = 2
role
repeated grants = 3
(role, object, previledge)
repeated privilege_groups = 4
privilege group info
message
milvus.proto:3119Used in: ,
int64 job_id = 1
Job identifier
string collection_name = 2
Collection name
RefreshExternalCollectionState state = 3
Current job state
int64 progress = 4
Progress percentage (0-100)
string reason = 5
Error message if failed
string external_source = 6
External source used for this job
int64 start_time = 7
Job start timestamp (Unix epoch ms)
int64 end_time = 8
Job end timestamp (0 if not completed)
string external_spec = 9
External spec used for this job
External Collection Refresh APIs
Used in:
RefreshPending = 0
Job is queued, waiting to execute
RefreshInProgress = 1
Job is currently executing
RefreshCompleted = 2
Job completed successfully
RefreshFailed = 3
Job failed with error
message
milvus.proto:1448Used as request type in: MilvusService.RegisterLink, ProxyService.RegisterLink
(message has no fields)
message
milvus.proto:1451Used as response type in: MilvusService.RegisterLink, ProxyService.RegisterLink
optional address = 1
optional status = 2
message
milvus.proto:1657ReplicaGroup
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:2674Used in:
uint64 confirmed_time_tick = 1
the source time tick of the last confirmed message that persisted into target WAL.
message
milvus.proto:2663Used in:
string source_cluster_id = 1
the cluster id of source cluster
optional message = 2
replicate message to be sent
message
milvus.proto:2241Used 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
optional config = 7
resource group configuration.
repeated nodes = 8
query node belong to this resource group now.
message
milvus.proto:2888Used in: ,
int64 job_id = 1
string snapshot_name = 2
string db_name = 3
string collection_name = 4
RestoreSnapshotState state = 5
int32 progress = 6
progress percentage (0-100)
string reason = 7
uint64 start_time = 8
start timestamp in milliseconds
uint64 time_cost = 9
time cost in milliseconds
Used in:
RestoreSnapshotNone = 0
RestoreSnapshotPending = 1
Job created, waiting to start
RestoreSnapshotExecuting = 2
Executing restore snapshot job
RestoreSnapshotCompleted = 3
All done
RestoreSnapshotFailed = 4
Failed
message
milvus.proto:1753https://wiki.lfaidata.foundation/display/MIL/MEP+29+--+Support+Role-Based+Access+Control
Used in: , , , , , , ,
string name = 1
string description = 2
message
milvus.proto:1902Used in:
optional role = 1
repeated users = 2
message
milvus.proto:2608Used in:
string policy_name = 1
repeated RowPolicyAction actions = 2
repeated string roles = 3
string using_expr = 4
string check_expr = 5
string description = 6
int64 created_at = 7
Row Policy Action enum
Used in: ,
Query = 0
Search = 1
Insert = 2
Delete = 3
Upsert = 4
message
milvus.proto:1156Used as request type in: MilvusService.Search
Used as field type in:
optional base = 1
must
string db_name = 2
string collection_name = 3
must
repeated string partition_names = 4
must
string dsl = 5
must
oneof search_input
bytes placeholder_group = 6
serialized `PlaceholderGroup` for vector search
ids = 22
primary keys for search by IDs
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
use search_input instead
repeated sub_reqs = 17
map<string, > expr_template_values = 18
optional function_score = 19
Mutually exclusive with function_chains. Milvus returns invalid argument if both are set.
optional string namespace = 20
optional highlighter = 21
optional search_aggregation = 23
repeated function_chains = 24
Mutually exclusive with function_score. Milvus returns invalid argument if both are set.
message
milvus.proto:1198Used as response type in: MilvusService.HybridSearch, MilvusService.Search
optional status = 1
optional results = 2
string collection_name = 3
uint64 session_ts = 4
for session-like operation like iterator
message
milvus.proto:1668Used 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:841optional base = 1
int64 collectionID = 2
int64 partitionID = 3
message
milvus.proto:847optional 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:427optional status = 1
string value = 2
message
milvus.proto:1145Used in:
string dsl = 1
must
bytes placeholder_group = 2
serialized `PlaceholderGroup`
must
common.DslType dsl_type = 3
must
repeated search_params = 4
must
int64 nq = 5
map<string, > expr_template_values = 6
optional string namespace = 7
message
milvus.proto:1758Used in: , , ,
string name = 1
message
milvus.proto:2038Used in:
string user = 1
string password = 2
repeated roles = 3
message
milvus.proto:1928Used in:
optional user = 1
repeated roles = 2
string description = 3
message
milvus.proto:1296Used in:
string collection_name = 1
string field_name = 2
optional id_array = 3
repeated string partition_names = 4
message
milvus.proto:1303Used in:
oneof array
id_array = 1
vector ids
data_array = 2
vectors data