From c05d4fa3628a31573ad27e18ffdb1f2d17c4470b Mon Sep 17 00:00:00 2001 From: dragondriver Date: Mon, 27 Sep 2021 18:23:59 +0800 Subject: [PATCH] [skip ci] Add description for proxy api (#8696) Signed-off-by: dragondriver --- internal/types/types.go | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/internal/types/types.go b/internal/types/types.go index 86e839f5a8..ed7c1ab5de 100644 --- a/internal/types/types.go +++ b/internal/types/types.go @@ -156,7 +156,31 @@ type RootCoordComponent interface { type Proxy interface { Component + // InvalidateCollectionMetaCache notifies Proxy to clear all the meta cache of specific collection. + // + // InvalidateCollectionMetaCache should be called when there are any meta changes in specific collection. + // Such as `DropCollection`, `CreatePartition`, `DropPartition`, etc. + // + // ctx is the request to control request deadline and cancellation. + // request contains the request params, which are database name(not used now) and collection name. + // + // InvalidateCollectionMetaCache should always succeed even though the specific collection doesn't exist in Proxy. + // So the code of response `Status` should be always `Success`. + // + // error is returned only when some communication issue occurs. InvalidateCollectionMetaCache(ctx context.Context, request *proxypb.InvalidateCollMetaCacheRequest) (*commonpb.Status, error) + + // ReleaseDQLMessageStream notifies Proxy to release and close the search message stream of specific collection. + // + // ReleaseDQLMessageStream should be called when the specific collection was released. + // + // ctx is the request to control request deadline and cancellation. + // request contains the request params, which are database id(not used now) and collection id. + // + // ReleaseDQLMessageStream should always succeed even though the specific collection doesn't exist in Proxy. + // So the code of response `Status` should be always `Success`. + // + // error is returned only when some communication issue occurs. ReleaseDQLMessageStream(ctx context.Context, in *proxypb.ReleaseDQLMessageStreamRequest) (*commonpb.Status, error) //TODO: move to milvus service