milvus-io
/
milvus
mirror of https://github.com/milvus-io/milvus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[skip ci] Improve milvus.proto comments (#8885) 

Signed-off-by: Gitea <zizhao.chen@zilliz.com>
pull/9703/head
nameczz 2021-10-11 21:23:50 +08:00 committed by GitHub
parent ce4e848663
commit 3cb286400f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 60 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
internal/proto/milvus.proto
View File

@ -112,7 +112,7 @@ message HasCollectionRequest {
string db_name = 2;
// The collection name you want to check.
string collection_name = 3;
// Not useful for now
// If time_stamp is not zero, will return true when time_stamp >= created collection timestamp, otherwise will return false.
uint64 time_stamp = 4;
}
@ -135,11 +135,11 @@ message DescribeCollectionRequest {
common.MsgBase base = 1;
// Not useful for now
string db_name = 2;
// The collection name you want to describe
// The collection name you want to describe, you can pass collection_name or collectionID
string collection_name = 3;
// Not useful for now
// The collection ID you want to describe
int64 collectionID = 4;
// Not useful for now
// If time_stamp is not zero, will describe collection success when time_stamp >= created collection timestamp, otherwise will throw error.
uint64 time_stamp = 5;
}
@ -331,24 +331,39 @@ message ReleasePartitionsRequest {
repeated string partition_names = 4;
}
/*
* Get partition statistics like row_count.
*/
message GetPartitionStatisticsRequest {
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
string partition_name = 4; // must
// The collection name in milvus
string collection_name = 3;
// The partition name you want to collect statistics
string partition_name = 4;
}
message GetPartitionStatisticsResponse {
common.Status status = 1;
repeated common.KeyValuePair stats = 2;
}
/*
* List all partitions for particular collection
*/
message ShowPartitionsRequest {
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 describe, you can pass collection_name or collectionID
string collection_name = 3;
// The collection id in milvus
int64 collectionID = 4;
repeated string partition_names = 5; // show partition in querynode, showType = InMemory
// When type is InMemory, will return these patitions's inMemory_percentages.(Optional)
repeated string partition_names = 5;
// Decide return Loaded partitions or All partitions(Optional)
ShowType type = 6;
}

54
internal/proto/milvuspb/milvus.pb.go
View File

@ -412,7 +412,7 @@ type HasCollectionRequest struct {
DbName string `protobuf:"bytes,2,opt,name=db_name,json=dbName,proto3" json:"db_name,omitempty"`
// The collection name you want to check.
CollectionName string `protobuf:"bytes,3,opt,name=collection_name,json=collectionName,proto3" json:"collection_name,omitempty"`
// Not useful for now
// If time_stamp is not zero, will return true when time_stamp >= created collection timestamp, otherwise will return false.
TimeStamp uint64 `protobuf:"varint,4,opt,name=time_stamp,json=timeStamp,proto3" json:"time_stamp,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
@ -573,11 +573,11 @@ type DescribeCollectionRequest struct {
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 describe
// The collection name you want to describe, you can pass collection_name or collectionID
CollectionName string `protobuf:"bytes,3,opt,name=collection_name,json=collectionName,proto3" json:"collection_name,omitempty"`
// Not useful for now
// The collection ID you want to describe
CollectionID int64 `protobuf:"varint,4,opt,name=collectionID,proto3" json:"collectionID,omitempty"`
// Not useful for now
// If time_stamp is not zero, will describe collection success when time_stamp >= created collection timestamp, otherwise will throw error.
TimeStamp uint64 `protobuf:"varint,5,opt,name=time_stamp,json=timeStamp,proto3" json:"time_stamp,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
@ -1510,14 +1510,20 @@ func (m *ReleasePartitionsRequest) GetPartitionNames() []string {
return nil
}
//
// Get partition statistics like row_count.
type GetPartitionStatisticsRequest 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"`
PartitionName string `protobuf:"bytes,4,opt,name=partition_name,json=partitionName,proto3" json:"partition_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 in milvus
CollectionName string `protobuf:"bytes,3,opt,name=collection_name,json=collectionName,proto3" json:"collection_name,omitempty"`
// The partition name you want to collect statistics
PartitionName string `protobuf:"bytes,4,opt,name=partition_name,json=partitionName,proto3" json:"partition_name,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
func (m *GetPartitionStatisticsRequest) Reset() { *m = GetPartitionStatisticsRequest{} }
@ -1620,16 +1626,24 @@ func (m *GetPartitionStatisticsResponse) GetStats() []*commonpb.KeyValuePair {
return nil
}
//
// List all partitions for particular collection
type ShowPartitionsRequest 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"`
CollectionID int64 `protobuf:"varint,4,opt,name=collectionID,proto3" json:"collectionID,omitempty"`
PartitionNames []string `protobuf:"bytes,5,rep,name=partition_names,json=partitionNames,proto3" json:"partition_names,omitempty"`
Type ShowType `protobuf:"varint,6,opt,name=type,proto3,enum=milvus.proto.milvus.ShowType" json:"type,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 describe, you can pass collection_name or collectionID
CollectionName string `protobuf:"bytes,3,opt,name=collection_name,json=collectionName,proto3" json:"collection_name,omitempty"`
// The collection id in milvus
CollectionID int64 `protobuf:"varint,4,opt,name=collectionID,proto3" json:"collectionID,omitempty"`
// When type is InMemory, will return these patitions's inMemory_percentages.(Optional)
PartitionNames []string `protobuf:"bytes,5,rep,name=partition_names,json=partitionNames,proto3" json:"partition_names,omitempty"`
// Decide return Loaded partitions or All partitions(Optional)
Type ShowType `protobuf:"varint,6,opt,name=type,proto3,enum=milvus.proto.milvus.ShowType" json:"type,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
func (m *ShowPartitionsRequest) Reset() { *m = ShowPartitionsRequest{} }