admin/milvus
1
0
Fork 0
mirror of https://gitee.com/milvus-io/milvus.git synced 2026-01-07 19:31:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

[skip ci] Add description for proxy api (#8696)

Browse Source 
Signed-off-by: dragondriver <jiquan.long@zilliz.com>
This commit is contained in:
dragondriver 2021-09-27 18:23:59 +08:00 committed by GitHub
parent e83054d5fc
commit c05d4fa362
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
internal/types/types.go
View File

@ -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