[skip ci] Add DescribeIndexRequest comments in milvus.proto (#9984)

Signed-off-by: Gitea <zizhao.chen@zilliz.com>
pull/10156/head
nameczz 2021-10-19 11:16:34 +08:00 committed by GitHub
parent eda9d550a8
commit 86a7378492
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 11 deletions

View File

@ -427,12 +427,21 @@ message CreateIndexRequest {
repeated common.KeyValuePair extra_params = 5;
}
/*
* Get created index information.
* Current release of Milvus only supports showing latest built index.
*/
message DescribeIndexRequest {
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 particular collection name in Milvus
string collection_name = 3;
// The vector field name in this particular collection
string field_name = 4;
string index_name = 5; // No need to set up for now @2021.06.30
// No need to set up for now @2021.06.30
string index_name = 5;
}
message IndexDescription {

View File

@ -2099,15 +2099,23 @@ func (m *CreateIndexRequest) GetExtraParams() []*commonpb.KeyValuePair {
return nil
}
//
// Get created index information.
// Current release of Milvus only supports showing latest built index.
type DescribeIndexRequest 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"`
FieldName string `protobuf:"bytes,4,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
IndexName string `protobuf:"bytes,5,opt,name=index_name,json=indexName,proto3" json:"index_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 particular collection name in Milvus
CollectionName string `protobuf:"bytes,3,opt,name=collection_name,json=collectionName,proto3" json:"collection_name,omitempty"`
// The vector field name in this particular collection
FieldName string `protobuf:"bytes,4,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
// No need to set up for now @2021.06.30
IndexName string `protobuf:"bytes,5,opt,name=index_name,json=indexName,proto3" json:"index_name,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
func (m *DescribeIndexRequest) Reset() { *m = DescribeIndexRequest{} }