Documentation ¶
Index ¶
- Variables
- func NewClient(ctx context.Context) (types.RootCoordClient, error)
- type Client
- func (c *Client) AllocID(ctx context.Context, in *rootcoordpb.AllocIDRequest, opts ...grpc.CallOption) (*rootcoordpb.AllocIDResponse, error)
- func (c *Client) AllocTimestamp(ctx context.Context, in *rootcoordpb.AllocTimestampRequest, ...) (*rootcoordpb.AllocTimestampResponse, error)
- func (c *Client) AlterAlias(ctx context.Context, req *milvuspb.AlterAliasRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
- func (c *Client) AlterCollection(ctx context.Context, request *milvuspb.AlterCollectionRequest, ...) (*commonpb.Status, error)
- func (c *Client) AlterDatabase(ctx context.Context, request *rootcoordpb.AlterDatabaseRequest, ...) (*commonpb.Status, error)
- func (c *Client) BackupRBAC(ctx context.Context, in *milvuspb.BackupRBACMetaRequest, ...) (*milvuspb.BackupRBACMetaResponse, error)
- func (c *Client) CheckHealth(ctx context.Context, req *milvuspb.CheckHealthRequest, opts ...grpc.CallOption) (*milvuspb.CheckHealthResponse, error)
- func (c *Client) Close() error
- func (c *Client) CreateAlias(ctx context.Context, req *milvuspb.CreateAliasRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
- func (c *Client) CreateCollection(ctx context.Context, in *milvuspb.CreateCollectionRequest, ...) (*commonpb.Status, error)
- func (c *Client) CreateCredential(ctx context.Context, req *internalpb.CredentialInfo, opts ...grpc.CallOption) (*commonpb.Status, error)
- func (c *Client) CreateDatabase(ctx context.Context, in *milvuspb.CreateDatabaseRequest, ...) (*commonpb.Status, error)
- func (c *Client) CreatePartition(ctx context.Context, in *milvuspb.CreatePartitionRequest, ...) (*commonpb.Status, error)
- func (c *Client) CreatePrivilegeGroup(ctx context.Context, in *milvuspb.CreatePrivilegeGroupRequest, ...) (*commonpb.Status, error)
- func (c *Client) CreateRole(ctx context.Context, req *milvuspb.CreateRoleRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
- func (c *Client) DeleteCredential(ctx context.Context, req *milvuspb.DeleteCredentialRequest, ...) (*commonpb.Status, error)
- func (c *Client) DescribeAlias(ctx context.Context, req *milvuspb.DescribeAliasRequest, ...) (*milvuspb.DescribeAliasResponse, error)
- func (c *Client) DescribeCollection(ctx context.Context, in *milvuspb.DescribeCollectionRequest, ...) (*milvuspb.DescribeCollectionResponse, error)
- func (c *Client) DescribeCollectionInternal(ctx context.Context, in *milvuspb.DescribeCollectionRequest, ...) (*milvuspb.DescribeCollectionResponse, error)
- func (c *Client) DescribeDatabase(ctx context.Context, req *rootcoordpb.DescribeDatabaseRequest, ...) (*rootcoordpb.DescribeDatabaseResponse, error)
- func (c *Client) DropAlias(ctx context.Context, req *milvuspb.DropAliasRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
- func (c *Client) DropCollection(ctx context.Context, in *milvuspb.DropCollectionRequest, ...) (*commonpb.Status, error)
- func (c *Client) DropDatabase(ctx context.Context, in *milvuspb.DropDatabaseRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
- func (c *Client) DropPartition(ctx context.Context, in *milvuspb.DropPartitionRequest, ...) (*commonpb.Status, error)
- func (c *Client) DropPrivilegeGroup(ctx context.Context, in *milvuspb.DropPrivilegeGroupRequest, ...) (*commonpb.Status, error)
- func (c *Client) DropRole(ctx context.Context, req *milvuspb.DropRoleRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
- func (c *Client) GetComponentStates(ctx context.Context, req *milvuspb.GetComponentStatesRequest, ...) (*milvuspb.ComponentStates, error)
- func (c *Client) GetCredential(ctx context.Context, req *rootcoordpb.GetCredentialRequest, ...) (*rootcoordpb.GetCredentialResponse, error)
- func (c *Client) GetMetrics(ctx context.Context, in *milvuspb.GetMetricsRequest, opts ...grpc.CallOption) (*milvuspb.GetMetricsResponse, error)
- func (c *Client) GetPChannelInfo(ctx context.Context, in *rootcoordpb.GetPChannelInfoRequest, ...) (*rootcoordpb.GetPChannelInfoResponse, error)
- func (c *Client) GetStatisticsChannel(ctx context.Context, req *internalpb.GetStatisticsChannelRequest, ...) (*milvuspb.StringResponse, error)
- func (c *Client) GetTimeTickChannel(ctx context.Context, req *internalpb.GetTimeTickChannelRequest, ...) (*milvuspb.StringResponse, error)
- func (c *Client) HasCollection(ctx context.Context, in *milvuspb.HasCollectionRequest, ...) (*milvuspb.BoolResponse, error)
- func (c *Client) HasPartition(ctx context.Context, in *milvuspb.HasPartitionRequest, opts ...grpc.CallOption) (*milvuspb.BoolResponse, error)
- func (c *Client) InvalidateCollectionMetaCache(ctx context.Context, in *proxypb.InvalidateCollMetaCacheRequest, ...) (*commonpb.Status, error)
- func (c *Client) ListAliases(ctx context.Context, req *milvuspb.ListAliasesRequest, opts ...grpc.CallOption) (*milvuspb.ListAliasesResponse, error)
- func (c *Client) ListCredUsers(ctx context.Context, req *milvuspb.ListCredUsersRequest, ...) (*milvuspb.ListCredUsersResponse, error)
- func (c *Client) ListDatabases(ctx context.Context, in *milvuspb.ListDatabasesRequest, ...) (*milvuspb.ListDatabasesResponse, error)
- func (c *Client) ListPolicy(ctx context.Context, req *internalpb.ListPolicyRequest, ...) (*internalpb.ListPolicyResponse, error)
- func (c *Client) ListPrivilegeGroups(ctx context.Context, in *milvuspb.ListPrivilegeGroupsRequest, ...) (*milvuspb.ListPrivilegeGroupsResponse, error)
- func (c *Client) OperatePrivilege(ctx context.Context, req *milvuspb.OperatePrivilegeRequest, ...) (*commonpb.Status, error)
- func (c *Client) OperatePrivilegeGroup(ctx context.Context, in *milvuspb.OperatePrivilegeGroupRequest, ...) (*commonpb.Status, error)
- func (c *Client) OperateUserRole(ctx context.Context, req *milvuspb.OperateUserRoleRequest, ...) (*commonpb.Status, error)
- func (c *Client) RenameCollection(ctx context.Context, req *milvuspb.RenameCollectionRequest, ...) (*commonpb.Status, error)
- func (c *Client) RestoreRBAC(ctx context.Context, in *milvuspb.RestoreRBACMetaRequest, ...) (*commonpb.Status, error)
- func (c *Client) SelectGrant(ctx context.Context, req *milvuspb.SelectGrantRequest, opts ...grpc.CallOption) (*milvuspb.SelectGrantResponse, error)
- func (c *Client) SelectRole(ctx context.Context, req *milvuspb.SelectRoleRequest, opts ...grpc.CallOption) (*milvuspb.SelectRoleResponse, error)
- func (c *Client) SelectUser(ctx context.Context, req *milvuspb.SelectUserRequest, opts ...grpc.CallOption) (*milvuspb.SelectUserResponse, error)
- func (c *Client) ShowCollections(ctx context.Context, in *milvuspb.ShowCollectionsRequest, ...) (*milvuspb.ShowCollectionsResponse, error)
- func (c *Client) ShowConfigurations(ctx context.Context, req *internalpb.ShowConfigurationsRequest, ...) (*internalpb.ShowConfigurationsResponse, error)
- func (c *Client) ShowPartitions(ctx context.Context, in *milvuspb.ShowPartitionsRequest, ...) (*milvuspb.ShowPartitionsResponse, error)
- func (c *Client) ShowPartitionsInternal(ctx context.Context, in *milvuspb.ShowPartitionsRequest, ...) (*milvuspb.ShowPartitionsResponse, error)
- func (c *Client) ShowSegments(ctx context.Context, in *milvuspb.ShowSegmentsRequest, opts ...grpc.CallOption) (*milvuspb.ShowSegmentsResponse, error)
- func (c *Client) UpdateChannelTimeTick(ctx context.Context, in *internalpb.ChannelTimeTickMsg, ...) (*commonpb.Status, error)
- func (c *Client) UpdateCredential(ctx context.Context, req *internalpb.CredentialInfo, opts ...grpc.CallOption) (*commonpb.Status, error)
Constants ¶
This section is empty.
Variables ¶
var Params *paramtable.ComponentParam = paramtable.Get()
Functions ¶
func NewClient ¶
func NewClient(ctx context.Context) (types.RootCoordClient, error)
NewClient create root coordinator client with specified etcd info and timeout ctx execution control context metaRoot is the path in etcd for root coordinator registration etcdEndpoints are the address list for etcd end points timeout is default setting for each grpc call
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client grpc client
func (*Client) AllocID ¶
func (c *Client) AllocID(ctx context.Context, in *rootcoordpb.AllocIDRequest, opts ...grpc.CallOption) (*rootcoordpb.AllocIDResponse, error)
AllocID global ID allocator
func (*Client) AllocTimestamp ¶
func (c *Client) AllocTimestamp(ctx context.Context, in *rootcoordpb.AllocTimestampRequest, opts ...grpc.CallOption) (*rootcoordpb.AllocTimestampResponse, error)
AllocTimestamp global timestamp allocator
func (*Client) AlterAlias ¶
func (c *Client) AlterAlias(ctx context.Context, req *milvuspb.AlterAliasRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
AlterAlias alter collection alias
func (*Client) AlterCollection ¶
func (c *Client) AlterCollection(ctx context.Context, request *milvuspb.AlterCollectionRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
func (*Client) AlterDatabase ¶
func (c *Client) AlterDatabase(ctx context.Context, request *rootcoordpb.AlterDatabaseRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
func (*Client) BackupRBAC ¶
func (c *Client) BackupRBAC(ctx context.Context, in *milvuspb.BackupRBACMetaRequest, opts ...grpc.CallOption) (*milvuspb.BackupRBACMetaResponse, error)
func (*Client) CheckHealth ¶
func (c *Client) CheckHealth(ctx context.Context, req *milvuspb.CheckHealthRequest, opts ...grpc.CallOption) (*milvuspb.CheckHealthResponse, error)
func (*Client) CreateAlias ¶
func (c *Client) CreateAlias(ctx context.Context, req *milvuspb.CreateAliasRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
CreateAlias create collection alias
func (*Client) CreateCollection ¶
func (c *Client) CreateCollection(ctx context.Context, in *milvuspb.CreateCollectionRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
CreateCollection create collection
func (*Client) CreateCredential ¶
func (c *Client) CreateCredential(ctx context.Context, req *internalpb.CredentialInfo, opts ...grpc.CallOption) (*commonpb.Status, error)
func (*Client) CreateDatabase ¶
func (c *Client) CreateDatabase(ctx context.Context, in *milvuspb.CreateDatabaseRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
func (*Client) CreatePartition ¶
func (c *Client) CreatePartition(ctx context.Context, in *milvuspb.CreatePartitionRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
CreatePartition create partition
func (*Client) CreatePrivilegeGroup ¶
func (c *Client) CreatePrivilegeGroup(ctx context.Context, in *milvuspb.CreatePrivilegeGroupRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
func (*Client) CreateRole ¶
func (c *Client) CreateRole(ctx context.Context, req *milvuspb.CreateRoleRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
func (*Client) DeleteCredential ¶
func (c *Client) DeleteCredential(ctx context.Context, req *milvuspb.DeleteCredentialRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
func (*Client) DescribeAlias ¶
func (c *Client) DescribeAlias(ctx context.Context, req *milvuspb.DescribeAliasRequest, opts ...grpc.CallOption) (*milvuspb.DescribeAliasResponse, error)
DescribeAlias describe alias
func (*Client) DescribeCollection ¶
func (c *Client) DescribeCollection(ctx context.Context, in *milvuspb.DescribeCollectionRequest, opts ...grpc.CallOption) (*milvuspb.DescribeCollectionResponse, error)
DescribeCollection return collection info
func (*Client) DescribeCollectionInternal ¶
func (c *Client) DescribeCollectionInternal(ctx context.Context, in *milvuspb.DescribeCollectionRequest, opts ...grpc.CallOption) (*milvuspb.DescribeCollectionResponse, error)
func (*Client) DescribeDatabase ¶
func (c *Client) DescribeDatabase(ctx context.Context, req *rootcoordpb.DescribeDatabaseRequest, opts ...grpc.CallOption) (*rootcoordpb.DescribeDatabaseResponse, error)
func (*Client) DropAlias ¶
func (c *Client) DropAlias(ctx context.Context, req *milvuspb.DropAliasRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
DropAlias drop collection alias
func (*Client) DropCollection ¶
func (c *Client) DropCollection(ctx context.Context, in *milvuspb.DropCollectionRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
DropCollection drop collection
func (*Client) DropDatabase ¶
func (c *Client) DropDatabase(ctx context.Context, in *milvuspb.DropDatabaseRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
func (*Client) DropPartition ¶
func (c *Client) DropPartition(ctx context.Context, in *milvuspb.DropPartitionRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
DropPartition drop partition
func (*Client) DropPrivilegeGroup ¶
func (c *Client) DropPrivilegeGroup(ctx context.Context, in *milvuspb.DropPrivilegeGroupRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
func (*Client) DropRole ¶
func (c *Client) DropRole(ctx context.Context, req *milvuspb.DropRoleRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
func (*Client) GetComponentStates ¶
func (c *Client) GetComponentStates(ctx context.Context, req *milvuspb.GetComponentStatesRequest, opts ...grpc.CallOption) (*milvuspb.ComponentStates, error)
GetComponentStates TODO: timeout need to be propagated through ctx
func (*Client) GetCredential ¶
func (c *Client) GetCredential(ctx context.Context, req *rootcoordpb.GetCredentialRequest, opts ...grpc.CallOption) (*rootcoordpb.GetCredentialResponse, error)
func (*Client) GetMetrics ¶
func (c *Client) GetMetrics(ctx context.Context, in *milvuspb.GetMetricsRequest, opts ...grpc.CallOption) (*milvuspb.GetMetricsResponse, error)
GetMetrics get metrics
func (*Client) GetPChannelInfo ¶
func (c *Client) GetPChannelInfo(ctx context.Context, in *rootcoordpb.GetPChannelInfoRequest, opts ...grpc.CallOption) (*rootcoordpb.GetPChannelInfoResponse, error)
GetVChannels returns all vchannels belonging to the pchannel.
func (*Client) GetStatisticsChannel ¶
func (c *Client) GetStatisticsChannel(ctx context.Context, req *internalpb.GetStatisticsChannelRequest, opts ...grpc.CallOption) (*milvuspb.StringResponse, error)
GetStatisticsChannel just define a channel, not used currently
func (*Client) GetTimeTickChannel ¶
func (c *Client) GetTimeTickChannel(ctx context.Context, req *internalpb.GetTimeTickChannelRequest, opts ...grpc.CallOption) (*milvuspb.StringResponse, error)
GetTimeTickChannel get timetick channel name
func (*Client) HasCollection ¶
func (c *Client) HasCollection(ctx context.Context, in *milvuspb.HasCollectionRequest, opts ...grpc.CallOption) (*milvuspb.BoolResponse, error)
HasCollection check collection existence
func (*Client) HasPartition ¶
func (c *Client) HasPartition(ctx context.Context, in *milvuspb.HasPartitionRequest, opts ...grpc.CallOption) (*milvuspb.BoolResponse, error)
HasPartition check partition existence
func (*Client) InvalidateCollectionMetaCache ¶
func (c *Client) InvalidateCollectionMetaCache(ctx context.Context, in *proxypb.InvalidateCollMetaCacheRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
InvalidateCollectionMetaCache notifies RootCoord to release the collection cache in Proxies.
func (*Client) ListAliases ¶
func (c *Client) ListAliases(ctx context.Context, req *milvuspb.ListAliasesRequest, opts ...grpc.CallOption) (*milvuspb.ListAliasesResponse, error)
ListAliases list all aliases of db or collection
func (*Client) ListCredUsers ¶
func (c *Client) ListCredUsers(ctx context.Context, req *milvuspb.ListCredUsersRequest, opts ...grpc.CallOption) (*milvuspb.ListCredUsersResponse, error)
func (*Client) ListDatabases ¶
func (c *Client) ListDatabases(ctx context.Context, in *milvuspb.ListDatabasesRequest, opts ...grpc.CallOption) (*milvuspb.ListDatabasesResponse, error)
func (*Client) ListPolicy ¶
func (c *Client) ListPolicy(ctx context.Context, req *internalpb.ListPolicyRequest, opts ...grpc.CallOption) (*internalpb.ListPolicyResponse, error)
func (*Client) ListPrivilegeGroups ¶
func (c *Client) ListPrivilegeGroups(ctx context.Context, in *milvuspb.ListPrivilegeGroupsRequest, opts ...grpc.CallOption) (*milvuspb.ListPrivilegeGroupsResponse, error)
func (*Client) OperatePrivilege ¶
func (c *Client) OperatePrivilege(ctx context.Context, req *milvuspb.OperatePrivilegeRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
func (*Client) OperatePrivilegeGroup ¶
func (c *Client) OperatePrivilegeGroup(ctx context.Context, in *milvuspb.OperatePrivilegeGroupRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
func (*Client) OperateUserRole ¶
func (c *Client) OperateUserRole(ctx context.Context, req *milvuspb.OperateUserRoleRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
func (*Client) RenameCollection ¶
func (c *Client) RenameCollection(ctx context.Context, req *milvuspb.RenameCollectionRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
func (*Client) RestoreRBAC ¶
func (c *Client) RestoreRBAC(ctx context.Context, in *milvuspb.RestoreRBACMetaRequest, opts ...grpc.CallOption) (*commonpb.Status, error)
func (*Client) SelectGrant ¶
func (c *Client) SelectGrant(ctx context.Context, req *milvuspb.SelectGrantRequest, opts ...grpc.CallOption) (*milvuspb.SelectGrantResponse, error)
func (*Client) SelectRole ¶
func (c *Client) SelectRole(ctx context.Context, req *milvuspb.SelectRoleRequest, opts ...grpc.CallOption) (*milvuspb.SelectRoleResponse, error)
func (*Client) SelectUser ¶
func (c *Client) SelectUser(ctx context.Context, req *milvuspb.SelectUserRequest, opts ...grpc.CallOption) (*milvuspb.SelectUserResponse, error)
func (*Client) ShowCollections ¶
func (c *Client) ShowCollections(ctx context.Context, in *milvuspb.ShowCollectionsRequest, opts ...grpc.CallOption) (*milvuspb.ShowCollectionsResponse, error)
ShowCollections list all collection names
func (*Client) ShowConfigurations ¶
func (c *Client) ShowConfigurations(ctx context.Context, req *internalpb.ShowConfigurationsRequest, opts ...grpc.CallOption) (*internalpb.ShowConfigurationsResponse, error)
ShowConfigurations gets specified configurations para of RootCoord
func (*Client) ShowPartitions ¶
func (c *Client) ShowPartitions(ctx context.Context, in *milvuspb.ShowPartitionsRequest, opts ...grpc.CallOption) (*milvuspb.ShowPartitionsResponse, error)
ShowPartitions list all partitions in collection
func (*Client) ShowPartitionsInternal ¶
func (c *Client) ShowPartitionsInternal(ctx context.Context, in *milvuspb.ShowPartitionsRequest, opts ...grpc.CallOption) (*milvuspb.ShowPartitionsResponse, error)
func (*Client) ShowSegments ¶
func (c *Client) ShowSegments(ctx context.Context, in *milvuspb.ShowSegmentsRequest, opts ...grpc.CallOption) (*milvuspb.ShowSegmentsResponse, error)
ShowSegments list all segments
func (*Client) UpdateChannelTimeTick ¶
func (c *Client) UpdateChannelTimeTick(ctx context.Context, in *internalpb.ChannelTimeTickMsg, opts ...grpc.CallOption) (*commonpb.Status, error)
UpdateChannelTimeTick used to handle ChannelTimeTickMsg
func (*Client) UpdateCredential ¶
func (c *Client) UpdateCredential(ctx context.Context, req *internalpb.CredentialInfo, opts ...grpc.CallOption) (*commonpb.Status, error)