package milvus.proto.common

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: milvus.RegisterLinkResponse

• string ip = 1

• int64 port = 2

Used in: msg.InsertRequest

• bytes value = 1

Used in: milvus.ConnectRequest

• string sdk_type = 1

  sdk_type can be `python`, `golang`, `nodejs` and etc. It's not proper to make `sdk_type` an enumerate type, since we cannot always update the enum value everytime when newly sdk is supported.

• string sdk_version = 2

• string local_time = 3

• string user = 4

• string host = 5

• map<string, string> reserved = 6

  reserved for newly-added feature if necessary.

Used in: milvus.GetCompactionPlansResponse, milvus.GetCompactionStateResponse

• UndefiedState = 0

• Executing = 1

• Completed = 2

Used in: milvus.CreateCollectionRequest, milvus.DescribeCollectionResponse, milvus.QueryRequest, milvus.SearchRequest

• Strong = 0

• Session = 1

  default in PyMilvus

• Bounded = 2

• Eventually = 3

• Customized = 4

  Users pass their own `guarantee_timestamp`.

Don't Modify This. @czs

• optional MsgBase base = 1

• string shardName = 2

Used in: milvus.SearchRequest

• Dsl = 0

• BoolExprV1 = 1

Deprecated

Used in: Status

• Success = 0

• UnexpectedError = 1

• ConnectFailed = 2

• PermissionDenied = 3

• CollectionNotExists = 4

• IllegalArgument = 5

• IllegalDimension = 7

• IllegalIndexType = 8

• IllegalCollectionName = 9

• IllegalTOPK = 10

• IllegalRowRecord = 11

• IllegalVectorID = 12

• IllegalSearchResult = 13

• FileNotFound = 14

• MetaFailed = 15

• CacheFailed = 16

• CannotCreateFolder = 17

• CannotCreateFile = 18

• CannotDeleteFolder = 19

• CannotDeleteFile = 20

• BuildIndexError = 21

• IllegalNLIST = 22

• IllegalMetricType = 23

• OutOfMemory = 24

• IndexNotExist = 25

• EmptyCollection = 26

• UpdateImportTaskFailure = 27

• CollectionNameNotFound = 28

• CreateCredentialFailure = 29

• UpdateCredentialFailure = 30

• DeleteCredentialFailure = 31

• GetCredentialFailure = 32

• ListCredUsersFailure = 33

• GetUserFailure = 34

• CreateRoleFailure = 35

• DropRoleFailure = 36

• OperateUserRoleFailure = 37

• SelectRoleFailure = 38

• SelectUserFailure = 39

• SelectResourceFailure = 40

• OperatePrivilegeFailure = 41

• SelectGrantFailure = 42

• RefreshPolicyInfoCacheFailure = 43

• ListPolicyFailure = 44

• NotShardLeader = 45

• NoReplicaAvailable = 46

• SegmentNotFound = 47

• ForceDeny = 48

• RateLimit = 49

• NodeIDNotMatch = 50

• UpsertAutoIDTrue = 51

• InsufficientMemoryToLoad = 52

• MemoryQuotaExhausted = 53

• DiskQuotaExhausted = 54

• TimeTickLongDelay = 55

• NotReadyServe = 56

• NotReadyCoordActivating = 57

  Coord is switching from standby mode to active mode

• DataCoordNA = 100

  Service availability. NA: Not Available.

• DDRequestRace = 1000

  internal error code.

Used in: milvus.GetImportStateResponse

• ImportPending = 0

  the task in in pending list of rootCoord, waiting to be executed

• ImportFailed = 1

  the task failed for some reason, get detail reason from GetImportStateResponse.infos

• ImportStarted = 2

  the task has been sent to datanode to execute

• ImportPersisted = 5

  all data files have been parsed and all meta data already persisted, ready to be flushed.

• ImportFlushed = 8

  all segments are successfully flushed.

• ImportCompleted = 6

  all indexes are successfully built and segments are able to be compacted as normal.

• ImportFailedAndCleaned = 7

  the task failed and all segments it generated are cleaned up.

Used in: milvus.GetIndexStateResponse, milvus.IndexDescription

• IndexStateNone = 0

• Unissued = 1

• InProgress = 2

• Finished = 3

• Failed = 4

• Retry = 5

Used in: milvus.DescribeCollectionResponse

• string key = 1

• bytes data = 2

