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 comments in milvus.proto (#8352) 

Signed-off-by: Gitea <zizhao.chen@zilliz.com>
pull/8807/head
nameczz 2021-09-28 22:32:13 +08:00 committed by GitHub
parent 0e50fa2d31
commit da9228769c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 96 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
internal/proto/milvus.proto
View File

@ -270,32 +270,62 @@ message CreatePartitionRequest {
string partition_name = 4;
}
/*
* Drop partition in created collection.
*/
message DropPartitionRequest {
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 drop
string partition_name = 4;
}
/*
* Check if partition exist in collection or not.
*/
message HasPartitionRequest {
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 check
string partition_name = 4;
}
/*
* Load specific partitions data of one collection into query nodes
* Then you can get these data as result when you do vector search on this collection.
*/
message LoadPartitionsRequest {
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
repeated string partition_names = 4; // must
// The collection name in milvus
string collection_name = 3;
// The partition names you want to load
repeated string partition_names = 4;
}
/*
* Release specific partitions data of one collection from query nodes.
* Then you can not get these data as result when you do vector search on this collection.
*/
message ReleasePartitionsRequest {
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
repeated string partition_names = 4; // must
// The collection name in milvus
string collection_name = 3;
// The partition names you want to release
repeated string partition_names = 4;
}
message GetPartitionStatisticsRequest {

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

@ -1208,14 +1208,20 @@ func (m *CreatePartitionRequest) GetPartitionName() string {
return ""
}
//
// Drop partition in created collection.
type DropPartitionRequest 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 drop
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 *DropPartitionRequest) Reset() { *m = DropPartitionRequest{} }
@ -1271,14 +1277,20 @@ func (m *DropPartitionRequest) GetPartitionName() string {
return ""
}
//
// Check if partition exist in collection or not.
type HasPartitionRequest 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 check
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 *HasPartitionRequest) Reset() { *m = HasPartitionRequest{} }
@ -1334,14 +1346,21 @@ func (m *HasPartitionRequest) GetPartitionName() string {
return ""
}
//
// Load specific partitions data of one collection into query nodes
// Then you can get these data as result when you do vector search on this collection.
type LoadPartitionsRequest 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"`
PartitionNames []string `protobuf:"bytes,4,rep,name=partition_names,json=partitionNames,proto3" json:"partition_names,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 names you want to load
PartitionNames []string `protobuf:"bytes,4,rep,name=partition_names,json=partitionNames,proto3" json:"partition_names,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
func (m *LoadPartitionsRequest) Reset() { *m = LoadPartitionsRequest{} }
@ -1397,14 +1416,21 @@ func (m *LoadPartitionsRequest) GetPartitionNames() []string {
return nil
}
//
// Release specific partitions data of one collection from query nodes.
// Then you can not get these data as result when you do vector search on this collection.
type ReleasePartitionsRequest 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"`
PartitionNames []string `protobuf:"bytes,4,rep,name=partition_names,json=partitionNames,proto3" json:"partition_names,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 names you want to release
PartitionNames []string `protobuf:"bytes,4,rep,name=partition_names,json=partitionNames,proto3" json:"partition_names,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
func (m *ReleasePartitionsRequest) Reset() { *m = ReleasePartitionsRequest{} }