@zilliz/milvus2-sdk-node 2.5.8 → 2.5.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/milvus/MilvusLiteClient.d.ts +5 -0
- package/dist/milvus/MilvusLiteClient.js +40 -0
- package/dist/milvus/MilvusLiteClient.js.map +1 -0
- package/dist/milvus/const/milvus.d.ts +4 -0
- package/dist/milvus/const/milvus.js +6 -1
- package/dist/milvus/const/milvus.js.map +1 -1
- package/dist/milvus/grpc/BaseClient.d.ts +0 -4
- package/dist/milvus/grpc/BaseClient.js +11 -20
- package/dist/milvus/grpc/BaseClient.js.map +1 -1
- package/dist/milvus/grpc/Data.js +7 -1
- package/dist/milvus/grpc/Data.js.map +1 -1
- package/dist/milvus/grpc/GrpcClient.d.ts +7 -1
- package/dist/milvus/grpc/GrpcClient.js +15 -1
- package/dist/milvus/grpc/GrpcClient.js.map +1 -1
- package/dist/milvus/index.d.ts +1 -0
- package/dist/milvus/index.js +1 -0
- package/dist/milvus/index.js.map +1 -1
- package/dist/milvus/lite/MilvusLiteServer.d.ts +11 -0
- package/dist/milvus/lite/MilvusLiteServer.js +201 -0
- package/dist/milvus/lite/MilvusLiteServer.js.map +1 -0
- package/dist/milvus/lite/start.py +66 -0
- package/dist/milvus/proto-json/milvus.base.d.ts +7092 -0
- package/dist/milvus/proto-json/milvus.base.js +7208 -0
- package/dist/milvus/proto-json/milvus.base.js.map +1 -0
- package/dist/milvus/proto-json/milvus.d.ts +7092 -0
- package/dist/milvus/proto-json/milvus.js +7208 -0
- package/dist/milvus/proto-json/milvus.js.map +1 -0
- package/dist/milvus/proto-json/schema.base.d.ts +2029 -0
- package/dist/milvus/proto-json/schema.base.js +2132 -0
- package/dist/milvus/proto-json/schema.base.js.map +1 -0
- package/dist/milvus/types/Client.d.ts +23 -4
- package/dist/milvus/types/Collection.d.ts +1 -0
- package/dist/milvus/types/Data.d.ts +1 -0
- package/dist/milvus/types/Http.d.ts +1 -0
- package/dist/milvus/types/Partition.d.ts +2 -0
- package/dist/milvus/utils/Grpc.d.ts +0 -1
- package/dist/milvus/utils/Grpc.js +3 -5
- package/dist/milvus/utils/Grpc.js.map +1 -1
- package/dist/sdk.json +1 -1
- package/package.json +8 -5
- package/dist/proto/proto/common.proto +0 -511
- package/dist/proto/proto/feder.proto +0 -40
- package/dist/proto/proto/google/protobuf/descriptor.proto +0 -1417
- package/dist/proto/proto/milvus.proto +0 -2106
- package/dist/proto/proto/msg.proto +0 -133
- package/dist/proto/proto/rg.proto +0 -35
- package/dist/proto/proto/schema.proto +0 -257
|
@@ -1,2106 +0,0 @@
|
|
|
1
|
-
syntax = "proto3";
|
|
2
|
-
package milvus.proto.milvus;
|
|
3
|
-
|
|
4
|
-
option go_package = "github.com/milvus-io/milvus-proto/go-api/v2/milvuspb";
|
|
5
|
-
|
|
6
|
-
option java_multiple_files = true;
|
|
7
|
-
option java_package = "io.milvus.grpc";
|
|
8
|
-
option java_outer_classname = "MilvusProto";
|
|
9
|
-
option java_generate_equals_and_hash = true;
|
|
10
|
-
|
|
11
|
-
option csharp_namespace = "Milvus.Client.Grpc";
|
|
12
|
-
|
|
13
|
-
import "common.proto";
|
|
14
|
-
import "rg.proto";
|
|
15
|
-
import "schema.proto";
|
|
16
|
-
import "feder.proto";
|
|
17
|
-
import "msg.proto";
|
|
18
|
-
import "google/protobuf/descriptor.proto";
|
|
19
|
-
|
|
20
|
-
service MilvusService {
|
|
21
|
-
rpc CreateCollection(CreateCollectionRequest) returns (common.Status) {}
|
|
22
|
-
rpc DropCollection(DropCollectionRequest) returns (common.Status) {}
|
|
23
|
-
rpc HasCollection(HasCollectionRequest) returns (BoolResponse) {}
|
|
24
|
-
rpc LoadCollection(LoadCollectionRequest) returns (common.Status) {}
|
|
25
|
-
rpc ReleaseCollection(ReleaseCollectionRequest) returns (common.Status) {}
|
|
26
|
-
rpc DescribeCollection(DescribeCollectionRequest) returns (DescribeCollectionResponse) {}
|
|
27
|
-
rpc GetCollectionStatistics(GetCollectionStatisticsRequest) returns (GetCollectionStatisticsResponse) {}
|
|
28
|
-
rpc ShowCollections(ShowCollectionsRequest) returns (ShowCollectionsResponse) {}
|
|
29
|
-
rpc AlterCollection(AlterCollectionRequest) returns (common.Status) {}
|
|
30
|
-
rpc AlterCollectionField(AlterCollectionFieldRequest) returns (common.Status) {}
|
|
31
|
-
|
|
32
|
-
rpc CreatePartition(CreatePartitionRequest) returns (common.Status) {}
|
|
33
|
-
rpc DropPartition(DropPartitionRequest) returns (common.Status) {}
|
|
34
|
-
rpc HasPartition(HasPartitionRequest) returns (BoolResponse) {}
|
|
35
|
-
rpc LoadPartitions(LoadPartitionsRequest) returns (common.Status) {}
|
|
36
|
-
rpc ReleasePartitions(ReleasePartitionsRequest) returns (common.Status) {}
|
|
37
|
-
rpc GetPartitionStatistics(GetPartitionStatisticsRequest) returns (GetPartitionStatisticsResponse) {}
|
|
38
|
-
rpc ShowPartitions(ShowPartitionsRequest) returns (ShowPartitionsResponse) {}
|
|
39
|
-
|
|
40
|
-
rpc GetLoadingProgress(GetLoadingProgressRequest) returns (GetLoadingProgressResponse) {}
|
|
41
|
-
rpc GetLoadState(GetLoadStateRequest) returns (GetLoadStateResponse) {}
|
|
42
|
-
|
|
43
|
-
rpc CreateAlias(CreateAliasRequest) returns (common.Status) {}
|
|
44
|
-
rpc DropAlias(DropAliasRequest) returns (common.Status) {}
|
|
45
|
-
rpc AlterAlias(AlterAliasRequest) returns (common.Status) {}
|
|
46
|
-
rpc DescribeAlias(DescribeAliasRequest) returns (DescribeAliasResponse) {}
|
|
47
|
-
rpc ListAliases(ListAliasesRequest) returns (ListAliasesResponse) {}
|
|
48
|
-
|
|
49
|
-
rpc CreateIndex(CreateIndexRequest) returns (common.Status) {}
|
|
50
|
-
rpc AlterIndex(AlterIndexRequest) returns (common.Status) {}
|
|
51
|
-
rpc DescribeIndex(DescribeIndexRequest) returns (DescribeIndexResponse) {}
|
|
52
|
-
rpc GetIndexStatistics(GetIndexStatisticsRequest) returns (GetIndexStatisticsResponse) {}
|
|
53
|
-
// Deprecated: use DescribeIndex instead
|
|
54
|
-
rpc GetIndexState(GetIndexStateRequest) returns (GetIndexStateResponse) {
|
|
55
|
-
option deprecated = true;
|
|
56
|
-
}
|
|
57
|
-
// Deprecated: use DescribeIndex instead
|
|
58
|
-
rpc GetIndexBuildProgress(GetIndexBuildProgressRequest) returns (GetIndexBuildProgressResponse) {
|
|
59
|
-
option deprecated = true;
|
|
60
|
-
}
|
|
61
|
-
rpc DropIndex(DropIndexRequest) returns (common.Status) {}
|
|
62
|
-
|
|
63
|
-
rpc Insert(InsertRequest) returns (MutationResult) {}
|
|
64
|
-
rpc Delete(DeleteRequest) returns (MutationResult) {}
|
|
65
|
-
rpc Upsert(UpsertRequest) returns (MutationResult) {}
|
|
66
|
-
rpc Search(SearchRequest) returns (SearchResults) {}
|
|
67
|
-
rpc HybridSearch(HybridSearchRequest) returns (SearchResults) {}
|
|
68
|
-
rpc Flush(FlushRequest) returns (FlushResponse) {}
|
|
69
|
-
rpc Query(QueryRequest) returns (QueryResults) {}
|
|
70
|
-
rpc CalcDistance(CalcDistanceRequest) returns (CalcDistanceResults) {}
|
|
71
|
-
rpc FlushAll(FlushAllRequest) returns (FlushAllResponse) {}
|
|
72
|
-
|
|
73
|
-
rpc GetFlushState(GetFlushStateRequest) returns (GetFlushStateResponse) {}
|
|
74
|
-
rpc GetFlushAllState(GetFlushAllStateRequest) returns (GetFlushAllStateResponse) {}
|
|
75
|
-
rpc GetPersistentSegmentInfo(GetPersistentSegmentInfoRequest) returns (GetPersistentSegmentInfoResponse) {}
|
|
76
|
-
rpc GetQuerySegmentInfo(GetQuerySegmentInfoRequest) returns (GetQuerySegmentInfoResponse) {}
|
|
77
|
-
rpc GetReplicas(GetReplicasRequest) returns (GetReplicasResponse) {}
|
|
78
|
-
|
|
79
|
-
rpc Dummy(DummyRequest) returns (DummyResponse) {}
|
|
80
|
-
|
|
81
|
-
// TODO: remove
|
|
82
|
-
rpc RegisterLink(RegisterLinkRequest) returns (RegisterLinkResponse) {}
|
|
83
|
-
|
|
84
|
-
// https://wiki.lfaidata.foundation/display/MIL/MEP+8+--+Add+metrics+for+proxy
|
|
85
|
-
rpc GetMetrics(GetMetricsRequest) returns (GetMetricsResponse) {}
|
|
86
|
-
rpc GetComponentStates(GetComponentStatesRequest) returns (ComponentStates) {}
|
|
87
|
-
|
|
88
|
-
rpc LoadBalance(LoadBalanceRequest) returns (common.Status) {}
|
|
89
|
-
rpc GetCompactionState(GetCompactionStateRequest) returns (GetCompactionStateResponse) {}
|
|
90
|
-
rpc ManualCompaction(ManualCompactionRequest) returns (ManualCompactionResponse) {}
|
|
91
|
-
rpc GetCompactionStateWithPlans(GetCompactionPlansRequest) returns (GetCompactionPlansResponse) {}
|
|
92
|
-
|
|
93
|
-
// https://wiki.lfaidata.foundation/display/MIL/MEP+24+--+Support+bulk+load
|
|
94
|
-
rpc Import(ImportRequest) returns (ImportResponse) {}
|
|
95
|
-
rpc GetImportState(GetImportStateRequest) returns (GetImportStateResponse) {}
|
|
96
|
-
rpc ListImportTasks(ListImportTasksRequest) returns (ListImportTasksResponse) {}
|
|
97
|
-
|
|
98
|
-
// https://wiki.lfaidata.foundation/display/MIL/MEP+27+--+Support+Basic+Authentication
|
|
99
|
-
rpc CreateCredential(CreateCredentialRequest) returns (common.Status) {}
|
|
100
|
-
rpc UpdateCredential(UpdateCredentialRequest) returns (common.Status) {}
|
|
101
|
-
rpc DeleteCredential(DeleteCredentialRequest) returns (common.Status) {}
|
|
102
|
-
rpc ListCredUsers(ListCredUsersRequest) returns (ListCredUsersResponse) {}
|
|
103
|
-
|
|
104
|
-
// https://wiki.lfaidata.foundation/display/MIL/MEP+29+--+Support+Role-Based+Access+Control
|
|
105
|
-
rpc CreateRole(CreateRoleRequest) returns (common.Status) {}
|
|
106
|
-
rpc DropRole(DropRoleRequest) returns (common.Status) {}
|
|
107
|
-
rpc OperateUserRole(OperateUserRoleRequest) returns (common.Status) {}
|
|
108
|
-
rpc SelectRole(SelectRoleRequest) returns (SelectRoleResponse) {}
|
|
109
|
-
rpc SelectUser(SelectUserRequest) returns (SelectUserResponse) {}
|
|
110
|
-
rpc OperatePrivilege(OperatePrivilegeRequest) returns (common.Status) {}
|
|
111
|
-
rpc OperatePrivilegeV2(OperatePrivilegeV2Request) returns (common.Status) {}
|
|
112
|
-
rpc SelectGrant(SelectGrantRequest) returns (SelectGrantResponse) {}
|
|
113
|
-
|
|
114
|
-
rpc GetVersion(GetVersionRequest) returns (GetVersionResponse) {}
|
|
115
|
-
rpc CheckHealth(CheckHealthRequest) returns (CheckHealthResponse) {}
|
|
116
|
-
|
|
117
|
-
rpc CreateResourceGroup(CreateResourceGroupRequest) returns (common.Status) {}
|
|
118
|
-
rpc DropResourceGroup(DropResourceGroupRequest) returns (common.Status) {}
|
|
119
|
-
rpc UpdateResourceGroups(UpdateResourceGroupsRequest) returns (common.Status) {}
|
|
120
|
-
rpc TransferNode(TransferNodeRequest) returns (common.Status) {}
|
|
121
|
-
rpc TransferReplica(TransferReplicaRequest) returns (common.Status) {}
|
|
122
|
-
rpc ListResourceGroups(ListResourceGroupsRequest) returns (ListResourceGroupsResponse) {}
|
|
123
|
-
rpc DescribeResourceGroup(DescribeResourceGroupRequest) returns (DescribeResourceGroupResponse) {}
|
|
124
|
-
|
|
125
|
-
rpc RenameCollection(RenameCollectionRequest) returns (common.Status) {}
|
|
126
|
-
|
|
127
|
-
rpc ListIndexedSegment(feder.ListIndexedSegmentRequest) returns(feder.ListIndexedSegmentResponse) {}
|
|
128
|
-
rpc DescribeSegmentIndexData(feder.DescribeSegmentIndexDataRequest) returns(feder.DescribeSegmentIndexDataResponse) {}
|
|
129
|
-
|
|
130
|
-
rpc Connect(ConnectRequest) returns (ConnectResponse) {}
|
|
131
|
-
|
|
132
|
-
rpc AllocTimestamp(AllocTimestampRequest) returns (AllocTimestampResponse) {}
|
|
133
|
-
|
|
134
|
-
rpc CreateDatabase(CreateDatabaseRequest) returns (common.Status) {}
|
|
135
|
-
rpc DropDatabase(DropDatabaseRequest) returns (common.Status) {}
|
|
136
|
-
rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse) {}
|
|
137
|
-
rpc AlterDatabase(AlterDatabaseRequest) returns (common.Status) {}
|
|
138
|
-
rpc DescribeDatabase(DescribeDatabaseRequest) returns (DescribeDatabaseResponse) {}
|
|
139
|
-
|
|
140
|
-
rpc ReplicateMessage(ReplicateMessageRequest) returns (ReplicateMessageResponse) {}
|
|
141
|
-
|
|
142
|
-
rpc BackupRBAC(BackupRBACMetaRequest) returns (BackupRBACMetaResponse){}
|
|
143
|
-
rpc RestoreRBAC(RestoreRBACMetaRequest) returns (common.Status){}
|
|
144
|
-
|
|
145
|
-
rpc CreatePrivilegeGroup(CreatePrivilegeGroupRequest) returns (common.Status) {}
|
|
146
|
-
rpc DropPrivilegeGroup(DropPrivilegeGroupRequest) returns (common.Status) {}
|
|
147
|
-
rpc ListPrivilegeGroups(ListPrivilegeGroupsRequest) returns (ListPrivilegeGroupsResponse) {}
|
|
148
|
-
rpc OperatePrivilegeGroup(OperatePrivilegeGroupRequest) returns (common.Status) {}
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
message CreateAliasRequest {
|
|
152
|
-
option (common.privilege_ext_obj) = {
|
|
153
|
-
object_type: Global
|
|
154
|
-
object_privilege: PrivilegeCreateAlias
|
|
155
|
-
object_name_index: -1
|
|
156
|
-
};
|
|
157
|
-
|
|
158
|
-
common.MsgBase base = 1;
|
|
159
|
-
string db_name = 2;
|
|
160
|
-
string collection_name = 3;
|
|
161
|
-
string alias = 4;
|
|
162
|
-
}
|
|
163
|
-
|
|
164
|
-
message DropAliasRequest {
|
|
165
|
-
option (common.privilege_ext_obj) = {
|
|
166
|
-
object_type: Global
|
|
167
|
-
object_privilege: PrivilegeDropAlias
|
|
168
|
-
object_name_index: -1
|
|
169
|
-
};
|
|
170
|
-
|
|
171
|
-
common.MsgBase base = 1;
|
|
172
|
-
string db_name = 2;
|
|
173
|
-
string alias = 3;
|
|
174
|
-
}
|
|
175
|
-
|
|
176
|
-
message AlterAliasRequest{
|
|
177
|
-
option (common.privilege_ext_obj) = {
|
|
178
|
-
object_type: Global
|
|
179
|
-
object_privilege: PrivilegeCreateAlias
|
|
180
|
-
object_name_index: -1
|
|
181
|
-
};
|
|
182
|
-
|
|
183
|
-
common.MsgBase base = 1;
|
|
184
|
-
string db_name = 2;
|
|
185
|
-
string collection_name = 3;
|
|
186
|
-
string alias = 4;
|
|
187
|
-
}
|
|
188
|
-
|
|
189
|
-
message DescribeAliasRequest{
|
|
190
|
-
option (common.privilege_ext_obj) = {
|
|
191
|
-
object_type: Global
|
|
192
|
-
object_privilege: PrivilegeDescribeAlias
|
|
193
|
-
object_name_index: -1
|
|
194
|
-
};
|
|
195
|
-
|
|
196
|
-
common.MsgBase base = 1;
|
|
197
|
-
string db_name = 2;
|
|
198
|
-
string alias = 3;
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
/*
|
|
202
|
-
* Describe alias response
|
|
203
|
-
*/
|
|
204
|
-
message DescribeAliasResponse {
|
|
205
|
-
// Response status
|
|
206
|
-
common.Status status = 1;
|
|
207
|
-
string db_name = 2;
|
|
208
|
-
string alias = 3;
|
|
209
|
-
string collection = 4;
|
|
210
|
-
}
|
|
211
|
-
|
|
212
|
-
message ListAliasesRequest{
|
|
213
|
-
option (common.privilege_ext_obj) = {
|
|
214
|
-
object_type: Global
|
|
215
|
-
object_privilege: PrivilegeListAliases
|
|
216
|
-
object_name_index: -1
|
|
217
|
-
};
|
|
218
|
-
|
|
219
|
-
common.MsgBase base = 1;
|
|
220
|
-
string db_name = 2;
|
|
221
|
-
string collection_name = 3;
|
|
222
|
-
}
|
|
223
|
-
|
|
224
|
-
/*
|
|
225
|
-
* List aliases response
|
|
226
|
-
*/
|
|
227
|
-
message ListAliasesResponse {
|
|
228
|
-
// Response status
|
|
229
|
-
common.Status status = 1;
|
|
230
|
-
string db_name = 2;
|
|
231
|
-
string collection_name = 3;
|
|
232
|
-
repeated string aliases = 4;
|
|
233
|
-
}
|
|
234
|
-
|
|
235
|
-
/**
|
|
236
|
-
* Create collection in milvus
|
|
237
|
-
*/
|
|
238
|
-
message CreateCollectionRequest {
|
|
239
|
-
option (common.privilege_ext_obj) = {
|
|
240
|
-
object_type: Global
|
|
241
|
-
object_privilege: PrivilegeCreateCollection
|
|
242
|
-
object_name_index: -1
|
|
243
|
-
};
|
|
244
|
-
// Not useful for now
|
|
245
|
-
common.MsgBase base = 1;
|
|
246
|
-
string db_name = 2;
|
|
247
|
-
// The unique collection name in milvus.(Required)
|
|
248
|
-
string collection_name = 3;
|
|
249
|
-
// The serialized `schema.CollectionSchema`(Required)
|
|
250
|
-
bytes schema = 4;
|
|
251
|
-
// Once set, no modification is allowed (Optional)
|
|
252
|
-
// https://github.com/milvus-io/milvus/issues/6690
|
|
253
|
-
int32 shards_num = 5;
|
|
254
|
-
// The consistency level that the collection used, modification is not supported now.
|
|
255
|
-
common.ConsistencyLevel consistency_level = 6;
|
|
256
|
-
repeated common.KeyValuePair properties = 7;
|
|
257
|
-
int64 num_partitions = 8; // num of default physical partitions, only used in partition key mode and changes are not supported
|
|
258
|
-
}
|
|
259
|
-
|
|
260
|
-
/**
|
|
261
|
-
* Drop collection in milvus, also will drop data in collection.
|
|
262
|
-
*/
|
|
263
|
-
message DropCollectionRequest {
|
|
264
|
-
option (common.privilege_ext_obj) = {
|
|
265
|
-
object_type: Global
|
|
266
|
-
object_privilege: PrivilegeDropCollection
|
|
267
|
-
object_name_index: -1
|
|
268
|
-
};
|
|
269
|
-
// Not useful for now
|
|
270
|
-
common.MsgBase base = 1;
|
|
271
|
-
string db_name = 2;
|
|
272
|
-
// The unique collection name in milvus.(Required)
|
|
273
|
-
string collection_name = 3;
|
|
274
|
-
}
|
|
275
|
-
|
|
276
|
-
/**
|
|
277
|
-
* Alter collection in milvus
|
|
278
|
-
*/
|
|
279
|
-
message AlterCollectionRequest {
|
|
280
|
-
option (common.privilege_ext_obj) = {
|
|
281
|
-
object_type: Global
|
|
282
|
-
object_privilege: PrivilegeCreateCollection
|
|
283
|
-
object_name_index: -1
|
|
284
|
-
};
|
|
285
|
-
// Not useful for now
|
|
286
|
-
common.MsgBase base = 1;
|
|
287
|
-
string db_name = 2;
|
|
288
|
-
// The unique collection name in milvus.(Required)
|
|
289
|
-
string collection_name = 3;
|
|
290
|
-
int64 collectionID = 4;
|
|
291
|
-
repeated common.KeyValuePair properties = 5;
|
|
292
|
-
repeated string delete_keys = 6;
|
|
293
|
-
}
|
|
294
|
-
|
|
295
|
-
message AlterCollectionFieldRequest {
|
|
296
|
-
option (common.privilege_ext_obj) = {
|
|
297
|
-
object_type: Global
|
|
298
|
-
object_privilege: PrivilegeCreateCollection
|
|
299
|
-
object_name_index: -1
|
|
300
|
-
};
|
|
301
|
-
// Not useful for now
|
|
302
|
-
common.MsgBase base = 1;
|
|
303
|
-
string db_name = 2;
|
|
304
|
-
// The unique collection name in milvus.(Required)
|
|
305
|
-
string collection_name = 3;
|
|
306
|
-
string field_name =4;
|
|
307
|
-
repeated common.KeyValuePair properties = 5;
|
|
308
|
-
}
|
|
309
|
-
|
|
310
|
-
/**
|
|
311
|
-
* Check collection exist in milvus or not.
|
|
312
|
-
*/
|
|
313
|
-
message HasCollectionRequest {
|
|
314
|
-
// Not useful for now
|
|
315
|
-
common.MsgBase base = 1;
|
|
316
|
-
string db_name = 2;
|
|
317
|
-
// The collection name you want to check.
|
|
318
|
-
string collection_name = 3;
|
|
319
|
-
// If time_stamp is not zero, will return true when time_stamp >= created collection timestamp, otherwise will return false.
|
|
320
|
-
uint64 time_stamp = 4;
|
|
321
|
-
}
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
message BoolResponse {
|
|
325
|
-
common.Status status = 1;
|
|
326
|
-
bool value = 2;
|
|
327
|
-
}
|
|
328
|
-
|
|
329
|
-
message StringResponse {
|
|
330
|
-
common.Status status = 1;
|
|
331
|
-
string value = 2;
|
|
332
|
-
}
|
|
333
|
-
|
|
334
|
-
/**
|
|
335
|
-
* Get collection meta datas like: schema, collectionID, shards number ...
|
|
336
|
-
*/
|
|
337
|
-
message DescribeCollectionRequest {
|
|
338
|
-
option (common.privilege_ext_obj) = {
|
|
339
|
-
object_type: Global
|
|
340
|
-
object_privilege: PrivilegeDescribeCollection
|
|
341
|
-
object_name_index: -1
|
|
342
|
-
};
|
|
343
|
-
// Not useful for now
|
|
344
|
-
common.MsgBase base = 1;
|
|
345
|
-
string db_name = 2;
|
|
346
|
-
// The collection name you want to describe, you can pass collection_name or collectionID
|
|
347
|
-
string collection_name = 3;
|
|
348
|
-
// The collection ID you want to describe
|
|
349
|
-
int64 collectionID = 4;
|
|
350
|
-
// If time_stamp is not zero, will describe collection success when time_stamp >= created collection timestamp, otherwise will throw error.
|
|
351
|
-
uint64 time_stamp = 5;
|
|
352
|
-
}
|
|
353
|
-
|
|
354
|
-
/**
|
|
355
|
-
* DescribeCollection Response
|
|
356
|
-
*/
|
|
357
|
-
message DescribeCollectionResponse {
|
|
358
|
-
// Contain error_code and reason
|
|
359
|
-
common.Status status = 1;
|
|
360
|
-
// The schema param when you created collection.
|
|
361
|
-
schema.CollectionSchema schema = 2;
|
|
362
|
-
// The collection id
|
|
363
|
-
int64 collectionID = 3;
|
|
364
|
-
// System design related, users should not perceive
|
|
365
|
-
repeated string virtual_channel_names = 4;
|
|
366
|
-
// System design related, users should not perceive
|
|
367
|
-
repeated string physical_channel_names = 5;
|
|
368
|
-
// Hybrid timestamp in milvus
|
|
369
|
-
uint64 created_timestamp = 6;
|
|
370
|
-
// The utc timestamp calculated by created_timestamp
|
|
371
|
-
uint64 created_utc_timestamp = 7;
|
|
372
|
-
// The shards number you set.
|
|
373
|
-
int32 shards_num = 8;
|
|
374
|
-
// The aliases of this collection
|
|
375
|
-
repeated string aliases = 9;
|
|
376
|
-
// The message ID/posititon when collection is created
|
|
377
|
-
repeated common.KeyDataPair start_positions = 10;
|
|
378
|
-
// The consistency level that the collection used, modification is not supported now.
|
|
379
|
-
common.ConsistencyLevel consistency_level = 11;
|
|
380
|
-
// The collection name
|
|
381
|
-
string collection_name = 12;
|
|
382
|
-
repeated common.KeyValuePair properties = 13;
|
|
383
|
-
string db_name = 14;
|
|
384
|
-
int64 num_partitions = 15;
|
|
385
|
-
int64 db_id =16;
|
|
386
|
-
uint64 request_time = 17;
|
|
387
|
-
uint64 update_timestamp = 18;
|
|
388
|
-
}
|
|
389
|
-
|
|
390
|
-
/**
|
|
391
|
-
* Load collection data into query nodes, then you can do vector search on this collection.
|
|
392
|
-
*/
|
|
393
|
-
message LoadCollectionRequest {
|
|
394
|
-
option (common.privilege_ext_obj) = {
|
|
395
|
-
object_type: Collection
|
|
396
|
-
object_privilege: PrivilegeLoad
|
|
397
|
-
object_name_index: 3
|
|
398
|
-
};
|
|
399
|
-
// Not useful for now
|
|
400
|
-
common.MsgBase base = 1;
|
|
401
|
-
string db_name = 2;
|
|
402
|
-
// The collection name you want to load
|
|
403
|
-
string collection_name = 3;
|
|
404
|
-
// The replica number to load, default by 1
|
|
405
|
-
int32 replica_number = 4;
|
|
406
|
-
// create replica used resource group
|
|
407
|
-
repeated string resource_groups = 5;
|
|
408
|
-
// Whether to enable refresh mode.
|
|
409
|
-
bool refresh = 6;
|
|
410
|
-
// Field Partial Load fields list
|
|
411
|
-
repeated string load_fields = 7;
|
|
412
|
-
// Field Partial load skip load dynamic fields
|
|
413
|
-
bool skip_load_dynamic_field = 8;
|
|
414
|
-
}
|
|
415
|
-
|
|
416
|
-
/**
|
|
417
|
-
* Release collection data from query nodes, then you can't do vector search on this collection.
|
|
418
|
-
*/
|
|
419
|
-
message ReleaseCollectionRequest {
|
|
420
|
-
option (common.privilege_ext_obj) = {
|
|
421
|
-
object_type: Collection
|
|
422
|
-
object_privilege: PrivilegeRelease
|
|
423
|
-
object_name_index: 3
|
|
424
|
-
};
|
|
425
|
-
// Not useful for now
|
|
426
|
-
common.MsgBase base = 1;
|
|
427
|
-
string db_name = 2;
|
|
428
|
-
// The collection name you want to release
|
|
429
|
-
string collection_name = 3;
|
|
430
|
-
}
|
|
431
|
-
|
|
432
|
-
/**
|
|
433
|
-
* Get statistics like row_count.
|
|
434
|
-
* WARNING: This API is experimental and not useful for now.
|
|
435
|
-
*/
|
|
436
|
-
message GetStatisticsRequest {
|
|
437
|
-
option (common.privilege_ext_obj) = {
|
|
438
|
-
object_type: Collection
|
|
439
|
-
object_privilege: PrivilegeGetStatistics
|
|
440
|
-
object_name_index: 3
|
|
441
|
-
};
|
|
442
|
-
// Not useful for now
|
|
443
|
-
common.MsgBase base = 1;
|
|
444
|
-
string db_name = 2;
|
|
445
|
-
// The collection name you want get statistics
|
|
446
|
-
string collection_name = 3;
|
|
447
|
-
// The partition names you want get statistics, empty for all partitions
|
|
448
|
-
repeated string partition_names = 4;
|
|
449
|
-
// Not useful for now, reserved for future
|
|
450
|
-
uint64 guarantee_timestamp = 5;
|
|
451
|
-
}
|
|
452
|
-
|
|
453
|
-
/**
|
|
454
|
-
* Will return statistics in stats field like [{key:"row_count",value:"1"}]
|
|
455
|
-
* WARNING: This API is experimental and not useful for now.
|
|
456
|
-
*/
|
|
457
|
-
message GetStatisticsResponse {
|
|
458
|
-
// Contain error_code and reason
|
|
459
|
-
common.Status status = 1;
|
|
460
|
-
// Collection statistics data
|
|
461
|
-
repeated common.KeyValuePair stats = 2;
|
|
462
|
-
}
|
|
463
|
-
|
|
464
|
-
/**
|
|
465
|
-
* Get collection statistics like row_count.
|
|
466
|
-
*/
|
|
467
|
-
message GetCollectionStatisticsRequest {
|
|
468
|
-
option (common.privilege_ext_obj) = {
|
|
469
|
-
object_type: Collection
|
|
470
|
-
object_privilege: PrivilegeGetStatistics
|
|
471
|
-
object_name_index: 3
|
|
472
|
-
};
|
|
473
|
-
// Not useful for now
|
|
474
|
-
common.MsgBase base = 1;
|
|
475
|
-
string db_name = 2;
|
|
476
|
-
// The collection name you want get statistics
|
|
477
|
-
string collection_name = 3;
|
|
478
|
-
}
|
|
479
|
-
|
|
480
|
-
/**
|
|
481
|
-
* Will return collection statistics in stats field like [{key:"row_count",value:"1"}]
|
|
482
|
-
*/
|
|
483
|
-
message GetCollectionStatisticsResponse {
|
|
484
|
-
// Contain error_code and reason
|
|
485
|
-
common.Status status = 1;
|
|
486
|
-
// Collection statistics data
|
|
487
|
-
repeated common.KeyValuePair stats = 2;
|
|
488
|
-
}
|
|
489
|
-
|
|
490
|
-
/*
|
|
491
|
-
* This is for ShowCollectionsRequest type field.
|
|
492
|
-
*/
|
|
493
|
-
// Deprecated: use GetLoadingProgress rpc instead
|
|
494
|
-
enum ShowType {
|
|
495
|
-
option deprecated = true;
|
|
496
|
-
// Will return all collections
|
|
497
|
-
All = 0;
|
|
498
|
-
// Will return loaded collections with their inMemory_percentages
|
|
499
|
-
InMemory = 1;
|
|
500
|
-
}
|
|
501
|
-
|
|
502
|
-
/*
|
|
503
|
-
* List collections
|
|
504
|
-
*/
|
|
505
|
-
message ShowCollectionsRequest {
|
|
506
|
-
// Not useful for now
|
|
507
|
-
common.MsgBase base = 1;
|
|
508
|
-
string db_name = 2;
|
|
509
|
-
// Not useful for now
|
|
510
|
-
uint64 time_stamp = 3;
|
|
511
|
-
// Decide return Loaded collections or All collections(Optional)
|
|
512
|
-
ShowType type = 4;
|
|
513
|
-
// When type is InMemory, will return these collection's inMemory_percentages.(Optional)
|
|
514
|
-
// Deprecated: use GetLoadingProgress rpc instead
|
|
515
|
-
repeated string collection_names = 5 [deprecated=true];
|
|
516
|
-
}
|
|
517
|
-
|
|
518
|
-
/*
|
|
519
|
-
* Return basic collection infos.
|
|
520
|
-
*/
|
|
521
|
-
message ShowCollectionsResponse {
|
|
522
|
-
// Contain error_code and reason
|
|
523
|
-
common.Status status = 1;
|
|
524
|
-
// Collection name array
|
|
525
|
-
repeated string collection_names = 2;
|
|
526
|
-
// Collection Id array
|
|
527
|
-
repeated int64 collection_ids = 3;
|
|
528
|
-
// Hybrid timestamps in milvus
|
|
529
|
-
repeated uint64 created_timestamps = 4;
|
|
530
|
-
// The utc timestamp calculated by created_timestamp
|
|
531
|
-
repeated uint64 created_utc_timestamps = 5;
|
|
532
|
-
// Load percentage on querynode when type is InMemory
|
|
533
|
-
// Deprecated: use GetLoadingProgress rpc instead
|
|
534
|
-
repeated int64 inMemory_percentages = 6 [deprecated=true];
|
|
535
|
-
// Indicate whether query service is available
|
|
536
|
-
repeated bool query_service_available = 7;
|
|
537
|
-
}
|
|
538
|
-
|
|
539
|
-
/*
|
|
540
|
-
* Create partition in created collection.
|
|
541
|
-
*/
|
|
542
|
-
message CreatePartitionRequest {
|
|
543
|
-
option (common.privilege_ext_obj) = {
|
|
544
|
-
object_type: Collection
|
|
545
|
-
object_privilege: PrivilegeCreatePartition
|
|
546
|
-
object_name_index: 3
|
|
547
|
-
};
|
|
548
|
-
// Not useful for now
|
|
549
|
-
common.MsgBase base = 1;
|
|
550
|
-
string db_name = 2;
|
|
551
|
-
// The collection name in milvus
|
|
552
|
-
string collection_name = 3;
|
|
553
|
-
// The partition name you want to create.
|
|
554
|
-
string partition_name = 4;
|
|
555
|
-
}
|
|
556
|
-
|
|
557
|
-
/*
|
|
558
|
-
* Drop partition in created collection.
|
|
559
|
-
*/
|
|
560
|
-
message DropPartitionRequest {
|
|
561
|
-
option (common.privilege_ext_obj) = {
|
|
562
|
-
object_type: Collection
|
|
563
|
-
object_privilege: PrivilegeDropPartition
|
|
564
|
-
object_name_index: 3
|
|
565
|
-
};
|
|
566
|
-
// Not useful for now
|
|
567
|
-
common.MsgBase base = 1;
|
|
568
|
-
string db_name = 2;
|
|
569
|
-
// The collection name in milvus
|
|
570
|
-
string collection_name = 3;
|
|
571
|
-
// The partition name you want to drop
|
|
572
|
-
string partition_name = 4;
|
|
573
|
-
}
|
|
574
|
-
|
|
575
|
-
/*
|
|
576
|
-
* Check if partition exist in collection or not.
|
|
577
|
-
*/
|
|
578
|
-
message HasPartitionRequest {
|
|
579
|
-
option (common.privilege_ext_obj) = {
|
|
580
|
-
object_type: Collection
|
|
581
|
-
object_privilege: PrivilegeHasPartition
|
|
582
|
-
object_name_index: 3
|
|
583
|
-
};
|
|
584
|
-
// Not useful for now
|
|
585
|
-
common.MsgBase base = 1;
|
|
586
|
-
string db_name = 2;
|
|
587
|
-
// The collection name in milvus
|
|
588
|
-
string collection_name = 3;
|
|
589
|
-
// The partition name you want to check
|
|
590
|
-
string partition_name = 4;
|
|
591
|
-
}
|
|
592
|
-
|
|
593
|
-
/*
|
|
594
|
-
* Load specific partitions data of one collection into query nodes
|
|
595
|
-
* Then you can get these data as result when you do vector search on this collection.
|
|
596
|
-
*/
|
|
597
|
-
message LoadPartitionsRequest {
|
|
598
|
-
option (common.privilege_ext_obj) = {
|
|
599
|
-
object_type: Collection
|
|
600
|
-
object_privilege: PrivilegeLoad
|
|
601
|
-
object_name_index: 3
|
|
602
|
-
};
|
|
603
|
-
// Not useful for now
|
|
604
|
-
common.MsgBase base = 1;
|
|
605
|
-
string db_name = 2;
|
|
606
|
-
// The collection name in milvus
|
|
607
|
-
string collection_name = 3;
|
|
608
|
-
// The partition names you want to load
|
|
609
|
-
repeated string partition_names = 4;
|
|
610
|
-
// The replicas number you would load, 1 by default
|
|
611
|
-
int32 replica_number = 5;
|
|
612
|
-
// create replica used resource group
|
|
613
|
-
repeated string resource_groups = 6;
|
|
614
|
-
// Whether to enable refresh mode.
|
|
615
|
-
bool refresh = 7;
|
|
616
|
-
// Field Partial Load fields list
|
|
617
|
-
repeated string load_fields = 8;
|
|
618
|
-
// Field Partial load skip load dynamic fields
|
|
619
|
-
bool skip_load_dynamic_field = 9;
|
|
620
|
-
}
|
|
621
|
-
|
|
622
|
-
/*
|
|
623
|
-
* Release specific partitions data of one collection from query nodes.
|
|
624
|
-
* Then you can not get these data as result when you do vector search on this collection.
|
|
625
|
-
*/
|
|
626
|
-
message ReleasePartitionsRequest {
|
|
627
|
-
option (common.privilege_ext_obj) = {
|
|
628
|
-
object_type: Collection
|
|
629
|
-
object_privilege: PrivilegeRelease
|
|
630
|
-
object_name_index: 3
|
|
631
|
-
};
|
|
632
|
-
// Not useful for now
|
|
633
|
-
common.MsgBase base = 1;
|
|
634
|
-
string db_name = 2;
|
|
635
|
-
// The collection name in milvus
|
|
636
|
-
string collection_name = 3;
|
|
637
|
-
// The partition names you want to release
|
|
638
|
-
repeated string partition_names = 4;
|
|
639
|
-
}
|
|
640
|
-
|
|
641
|
-
/*
|
|
642
|
-
* Get partition statistics like row_count.
|
|
643
|
-
*/
|
|
644
|
-
message GetPartitionStatisticsRequest {
|
|
645
|
-
// Not useful for now
|
|
646
|
-
common.MsgBase base = 1;
|
|
647
|
-
string db_name = 2;
|
|
648
|
-
// The collection name in milvus
|
|
649
|
-
string collection_name = 3;
|
|
650
|
-
// The partition name you want to collect statistics
|
|
651
|
-
string partition_name = 4;
|
|
652
|
-
}
|
|
653
|
-
|
|
654
|
-
message GetPartitionStatisticsResponse {
|
|
655
|
-
common.Status status = 1;
|
|
656
|
-
repeated common.KeyValuePair stats = 2;
|
|
657
|
-
}
|
|
658
|
-
|
|
659
|
-
/*
|
|
660
|
-
* List all partitions for particular collection
|
|
661
|
-
*/
|
|
662
|
-
message ShowPartitionsRequest {
|
|
663
|
-
option (common.privilege_ext_obj) = {
|
|
664
|
-
object_type: Collection
|
|
665
|
-
object_privilege: PrivilegeShowPartitions
|
|
666
|
-
object_name_index: 3
|
|
667
|
-
};
|
|
668
|
-
// Not useful for now
|
|
669
|
-
common.MsgBase base = 1;
|
|
670
|
-
string db_name = 2;
|
|
671
|
-
// The collection name you want to describe, you can pass collection_name or collectionID
|
|
672
|
-
string collection_name = 3;
|
|
673
|
-
// The collection id in milvus
|
|
674
|
-
int64 collectionID = 4;
|
|
675
|
-
// When type is InMemory, will return these patitions's inMemory_percentages.(Optional)
|
|
676
|
-
repeated string partition_names = 5;
|
|
677
|
-
// Decide return Loaded partitions or All partitions(Optional)
|
|
678
|
-
// Deprecated: use GetLoadingProgress rpc instead
|
|
679
|
-
ShowType type = 6 [deprecated=true];
|
|
680
|
-
}
|
|
681
|
-
|
|
682
|
-
/*
|
|
683
|
-
* List all partitions for particular collection response.
|
|
684
|
-
* The returned datas are all rows, we can format to columns by therir index.
|
|
685
|
-
*/
|
|
686
|
-
message ShowPartitionsResponse {
|
|
687
|
-
// Contain error_code and reason
|
|
688
|
-
common.Status status = 1;
|
|
689
|
-
// All partition names for this collection
|
|
690
|
-
repeated string partition_names = 2;
|
|
691
|
-
// All partition ids for this collection
|
|
692
|
-
repeated int64 partitionIDs = 3;
|
|
693
|
-
// All hybrid timestamps
|
|
694
|
-
repeated uint64 created_timestamps = 4;
|
|
695
|
-
// All utc timestamps calculated by created_timestamps
|
|
696
|
-
repeated uint64 created_utc_timestamps = 5;
|
|
697
|
-
// Load percentage on querynode
|
|
698
|
-
// Deprecated: use GetLoadingProgress rpc instead
|
|
699
|
-
repeated int64 inMemory_percentages = 6 [deprecated=true];
|
|
700
|
-
}
|
|
701
|
-
|
|
702
|
-
message DescribeSegmentRequest {
|
|
703
|
-
common.MsgBase base = 1;
|
|
704
|
-
int64 collectionID = 2;
|
|
705
|
-
int64 segmentID = 3;
|
|
706
|
-
}
|
|
707
|
-
|
|
708
|
-
message DescribeSegmentResponse {
|
|
709
|
-
common.Status status = 1;
|
|
710
|
-
int64 indexID = 2;
|
|
711
|
-
int64 buildID = 3;
|
|
712
|
-
bool enable_index = 4;
|
|
713
|
-
int64 fieldID = 5;
|
|
714
|
-
}
|
|
715
|
-
|
|
716
|
-
message ShowSegmentsRequest {
|
|
717
|
-
common.MsgBase base = 1;
|
|
718
|
-
int64 collectionID = 2;
|
|
719
|
-
int64 partitionID = 3;
|
|
720
|
-
}
|
|
721
|
-
|
|
722
|
-
message ShowSegmentsResponse {
|
|
723
|
-
common.Status status = 1;
|
|
724
|
-
repeated int64 segmentIDs = 2;
|
|
725
|
-
}
|
|
726
|
-
|
|
727
|
-
/*
|
|
728
|
-
* Create index for vector datas
|
|
729
|
-
*/
|
|
730
|
-
message CreateIndexRequest {
|
|
731
|
-
option (common.privilege_ext_obj) = {
|
|
732
|
-
object_type: Collection
|
|
733
|
-
object_privilege: PrivilegeCreateIndex
|
|
734
|
-
object_name_index: 3
|
|
735
|
-
};
|
|
736
|
-
// Not useful for now
|
|
737
|
-
common.MsgBase base = 1;
|
|
738
|
-
string db_name = 2;
|
|
739
|
-
// The particular collection name you want to create index.
|
|
740
|
-
string collection_name = 3;
|
|
741
|
-
// The vector field name in this particular collection
|
|
742
|
-
string field_name = 4;
|
|
743
|
-
// Support keys: index_type,metric_type, params. Different index_type may has different params.
|
|
744
|
-
repeated common.KeyValuePair extra_params = 5;
|
|
745
|
-
// Version before 2.0.2 doesn't contain index_name, we use default index name.
|
|
746
|
-
string index_name = 6;
|
|
747
|
-
}
|
|
748
|
-
|
|
749
|
-
/*
|
|
750
|
-
* Alter index
|
|
751
|
-
*/
|
|
752
|
-
message AlterIndexRequest {
|
|
753
|
-
option (common.privilege_ext_obj) = {
|
|
754
|
-
object_type: Collection
|
|
755
|
-
object_privilege: PrivilegeCreateIndex
|
|
756
|
-
object_name_index: 3
|
|
757
|
-
};
|
|
758
|
-
|
|
759
|
-
common.MsgBase base = 1;
|
|
760
|
-
string db_name = 2;
|
|
761
|
-
string collection_name = 3;
|
|
762
|
-
string index_name = 4;
|
|
763
|
-
repeated common.KeyValuePair extra_params = 5;
|
|
764
|
-
repeated string delete_keys = 6;
|
|
765
|
-
}
|
|
766
|
-
|
|
767
|
-
/*
|
|
768
|
-
* Get created index information.
|
|
769
|
-
* Current release of Milvus only supports showing latest built index.
|
|
770
|
-
*/
|
|
771
|
-
message DescribeIndexRequest {
|
|
772
|
-
option (common.privilege_ext_obj) = {
|
|
773
|
-
object_type: Collection
|
|
774
|
-
object_privilege: PrivilegeIndexDetail
|
|
775
|
-
object_name_index: 3
|
|
776
|
-
};
|
|
777
|
-
// Not useful for now
|
|
778
|
-
common.MsgBase base = 1;
|
|
779
|
-
string db_name = 2;
|
|
780
|
-
// The particular collection name in Milvus
|
|
781
|
-
string collection_name = 3;
|
|
782
|
-
// The vector field name in this particular collection
|
|
783
|
-
string field_name = 4;
|
|
784
|
-
// No need to set up for now @2021.06.30
|
|
785
|
-
string index_name = 5;
|
|
786
|
-
uint64 timestamp = 6;
|
|
787
|
-
}
|
|
788
|
-
|
|
789
|
-
/*
|
|
790
|
-
* Index informations
|
|
791
|
-
*/
|
|
792
|
-
message IndexDescription {
|
|
793
|
-
// Index name
|
|
794
|
-
string index_name = 1;
|
|
795
|
-
// Index id
|
|
796
|
-
int64 indexID = 2;
|
|
797
|
-
// Will return index_type, metric_type, params(like nlist).
|
|
798
|
-
repeated common.KeyValuePair params = 3;
|
|
799
|
-
// The vector field name
|
|
800
|
-
string field_name = 4;
|
|
801
|
-
// index build progress
|
|
802
|
-
int64 indexed_rows = 5;
|
|
803
|
-
int64 total_rows = 6;
|
|
804
|
-
// index state
|
|
805
|
-
common.IndexState state = 7;
|
|
806
|
-
string index_state_fail_reason = 8;
|
|
807
|
-
int64 pending_index_rows = 9;
|
|
808
|
-
}
|
|
809
|
-
|
|
810
|
-
/*
|
|
811
|
-
* Describe index response
|
|
812
|
-
*/
|
|
813
|
-
message DescribeIndexResponse {
|
|
814
|
-
// Response status
|
|
815
|
-
common.Status status = 1;
|
|
816
|
-
// All index informations, for now only return tha latest index you created for the collection.
|
|
817
|
-
repeated IndexDescription index_descriptions = 2;
|
|
818
|
-
}
|
|
819
|
-
|
|
820
|
-
/*
|
|
821
|
-
* Get index building progress
|
|
822
|
-
*/
|
|
823
|
-
message GetIndexBuildProgressRequest {
|
|
824
|
-
option (common.privilege_ext_obj) = {
|
|
825
|
-
object_type: Collection
|
|
826
|
-
object_privilege: PrivilegeIndexDetail
|
|
827
|
-
object_name_index: 3
|
|
828
|
-
};
|
|
829
|
-
// Not useful for now
|
|
830
|
-
common.MsgBase base = 1;
|
|
831
|
-
string db_name = 2 ;
|
|
832
|
-
// The collection name in milvus
|
|
833
|
-
string collection_name = 3;
|
|
834
|
-
// The vector field name in this collection
|
|
835
|
-
string field_name = 4;
|
|
836
|
-
// Not useful for now
|
|
837
|
-
string index_name = 5;
|
|
838
|
-
}
|
|
839
|
-
|
|
840
|
-
message GetIndexBuildProgressResponse {
|
|
841
|
-
common.Status status = 1;
|
|
842
|
-
int64 indexed_rows = 2;
|
|
843
|
-
int64 total_rows = 3;
|
|
844
|
-
}
|
|
845
|
-
|
|
846
|
-
message GetIndexStateRequest {
|
|
847
|
-
option (common.privilege_ext_obj) = {
|
|
848
|
-
object_type: Collection
|
|
849
|
-
object_privilege: PrivilegeIndexDetail
|
|
850
|
-
object_name_index: 3
|
|
851
|
-
};
|
|
852
|
-
common.MsgBase base = 1; // must
|
|
853
|
-
string db_name = 2 ;
|
|
854
|
-
string collection_name = 3; // must
|
|
855
|
-
string field_name = 4;
|
|
856
|
-
string index_name = 5; // No need to set up for now @2021.06.30
|
|
857
|
-
}
|
|
858
|
-
|
|
859
|
-
message GetIndexStateResponse {
|
|
860
|
-
common.Status status = 1;
|
|
861
|
-
common.IndexState state = 2;
|
|
862
|
-
string fail_reason = 3;
|
|
863
|
-
}
|
|
864
|
-
|
|
865
|
-
message DropIndexRequest {
|
|
866
|
-
option (common.privilege_ext_obj) = {
|
|
867
|
-
object_type: Collection
|
|
868
|
-
object_privilege: PrivilegeDropIndex
|
|
869
|
-
object_name_index: 3
|
|
870
|
-
};
|
|
871
|
-
common.MsgBase base = 1; // must
|
|
872
|
-
string db_name = 2;
|
|
873
|
-
string collection_name = 3; // must
|
|
874
|
-
// Deprecated: not be used in the milvus
|
|
875
|
-
string field_name = 4;
|
|
876
|
-
string index_name = 5;
|
|
877
|
-
}
|
|
878
|
-
|
|
879
|
-
message InsertRequest {
|
|
880
|
-
option (common.privilege_ext_obj) = {
|
|
881
|
-
object_type: Collection
|
|
882
|
-
object_privilege: PrivilegeInsert
|
|
883
|
-
object_name_index: 3
|
|
884
|
-
};
|
|
885
|
-
common.MsgBase base = 1;
|
|
886
|
-
string db_name = 2;
|
|
887
|
-
string collection_name = 3;
|
|
888
|
-
string partition_name = 4;
|
|
889
|
-
repeated schema.FieldData fields_data = 5;
|
|
890
|
-
repeated uint32 hash_keys = 6;
|
|
891
|
-
uint32 num_rows = 7;
|
|
892
|
-
uint64 schema_timestamp = 8;
|
|
893
|
-
}
|
|
894
|
-
|
|
895
|
-
message UpsertRequest {
|
|
896
|
-
option (common.privilege_ext_obj) = {
|
|
897
|
-
object_type: Collection
|
|
898
|
-
object_privilege: PrivilegeUpsert
|
|
899
|
-
object_name_index: 3
|
|
900
|
-
};
|
|
901
|
-
common.MsgBase base = 1;
|
|
902
|
-
string db_name = 2;
|
|
903
|
-
string collection_name = 3;
|
|
904
|
-
string partition_name = 4;
|
|
905
|
-
repeated schema.FieldData fields_data = 5;
|
|
906
|
-
repeated uint32 hash_keys = 6;
|
|
907
|
-
uint32 num_rows = 7;
|
|
908
|
-
uint64 schema_timestamp = 8;
|
|
909
|
-
}
|
|
910
|
-
|
|
911
|
-
message MutationResult {
|
|
912
|
-
common.Status status = 1;
|
|
913
|
-
schema.IDs IDs = 2; // required for insert, delete, upsert
|
|
914
|
-
repeated uint32 succ_index = 3; // error indexes indicate
|
|
915
|
-
repeated uint32 err_index = 4; // error indexes indicate
|
|
916
|
-
bool acknowledged = 5;
|
|
917
|
-
int64 insert_cnt = 6;
|
|
918
|
-
int64 delete_cnt = 7;
|
|
919
|
-
int64 upsert_cnt = 8;
|
|
920
|
-
uint64 timestamp = 9;
|
|
921
|
-
}
|
|
922
|
-
|
|
923
|
-
message DeleteRequest {
|
|
924
|
-
option (common.privilege_ext_obj) = {
|
|
925
|
-
object_type: Collection
|
|
926
|
-
object_privilege: PrivilegeDelete
|
|
927
|
-
object_name_index: 3
|
|
928
|
-
};
|
|
929
|
-
common.MsgBase base = 1;
|
|
930
|
-
string db_name = 2;
|
|
931
|
-
string collection_name = 3;
|
|
932
|
-
string partition_name = 4;
|
|
933
|
-
string expr = 5;
|
|
934
|
-
repeated uint32 hash_keys = 6;
|
|
935
|
-
common.ConsistencyLevel consistency_level = 7;
|
|
936
|
-
map<string, schema.TemplateValue> expr_template_values = 8;
|
|
937
|
-
}
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
message SubSearchRequest {
|
|
941
|
-
string dsl = 1; // must
|
|
942
|
-
// serialized `PlaceholderGroup`
|
|
943
|
-
bytes placeholder_group = 2; // must
|
|
944
|
-
common.DslType dsl_type = 3; // must
|
|
945
|
-
repeated common.KeyValuePair search_params = 4; // must
|
|
946
|
-
int64 nq = 5;
|
|
947
|
-
map<string, schema.TemplateValue> expr_template_values = 6;
|
|
948
|
-
}
|
|
949
|
-
|
|
950
|
-
message SearchRequest {
|
|
951
|
-
option (common.privilege_ext_obj) = {
|
|
952
|
-
object_type: Collection
|
|
953
|
-
object_privilege: PrivilegeSearch
|
|
954
|
-
object_name_index: 3
|
|
955
|
-
};
|
|
956
|
-
common.MsgBase base = 1; // must
|
|
957
|
-
string db_name = 2;
|
|
958
|
-
string collection_name = 3; // must
|
|
959
|
-
repeated string partition_names = 4; // must
|
|
960
|
-
string dsl = 5; // must
|
|
961
|
-
// serialized `PlaceholderGroup`
|
|
962
|
-
bytes placeholder_group = 6; // must
|
|
963
|
-
common.DslType dsl_type = 7; // must
|
|
964
|
-
repeated string output_fields = 8;
|
|
965
|
-
repeated common.KeyValuePair search_params = 9; // must
|
|
966
|
-
uint64 travel_timestamp = 10;
|
|
967
|
-
uint64 guarantee_timestamp = 11; // guarantee_timestamp
|
|
968
|
-
int64 nq = 12;
|
|
969
|
-
bool not_return_all_meta = 13;
|
|
970
|
-
common.ConsistencyLevel consistency_level = 14;
|
|
971
|
-
bool use_default_consistency = 15;
|
|
972
|
-
bool search_by_primary_keys = 16;
|
|
973
|
-
repeated SubSearchRequest sub_reqs = 17;
|
|
974
|
-
map<string, schema.TemplateValue> expr_template_values = 18;
|
|
975
|
-
}
|
|
976
|
-
|
|
977
|
-
message Hits {
|
|
978
|
-
repeated int64 IDs = 1;
|
|
979
|
-
repeated bytes row_data = 2;
|
|
980
|
-
repeated float scores = 3;
|
|
981
|
-
}
|
|
982
|
-
|
|
983
|
-
message SearchResults {
|
|
984
|
-
common.Status status = 1;
|
|
985
|
-
schema.SearchResultData results = 2;
|
|
986
|
-
string collection_name = 3;
|
|
987
|
-
uint64 session_ts = 4; // for session-like operation like iterator
|
|
988
|
-
}
|
|
989
|
-
|
|
990
|
-
message HybridSearchRequest {
|
|
991
|
-
option (common.privilege_ext_obj) = {
|
|
992
|
-
object_type: Collection
|
|
993
|
-
object_privilege: PrivilegeSearch
|
|
994
|
-
object_name_index: 3
|
|
995
|
-
};
|
|
996
|
-
common.MsgBase base = 1; // must
|
|
997
|
-
string db_name = 2;
|
|
998
|
-
string collection_name = 3; // must
|
|
999
|
-
repeated string partition_names = 4; // must
|
|
1000
|
-
repeated SearchRequest requests = 5;
|
|
1001
|
-
repeated common.KeyValuePair rank_params = 6; // must
|
|
1002
|
-
uint64 travel_timestamp = 7;
|
|
1003
|
-
uint64 guarantee_timestamp = 8; // guarantee_timestamp
|
|
1004
|
-
bool not_return_all_meta = 9;
|
|
1005
|
-
repeated string output_fields = 10;
|
|
1006
|
-
common.ConsistencyLevel consistency_level = 11;
|
|
1007
|
-
bool use_default_consistency = 12;
|
|
1008
|
-
}
|
|
1009
|
-
|
|
1010
|
-
message FlushRequest {
|
|
1011
|
-
option (common.privilege_ext_obj) = {
|
|
1012
|
-
object_type: Collection
|
|
1013
|
-
object_privilege: PrivilegeFlush
|
|
1014
|
-
object_name_indexs: 3
|
|
1015
|
-
};
|
|
1016
|
-
common.MsgBase base = 1;
|
|
1017
|
-
string db_name = 2;
|
|
1018
|
-
repeated string collection_names = 3;
|
|
1019
|
-
}
|
|
1020
|
-
|
|
1021
|
-
message FlushResponse{
|
|
1022
|
-
common.Status status = 1;
|
|
1023
|
-
string db_name = 2;
|
|
1024
|
-
map<string, schema.LongArray> coll_segIDs = 3;
|
|
1025
|
-
map<string, schema.LongArray> flush_coll_segIDs = 4;
|
|
1026
|
-
map<string, int64> coll_seal_times = 5; // physical time for backup tool
|
|
1027
|
-
map<string, uint64> coll_flush_ts = 6; // hybrid ts for geting flush tate
|
|
1028
|
-
map<string, msg.MsgPosition> channel_cps = 7;
|
|
1029
|
-
}
|
|
1030
|
-
|
|
1031
|
-
message QueryRequest {
|
|
1032
|
-
option (common.privilege_ext_obj) = {
|
|
1033
|
-
object_type: Collection
|
|
1034
|
-
object_privilege: PrivilegeQuery
|
|
1035
|
-
object_name_index: 3
|
|
1036
|
-
};
|
|
1037
|
-
common.MsgBase base = 1;
|
|
1038
|
-
string db_name = 2;
|
|
1039
|
-
string collection_name = 3;
|
|
1040
|
-
string expr = 4;
|
|
1041
|
-
repeated string output_fields = 5;
|
|
1042
|
-
repeated string partition_names = 6;
|
|
1043
|
-
uint64 travel_timestamp = 7;
|
|
1044
|
-
uint64 guarantee_timestamp = 8; // guarantee_timestamp
|
|
1045
|
-
repeated common.KeyValuePair query_params = 9; // optional
|
|
1046
|
-
bool not_return_all_meta = 10;
|
|
1047
|
-
common.ConsistencyLevel consistency_level = 11;
|
|
1048
|
-
bool use_default_consistency = 12;
|
|
1049
|
-
map<string, schema.TemplateValue> expr_template_values = 13;
|
|
1050
|
-
}
|
|
1051
|
-
|
|
1052
|
-
message QueryResults {
|
|
1053
|
-
common.Status status = 1;
|
|
1054
|
-
repeated schema.FieldData fields_data = 2;
|
|
1055
|
-
string collection_name = 3;
|
|
1056
|
-
repeated string output_fields = 4;
|
|
1057
|
-
uint64 session_ts = 5; // for session-like operation like iterator
|
|
1058
|
-
string primary_field_name = 6;
|
|
1059
|
-
}
|
|
1060
|
-
|
|
1061
|
-
message QueryCursor {
|
|
1062
|
-
uint64 session_ts = 1;
|
|
1063
|
-
oneof cursor_pk {
|
|
1064
|
-
string str_pk = 2;
|
|
1065
|
-
int64 int_pk = 3;
|
|
1066
|
-
}
|
|
1067
|
-
}
|
|
1068
|
-
|
|
1069
|
-
message VectorIDs {
|
|
1070
|
-
string collection_name = 1;
|
|
1071
|
-
string field_name = 2;
|
|
1072
|
-
schema.IDs id_array = 3;
|
|
1073
|
-
repeated string partition_names = 4;
|
|
1074
|
-
}
|
|
1075
|
-
|
|
1076
|
-
message VectorsArray {
|
|
1077
|
-
oneof array {
|
|
1078
|
-
VectorIDs id_array = 1; // vector ids
|
|
1079
|
-
schema.VectorField data_array = 2; // vectors data
|
|
1080
|
-
}
|
|
1081
|
-
}
|
|
1082
|
-
|
|
1083
|
-
message CalcDistanceRequest {
|
|
1084
|
-
common.MsgBase base = 1;
|
|
1085
|
-
VectorsArray op_left = 2; // vectors on the left of operator
|
|
1086
|
-
VectorsArray op_right = 3; // vectors on the right of operator
|
|
1087
|
-
repeated common.KeyValuePair params = 4; // "metric":"L2"/"IP"/"HAMMIN"/"TANIMOTO"
|
|
1088
|
-
}
|
|
1089
|
-
|
|
1090
|
-
message CalcDistanceResults {
|
|
1091
|
-
common.Status status = 1;
|
|
1092
|
-
// num(op_left)*num(op_right) distance values, "HAMMIN" return integer distance
|
|
1093
|
-
oneof array {
|
|
1094
|
-
schema.IntArray int_dist = 2;
|
|
1095
|
-
schema.FloatArray float_dist = 3;
|
|
1096
|
-
}
|
|
1097
|
-
}
|
|
1098
|
-
|
|
1099
|
-
message FlushAllRequest {
|
|
1100
|
-
option (common.privilege_ext_obj) = {
|
|
1101
|
-
object_type: Global
|
|
1102
|
-
object_privilege: PrivilegeFlushAll
|
|
1103
|
-
object_name_index: -1
|
|
1104
|
-
};
|
|
1105
|
-
common.MsgBase base = 1;
|
|
1106
|
-
string db_name = 2;
|
|
1107
|
-
}
|
|
1108
|
-
|
|
1109
|
-
message FlushAllResponse {
|
|
1110
|
-
common.Status status = 1;
|
|
1111
|
-
uint64 flush_all_ts = 2;
|
|
1112
|
-
}
|
|
1113
|
-
|
|
1114
|
-
message PersistentSegmentInfo {
|
|
1115
|
-
int64 segmentID = 1;
|
|
1116
|
-
int64 collectionID = 2;
|
|
1117
|
-
int64 partitionID = 3;
|
|
1118
|
-
int64 num_rows = 4;
|
|
1119
|
-
common.SegmentState state = 5;
|
|
1120
|
-
common.SegmentLevel level = 6;
|
|
1121
|
-
bool is_sorted = 7;
|
|
1122
|
-
}
|
|
1123
|
-
|
|
1124
|
-
message GetPersistentSegmentInfoRequest {
|
|
1125
|
-
common.MsgBase base = 1; // must
|
|
1126
|
-
string dbName = 2;
|
|
1127
|
-
string collectionName = 3; // must
|
|
1128
|
-
}
|
|
1129
|
-
|
|
1130
|
-
message GetPersistentSegmentInfoResponse {
|
|
1131
|
-
common.Status status = 1;
|
|
1132
|
-
repeated PersistentSegmentInfo infos = 2;
|
|
1133
|
-
}
|
|
1134
|
-
|
|
1135
|
-
message QuerySegmentInfo {
|
|
1136
|
-
int64 segmentID = 1;
|
|
1137
|
-
int64 collectionID = 2;
|
|
1138
|
-
int64 partitionID = 3;
|
|
1139
|
-
int64 mem_size = 4;
|
|
1140
|
-
int64 num_rows = 5;
|
|
1141
|
-
string index_name = 6;
|
|
1142
|
-
int64 indexID = 7;
|
|
1143
|
-
// deprecated, check node_ids(NodeIds) field
|
|
1144
|
-
int64 nodeID = 8 [deprecated=true];
|
|
1145
|
-
common.SegmentState state = 9;
|
|
1146
|
-
repeated int64 nodeIds = 10;
|
|
1147
|
-
common.SegmentLevel level = 11;
|
|
1148
|
-
bool is_sorted = 12;
|
|
1149
|
-
}
|
|
1150
|
-
|
|
1151
|
-
message GetQuerySegmentInfoRequest {
|
|
1152
|
-
common.MsgBase base = 1; // must
|
|
1153
|
-
string dbName = 2;
|
|
1154
|
-
string collectionName = 3; // must
|
|
1155
|
-
}
|
|
1156
|
-
|
|
1157
|
-
message GetQuerySegmentInfoResponse {
|
|
1158
|
-
common.Status status = 1;
|
|
1159
|
-
repeated QuerySegmentInfo infos = 2;
|
|
1160
|
-
}
|
|
1161
|
-
|
|
1162
|
-
message DummyRequest {
|
|
1163
|
-
string request_type = 1;
|
|
1164
|
-
}
|
|
1165
|
-
|
|
1166
|
-
message DummyResponse {
|
|
1167
|
-
string response = 1;
|
|
1168
|
-
}
|
|
1169
|
-
|
|
1170
|
-
message RegisterLinkRequest {
|
|
1171
|
-
}
|
|
1172
|
-
|
|
1173
|
-
message RegisterLinkResponse {
|
|
1174
|
-
common.Address address = 1;
|
|
1175
|
-
common.Status status = 2;
|
|
1176
|
-
}
|
|
1177
|
-
|
|
1178
|
-
message GetMetricsRequest {
|
|
1179
|
-
common.MsgBase base = 1;
|
|
1180
|
-
string request = 2; // request is of jsonic format
|
|
1181
|
-
}
|
|
1182
|
-
|
|
1183
|
-
message GetMetricsResponse {
|
|
1184
|
-
common.Status status = 1;
|
|
1185
|
-
string response = 2; // response is of jsonic format
|
|
1186
|
-
string component_name = 3; // metrics from which component
|
|
1187
|
-
}
|
|
1188
|
-
|
|
1189
|
-
message ComponentInfo {
|
|
1190
|
-
int64 nodeID = 1;
|
|
1191
|
-
string role = 2;
|
|
1192
|
-
common.StateCode state_code = 3;
|
|
1193
|
-
repeated common.KeyValuePair extra_info = 4;
|
|
1194
|
-
}
|
|
1195
|
-
|
|
1196
|
-
message ComponentStates {
|
|
1197
|
-
ComponentInfo state = 1;
|
|
1198
|
-
repeated ComponentInfo subcomponent_states = 2;
|
|
1199
|
-
common.Status status = 3;
|
|
1200
|
-
}
|
|
1201
|
-
|
|
1202
|
-
message GetComponentStatesRequest {
|
|
1203
|
-
}
|
|
1204
|
-
|
|
1205
|
-
/*
|
|
1206
|
-
* Do load balancing operation from src_nodeID to dst_nodeID.
|
|
1207
|
-
*/
|
|
1208
|
-
message LoadBalanceRequest {
|
|
1209
|
-
option (common.privilege_ext_obj) = {
|
|
1210
|
-
object_type: Collection
|
|
1211
|
-
object_privilege: PrivilegeLoadBalance
|
|
1212
|
-
object_name_index: 5
|
|
1213
|
-
};
|
|
1214
|
-
common.MsgBase base = 1;
|
|
1215
|
-
int64 src_nodeID = 2;
|
|
1216
|
-
repeated int64 dst_nodeIDs = 3;
|
|
1217
|
-
repeated int64 sealed_segmentIDs = 4;
|
|
1218
|
-
string collectionName = 5;
|
|
1219
|
-
string db_name = 6;
|
|
1220
|
-
}
|
|
1221
|
-
|
|
1222
|
-
message ManualCompactionRequest {
|
|
1223
|
-
option (common.privilege_ext_obj) = {
|
|
1224
|
-
object_type: Collection
|
|
1225
|
-
object_privilege: PrivilegeCompaction
|
|
1226
|
-
object_name_index: 4
|
|
1227
|
-
};
|
|
1228
|
-
int64 collectionID = 1;
|
|
1229
|
-
uint64 timetravel = 2;
|
|
1230
|
-
bool majorCompaction = 3;
|
|
1231
|
-
string collection_name = 4;
|
|
1232
|
-
string db_name = 5;
|
|
1233
|
-
int64 partition_id = 6;
|
|
1234
|
-
string channel = 7;
|
|
1235
|
-
repeated int64 segment_ids = 8;
|
|
1236
|
-
}
|
|
1237
|
-
|
|
1238
|
-
message ManualCompactionResponse {
|
|
1239
|
-
common.Status status = 1;
|
|
1240
|
-
int64 compactionID = 2;
|
|
1241
|
-
int32 compactionPlanCount = 3;
|
|
1242
|
-
}
|
|
1243
|
-
|
|
1244
|
-
message GetCompactionStateRequest {
|
|
1245
|
-
int64 compactionID = 1;
|
|
1246
|
-
}
|
|
1247
|
-
|
|
1248
|
-
message GetCompactionStateResponse {
|
|
1249
|
-
common.Status status = 1;
|
|
1250
|
-
common.CompactionState state = 2;
|
|
1251
|
-
int64 executingPlanNo = 3;
|
|
1252
|
-
int64 timeoutPlanNo = 4;
|
|
1253
|
-
int64 completedPlanNo = 5;
|
|
1254
|
-
int64 failedPlanNo = 6;
|
|
1255
|
-
}
|
|
1256
|
-
|
|
1257
|
-
message GetCompactionPlansRequest {
|
|
1258
|
-
int64 compactionID = 1;
|
|
1259
|
-
}
|
|
1260
|
-
|
|
1261
|
-
message GetCompactionPlansResponse {
|
|
1262
|
-
common.Status status = 1;
|
|
1263
|
-
common.CompactionState state = 2;
|
|
1264
|
-
repeated CompactionMergeInfo mergeInfos = 3;
|
|
1265
|
-
}
|
|
1266
|
-
|
|
1267
|
-
message CompactionMergeInfo {
|
|
1268
|
-
repeated int64 sources = 1;
|
|
1269
|
-
int64 target = 2;
|
|
1270
|
-
}
|
|
1271
|
-
|
|
1272
|
-
message GetFlushStateRequest {
|
|
1273
|
-
option (common.privilege_ext_obj) = {
|
|
1274
|
-
object_type: Collection
|
|
1275
|
-
object_privilege: PrivilegeGetFlushState
|
|
1276
|
-
object_name_index: 4
|
|
1277
|
-
};
|
|
1278
|
-
repeated int64 segmentIDs = 1;
|
|
1279
|
-
uint64 flush_ts = 2;
|
|
1280
|
-
string db_name = 3;
|
|
1281
|
-
string collection_name = 4;
|
|
1282
|
-
}
|
|
1283
|
-
|
|
1284
|
-
message GetFlushStateResponse {
|
|
1285
|
-
common.Status status = 1;
|
|
1286
|
-
bool flushed = 2;
|
|
1287
|
-
}
|
|
1288
|
-
|
|
1289
|
-
message GetFlushAllStateRequest {
|
|
1290
|
-
common.MsgBase base = 1;
|
|
1291
|
-
uint64 flush_all_ts = 2;
|
|
1292
|
-
string db_name = 3;
|
|
1293
|
-
}
|
|
1294
|
-
|
|
1295
|
-
message GetFlushAllStateResponse {
|
|
1296
|
-
common.Status status = 1;
|
|
1297
|
-
bool flushed = 2;
|
|
1298
|
-
}
|
|
1299
|
-
|
|
1300
|
-
message ImportRequest {
|
|
1301
|
-
option (common.privilege_ext_obj) = {
|
|
1302
|
-
object_type: Collection
|
|
1303
|
-
object_privilege: PrivilegeImport
|
|
1304
|
-
object_name_index: 1
|
|
1305
|
-
};
|
|
1306
|
-
string collection_name = 1; // target collection
|
|
1307
|
-
string partition_name = 2; // target partition
|
|
1308
|
-
repeated string channel_names = 3; // channel names for the collection
|
|
1309
|
-
bool row_based = 4; // the file is row-based or column-based
|
|
1310
|
-
repeated string files = 5; // file paths to be imported
|
|
1311
|
-
repeated common.KeyValuePair options = 6; // import options, bucket, etc.
|
|
1312
|
-
string db_name = 7; // target database
|
|
1313
|
-
bytes clustering_info = 8; // serialized `schema.ClusteringInfo`
|
|
1314
|
-
}
|
|
1315
|
-
|
|
1316
|
-
message ImportResponse {
|
|
1317
|
-
common.Status status = 1;
|
|
1318
|
-
repeated int64 tasks = 2; // id array of import tasks
|
|
1319
|
-
}
|
|
1320
|
-
|
|
1321
|
-
message GetImportStateRequest {
|
|
1322
|
-
int64 task = 1; // id of an import task
|
|
1323
|
-
}
|
|
1324
|
-
|
|
1325
|
-
message GetImportStateResponse {
|
|
1326
|
-
common.Status status = 1;
|
|
1327
|
-
common.ImportState state = 2; // is this import task finished or not
|
|
1328
|
-
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.
|
|
1329
|
-
repeated int64 id_list = 4; // auto generated ids if the primary key is autoid
|
|
1330
|
-
repeated common.KeyValuePair infos = 5; // more information about the task, progress percent, file path, failed reason, etc.
|
|
1331
|
-
int64 id = 6; // id of an import task
|
|
1332
|
-
int64 collection_id = 7; // collection ID of the import task.
|
|
1333
|
-
repeated int64 segment_ids = 8; // a list of segment IDs created by the import task.
|
|
1334
|
-
int64 create_ts = 9; // timestamp when the import task is created.
|
|
1335
|
-
}
|
|
1336
|
-
|
|
1337
|
-
message ListImportTasksRequest {
|
|
1338
|
-
string collection_name = 1; // target collection, list all tasks if the name is empty
|
|
1339
|
-
int64 limit = 2; // maximum number of tasks returned, list all tasks if the value is 0
|
|
1340
|
-
string db_name = 3;
|
|
1341
|
-
}
|
|
1342
|
-
|
|
1343
|
-
message ListImportTasksResponse {
|
|
1344
|
-
common.Status status = 1;
|
|
1345
|
-
repeated GetImportStateResponse tasks = 2; // list of all import tasks
|
|
1346
|
-
}
|
|
1347
|
-
|
|
1348
|
-
message GetReplicasRequest {
|
|
1349
|
-
common.MsgBase base = 1;
|
|
1350
|
-
int64 collectionID = 2;
|
|
1351
|
-
bool with_shard_nodes = 3;
|
|
1352
|
-
string collection_name = 4;
|
|
1353
|
-
string db_name = 5;
|
|
1354
|
-
}
|
|
1355
|
-
|
|
1356
|
-
message GetReplicasResponse {
|
|
1357
|
-
common.Status status = 1;
|
|
1358
|
-
repeated ReplicaInfo replicas = 2;
|
|
1359
|
-
}
|
|
1360
|
-
|
|
1361
|
-
message ReplicaInfo { // ReplicaGroup
|
|
1362
|
-
int64 replicaID = 1;
|
|
1363
|
-
int64 collectionID = 2;
|
|
1364
|
-
repeated int64 partition_ids = 3; // empty indicates to load collection
|
|
1365
|
-
repeated ShardReplica shard_replicas = 4;
|
|
1366
|
-
repeated int64 node_ids = 5; // include leaders
|
|
1367
|
-
string resource_group_name = 6;
|
|
1368
|
-
// outbound access rg -> node num
|
|
1369
|
-
map<string, int32> num_outbound_node = 7;
|
|
1370
|
-
}
|
|
1371
|
-
|
|
1372
|
-
message ShardReplica {
|
|
1373
|
-
int64 leaderID = 1;
|
|
1374
|
-
string leader_addr = 2; // IP:port
|
|
1375
|
-
string dm_channel_name = 3;
|
|
1376
|
-
// optional, DO NOT save it in meta, set it only for GetReplicas()
|
|
1377
|
-
// if with_shard_nodes is true
|
|
1378
|
-
repeated int64 node_ids = 4;
|
|
1379
|
-
}
|
|
1380
|
-
|
|
1381
|
-
service ProxyService {
|
|
1382
|
-
rpc RegisterLink(RegisterLinkRequest) returns (RegisterLinkResponse) {}
|
|
1383
|
-
}
|
|
1384
|
-
|
|
1385
|
-
// https://wiki.lfaidata.foundation/display/MIL/MEP+27+--+Support+Basic+Authentication
|
|
1386
|
-
|
|
1387
|
-
message CreateCredentialRequest {
|
|
1388
|
-
option (common.privilege_ext_obj) = {
|
|
1389
|
-
object_type: Global
|
|
1390
|
-
object_privilege: PrivilegeCreateOwnership
|
|
1391
|
-
object_name_index: -1
|
|
1392
|
-
};
|
|
1393
|
-
// Not useful for now
|
|
1394
|
-
common.MsgBase base = 1;
|
|
1395
|
-
// username
|
|
1396
|
-
string username = 2;
|
|
1397
|
-
// ciphertext password
|
|
1398
|
-
string password = 3;
|
|
1399
|
-
// create time
|
|
1400
|
-
uint64 created_utc_timestamps = 4;
|
|
1401
|
-
// modify time
|
|
1402
|
-
uint64 modified_utc_timestamps = 5;
|
|
1403
|
-
}
|
|
1404
|
-
|
|
1405
|
-
message UpdateCredentialRequest {
|
|
1406
|
-
option (common.privilege_ext_obj) = {
|
|
1407
|
-
object_type: User
|
|
1408
|
-
object_privilege: PrivilegeUpdateUser
|
|
1409
|
-
object_name_index: 2
|
|
1410
|
-
};
|
|
1411
|
-
// Not useful for now
|
|
1412
|
-
common.MsgBase base = 1;
|
|
1413
|
-
// username
|
|
1414
|
-
string username = 2;
|
|
1415
|
-
// old password
|
|
1416
|
-
string oldPassword = 3;
|
|
1417
|
-
// new password
|
|
1418
|
-
string newPassword = 4;
|
|
1419
|
-
// create time
|
|
1420
|
-
uint64 created_utc_timestamps = 5;
|
|
1421
|
-
// modify time
|
|
1422
|
-
uint64 modified_utc_timestamps = 6;
|
|
1423
|
-
}
|
|
1424
|
-
|
|
1425
|
-
message DeleteCredentialRequest {
|
|
1426
|
-
option (common.privilege_ext_obj) = {
|
|
1427
|
-
object_type: Global
|
|
1428
|
-
object_privilege: PrivilegeDropOwnership
|
|
1429
|
-
object_name_index: -1
|
|
1430
|
-
};
|
|
1431
|
-
// Not useful for now
|
|
1432
|
-
common.MsgBase base = 1;
|
|
1433
|
-
// Not useful for now
|
|
1434
|
-
string username = 2;
|
|
1435
|
-
}
|
|
1436
|
-
|
|
1437
|
-
message ListCredUsersResponse {
|
|
1438
|
-
// Contain error_code and reason
|
|
1439
|
-
common.Status status = 1;
|
|
1440
|
-
// username array
|
|
1441
|
-
repeated string usernames = 2;
|
|
1442
|
-
}
|
|
1443
|
-
|
|
1444
|
-
message ListCredUsersRequest {
|
|
1445
|
-
option (common.privilege_ext_obj) = {
|
|
1446
|
-
object_type: Global
|
|
1447
|
-
object_privilege: PrivilegeSelectOwnership
|
|
1448
|
-
object_name_index: -1
|
|
1449
|
-
};
|
|
1450
|
-
// Not useful for now
|
|
1451
|
-
common.MsgBase base = 1;
|
|
1452
|
-
}
|
|
1453
|
-
|
|
1454
|
-
// https://wiki.lfaidata.foundation/display/MIL/MEP+29+--+Support+Role-Based+Access+Control
|
|
1455
|
-
message RoleEntity {
|
|
1456
|
-
string name = 1;
|
|
1457
|
-
}
|
|
1458
|
-
|
|
1459
|
-
message UserEntity {
|
|
1460
|
-
string name = 1;
|
|
1461
|
-
}
|
|
1462
|
-
|
|
1463
|
-
message CreateRoleRequest {
|
|
1464
|
-
option (common.privilege_ext_obj) = {
|
|
1465
|
-
object_type: Global
|
|
1466
|
-
object_privilege: PrivilegeCreateOwnership
|
|
1467
|
-
object_name_index: -1
|
|
1468
|
-
};
|
|
1469
|
-
// Not useful for now
|
|
1470
|
-
common.MsgBase base = 1;
|
|
1471
|
-
// role
|
|
1472
|
-
RoleEntity entity = 2;
|
|
1473
|
-
}
|
|
1474
|
-
|
|
1475
|
-
message DropRoleRequest {
|
|
1476
|
-
option (common.privilege_ext_obj) = {
|
|
1477
|
-
object_type: Global
|
|
1478
|
-
object_privilege: PrivilegeDropOwnership
|
|
1479
|
-
object_name_index: -1
|
|
1480
|
-
};
|
|
1481
|
-
// Not useful for now
|
|
1482
|
-
common.MsgBase base = 1;
|
|
1483
|
-
// role name
|
|
1484
|
-
string role_name = 2;
|
|
1485
|
-
// force to drop the role even if there is permission binding
|
|
1486
|
-
bool force_drop = 3;
|
|
1487
|
-
}
|
|
1488
|
-
|
|
1489
|
-
message CreatePrivilegeGroupRequest {
|
|
1490
|
-
option (common.privilege_ext_obj) = {
|
|
1491
|
-
object_type: Global
|
|
1492
|
-
object_privilege: PrivilegeCreatePrivilegeGroup
|
|
1493
|
-
object_name_index: -1
|
|
1494
|
-
};
|
|
1495
|
-
// Not useful for now
|
|
1496
|
-
common.MsgBase base = 1;
|
|
1497
|
-
// group name
|
|
1498
|
-
string group_name = 2;
|
|
1499
|
-
}
|
|
1500
|
-
|
|
1501
|
-
message DropPrivilegeGroupRequest {
|
|
1502
|
-
option (common.privilege_ext_obj) = {
|
|
1503
|
-
object_type: Global
|
|
1504
|
-
object_privilege: PrivilegeDropPrivilegeGroup
|
|
1505
|
-
object_name_index: -1
|
|
1506
|
-
};
|
|
1507
|
-
// Not useful for now
|
|
1508
|
-
common.MsgBase base = 1;
|
|
1509
|
-
// group name
|
|
1510
|
-
string group_name = 2;
|
|
1511
|
-
}
|
|
1512
|
-
|
|
1513
|
-
message ListPrivilegeGroupsRequest {
|
|
1514
|
-
option (common.privilege_ext_obj) = {
|
|
1515
|
-
object_type: Global
|
|
1516
|
-
object_privilege: PrivilegeListPrivilegeGroups
|
|
1517
|
-
object_name_index: -1
|
|
1518
|
-
};
|
|
1519
|
-
// Not useful for now
|
|
1520
|
-
common.MsgBase base = 1;
|
|
1521
|
-
}
|
|
1522
|
-
|
|
1523
|
-
message ListPrivilegeGroupsResponse {
|
|
1524
|
-
common.Status status = 1;
|
|
1525
|
-
repeated PrivilegeGroupInfo privilege_groups = 2;
|
|
1526
|
-
}
|
|
1527
|
-
|
|
1528
|
-
message OperatePrivilegeGroupRequest {
|
|
1529
|
-
option (common.privilege_ext_obj) = {
|
|
1530
|
-
object_type: Global
|
|
1531
|
-
object_privilege: PrivilegeOperatePrivilegeGroup
|
|
1532
|
-
object_name_index: -1
|
|
1533
|
-
};
|
|
1534
|
-
// Not useful for now
|
|
1535
|
-
common.MsgBase base = 1;
|
|
1536
|
-
// group name
|
|
1537
|
-
string group_name = 2;
|
|
1538
|
-
// privileges
|
|
1539
|
-
repeated PrivilegeEntity privileges = 3;
|
|
1540
|
-
// operation type
|
|
1541
|
-
OperatePrivilegeGroupType type = 4;
|
|
1542
|
-
}
|
|
1543
|
-
|
|
1544
|
-
enum OperatePrivilegeGroupType {
|
|
1545
|
-
AddPrivilegesToGroup = 0;
|
|
1546
|
-
RemovePrivilegesFromGroup = 1;
|
|
1547
|
-
}
|
|
1548
|
-
|
|
1549
|
-
enum OperateUserRoleType {
|
|
1550
|
-
AddUserToRole = 0;
|
|
1551
|
-
RemoveUserFromRole = 1;
|
|
1552
|
-
}
|
|
1553
|
-
|
|
1554
|
-
message OperateUserRoleRequest {
|
|
1555
|
-
option (common.privilege_ext_obj) = {
|
|
1556
|
-
object_type: Global
|
|
1557
|
-
object_privilege: PrivilegeManageOwnership
|
|
1558
|
-
object_name_index: -1
|
|
1559
|
-
};
|
|
1560
|
-
// Not useful for now
|
|
1561
|
-
common.MsgBase base = 1;
|
|
1562
|
-
// username
|
|
1563
|
-
string username = 2;
|
|
1564
|
-
// role name
|
|
1565
|
-
string role_name = 3;
|
|
1566
|
-
// operation type
|
|
1567
|
-
OperateUserRoleType type = 4;
|
|
1568
|
-
}
|
|
1569
|
-
|
|
1570
|
-
message PrivilegeGroupInfo {
|
|
1571
|
-
string group_name = 1;
|
|
1572
|
-
repeated PrivilegeEntity privileges = 2;
|
|
1573
|
-
}
|
|
1574
|
-
|
|
1575
|
-
message SelectRoleRequest {
|
|
1576
|
-
option (common.privilege_ext_obj) = {
|
|
1577
|
-
object_type: Global
|
|
1578
|
-
object_privilege: PrivilegeSelectOwnership
|
|
1579
|
-
object_name_index: -1
|
|
1580
|
-
};
|
|
1581
|
-
// Not useful for now
|
|
1582
|
-
common.MsgBase base = 1;
|
|
1583
|
-
// role
|
|
1584
|
-
RoleEntity role = 2;
|
|
1585
|
-
// include user info
|
|
1586
|
-
bool include_user_info = 3;
|
|
1587
|
-
}
|
|
1588
|
-
|
|
1589
|
-
message RoleResult {
|
|
1590
|
-
RoleEntity role = 1;
|
|
1591
|
-
repeated UserEntity users = 2;
|
|
1592
|
-
}
|
|
1593
|
-
|
|
1594
|
-
message SelectRoleResponse {
|
|
1595
|
-
// Not useful for now
|
|
1596
|
-
common.Status status = 1;
|
|
1597
|
-
// role result array
|
|
1598
|
-
repeated RoleResult results = 2;
|
|
1599
|
-
}
|
|
1600
|
-
|
|
1601
|
-
message SelectUserRequest {
|
|
1602
|
-
option (common.privilege_ext_obj) = {
|
|
1603
|
-
object_type: User
|
|
1604
|
-
object_privilege: PrivilegeSelectUser
|
|
1605
|
-
object_name_index: 2
|
|
1606
|
-
};
|
|
1607
|
-
// Not useful for now
|
|
1608
|
-
common.MsgBase base = 1;
|
|
1609
|
-
// user
|
|
1610
|
-
UserEntity user = 2;
|
|
1611
|
-
// include user info
|
|
1612
|
-
bool include_role_info = 3;
|
|
1613
|
-
}
|
|
1614
|
-
|
|
1615
|
-
message UserResult {
|
|
1616
|
-
UserEntity user = 1;
|
|
1617
|
-
repeated RoleEntity roles = 2;
|
|
1618
|
-
}
|
|
1619
|
-
|
|
1620
|
-
message SelectUserResponse {
|
|
1621
|
-
// Not useful for now
|
|
1622
|
-
common.Status status = 1;
|
|
1623
|
-
// user result array
|
|
1624
|
-
repeated UserResult results = 2;
|
|
1625
|
-
}
|
|
1626
|
-
|
|
1627
|
-
message ObjectEntity {
|
|
1628
|
-
string name = 1;
|
|
1629
|
-
}
|
|
1630
|
-
|
|
1631
|
-
message PrivilegeEntity {
|
|
1632
|
-
string name = 1;
|
|
1633
|
-
}
|
|
1634
|
-
|
|
1635
|
-
message GrantorEntity {
|
|
1636
|
-
UserEntity user = 1;
|
|
1637
|
-
PrivilegeEntity privilege = 2;
|
|
1638
|
-
}
|
|
1639
|
-
|
|
1640
|
-
message GrantPrivilegeEntity {
|
|
1641
|
-
repeated GrantorEntity entities = 1;
|
|
1642
|
-
}
|
|
1643
|
-
|
|
1644
|
-
message GrantEntity {
|
|
1645
|
-
// role
|
|
1646
|
-
RoleEntity role = 1;
|
|
1647
|
-
// object
|
|
1648
|
-
ObjectEntity object = 2;
|
|
1649
|
-
// object name
|
|
1650
|
-
string object_name = 3;
|
|
1651
|
-
// privilege
|
|
1652
|
-
GrantorEntity grantor = 4;
|
|
1653
|
-
// db name
|
|
1654
|
-
string db_name = 5;
|
|
1655
|
-
}
|
|
1656
|
-
|
|
1657
|
-
enum PrivilegeLevel {
|
|
1658
|
-
Cluster = 0;
|
|
1659
|
-
Database = 1;
|
|
1660
|
-
Collection = 2;
|
|
1661
|
-
}
|
|
1662
|
-
|
|
1663
|
-
message SelectGrantRequest {
|
|
1664
|
-
option (common.privilege_ext_obj) = {
|
|
1665
|
-
object_type: Global
|
|
1666
|
-
object_privilege: PrivilegeSelectOwnership
|
|
1667
|
-
object_name_index: -1
|
|
1668
|
-
};
|
|
1669
|
-
// Not useful for now
|
|
1670
|
-
common.MsgBase base = 1;
|
|
1671
|
-
// grant
|
|
1672
|
-
GrantEntity entity = 2;
|
|
1673
|
-
}
|
|
1674
|
-
|
|
1675
|
-
message SelectGrantResponse {
|
|
1676
|
-
// Not useful for now
|
|
1677
|
-
common.Status status = 1;
|
|
1678
|
-
// grant info array
|
|
1679
|
-
repeated GrantEntity entities = 2;
|
|
1680
|
-
}
|
|
1681
|
-
|
|
1682
|
-
enum OperatePrivilegeType {
|
|
1683
|
-
Grant = 0;
|
|
1684
|
-
Revoke = 1;
|
|
1685
|
-
}
|
|
1686
|
-
|
|
1687
|
-
message OperatePrivilegeRequest {
|
|
1688
|
-
option (common.privilege_ext_obj) = {
|
|
1689
|
-
object_type: Global
|
|
1690
|
-
object_privilege: PrivilegeManageOwnership
|
|
1691
|
-
object_name_index: -1
|
|
1692
|
-
};
|
|
1693
|
-
// Not useful for now
|
|
1694
|
-
common.MsgBase base = 1;
|
|
1695
|
-
// grant
|
|
1696
|
-
GrantEntity entity = 2;
|
|
1697
|
-
// operation type
|
|
1698
|
-
OperatePrivilegeType type = 3;
|
|
1699
|
-
// version
|
|
1700
|
-
string version = 4;
|
|
1701
|
-
}
|
|
1702
|
-
|
|
1703
|
-
|
|
1704
|
-
message OperatePrivilegeV2Request {
|
|
1705
|
-
option (common.privilege_ext_obj) = {
|
|
1706
|
-
object_type: Global
|
|
1707
|
-
object_privilege: PrivilegeManageOwnership
|
|
1708
|
-
object_name_index: -1
|
|
1709
|
-
};
|
|
1710
|
-
// Not useful for now
|
|
1711
|
-
common.MsgBase base = 1;
|
|
1712
|
-
// role
|
|
1713
|
-
RoleEntity role = 2;
|
|
1714
|
-
// privilege
|
|
1715
|
-
GrantorEntity grantor = 3;
|
|
1716
|
-
// operation type
|
|
1717
|
-
OperatePrivilegeType type = 4;
|
|
1718
|
-
// db name
|
|
1719
|
-
string db_name = 5;
|
|
1720
|
-
// collection name
|
|
1721
|
-
string collection_name = 6;
|
|
1722
|
-
}
|
|
1723
|
-
|
|
1724
|
-
message UserInfo {
|
|
1725
|
-
string user = 1;
|
|
1726
|
-
string password = 2;
|
|
1727
|
-
repeated RoleEntity roles = 3;
|
|
1728
|
-
}
|
|
1729
|
-
|
|
1730
|
-
message RBACMeta {
|
|
1731
|
-
// user
|
|
1732
|
-
repeated UserInfo users = 1;
|
|
1733
|
-
// role
|
|
1734
|
-
repeated milvus.RoleEntity roles = 2;
|
|
1735
|
-
// (role, object, previledge)
|
|
1736
|
-
repeated milvus.GrantEntity grants = 3;
|
|
1737
|
-
// privilege group info
|
|
1738
|
-
repeated milvus.PrivilegeGroupInfo privilege_groups = 4;
|
|
1739
|
-
}
|
|
1740
|
-
|
|
1741
|
-
message BackupRBACMetaRequest {
|
|
1742
|
-
option (common.privilege_ext_obj) = {
|
|
1743
|
-
object_type: Global
|
|
1744
|
-
object_privilege: PrivilegeBackupRBAC
|
|
1745
|
-
object_name_index: -1
|
|
1746
|
-
};
|
|
1747
|
-
// Not useful for now
|
|
1748
|
-
common.MsgBase base = 1;
|
|
1749
|
-
}
|
|
1750
|
-
|
|
1751
|
-
message BackupRBACMetaResponse {
|
|
1752
|
-
common.Status status = 1;
|
|
1753
|
-
RBACMeta RBAC_meta = 2;
|
|
1754
|
-
}
|
|
1755
|
-
|
|
1756
|
-
message RestoreRBACMetaRequest {
|
|
1757
|
-
option (common.privilege_ext_obj) = {
|
|
1758
|
-
object_type: Global
|
|
1759
|
-
object_privilege: PrivilegeRestoreRBAC
|
|
1760
|
-
object_name_index: -1
|
|
1761
|
-
};
|
|
1762
|
-
// Not useful for now
|
|
1763
|
-
common.MsgBase base = 1;
|
|
1764
|
-
RBACMeta RBAC_meta = 2;
|
|
1765
|
-
}
|
|
1766
|
-
|
|
1767
|
-
message GetLoadingProgressRequest {
|
|
1768
|
-
option (common.privilege_ext_obj) = {
|
|
1769
|
-
object_type: Collection
|
|
1770
|
-
object_privilege: PrivilegeGetLoadState
|
|
1771
|
-
object_name_index: 2
|
|
1772
|
-
};
|
|
1773
|
-
// Not useful for now
|
|
1774
|
-
common.MsgBase base = 1;
|
|
1775
|
-
string collection_name = 2;
|
|
1776
|
-
repeated string partition_names = 3;
|
|
1777
|
-
string db_name = 4;
|
|
1778
|
-
}
|
|
1779
|
-
|
|
1780
|
-
message GetLoadingProgressResponse {
|
|
1781
|
-
common.Status status = 1;
|
|
1782
|
-
int64 progress = 2;
|
|
1783
|
-
int64 refresh_progress = 3;
|
|
1784
|
-
}
|
|
1785
|
-
|
|
1786
|
-
message GetLoadStateRequest {
|
|
1787
|
-
option (common.privilege_ext_obj) = {
|
|
1788
|
-
object_type: Collection
|
|
1789
|
-
object_privilege: PrivilegeGetLoadState
|
|
1790
|
-
object_name_index: 2
|
|
1791
|
-
};
|
|
1792
|
-
// Not useful for now
|
|
1793
|
-
common.MsgBase base = 1;
|
|
1794
|
-
string collection_name = 2;
|
|
1795
|
-
repeated string partition_names = 3;
|
|
1796
|
-
string db_name = 4;
|
|
1797
|
-
}
|
|
1798
|
-
|
|
1799
|
-
message GetLoadStateResponse {
|
|
1800
|
-
common.Status status = 1;
|
|
1801
|
-
common.LoadState state = 2;
|
|
1802
|
-
}
|
|
1803
|
-
|
|
1804
|
-
message MilvusExt {
|
|
1805
|
-
string version = 1;
|
|
1806
|
-
}
|
|
1807
|
-
|
|
1808
|
-
extend google.protobuf.FileOptions {
|
|
1809
|
-
MilvusExt milvus_ext_obj = 1001;
|
|
1810
|
-
}
|
|
1811
|
-
|
|
1812
|
-
message GetVersionRequest {
|
|
1813
|
-
}
|
|
1814
|
-
|
|
1815
|
-
message GetVersionResponse {
|
|
1816
|
-
common.Status status = 1;
|
|
1817
|
-
string version =2;
|
|
1818
|
-
}
|
|
1819
|
-
|
|
1820
|
-
enum QuotaState {
|
|
1821
|
-
Unknown = 0;
|
|
1822
|
-
ReadLimited = 2;
|
|
1823
|
-
WriteLimited = 3;
|
|
1824
|
-
DenyToRead = 4;
|
|
1825
|
-
DenyToWrite = 5;
|
|
1826
|
-
DenyToDDL = 6;
|
|
1827
|
-
}
|
|
1828
|
-
|
|
1829
|
-
message CheckHealthRequest {
|
|
1830
|
-
}
|
|
1831
|
-
|
|
1832
|
-
message CheckHealthResponse {
|
|
1833
|
-
common.Status status = 1;
|
|
1834
|
-
bool isHealthy = 2;
|
|
1835
|
-
repeated string reasons = 3;
|
|
1836
|
-
repeated QuotaState quota_states = 4;
|
|
1837
|
-
}
|
|
1838
|
-
|
|
1839
|
-
message CreateResourceGroupRequest {
|
|
1840
|
-
option (common.privilege_ext_obj) = {
|
|
1841
|
-
object_type: Global
|
|
1842
|
-
object_privilege: PrivilegeCreateResourceGroup
|
|
1843
|
-
object_name_index: -1
|
|
1844
|
-
};
|
|
1845
|
-
common.MsgBase base = 1;
|
|
1846
|
-
string resource_group = 2;
|
|
1847
|
-
rg.ResourceGroupConfig config = 3;
|
|
1848
|
-
}
|
|
1849
|
-
|
|
1850
|
-
message UpdateResourceGroupsRequest {
|
|
1851
|
-
option (common.privilege_ext_obj) = {
|
|
1852
|
-
object_type: Global
|
|
1853
|
-
object_privilege: PrivilegeUpdateResourceGroups
|
|
1854
|
-
object_name_index: -1
|
|
1855
|
-
};
|
|
1856
|
-
common.MsgBase base = 1;
|
|
1857
|
-
map<string, rg.ResourceGroupConfig> resource_groups = 2;
|
|
1858
|
-
}
|
|
1859
|
-
|
|
1860
|
-
message DropResourceGroupRequest {
|
|
1861
|
-
option (common.privilege_ext_obj) = {
|
|
1862
|
-
object_type: Global
|
|
1863
|
-
object_privilege: PrivilegeDropResourceGroup
|
|
1864
|
-
object_name_index: -1
|
|
1865
|
-
};
|
|
1866
|
-
common.MsgBase base = 1;
|
|
1867
|
-
string resource_group = 2;
|
|
1868
|
-
}
|
|
1869
|
-
|
|
1870
|
-
// transfer `nodeNum` nodes from `source_resource_group` to `target_resource_group`
|
|
1871
|
-
message TransferNodeRequest {
|
|
1872
|
-
option (common.privilege_ext_obj) = {
|
|
1873
|
-
object_type: Global
|
|
1874
|
-
object_privilege: PrivilegeTransferNode
|
|
1875
|
-
object_name_index: -1
|
|
1876
|
-
};
|
|
1877
|
-
common.MsgBase base = 1;
|
|
1878
|
-
string source_resource_group = 2;
|
|
1879
|
-
string target_resource_group = 3;
|
|
1880
|
-
int32 num_node = 4;
|
|
1881
|
-
}
|
|
1882
|
-
|
|
1883
|
-
// transfer `replicaNum` replicas in `collectionID` from `source_resource_group` to `target_resource_group`
|
|
1884
|
-
message TransferReplicaRequest {
|
|
1885
|
-
option (common.privilege_ext_obj) = {
|
|
1886
|
-
object_type: Global
|
|
1887
|
-
object_privilege: PrivilegeTransferReplica
|
|
1888
|
-
object_name_index: -1
|
|
1889
|
-
};
|
|
1890
|
-
common.MsgBase base = 1;
|
|
1891
|
-
string source_resource_group = 2;
|
|
1892
|
-
string target_resource_group = 3;
|
|
1893
|
-
string collection_name = 4;
|
|
1894
|
-
int64 num_replica = 5;
|
|
1895
|
-
string db_name = 6;
|
|
1896
|
-
}
|
|
1897
|
-
|
|
1898
|
-
message ListResourceGroupsRequest {
|
|
1899
|
-
option (common.privilege_ext_obj) = {
|
|
1900
|
-
object_type: Global
|
|
1901
|
-
object_privilege: PrivilegeListResourceGroups
|
|
1902
|
-
object_name_index: -1
|
|
1903
|
-
};
|
|
1904
|
-
common.MsgBase base = 1;
|
|
1905
|
-
}
|
|
1906
|
-
|
|
1907
|
-
message ListResourceGroupsResponse {
|
|
1908
|
-
common.Status status = 1;
|
|
1909
|
-
repeated string resource_groups = 2;
|
|
1910
|
-
}
|
|
1911
|
-
|
|
1912
|
-
message DescribeResourceGroupRequest {
|
|
1913
|
-
option (common.privilege_ext_obj) = {
|
|
1914
|
-
object_type: Global
|
|
1915
|
-
object_privilege: PrivilegeDescribeResourceGroup
|
|
1916
|
-
object_name_index: -1
|
|
1917
|
-
};
|
|
1918
|
-
common.MsgBase base = 1;
|
|
1919
|
-
string resource_group = 2;
|
|
1920
|
-
}
|
|
1921
|
-
|
|
1922
|
-
message DescribeResourceGroupResponse {
|
|
1923
|
-
common.Status status = 1;
|
|
1924
|
-
ResourceGroup resource_group = 2;
|
|
1925
|
-
}
|
|
1926
|
-
|
|
1927
|
-
message ResourceGroup {
|
|
1928
|
-
string name = 1;
|
|
1929
|
-
int32 capacity = 2;
|
|
1930
|
-
int32 num_available_node = 3;
|
|
1931
|
-
// collection name -> loaded replica num
|
|
1932
|
-
map<string, int32> num_loaded_replica = 4;
|
|
1933
|
-
// collection name -> accessed other rg's node num
|
|
1934
|
-
map<string, int32> num_outgoing_node = 5;
|
|
1935
|
-
// collection name -> be accessed node num by other rg
|
|
1936
|
-
map<string, int32> num_incoming_node = 6;
|
|
1937
|
-
// resource group configuration.
|
|
1938
|
-
rg.ResourceGroupConfig config = 7;
|
|
1939
|
-
// query node belong to this resource group now.
|
|
1940
|
-
repeated common.NodeInfo nodes = 8;
|
|
1941
|
-
}
|
|
1942
|
-
|
|
1943
|
-
message RenameCollectionRequest {
|
|
1944
|
-
option (common.privilege_ext_obj) = {
|
|
1945
|
-
object_type: Global
|
|
1946
|
-
object_privilege: PrivilegeRenameCollection
|
|
1947
|
-
object_name_index: -1
|
|
1948
|
-
};
|
|
1949
|
-
common.MsgBase base = 1;
|
|
1950
|
-
string db_name = 2;
|
|
1951
|
-
string oldName = 3;
|
|
1952
|
-
string newName = 4;
|
|
1953
|
-
string newDBName =5;
|
|
1954
|
-
}
|
|
1955
|
-
|
|
1956
|
-
message GetIndexStatisticsRequest {
|
|
1957
|
-
option (common.privilege_ext_obj) = {
|
|
1958
|
-
object_type: Collection
|
|
1959
|
-
object_privilege: PrivilegeIndexDetail
|
|
1960
|
-
object_name_index: 3
|
|
1961
|
-
};
|
|
1962
|
-
// Not useful for now
|
|
1963
|
-
common.MsgBase base = 1;
|
|
1964
|
-
// Not useful for now
|
|
1965
|
-
string db_name = 2;
|
|
1966
|
-
// The particular collection name in Milvus
|
|
1967
|
-
string collection_name = 3;
|
|
1968
|
-
// The index name in this particular collection
|
|
1969
|
-
string index_name = 4;
|
|
1970
|
-
uint64 timestamp = 5;
|
|
1971
|
-
}
|
|
1972
|
-
|
|
1973
|
-
message GetIndexStatisticsResponse {
|
|
1974
|
-
// Response status
|
|
1975
|
-
common.Status status = 1;
|
|
1976
|
-
// All index information.
|
|
1977
|
-
repeated IndexDescription index_descriptions = 2;
|
|
1978
|
-
}
|
|
1979
|
-
|
|
1980
|
-
message ConnectRequest {
|
|
1981
|
-
common.MsgBase base = 1;
|
|
1982
|
-
common.ClientInfo client_info = 2;
|
|
1983
|
-
}
|
|
1984
|
-
|
|
1985
|
-
message ConnectResponse {
|
|
1986
|
-
common.Status status = 1;
|
|
1987
|
-
common.ServerInfo server_info = 2;
|
|
1988
|
-
int64 identifier = 3;
|
|
1989
|
-
}
|
|
1990
|
-
|
|
1991
|
-
message AllocTimestampRequest {
|
|
1992
|
-
common.MsgBase base = 1;
|
|
1993
|
-
}
|
|
1994
|
-
|
|
1995
|
-
message AllocTimestampResponse {
|
|
1996
|
-
common.Status status = 1;
|
|
1997
|
-
uint64 timestamp = 2;
|
|
1998
|
-
}
|
|
1999
|
-
|
|
2000
|
-
message CreateDatabaseRequest {
|
|
2001
|
-
option (common.privilege_ext_obj) = {
|
|
2002
|
-
object_type: Global
|
|
2003
|
-
object_privilege: PrivilegeCreateDatabase
|
|
2004
|
-
object_name_index: -1
|
|
2005
|
-
};
|
|
2006
|
-
common.MsgBase base = 1;
|
|
2007
|
-
string db_name = 2;
|
|
2008
|
-
repeated common.KeyValuePair properties = 3;
|
|
2009
|
-
}
|
|
2010
|
-
|
|
2011
|
-
message DropDatabaseRequest {
|
|
2012
|
-
option (common.privilege_ext_obj) = {
|
|
2013
|
-
object_type: Global
|
|
2014
|
-
object_privilege: PrivilegeDropDatabase
|
|
2015
|
-
object_name_index: -1
|
|
2016
|
-
};
|
|
2017
|
-
common.MsgBase base = 1;
|
|
2018
|
-
string db_name = 2;
|
|
2019
|
-
}
|
|
2020
|
-
|
|
2021
|
-
message ListDatabasesRequest {
|
|
2022
|
-
common.MsgBase base = 1;
|
|
2023
|
-
}
|
|
2024
|
-
|
|
2025
|
-
message ListDatabasesResponse {
|
|
2026
|
-
common.Status status = 1;
|
|
2027
|
-
repeated string db_names = 2;
|
|
2028
|
-
repeated uint64 created_timestamp = 3;
|
|
2029
|
-
repeated int64 db_ids = 4;
|
|
2030
|
-
}
|
|
2031
|
-
|
|
2032
|
-
message AlterDatabaseRequest {
|
|
2033
|
-
option (common.privilege_ext_obj) = {
|
|
2034
|
-
object_type: Global
|
|
2035
|
-
object_privilege: PrivilegeAlterDatabase
|
|
2036
|
-
object_name_index: -1
|
|
2037
|
-
};
|
|
2038
|
-
common.MsgBase base = 1;
|
|
2039
|
-
string db_name = 2;
|
|
2040
|
-
string db_id = 3;
|
|
2041
|
-
repeated common.KeyValuePair properties = 4;
|
|
2042
|
-
repeated string delete_keys = 5;
|
|
2043
|
-
}
|
|
2044
|
-
|
|
2045
|
-
message DescribeDatabaseRequest {
|
|
2046
|
-
option (common.privilege_ext_obj) = {
|
|
2047
|
-
object_type: Global
|
|
2048
|
-
object_privilege: PrivilegeDescribeDatabase
|
|
2049
|
-
object_name_index: -1
|
|
2050
|
-
};
|
|
2051
|
-
common.MsgBase base = 1;
|
|
2052
|
-
string db_name = 2;
|
|
2053
|
-
}
|
|
2054
|
-
|
|
2055
|
-
message DescribeDatabaseResponse {
|
|
2056
|
-
common.Status status = 1;
|
|
2057
|
-
string db_name = 2;
|
|
2058
|
-
int64 dbID = 3;
|
|
2059
|
-
uint64 created_timestamp = 4;
|
|
2060
|
-
repeated common.KeyValuePair properties = 5;
|
|
2061
|
-
}
|
|
2062
|
-
|
|
2063
|
-
message ReplicateMessageRequest {
|
|
2064
|
-
common.MsgBase base = 1;
|
|
2065
|
-
string channel_name = 2;
|
|
2066
|
-
uint64 BeginTs = 3;
|
|
2067
|
-
uint64 EndTs = 4;
|
|
2068
|
-
repeated bytes Msgs = 5;
|
|
2069
|
-
repeated msg.MsgPosition StartPositions = 6;
|
|
2070
|
-
repeated msg.MsgPosition EndPositions = 7;
|
|
2071
|
-
}
|
|
2072
|
-
|
|
2073
|
-
message ReplicateMessageResponse {
|
|
2074
|
-
common.Status status = 1;
|
|
2075
|
-
string position = 2;
|
|
2076
|
-
}
|
|
2077
|
-
|
|
2078
|
-
message ImportAuthPlaceholder {
|
|
2079
|
-
option (common.privilege_ext_obj) = {
|
|
2080
|
-
object_type: Collection
|
|
2081
|
-
object_privilege: PrivilegeImport
|
|
2082
|
-
object_name_index: 2
|
|
2083
|
-
};
|
|
2084
|
-
string db_name = 1;
|
|
2085
|
-
string collection_name = 2;
|
|
2086
|
-
string partition_name = 3;
|
|
2087
|
-
}
|
|
2088
|
-
|
|
2089
|
-
message GetImportProgressAuthPlaceholder {
|
|
2090
|
-
option (common.privilege_ext_obj) = {
|
|
2091
|
-
object_type: Collection
|
|
2092
|
-
object_privilege: PrivilegeImport
|
|
2093
|
-
object_name_index: -1
|
|
2094
|
-
};
|
|
2095
|
-
string db_name = 1;
|
|
2096
|
-
}
|
|
2097
|
-
|
|
2098
|
-
message ListImportsAuthPlaceholder {
|
|
2099
|
-
option (common.privilege_ext_obj) = {
|
|
2100
|
-
object_type: Collection
|
|
2101
|
-
object_privilege: PrivilegeImport
|
|
2102
|
-
object_name_index: 1
|
|
2103
|
-
};
|
|
2104
|
-
string db_name = 3;
|
|
2105
|
-
string collection_name = 1;
|
|
2106
|
-
}
|