Used in: feder.DescribeSegmentIndexDataResponse, milvus.AlterCollectionRequest, milvus.CalcDistanceRequest, milvus.ComponentInfo, milvus.CreateCollectionRequest, milvus.CreateIndexRequest, milvus.DescribeCollectionResponse, milvus.GetCollectionStatisticsResponse, milvus.GetImportStateResponse, milvus.GetPartitionStatisticsResponse, milvus.GetStatisticsResponse, milvus.ImportRequest, milvus.IndexDescription, milvus.QueryRequest, milvus.SearchRequest, schema.FieldSchema

• string key = 1

• string value = 2

Used in: milvus.GetLoadStateResponse

• LoadStateNotExist = 0

• LoadStateNotLoad = 1

• LoadStateLoading = 2

• LoadStateLoaded = 3

Used in: DMLMsgHeader, MsgHeader, feder.DescribeSegmentIndexDataRequest, feder.ListIndexedSegmentRequest, milvus.AllocTimestampRequest, milvus.AlterAliasRequest, milvus.AlterCollectionRequest, milvus.CalcDistanceRequest, milvus.ConnectRequest, milvus.CreateAliasRequest, milvus.CreateCollectionRequest, milvus.CreateCredentialRequest, milvus.CreateDatabaseRequest, milvus.CreateIndexRequest, milvus.CreatePartitionRequest, milvus.CreateResourceGroupRequest, milvus.CreateRoleRequest, milvus.DeleteCredentialRequest, milvus.DeleteRequest, milvus.DescribeAliasRequest, milvus.DescribeCollectionRequest, milvus.DescribeIndexRequest, milvus.DescribeResourceGroupRequest, milvus.DescribeSegmentRequest, milvus.DropAliasRequest, milvus.DropCollectionRequest, milvus.DropDatabaseRequest, milvus.DropIndexRequest, milvus.DropPartitionRequest, milvus.DropResourceGroupRequest, milvus.DropRoleRequest, milvus.FlushRequest, milvus.GetCollectionStatisticsRequest, milvus.GetFlushAllStateRequest, milvus.GetIndexBuildProgressRequest, milvus.GetIndexStateRequest, milvus.GetIndexStatisticsRequest, milvus.GetLoadStateRequest, milvus.GetLoadingProgressRequest, milvus.GetMetricsRequest, milvus.GetPartitionStatisticsRequest, milvus.GetPersistentSegmentInfoRequest, milvus.GetQuerySegmentInfoRequest, milvus.GetReplicasRequest, milvus.GetStatisticsRequest, milvus.HasCollectionRequest, milvus.HasPartitionRequest, milvus.InsertRequest, milvus.ListAliasesRequest, milvus.ListCredUsersRequest, milvus.ListDatabasesRequest, milvus.ListResourceGroupsRequest, milvus.LoadBalanceRequest, milvus.LoadCollectionRequest, milvus.LoadPartitionsRequest, milvus.OperatePrivilegeRequest, milvus.OperateUserRoleRequest, milvus.QueryRequest, milvus.ReleaseCollectionRequest, milvus.ReleasePartitionsRequest, milvus.RenameCollectionRequest, milvus.SearchRequest, milvus.SelectGrantRequest, milvus.SelectRoleRequest, milvus.SelectUserRequest, milvus.ShowCollectionsRequest, milvus.ShowPartitionsRequest, milvus.ShowSegmentsRequest, milvus.TransferNodeRequest, milvus.TransferReplicaRequest, milvus.UpdateCredentialRequest, milvus.UpsertRequest, msg.CreateCollectionRequest, msg.CreatePartitionRequest, msg.DataNodeTtMsg, msg.DeleteRequest, msg.DropCollectionRequest, msg.DropPartitionRequest, msg.InsertRequest, msg.TimeTickMsg

• MsgType msg_type = 1

• int64 msgID = 2

• uint64 timestamp = 3

• int64 sourceID = 4

• int64 targetID = 5

Don't Modify This. @czs

• optional MsgBase base = 1

Used in: MsgBase

• Undefined = 0

• CreateCollection = 100

  DEFINITION REQUESTS: COLLECTION

• DropCollection = 101

• HasCollection = 102

• DescribeCollection = 103

• ShowCollections = 104

• GetSystemConfigs = 105

• LoadCollection = 106

• ReleaseCollection = 107

• CreateAlias = 108

• DropAlias = 109

• AlterAlias = 110

• AlterCollection = 111

• RenameCollection = 112

• DescribeAlias = 113

• ListAliases = 114

• CreatePartition = 200

  DEFINITION REQUESTS: PARTITION

• DropPartition = 201

• HasPartition = 202

• DescribePartition = 203

• ShowPartitions = 204

• LoadPartitions = 205

