From da9228769ca7e5c6d2efb3c8f1787e62b6e2934a Mon Sep 17 00:00:00 2001 From: nameczz Date: Tue, 28 Sep 2021 22:32:13 +0800 Subject: [PATCH] [skip ci] Improve comments in milvus.proto (#8352) Signed-off-by: Gitea --- internal/proto/milvus.proto | 54 ++++++++++++++---- internal/proto/milvuspb/milvus.pb.go | 82 ++++++++++++++++++---------- 2 files changed, 96 insertions(+), 40 deletions(-) diff --git a/internal/proto/milvus.proto b/internal/proto/milvus.proto index 6a4a79d19d..92173abadc 100644 --- a/internal/proto/milvus.proto +++ b/internal/proto/milvus.proto @@ -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 { diff --git a/internal/proto/milvuspb/milvus.pb.go b/internal/proto/milvuspb/milvus.pb.go index 0bdf968cf2..22e5b8077b 100644 --- a/internal/proto/milvuspb/milvus.pb.go +++ b/internal/proto/milvuspb/milvus.pb.go @@ -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{} }