From b304ab14ef5bbae34515e0e9c3a4e7b15d0791ef Mon Sep 17 00:00:00 2001 From: Cai Yudong Date: Fri, 1 Oct 2021 00:40:08 +0800 Subject: [PATCH] [skip ci] Update comment for create alias (#8915) Signed-off-by: yudong.cai --- internal/types/types.go | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/internal/types/types.go b/internal/types/types.go index 4ddb09c6d9..76f1ad2c9a 100644 --- a/internal/types/types.go +++ b/internal/types/types.go @@ -265,7 +265,14 @@ type RootCoord interface { // error is always nil DropIndex(ctx context.Context, req *milvuspb.DropIndexRequest) (*commonpb.Status, error) - // collection alias + // CreateAlias notifies RootCoord to create an alias for the collection + // + // ctx is the context to control request deadline and cancellation + // req contains the request params, including collection name and alias + // + // The `ErrorCode` of `Status` is `Success` if create alias successfully; + // otherwise, the `ErrorCode` of `Status` will be `Error`, and the `Reason` of `Status` will record the fail cause. + // error is always nil CreateAlias(ctx context.Context, req *milvuspb.CreateAliasRequest) (*commonpb.Status, error) DropAlias(ctx context.Context, req *milvuspb.DropAliasRequest) (*commonpb.Status, error) AlterAlias(ctx context.Context, req *milvuspb.AlterAliasRequest) (*commonpb.Status, error)