mirror of https://github.com/milvus-io/milvus.git
[skip ci] improve DescribeCollection comments (#7882)
Signed-off-by: Gitea <zizhao.chen@zilliz.com>pull/8035/head
parent
4814f9cb1c
commit
8ee55aad0a
|
@ -62,6 +62,7 @@ message CreateCollectionRequest {
|
|||
// The serialized `schema.CollectionSchema`(Required)
|
||||
bytes schema = 4;
|
||||
// Once set, no modification is allowed (Optional)
|
||||
// https://github.com/milvus-io/milvus/issues/6690
|
||||
int32 shards_num = 5;
|
||||
}
|
||||
|
||||
|
@ -91,6 +92,7 @@ message HasCollectionRequest {
|
|||
uint64 time_stamp = 4;
|
||||
}
|
||||
|
||||
|
||||
message BoolResponse {
|
||||
common.Status status = 1;
|
||||
bool value = 2;
|
||||
|
@ -101,23 +103,42 @@ message StringResponse {
|
|||
string value = 2;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get collection meta datas like: schema, collectionID, shards number ...
|
||||
*/
|
||||
message DescribeCollectionRequest {
|
||||
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
|
||||
string collection_name = 3;
|
||||
// Not useful for now
|
||||
int64 collectionID = 4;
|
||||
// Not useful for now
|
||||
uint64 time_stamp = 5;
|
||||
}
|
||||
|
||||
/**
|
||||
* DescribeCollection Response
|
||||
*/
|
||||
message DescribeCollectionResponse {
|
||||
// Contain error_code and reason
|
||||
common.Status status = 1;
|
||||
// The schema param when you created collection.
|
||||
schema.CollectionSchema schema = 2;
|
||||
// The collection id
|
||||
int64 collectionID = 3;
|
||||
// System design related, users should not perceive
|
||||
repeated string virtual_channel_names = 4;
|
||||
// System design related, users should not perceive
|
||||
repeated string physical_channel_names = 5;
|
||||
uint64 created_timestamp = 6; // hybrid timestamp
|
||||
uint64 created_utc_timestamp = 7; // physical timestamp
|
||||
int32 shards_num = 8; // shards number
|
||||
// Hybrid timestamp in milvus
|
||||
uint64 created_timestamp = 6;
|
||||
// The utc timestamp calculated by created_timestamp
|
||||
uint64 created_utc_timestamp = 7;
|
||||
// The shards number you set.
|
||||
int32 shards_num = 8;
|
||||
}
|
||||
|
||||
message LoadCollectionRequest {
|
||||
|
@ -518,4 +539,4 @@ message GetMetricsResponse {
|
|||
|
||||
service ProxyService {
|
||||
rpc RegisterLink(RegisterLinkRequest) returns (RegisterLinkResponse) {}
|
||||
}
|
||||
}
|
|
@ -91,6 +91,7 @@ type CreateCollectionRequest struct {
|
|||
// The serialized `schema.CollectionSchema`(Required)
|
||||
Schema []byte `protobuf:"bytes,4,opt,name=schema,proto3" json:"schema,omitempty"`
|
||||
// Once set, no modification is allowed (Optional)
|
||||
// https://github.com/milvus-io/milvus/issues/6690
|
||||
ShardsNum int32 `protobuf:"varint,5,opt,name=shards_num,json=shardsNum,proto3" json:"shards_num,omitempty"`
|
||||
XXX_NoUnkeyedLiteral struct{} `json:"-"`
|
||||
XXX_unrecognized []byte `json:"-"`
|
||||
|
@ -380,15 +381,22 @@ func (m *StringResponse) GetValue() string {
|
|||
return ""
|
||||
}
|
||||
|
||||
//*
|
||||
// Get collection meta datas like: schema, collectionID, shards number ...
|
||||
type DescribeCollectionRequest 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"`
|
||||
TimeStamp uint64 `protobuf:"varint,5,opt,name=time_stamp,json=timeStamp,proto3" json:"time_stamp,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
|
||||
CollectionName string `protobuf:"bytes,3,opt,name=collection_name,json=collectionName,proto3" json:"collection_name,omitempty"`
|
||||
// Not useful for now
|
||||
CollectionID int64 `protobuf:"varint,4,opt,name=collectionID,proto3" json:"collectionID,omitempty"`
|
||||
// Not useful for now
|
||||
TimeStamp uint64 `protobuf:"varint,5,opt,name=time_stamp,json=timeStamp,proto3" json:"time_stamp,omitempty"`
|
||||
XXX_NoUnkeyedLiteral struct{} `json:"-"`
|
||||
XXX_unrecognized []byte `json:"-"`
|
||||
XXX_sizecache int32 `json:"-"`
|
||||
}
|
||||
|
||||
func (m *DescribeCollectionRequest) Reset() { *m = DescribeCollectionRequest{} }
|
||||
|
@ -451,18 +459,28 @@ func (m *DescribeCollectionRequest) GetTimeStamp() uint64 {
|
|||
return 0
|
||||
}
|
||||
|
||||
//*
|
||||
// DescribeCollection Response
|
||||
type DescribeCollectionResponse struct {
|
||||
Status *commonpb.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
|
||||
Schema *schemapb.CollectionSchema `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
|
||||
CollectionID int64 `protobuf:"varint,3,opt,name=collectionID,proto3" json:"collectionID,omitempty"`
|
||||
VirtualChannelNames []string `protobuf:"bytes,4,rep,name=virtual_channel_names,json=virtualChannelNames,proto3" json:"virtual_channel_names,omitempty"`
|
||||
PhysicalChannelNames []string `protobuf:"bytes,5,rep,name=physical_channel_names,json=physicalChannelNames,proto3" json:"physical_channel_names,omitempty"`
|
||||
CreatedTimestamp uint64 `protobuf:"varint,6,opt,name=created_timestamp,json=createdTimestamp,proto3" json:"created_timestamp,omitempty"`
|
||||
CreatedUtcTimestamp uint64 `protobuf:"varint,7,opt,name=created_utc_timestamp,json=createdUtcTimestamp,proto3" json:"created_utc_timestamp,omitempty"`
|
||||
ShardsNum int32 `protobuf:"varint,8,opt,name=shards_num,json=shardsNum,proto3" json:"shards_num,omitempty"`
|
||||
XXX_NoUnkeyedLiteral struct{} `json:"-"`
|
||||
XXX_unrecognized []byte `json:"-"`
|
||||
XXX_sizecache int32 `json:"-"`
|
||||
// Contain error_code and reason
|
||||
Status *commonpb.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
|
||||
// The schema param when you created collection.
|
||||
Schema *schemapb.CollectionSchema `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
|
||||
// The collection id
|
||||
CollectionID int64 `protobuf:"varint,3,opt,name=collectionID,proto3" json:"collectionID,omitempty"`
|
||||
// System design related, users should not perceive
|
||||
VirtualChannelNames []string `protobuf:"bytes,4,rep,name=virtual_channel_names,json=virtualChannelNames,proto3" json:"virtual_channel_names,omitempty"`
|
||||
// System design related, users should not perceive
|
||||
PhysicalChannelNames []string `protobuf:"bytes,5,rep,name=physical_channel_names,json=physicalChannelNames,proto3" json:"physical_channel_names,omitempty"`
|
||||
// Hybrid timestamp in milvus
|
||||
CreatedTimestamp uint64 `protobuf:"varint,6,opt,name=created_timestamp,json=createdTimestamp,proto3" json:"created_timestamp,omitempty"`
|
||||
// The utc timestamp calculated by created_timestamp
|
||||
CreatedUtcTimestamp uint64 `protobuf:"varint,7,opt,name=created_utc_timestamp,json=createdUtcTimestamp,proto3" json:"created_utc_timestamp,omitempty"`
|
||||
// The shards number you set.
|
||||
ShardsNum int32 `protobuf:"varint,8,opt,name=shards_num,json=shardsNum,proto3" json:"shards_num,omitempty"`
|
||||
XXX_NoUnkeyedLiteral struct{} `json:"-"`
|
||||
XXX_unrecognized []byte `json:"-"`
|
||||
XXX_sizecache int32 `json:"-"`
|
||||
}
|
||||
|
||||
func (m *DescribeCollectionResponse) Reset() { *m = DescribeCollectionResponse{} }
|
||||
|
|
Loading…
Reference in New Issue