• ReleasePartitions = 206

• ShowSegments = 250

  DEFINE REQUESTS: SEGMENT

• DescribeSegment = 251

• LoadSegments = 252

• ReleaseSegments = 253

• HandoffSegments = 254

• LoadBalanceSegments = 255

• DescribeSegments = 256

• FederListIndexedSegment = 257

• FederDescribeSegmentIndexData = 258

• CreateIndex = 300

  DEFINITION REQUESTS: INDEX

• DescribeIndex = 301

• DropIndex = 302

• GetIndexStatistics = 303

• Insert = 400

  MANIPULATION REQUESTS

• Delete = 401

• Flush = 402

• ResendSegmentStats = 403

• Upsert = 404

• Search = 500

  QUERY

• SearchResult = 501

• GetIndexState = 502

• GetIndexBuildProgress = 503

• GetCollectionStatistics = 504

• GetPartitionStatistics = 505

• Retrieve = 506

• RetrieveResult = 507

• WatchDmChannels = 508

• RemoveDmChannels = 509

• WatchQueryChannels = 510

• RemoveQueryChannels = 511

• SealedSegmentsChangeInfo = 512

• WatchDeltaChannels = 513

• GetShardLeaders = 514

• GetReplicas = 515

• UnsubDmChannel = 516

• GetDistribution = 517

• SyncDistribution = 518

• SegmentInfo = 600

  DATA SERVICE

• SystemInfo = 601

• GetRecoveryInfo = 602

• GetSegmentState = 603

• TimeTick = 1200

  SYSTEM CONTROL

• QueryNodeStats = 1201

  GOOSE TODO: Remove kQueryNodeStats

• LoadIndex = 1202

• RequestID = 1203

• RequestTSO = 1204

• AllocateSegment = 1205

• SegmentStatistics = 1206

• SegmentFlushDone = 1207

• DataNodeTt = 1208

• Connect = 1209

• ListClientInfos = 1210

• AllocTimestamp = 1211

• CreateCredential = 1500

  Credential

• GetCredential = 1501

• DeleteCredential = 1502

• UpdateCredential = 1503

• ListCredUsernames = 1504

• CreateRole = 1600

  RBAC

• DropRole = 1601

• OperateUserRole = 1602

• SelectRole = 1603

• SelectUser = 1604

• SelectResource = 1605

• OperatePrivilege = 1606

• SelectGrant = 1607

• RefreshPolicyInfoCache = 1608

• ListPolicy = 1609

• CreateResourceGroup = 1700

  Resource group

• DropResourceGroup = 1701

• ListResourceGroups = 1702

• DescribeResourceGroup = 1703

• TransferNode = 1704

• TransferReplica = 1705

• CreateDatabase = 1801

  Database group

• DropDatabase = 1802

• ListDatabases = 1803

Used in: PrivilegeExt

• PrivilegeAll = 0

• PrivilegeCreateCollection = 1

• PrivilegeDropCollection = 2

• PrivilegeDescribeCollection = 3

• PrivilegeShowCollections = 4

• PrivilegeLoad = 5

• PrivilegeRelease = 6

• PrivilegeCompaction = 7

• PrivilegeInsert = 8

• PrivilegeDelete = 9

• PrivilegeGetStatistics = 10

• PrivilegeCreateIndex = 11

• PrivilegeIndexDetail = 12

• PrivilegeDropIndex = 13

• PrivilegeSearch = 14

• PrivilegeFlush = 15

• PrivilegeQuery = 16

• PrivilegeLoadBalance = 17

• PrivilegeImport = 18

• PrivilegeCreateOwnership = 19

• PrivilegeUpdateUser = 20

• PrivilegeDropOwnership = 21

• PrivilegeSelectOwnership = 22

• PrivilegeManageOwnership = 23

• PrivilegeSelectUser = 24

• PrivilegeUpsert = 25

• PrivilegeCreateResourceGroup = 26

• PrivilegeDropResourceGroup = 27

• PrivilegeDescribeResourceGroup = 28

• PrivilegeListResourceGroups = 29

• PrivilegeTransferNode = 30

• PrivilegeTransferReplica = 31

• PrivilegeGetLoadingProgress = 32

• PrivilegeGetLoadState = 33

• PrivilegeRenameCollection = 34

• PrivilegeCreateDatabase = 35

• PrivilegeDropDatabase = 36

• PrivilegeListDatabases = 37

• PrivilegeFlushAll = 38

Used in: PrivilegeExt

• Collection = 0

• Global = 1

• User = 2

• repeated PlaceholderValue placeholders = 1

