diff --git a/internal/proto/milvus.proto b/internal/proto/milvus.proto index 7d9a431c93..17823e4bb7 100644 --- a/internal/proto/milvus.proto +++ b/internal/proto/milvus.proto @@ -141,29 +141,53 @@ message DescribeCollectionResponse { int32 shards_num = 8; } +/** +* Load collection data into query nodes, then you can do vector search on this collection. +*/ message LoadCollectionRequest { - common.MsgBase base = 1; // must + // Not useful for now + common.MsgBase base = 1; + // Not useful for now string db_name = 2; - string collection_name = 3; // must + // The collection name you want to load + string collection_name = 3; } +/** +* Release collection data from query nodes, then you can't do vector search on this collection. +*/ message ReleaseCollectionRequest { - common.MsgBase base = 1; // must + // Not useful for now + common.MsgBase base = 1; + // Not useful for now string db_name = 2; - string collection_name = 3; // must + // The collection name you want to release + string collection_name = 3; } +/** +* Get collection statistics like row_count. +*/ message GetCollectionStatisticsRequest { - common.MsgBase base = 1; // must + // Not useful for now + common.MsgBase base = 1; + // Not useful for now string db_name = 2; - string collection_name = 3; // must + // The collection name you want get statistics + string collection_name = 3; } +/** +* Will return collection statistics in stats field like [{key:"row_count",value:"1"}] +*/ message GetCollectionStatisticsResponse { + // Contain error_code and reason common.Status status = 1; + // Collection statistics data repeated common.KeyValuePair stats = 2; } + enum ShowType { All = 0; InMemory = 1; diff --git a/internal/proto/milvuspb/milvus.pb.go b/internal/proto/milvuspb/milvus.pb.go index 99d98c4258..ffa1d8d3ed 100644 --- a/internal/proto/milvuspb/milvus.pb.go +++ b/internal/proto/milvuspb/milvus.pb.go @@ -564,13 +564,18 @@ func (m *DescribeCollectionResponse) GetShardsNum() int32 { return 0 } +//* +// Load collection data into query nodes, then you can do vector search on this collection. type LoadCollectionRequest struct { - Base *commonpb.MsgBase `protobuf:"bytes,1,opt,name=base,proto3" json:"base,omitempty"` - DbName string `protobuf:"bytes,2,opt,name=db_name,json=dbName,proto3" json:"db_name,omitempty"` - CollectionName string `protobuf:"bytes,3,opt,name=collection_name,json=collectionName,proto3" json:"collection_name,omitempty"` - XXX_NoUnkeyedLiteral struct{} `json:"-"` - XXX_unrecognized []byte `json:"-"` - XXX_sizecache int32 `json:"-"` + // Not useful for now + Base *commonpb.MsgBase `protobuf:"bytes,1,opt,name=base,proto3" json:"base,omitempty"` + // Not useful for now + DbName string `protobuf:"bytes,2,opt,name=db_name,json=dbName,proto3" json:"db_name,omitempty"` + // The collection name you want to load + CollectionName string `protobuf:"bytes,3,opt,name=collection_name,json=collectionName,proto3" json:"collection_name,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` } func (m *LoadCollectionRequest) Reset() { *m = LoadCollectionRequest{} } @@ -619,13 +624,18 @@ func (m *LoadCollectionRequest) GetCollectionName() string { return "" } +//* +// Release collection data from query nodes, then you can't do vector search on this collection. type ReleaseCollectionRequest struct { - Base *commonpb.MsgBase `protobuf:"bytes,1,opt,name=base,proto3" json:"base,omitempty"` - DbName string `protobuf:"bytes,2,opt,name=db_name,json=dbName,proto3" json:"db_name,omitempty"` - CollectionName string `protobuf:"bytes,3,opt,name=collection_name,json=collectionName,proto3" json:"collection_name,omitempty"` - XXX_NoUnkeyedLiteral struct{} `json:"-"` - XXX_unrecognized []byte `json:"-"` - XXX_sizecache int32 `json:"-"` + // Not useful for now + Base *commonpb.MsgBase `protobuf:"bytes,1,opt,name=base,proto3" json:"base,omitempty"` + // Not useful for now + DbName string `protobuf:"bytes,2,opt,name=db_name,json=dbName,proto3" json:"db_name,omitempty"` + // The collection name you want to release + CollectionName string `protobuf:"bytes,3,opt,name=collection_name,json=collectionName,proto3" json:"collection_name,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` } func (m *ReleaseCollectionRequest) Reset() { *m = ReleaseCollectionRequest{} } @@ -674,13 +684,18 @@ func (m *ReleaseCollectionRequest) GetCollectionName() string { return "" } +//* +// Get collection statistics like row_count. type GetCollectionStatisticsRequest struct { - Base *commonpb.MsgBase `protobuf:"bytes,1,opt,name=base,proto3" json:"base,omitempty"` - DbName string `protobuf:"bytes,2,opt,name=db_name,json=dbName,proto3" json:"db_name,omitempty"` - CollectionName string `protobuf:"bytes,3,opt,name=collection_name,json=collectionName,proto3" json:"collection_name,omitempty"` - XXX_NoUnkeyedLiteral struct{} `json:"-"` - XXX_unrecognized []byte `json:"-"` - XXX_sizecache int32 `json:"-"` + // Not useful for now + Base *commonpb.MsgBase `protobuf:"bytes,1,opt,name=base,proto3" json:"base,omitempty"` + // Not useful for now + DbName string `protobuf:"bytes,2,opt,name=db_name,json=dbName,proto3" json:"db_name,omitempty"` + // The collection name you want get statistics + CollectionName string `protobuf:"bytes,3,opt,name=collection_name,json=collectionName,proto3" json:"collection_name,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` } func (m *GetCollectionStatisticsRequest) Reset() { *m = GetCollectionStatisticsRequest{} } @@ -729,8 +744,12 @@ func (m *GetCollectionStatisticsRequest) GetCollectionName() string { return "" } +//* +// Will return collection statistics in stats field like [{key:"row_count",value:"1"}] type GetCollectionStatisticsResponse struct { - Status *commonpb.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"` + // Contain error_code and reason + Status *commonpb.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"` + // Collection statistics data Stats []*commonpb.KeyValuePair `protobuf:"bytes,2,rep,name=stats,proto3" json:"stats,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"`