From d7fb7000050ac22f8a50bbadff699a24879cca00 Mon Sep 17 00:00:00 2001 From: ryjiang Date: Wed, 27 Oct 2021 14:48:47 +0800 Subject: [PATCH] [skip ci]Add some comments in chap06_root_coordinator.md (#10707) Signed-off-by: ruiyi.jiang --- .../chap06_root_coordinator.md | 24 +++++++------------ 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/docs/developer_guides/chap06_root_coordinator.md b/docs/developer_guides/chap06_root_coordinator.md index 5e3b256a8a..92b30e81dd 100644 --- a/docs/developer_guides/chap06_root_coordinator.md +++ b/docs/developer_guides/chap06_root_coordinator.md @@ -11,30 +11,22 @@ type RootCoord interface { // DDL request // CreateCollection notifies RootCoord to create a collection - // - // ctx is the context to control request deadline and cancellation - // req contains the request params, including database name(not used), collection name, collection schema and - // physical channel num for inserting data - // - // The `ErrorCode` of `Status` is `Success` if create collection successfully; - // otherwise, the `ErrorCode` of `Status` will be `Error`, and the `Reason` of `Status` will record the fail cause. - // error is always nil CreateCollection(ctx context.Context, req *milvuspb.CreateCollectionRequest) (*commonpb.Status, error) // DropCollection notifies RootCoord to drop a collection - // - // ctx is the context to control request deadline and cancellation - // req contains the request params, including database name(not used) and collection name - // - // The `ErrorCode` of `Status` is `Success` if drop collection successfully; - // otherwise, the `ErrorCode` of `Status` will be `Error`, and the `Reason` of `Status` will record the fail cause. - // error is always nil DropCollection(ctx context.Context, req *milvuspb.DropCollectionRequest) (*commonpb.Status, error) + // HasCollection notifies RootCoord to check a collection's existence at specified timestamp HasCollection(ctx context.Context, req *milvuspb.HasCollectionRequest) (*milvuspb.BoolResponse, error) + // DescribeCollection notifies RootCoord to get all information about this collection at specified timestamp DescribeCollection(ctx context.Context, req *milvuspb.DescribeCollectionRequest) (*milvuspb.DescribeCollectionResponse, error) + // ShowCollections notifies RootCoord to list all collection names and other info in database at specified timestamp ShowCollections(ctx context.Context, req *milvuspb.ShowCollectionsRequest) (*milvuspb.ShowCollectionsResponse, error) - CreatePartition(ctx context.Context, req *milvuspb.CreatePartitionRequest) (*commonpb.Status, error) + // CreatePartition notifies RootCoord to create a partition + CreatePartition(ctx context.Context, req *milvuspb.CreatePartitionRequest) (*commonpb.Status, error) + // DropPartition notifies RootCoord to drop a partition DropPartition(ctx context.Context, req *milvuspb.DropPartitionRequest) (*commonpb.Status, error) + // HasPartition notifies RootCoord to check if a partition with specified name exists in the collection HasPartition(ctx context.Context, req *milvuspb.HasPartitionRequest) (*milvuspb.BoolResponse, error) + // ShowPartitions notifies RootCoord to list all partition names and other info in the collection ShowPartitions(ctx context.Context, req *milvuspb.ShowPartitionsRequest) (*milvuspb.ShowPartitionsResponse, error) //index builder service