Used in: PlaceholderValue

• None = 0

• BinaryVector = 100

• FloatVector = 101

• Float16Vector = 102

• Int64 = 5

• VarChar = 21

Used in: PlaceholderGroup

• string tag = 1

• PlaceholderType type = 2

• repeated bytes values = 3

  values is a 2d-array, every array contains a vector

• ObjectType object_type = 1

• ObjectPrivilege object_privilege = 2

• int32 object_name_index = 3

• int32 object_name_indexs = 4

Used in: milvus.PersistentSegmentInfo, milvus.QuerySegmentInfo

• SegmentStateNone = 0

• NotExist = 1

• Growing = 2

• Sealed = 3

• Flushed = 4

• Flushing = 5

• Dropped = 6

• Importing = 7

Used in: msg.DataNodeTtMsg

• int64 SegmentID = 1

• int64 NumRows = 2

Used in: milvus.ConnectResponse

• string build_tags = 1

• string build_time = 2

• string git_commit = 3

• string go_version = 4

• string deploy_mode = 5

• map<string, string> reserved = 6

  reserved for newly-added feature if necessary.

Used in: milvus.ComponentInfo

• Initializing = 0

• Healthy = 1

• Abnormal = 2

• StandBy = 3

• Stopping = 4

Used as response type in: milvus.MilvusService.AlterAlias, milvus.MilvusService.AlterCollection, milvus.MilvusService.CreateAlias, milvus.MilvusService.CreateCollection, milvus.MilvusService.CreateCredential, milvus.MilvusService.CreateDatabase, milvus.MilvusService.CreateIndex, milvus.MilvusService.CreatePartition, milvus.MilvusService.CreateResourceGroup, milvus.MilvusService.CreateRole, milvus.MilvusService.DeleteCredential, milvus.MilvusService.DropAlias, milvus.MilvusService.DropCollection, milvus.MilvusService.DropDatabase, milvus.MilvusService.DropIndex, milvus.MilvusService.DropPartition, milvus.MilvusService.DropResourceGroup, milvus.MilvusService.DropRole, milvus.MilvusService.LoadBalance, milvus.MilvusService.LoadCollection, milvus.MilvusService.LoadPartitions, milvus.MilvusService.OperatePrivilege, milvus.MilvusService.OperateUserRole, milvus.MilvusService.ReleaseCollection, milvus.MilvusService.ReleasePartitions, milvus.MilvusService.RenameCollection, milvus.MilvusService.TransferNode, milvus.MilvusService.TransferReplica, milvus.MilvusService.UpdateCredential

Used as field type in: feder.DescribeSegmentIndexDataResponse, feder.ListIndexedSegmentResponse, milvus.AllocTimestampResponse, milvus.BoolResponse, milvus.CalcDistanceResults, milvus.CheckHealthResponse, milvus.ComponentStates, milvus.ConnectResponse, milvus.DescribeAliasResponse, milvus.DescribeCollectionResponse, milvus.DescribeIndexResponse, milvus.DescribeResourceGroupResponse, milvus.DescribeSegmentResponse, milvus.FlushAllResponse, milvus.FlushResponse, milvus.GetCollectionStatisticsResponse, milvus.GetCompactionPlansResponse, milvus.GetCompactionStateResponse, milvus.GetFlushAllStateResponse, milvus.GetFlushStateResponse, milvus.GetImportStateResponse, milvus.GetIndexBuildProgressResponse, milvus.GetIndexStateResponse, milvus.GetIndexStatisticsResponse, milvus.GetLoadStateResponse, milvus.GetLoadingProgressResponse, milvus.GetMetricsResponse, milvus.GetPartitionStatisticsResponse, milvus.GetPersistentSegmentInfoResponse, milvus.GetQuerySegmentInfoResponse, milvus.GetReplicasResponse, milvus.GetStatisticsResponse, milvus.GetVersionResponse, milvus.ImportResponse, milvus.ListAliasesResponse, milvus.ListCredUsersResponse, milvus.ListDatabasesResponse, milvus.ListImportTasksResponse, milvus.ListResourceGroupsResponse, milvus.ManualCompactionResponse, milvus.MutationResult, milvus.QueryResults, milvus.RegisterLinkResponse, milvus.SearchResults, milvus.SelectGrantResponse, milvus.SelectRoleResponse, milvus.SelectUserResponse, milvus.ShowCollectionsResponse, milvus.ShowPartitionsResponse, milvus.ShowSegmentsResponse, milvus.StringResponse

• ErrorCode error_code = 1

• string reason = 2

• int32 code = 3