Documentation ¶
Index ¶
- func RegisterVtctlServer(s *grpc.Server, srv VtctlServer)
- func RegisterVtctldServer(s *grpc.Server, srv VtctldServer)
- type UnimplementedVtctlServer
- type UnimplementedVtctldServer
- func (*UnimplementedVtctldServer) ChangeTabletType(ctx context.Context, req *vtctldata.ChangeTabletTypeRequest) (*vtctldata.ChangeTabletTypeResponse, error)
- func (*UnimplementedVtctldServer) CreateKeyspace(ctx context.Context, req *vtctldata.CreateKeyspaceRequest) (*vtctldata.CreateKeyspaceResponse, error)
- func (*UnimplementedVtctldServer) CreateShard(ctx context.Context, req *vtctldata.CreateShardRequest) (*vtctldata.CreateShardResponse, error)
- func (*UnimplementedVtctldServer) DeleteKeyspace(ctx context.Context, req *vtctldata.DeleteKeyspaceRequest) (*vtctldata.DeleteKeyspaceResponse, error)
- func (*UnimplementedVtctldServer) DeleteShards(ctx context.Context, req *vtctldata.DeleteShardsRequest) (*vtctldata.DeleteShardsResponse, error)
- func (*UnimplementedVtctldServer) DeleteTablets(ctx context.Context, req *vtctldata.DeleteTabletsRequest) (*vtctldata.DeleteTabletsResponse, error)
- func (*UnimplementedVtctldServer) EmergencyReparentShard(ctx context.Context, req *vtctldata.EmergencyReparentShardRequest) (*vtctldata.EmergencyReparentShardResponse, error)
- func (*UnimplementedVtctldServer) FindAllShardsInKeyspace(ctx context.Context, req *vtctldata.FindAllShardsInKeyspaceRequest) (*vtctldata.FindAllShardsInKeyspaceResponse, error)
- func (*UnimplementedVtctldServer) GetBackups(ctx context.Context, req *vtctldata.GetBackupsRequest) (*vtctldata.GetBackupsResponse, error)
- func (*UnimplementedVtctldServer) GetCellInfo(ctx context.Context, req *vtctldata.GetCellInfoRequest) (*vtctldata.GetCellInfoResponse, error)
- func (*UnimplementedVtctldServer) GetCellInfoNames(ctx context.Context, req *vtctldata.GetCellInfoNamesRequest) (*vtctldata.GetCellInfoNamesResponse, error)
- func (*UnimplementedVtctldServer) GetCellsAliases(ctx context.Context, req *vtctldata.GetCellsAliasesRequest) (*vtctldata.GetCellsAliasesResponse, error)
- func (*UnimplementedVtctldServer) GetKeyspace(ctx context.Context, req *vtctldata.GetKeyspaceRequest) (*vtctldata.GetKeyspaceResponse, error)
- func (*UnimplementedVtctldServer) GetKeyspaces(ctx context.Context, req *vtctldata.GetKeyspacesRequest) (*vtctldata.GetKeyspacesResponse, error)
- func (*UnimplementedVtctldServer) GetSchema(ctx context.Context, req *vtctldata.GetSchemaRequest) (*vtctldata.GetSchemaResponse, error)
- func (*UnimplementedVtctldServer) GetShard(ctx context.Context, req *vtctldata.GetShardRequest) (*vtctldata.GetShardResponse, error)
- func (*UnimplementedVtctldServer) GetSrvKeyspaces(ctx context.Context, req *vtctldata.GetSrvKeyspacesRequest) (*vtctldata.GetSrvKeyspacesResponse, error)
- func (*UnimplementedVtctldServer) GetSrvVSchema(ctx context.Context, req *vtctldata.GetSrvVSchemaRequest) (*vtctldata.GetSrvVSchemaResponse, error)
- func (*UnimplementedVtctldServer) GetTablet(ctx context.Context, req *vtctldata.GetTabletRequest) (*vtctldata.GetTabletResponse, error)
- func (*UnimplementedVtctldServer) GetTablets(ctx context.Context, req *vtctldata.GetTabletsRequest) (*vtctldata.GetTabletsResponse, error)
- func (*UnimplementedVtctldServer) GetVSchema(ctx context.Context, req *vtctldata.GetVSchemaRequest) (*vtctldata.GetVSchemaResponse, error)
- func (*UnimplementedVtctldServer) GetWorkflows(ctx context.Context, req *vtctldata.GetWorkflowsRequest) (*vtctldata.GetWorkflowsResponse, error)
- func (*UnimplementedVtctldServer) InitShardPrimary(ctx context.Context, req *vtctldata.InitShardPrimaryRequest) (*vtctldata.InitShardPrimaryResponse, error)
- func (*UnimplementedVtctldServer) PlannedReparentShard(ctx context.Context, req *vtctldata.PlannedReparentShardRequest) (*vtctldata.PlannedReparentShardResponse, error)
- func (*UnimplementedVtctldServer) RemoveKeyspaceCell(ctx context.Context, req *vtctldata.RemoveKeyspaceCellRequest) (*vtctldata.RemoveKeyspaceCellResponse, error)
- func (*UnimplementedVtctldServer) RemoveShardCell(ctx context.Context, req *vtctldata.RemoveShardCellRequest) (*vtctldata.RemoveShardCellResponse, error)
- func (*UnimplementedVtctldServer) ReparentTablet(ctx context.Context, req *vtctldata.ReparentTabletRequest) (*vtctldata.ReparentTabletResponse, error)
- func (*UnimplementedVtctldServer) ShardReplicationPositions(ctx context.Context, req *vtctldata.ShardReplicationPositionsRequest) (*vtctldata.ShardReplicationPositionsResponse, error)
- func (*UnimplementedVtctldServer) TabletExternallyReparented(ctx context.Context, req *vtctldata.TabletExternallyReparentedRequest) (*vtctldata.TabletExternallyReparentedResponse, error)
- type VtctlClient
- type VtctlServer
- type Vtctl_ExecuteVtctlCommandClient
- type Vtctl_ExecuteVtctlCommandServer
- type VtctldClient
- type VtctldServer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterVtctlServer ¶
func RegisterVtctlServer(s *grpc.Server, srv VtctlServer)
func RegisterVtctldServer ¶ added in v0.9.0
func RegisterVtctldServer(s *grpc.Server, srv VtctldServer)
Types ¶
type UnimplementedVtctlServer ¶
type UnimplementedVtctlServer struct { }
UnimplementedVtctlServer can be embedded to have forward compatible implementations.
func (*UnimplementedVtctlServer) ExecuteVtctlCommand ¶
func (*UnimplementedVtctlServer) ExecuteVtctlCommand(req *vtctldata.ExecuteVtctlCommandRequest, srv Vtctl_ExecuteVtctlCommandServer) error
type UnimplementedVtctldServer ¶ added in v0.9.0
type UnimplementedVtctldServer struct { }
UnimplementedVtctldServer can be embedded to have forward compatible implementations.
func (*UnimplementedVtctldServer) ChangeTabletType ¶ added in v0.10.0
func (*UnimplementedVtctldServer) ChangeTabletType(ctx context.Context, req *vtctldata.ChangeTabletTypeRequest) (*vtctldata.ChangeTabletTypeResponse, error)
func (*UnimplementedVtctldServer) CreateKeyspace ¶ added in v0.10.0
func (*UnimplementedVtctldServer) CreateKeyspace(ctx context.Context, req *vtctldata.CreateKeyspaceRequest) (*vtctldata.CreateKeyspaceResponse, error)
func (*UnimplementedVtctldServer) CreateShard ¶ added in v0.10.0
func (*UnimplementedVtctldServer) CreateShard(ctx context.Context, req *vtctldata.CreateShardRequest) (*vtctldata.CreateShardResponse, error)
func (*UnimplementedVtctldServer) DeleteKeyspace ¶ added in v0.10.0
func (*UnimplementedVtctldServer) DeleteKeyspace(ctx context.Context, req *vtctldata.DeleteKeyspaceRequest) (*vtctldata.DeleteKeyspaceResponse, error)
func (*UnimplementedVtctldServer) DeleteShards ¶ added in v0.10.0
func (*UnimplementedVtctldServer) DeleteShards(ctx context.Context, req *vtctldata.DeleteShardsRequest) (*vtctldata.DeleteShardsResponse, error)
func (*UnimplementedVtctldServer) DeleteTablets ¶ added in v0.10.0
func (*UnimplementedVtctldServer) DeleteTablets(ctx context.Context, req *vtctldata.DeleteTabletsRequest) (*vtctldata.DeleteTabletsResponse, error)
func (*UnimplementedVtctldServer) EmergencyReparentShard ¶ added in v0.10.0
func (*UnimplementedVtctldServer) EmergencyReparentShard(ctx context.Context, req *vtctldata.EmergencyReparentShardRequest) (*vtctldata.EmergencyReparentShardResponse, error)
func (*UnimplementedVtctldServer) FindAllShardsInKeyspace ¶ added in v0.9.0
func (*UnimplementedVtctldServer) FindAllShardsInKeyspace(ctx context.Context, req *vtctldata.FindAllShardsInKeyspaceRequest) (*vtctldata.FindAllShardsInKeyspaceResponse, error)
func (*UnimplementedVtctldServer) GetBackups ¶ added in v0.10.0
func (*UnimplementedVtctldServer) GetBackups(ctx context.Context, req *vtctldata.GetBackupsRequest) (*vtctldata.GetBackupsResponse, error)
func (*UnimplementedVtctldServer) GetCellInfo ¶ added in v0.10.0
func (*UnimplementedVtctldServer) GetCellInfo(ctx context.Context, req *vtctldata.GetCellInfoRequest) (*vtctldata.GetCellInfoResponse, error)
func (*UnimplementedVtctldServer) GetCellInfoNames ¶ added in v0.10.0
func (*UnimplementedVtctldServer) GetCellInfoNames(ctx context.Context, req *vtctldata.GetCellInfoNamesRequest) (*vtctldata.GetCellInfoNamesResponse, error)
func (*UnimplementedVtctldServer) GetCellsAliases ¶ added in v0.10.0
func (*UnimplementedVtctldServer) GetCellsAliases(ctx context.Context, req *vtctldata.GetCellsAliasesRequest) (*vtctldata.GetCellsAliasesResponse, error)
func (*UnimplementedVtctldServer) GetKeyspace ¶ added in v0.9.0
func (*UnimplementedVtctldServer) GetKeyspace(ctx context.Context, req *vtctldata.GetKeyspaceRequest) (*vtctldata.GetKeyspaceResponse, error)
func (*UnimplementedVtctldServer) GetKeyspaces ¶ added in v0.9.0
func (*UnimplementedVtctldServer) GetKeyspaces(ctx context.Context, req *vtctldata.GetKeyspacesRequest) (*vtctldata.GetKeyspacesResponse, error)
func (*UnimplementedVtctldServer) GetSchema ¶ added in v0.10.0
func (*UnimplementedVtctldServer) GetSchema(ctx context.Context, req *vtctldata.GetSchemaRequest) (*vtctldata.GetSchemaResponse, error)
func (*UnimplementedVtctldServer) GetShard ¶ added in v0.10.0
func (*UnimplementedVtctldServer) GetShard(ctx context.Context, req *vtctldata.GetShardRequest) (*vtctldata.GetShardResponse, error)
func (*UnimplementedVtctldServer) GetSrvKeyspaces ¶ added in v0.10.0
func (*UnimplementedVtctldServer) GetSrvKeyspaces(ctx context.Context, req *vtctldata.GetSrvKeyspacesRequest) (*vtctldata.GetSrvKeyspacesResponse, error)
func (*UnimplementedVtctldServer) GetSrvVSchema ¶ added in v0.10.0
func (*UnimplementedVtctldServer) GetSrvVSchema(ctx context.Context, req *vtctldata.GetSrvVSchemaRequest) (*vtctldata.GetSrvVSchemaResponse, error)
func (*UnimplementedVtctldServer) GetTablet ¶ added in v0.10.0
func (*UnimplementedVtctldServer) GetTablet(ctx context.Context, req *vtctldata.GetTabletRequest) (*vtctldata.GetTabletResponse, error)
func (*UnimplementedVtctldServer) GetTablets ¶ added in v0.10.0
func (*UnimplementedVtctldServer) GetTablets(ctx context.Context, req *vtctldata.GetTabletsRequest) (*vtctldata.GetTabletsResponse, error)
func (*UnimplementedVtctldServer) GetVSchema ¶ added in v0.10.0
func (*UnimplementedVtctldServer) GetVSchema(ctx context.Context, req *vtctldata.GetVSchemaRequest) (*vtctldata.GetVSchemaResponse, error)
func (*UnimplementedVtctldServer) GetWorkflows ¶ added in v0.10.0
func (*UnimplementedVtctldServer) GetWorkflows(ctx context.Context, req *vtctldata.GetWorkflowsRequest) (*vtctldata.GetWorkflowsResponse, error)
func (*UnimplementedVtctldServer) InitShardPrimary ¶ added in v0.10.0
func (*UnimplementedVtctldServer) InitShardPrimary(ctx context.Context, req *vtctldata.InitShardPrimaryRequest) (*vtctldata.InitShardPrimaryResponse, error)
func (*UnimplementedVtctldServer) PlannedReparentShard ¶ added in v0.10.0
func (*UnimplementedVtctldServer) PlannedReparentShard(ctx context.Context, req *vtctldata.PlannedReparentShardRequest) (*vtctldata.PlannedReparentShardResponse, error)
func (*UnimplementedVtctldServer) RemoveKeyspaceCell ¶ added in v0.10.0
func (*UnimplementedVtctldServer) RemoveKeyspaceCell(ctx context.Context, req *vtctldata.RemoveKeyspaceCellRequest) (*vtctldata.RemoveKeyspaceCellResponse, error)
func (*UnimplementedVtctldServer) RemoveShardCell ¶ added in v0.10.0
func (*UnimplementedVtctldServer) RemoveShardCell(ctx context.Context, req *vtctldata.RemoveShardCellRequest) (*vtctldata.RemoveShardCellResponse, error)
func (*UnimplementedVtctldServer) ReparentTablet ¶ added in v0.10.0
func (*UnimplementedVtctldServer) ReparentTablet(ctx context.Context, req *vtctldata.ReparentTabletRequest) (*vtctldata.ReparentTabletResponse, error)
func (*UnimplementedVtctldServer) ShardReplicationPositions ¶ added in v0.10.0
func (*UnimplementedVtctldServer) ShardReplicationPositions(ctx context.Context, req *vtctldata.ShardReplicationPositionsRequest) (*vtctldata.ShardReplicationPositionsResponse, error)
func (*UnimplementedVtctldServer) TabletExternallyReparented ¶ added in v0.10.0
func (*UnimplementedVtctldServer) TabletExternallyReparented(ctx context.Context, req *vtctldata.TabletExternallyReparentedRequest) (*vtctldata.TabletExternallyReparentedResponse, error)
type VtctlClient ¶
type VtctlClient interface {
ExecuteVtctlCommand(ctx context.Context, in *vtctldata.ExecuteVtctlCommandRequest, opts ...grpc.CallOption) (Vtctl_ExecuteVtctlCommandClient, error)
}
VtctlClient is the client API for Vtctl service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewVtctlClient ¶
func NewVtctlClient(cc *grpc.ClientConn) VtctlClient
type VtctlServer ¶
type VtctlServer interface {
ExecuteVtctlCommand(*vtctldata.ExecuteVtctlCommandRequest, Vtctl_ExecuteVtctlCommandServer) error
}
VtctlServer is the server API for Vtctl service.
type Vtctl_ExecuteVtctlCommandClient ¶
type Vtctl_ExecuteVtctlCommandClient interface { Recv() (*vtctldata.ExecuteVtctlCommandResponse, error) grpc.ClientStream }
type Vtctl_ExecuteVtctlCommandServer ¶
type Vtctl_ExecuteVtctlCommandServer interface { Send(*vtctldata.ExecuteVtctlCommandResponse) error grpc.ServerStream }
type VtctldClient ¶ added in v0.9.0
type VtctldClient interface { // ChangeTabletType changes the db type for the specified tablet, if possible. // This is used primarily to arrange replicas, and it will not convert a // primary. For that, use InitShardPrimary. // // NOTE: This command automatically updates the serving graph. ChangeTabletType(ctx context.Context, in *vtctldata.ChangeTabletTypeRequest, opts ...grpc.CallOption) (*vtctldata.ChangeTabletTypeResponse, error) // CreateKeyspace creates the specified keyspace in the topology. For a // SNAPSHOT keyspace, the request must specify the name of a base keyspace, // as well as a snapshot time. CreateKeyspace(ctx context.Context, in *vtctldata.CreateKeyspaceRequest, opts ...grpc.CallOption) (*vtctldata.CreateKeyspaceResponse, error) // CreateShard creates the specified shard in the topology. CreateShard(ctx context.Context, in *vtctldata.CreateShardRequest, opts ...grpc.CallOption) (*vtctldata.CreateShardResponse, error) // DeleteKeyspace deletes the specified keyspace from the topology. In // recursive mode, it also recursively deletes all shards in the keyspace. // Otherwise, the keyspace must be empty (have no shards), or DeleteKeyspace // returns an error. DeleteKeyspace(ctx context.Context, in *vtctldata.DeleteKeyspaceRequest, opts ...grpc.CallOption) (*vtctldata.DeleteKeyspaceResponse, error) // DeleteShards deletes the specified shards from the topology. In recursive // mode, it also deletes all tablets belonging to the shard. Otherwise, the // shard must be empty (have no tablets) or DeleteShards returns an error for // that shard. DeleteShards(ctx context.Context, in *vtctldata.DeleteShardsRequest, opts ...grpc.CallOption) (*vtctldata.DeleteShardsResponse, error) // DeleteTablets deletes one or more tablets from the topology. DeleteTablets(ctx context.Context, in *vtctldata.DeleteTabletsRequest, opts ...grpc.CallOption) (*vtctldata.DeleteTabletsResponse, error) // EmergencyReparentShard reparents the shard to the new primary. It assumes // the old primary is dead or otherwise not responding. EmergencyReparentShard(ctx context.Context, in *vtctldata.EmergencyReparentShardRequest, opts ...grpc.CallOption) (*vtctldata.EmergencyReparentShardResponse, error) // FindAllShardsInKeyspace returns a map of shard names to shard references // for a given keyspace. FindAllShardsInKeyspace(ctx context.Context, in *vtctldata.FindAllShardsInKeyspaceRequest, opts ...grpc.CallOption) (*vtctldata.FindAllShardsInKeyspaceResponse, error) // GetBackups returns all the backups for a shard. GetBackups(ctx context.Context, in *vtctldata.GetBackupsRequest, opts ...grpc.CallOption) (*vtctldata.GetBackupsResponse, error) // GetCellInfoNames returns all the cells for which we have a CellInfo object, // meaning we have a topology service registered. GetCellInfoNames(ctx context.Context, in *vtctldata.GetCellInfoNamesRequest, opts ...grpc.CallOption) (*vtctldata.GetCellInfoNamesResponse, error) // GetCellInfo returns the information for a cell. GetCellInfo(ctx context.Context, in *vtctldata.GetCellInfoRequest, opts ...grpc.CallOption) (*vtctldata.GetCellInfoResponse, error) // GetCellsAliases returns a mapping of cell alias to cells identified by that // alias. GetCellsAliases(ctx context.Context, in *vtctldata.GetCellsAliasesRequest, opts ...grpc.CallOption) (*vtctldata.GetCellsAliasesResponse, error) // GetKeyspace reads the given keyspace from the topo and returns it. GetKeyspace(ctx context.Context, in *vtctldata.GetKeyspaceRequest, opts ...grpc.CallOption) (*vtctldata.GetKeyspaceResponse, error) // GetKeyspaces returns the keyspace struct of all keyspaces in the topo. GetKeyspaces(ctx context.Context, in *vtctldata.GetKeyspacesRequest, opts ...grpc.CallOption) (*vtctldata.GetKeyspacesResponse, error) // GetSchema returns the schema for a tablet, or just the schema for the // specified tables in that tablet. GetSchema(ctx context.Context, in *vtctldata.GetSchemaRequest, opts ...grpc.CallOption) (*vtctldata.GetSchemaResponse, error) // GetShard returns information about a shard in the topology. GetShard(ctx context.Context, in *vtctldata.GetShardRequest, opts ...grpc.CallOption) (*vtctldata.GetShardResponse, error) // GetSrvKeyspaces returns the SrvKeyspaces for a keyspace in one or more // cells. GetSrvKeyspaces(ctx context.Context, in *vtctldata.GetSrvKeyspacesRequest, opts ...grpc.CallOption) (*vtctldata.GetSrvKeyspacesResponse, error) // GetSrvVSchema returns a the SrvVSchema for a cell. GetSrvVSchema(ctx context.Context, in *vtctldata.GetSrvVSchemaRequest, opts ...grpc.CallOption) (*vtctldata.GetSrvVSchemaResponse, error) // GetTablet returns information about a tablet. GetTablet(ctx context.Context, in *vtctldata.GetTabletRequest, opts ...grpc.CallOption) (*vtctldata.GetTabletResponse, error) // GetTablets returns tablets, optionally filtered by keyspace and shard. GetTablets(ctx context.Context, in *vtctldata.GetTabletsRequest, opts ...grpc.CallOption) (*vtctldata.GetTabletsResponse, error) // GetVSchema returns the vschema for a keyspace. GetVSchema(ctx context.Context, in *vtctldata.GetVSchemaRequest, opts ...grpc.CallOption) (*vtctldata.GetVSchemaResponse, error) // GetWorkflows returns a list of workflows for the given keyspace. GetWorkflows(ctx context.Context, in *vtctldata.GetWorkflowsRequest, opts ...grpc.CallOption) (*vtctldata.GetWorkflowsResponse, error) // InitShardPrimary sets the initial primary for a shard. Will make all other // tablets in the shard replicas of the provided primary. // // WARNING: This could cause data loss on an already replicating shard. // PlannedReparentShard or EmergencyReparentShard should be used in those // cases instead. InitShardPrimary(ctx context.Context, in *vtctldata.InitShardPrimaryRequest, opts ...grpc.CallOption) (*vtctldata.InitShardPrimaryResponse, error) // PlannedReparentShard reparents the shard to the new primary, or away from // an old primary. Both the old and new primaries need to be reachable and // running. // // **NOTE**: The vtctld will not consider any replicas outside the cell the // current shard primary is in for promotion unless NewPrimary is explicitly // provided in the request. PlannedReparentShard(ctx context.Context, in *vtctldata.PlannedReparentShardRequest, opts ...grpc.CallOption) (*vtctldata.PlannedReparentShardResponse, error) // RemoveKeyspaceCell removes the specified cell from the Cells list for all // shards in the specified keyspace, as well as from the SrvKeyspace for that // keyspace in that cell. RemoveKeyspaceCell(ctx context.Context, in *vtctldata.RemoveKeyspaceCellRequest, opts ...grpc.CallOption) (*vtctldata.RemoveKeyspaceCellResponse, error) // RemoveShardCell removes the specified cell from the specified shard's Cells // list. RemoveShardCell(ctx context.Context, in *vtctldata.RemoveShardCellRequest, opts ...grpc.CallOption) (*vtctldata.RemoveShardCellResponse, error) // ReparentTablet reparents a tablet to the current primary in the shard. This // only works if the current replica position matches the last known reparent // action. ReparentTablet(ctx context.Context, in *vtctldata.ReparentTabletRequest, opts ...grpc.CallOption) (*vtctldata.ReparentTabletResponse, error) // ShardReplicationPositions returns the replication position of each tablet // in a shard. This RPC makes a best-effort to return partial results. For // example, if one tablet in the shard graph is unreachable, then // ShardReplicationPositions will return non-error, and include valid results // for the reachable tablets. ShardReplicationPositions(ctx context.Context, in *vtctldata.ShardReplicationPositionsRequest, opts ...grpc.CallOption) (*vtctldata.ShardReplicationPositionsResponse, error) // TabletExternallyReparented changes metadata in the topology server to // acknowledge a shard primary change performed by an external tool (e.g. // orchestrator). // // See the Reparenting guide for more information: // https://vitess.io/docs/user-guides/configuration-advanced/reparenting/#external-reparenting. TabletExternallyReparented(ctx context.Context, in *vtctldata.TabletExternallyReparentedRequest, opts ...grpc.CallOption) (*vtctldata.TabletExternallyReparentedResponse, error) }
VtctldClient is the client API for Vtctld service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewVtctldClient ¶ added in v0.9.0
func NewVtctldClient(cc *grpc.ClientConn) VtctldClient
type VtctldServer ¶ added in v0.9.0
type VtctldServer interface { // ChangeTabletType changes the db type for the specified tablet, if possible. // This is used primarily to arrange replicas, and it will not convert a // primary. For that, use InitShardPrimary. // // NOTE: This command automatically updates the serving graph. ChangeTabletType(context.Context, *vtctldata.ChangeTabletTypeRequest) (*vtctldata.ChangeTabletTypeResponse, error) // CreateKeyspace creates the specified keyspace in the topology. For a // SNAPSHOT keyspace, the request must specify the name of a base keyspace, // as well as a snapshot time. CreateKeyspace(context.Context, *vtctldata.CreateKeyspaceRequest) (*vtctldata.CreateKeyspaceResponse, error) // CreateShard creates the specified shard in the topology. CreateShard(context.Context, *vtctldata.CreateShardRequest) (*vtctldata.CreateShardResponse, error) // DeleteKeyspace deletes the specified keyspace from the topology. In // recursive mode, it also recursively deletes all shards in the keyspace. // Otherwise, the keyspace must be empty (have no shards), or DeleteKeyspace // returns an error. DeleteKeyspace(context.Context, *vtctldata.DeleteKeyspaceRequest) (*vtctldata.DeleteKeyspaceResponse, error) // DeleteShards deletes the specified shards from the topology. In recursive // mode, it also deletes all tablets belonging to the shard. Otherwise, the // shard must be empty (have no tablets) or DeleteShards returns an error for // that shard. DeleteShards(context.Context, *vtctldata.DeleteShardsRequest) (*vtctldata.DeleteShardsResponse, error) // DeleteTablets deletes one or more tablets from the topology. DeleteTablets(context.Context, *vtctldata.DeleteTabletsRequest) (*vtctldata.DeleteTabletsResponse, error) // EmergencyReparentShard reparents the shard to the new primary. It assumes // the old primary is dead or otherwise not responding. EmergencyReparentShard(context.Context, *vtctldata.EmergencyReparentShardRequest) (*vtctldata.EmergencyReparentShardResponse, error) // FindAllShardsInKeyspace returns a map of shard names to shard references // for a given keyspace. FindAllShardsInKeyspace(context.Context, *vtctldata.FindAllShardsInKeyspaceRequest) (*vtctldata.FindAllShardsInKeyspaceResponse, error) // GetBackups returns all the backups for a shard. GetBackups(context.Context, *vtctldata.GetBackupsRequest) (*vtctldata.GetBackupsResponse, error) // GetCellInfoNames returns all the cells for which we have a CellInfo object, // meaning we have a topology service registered. GetCellInfoNames(context.Context, *vtctldata.GetCellInfoNamesRequest) (*vtctldata.GetCellInfoNamesResponse, error) // GetCellInfo returns the information for a cell. GetCellInfo(context.Context, *vtctldata.GetCellInfoRequest) (*vtctldata.GetCellInfoResponse, error) // GetCellsAliases returns a mapping of cell alias to cells identified by that // alias. GetCellsAliases(context.Context, *vtctldata.GetCellsAliasesRequest) (*vtctldata.GetCellsAliasesResponse, error) // GetKeyspace reads the given keyspace from the topo and returns it. GetKeyspace(context.Context, *vtctldata.GetKeyspaceRequest) (*vtctldata.GetKeyspaceResponse, error) // GetKeyspaces returns the keyspace struct of all keyspaces in the topo. GetKeyspaces(context.Context, *vtctldata.GetKeyspacesRequest) (*vtctldata.GetKeyspacesResponse, error) // GetSchema returns the schema for a tablet, or just the schema for the // specified tables in that tablet. GetSchema(context.Context, *vtctldata.GetSchemaRequest) (*vtctldata.GetSchemaResponse, error) // GetShard returns information about a shard in the topology. GetShard(context.Context, *vtctldata.GetShardRequest) (*vtctldata.GetShardResponse, error) // GetSrvKeyspaces returns the SrvKeyspaces for a keyspace in one or more // cells. GetSrvKeyspaces(context.Context, *vtctldata.GetSrvKeyspacesRequest) (*vtctldata.GetSrvKeyspacesResponse, error) // GetSrvVSchema returns a the SrvVSchema for a cell. GetSrvVSchema(context.Context, *vtctldata.GetSrvVSchemaRequest) (*vtctldata.GetSrvVSchemaResponse, error) // GetTablet returns information about a tablet. GetTablet(context.Context, *vtctldata.GetTabletRequest) (*vtctldata.GetTabletResponse, error) // GetTablets returns tablets, optionally filtered by keyspace and shard. GetTablets(context.Context, *vtctldata.GetTabletsRequest) (*vtctldata.GetTabletsResponse, error) // GetVSchema returns the vschema for a keyspace. GetVSchema(context.Context, *vtctldata.GetVSchemaRequest) (*vtctldata.GetVSchemaResponse, error) // GetWorkflows returns a list of workflows for the given keyspace. GetWorkflows(context.Context, *vtctldata.GetWorkflowsRequest) (*vtctldata.GetWorkflowsResponse, error) // InitShardPrimary sets the initial primary for a shard. Will make all other // tablets in the shard replicas of the provided primary. // // WARNING: This could cause data loss on an already replicating shard. // PlannedReparentShard or EmergencyReparentShard should be used in those // cases instead. InitShardPrimary(context.Context, *vtctldata.InitShardPrimaryRequest) (*vtctldata.InitShardPrimaryResponse, error) // PlannedReparentShard reparents the shard to the new primary, or away from // an old primary. Both the old and new primaries need to be reachable and // running. // // **NOTE**: The vtctld will not consider any replicas outside the cell the // current shard primary is in for promotion unless NewPrimary is explicitly // provided in the request. PlannedReparentShard(context.Context, *vtctldata.PlannedReparentShardRequest) (*vtctldata.PlannedReparentShardResponse, error) // RemoveKeyspaceCell removes the specified cell from the Cells list for all // shards in the specified keyspace, as well as from the SrvKeyspace for that // keyspace in that cell. RemoveKeyspaceCell(context.Context, *vtctldata.RemoveKeyspaceCellRequest) (*vtctldata.RemoveKeyspaceCellResponse, error) // RemoveShardCell removes the specified cell from the specified shard's Cells // list. RemoveShardCell(context.Context, *vtctldata.RemoveShardCellRequest) (*vtctldata.RemoveShardCellResponse, error) // ReparentTablet reparents a tablet to the current primary in the shard. This // only works if the current replica position matches the last known reparent // action. ReparentTablet(context.Context, *vtctldata.ReparentTabletRequest) (*vtctldata.ReparentTabletResponse, error) // ShardReplicationPositions returns the replication position of each tablet // in a shard. This RPC makes a best-effort to return partial results. For // example, if one tablet in the shard graph is unreachable, then // ShardReplicationPositions will return non-error, and include valid results // for the reachable tablets. ShardReplicationPositions(context.Context, *vtctldata.ShardReplicationPositionsRequest) (*vtctldata.ShardReplicationPositionsResponse, error) // TabletExternallyReparented changes metadata in the topology server to // acknowledge a shard primary change performed by an external tool (e.g. // orchestrator). // // See the Reparenting guide for more information: // https://vitess.io/docs/user-guides/configuration-advanced/reparenting/#external-reparenting. TabletExternallyReparented(context.Context, *vtctldata.TabletExternallyReparentedRequest) (*vtctldata.TabletExternallyReparentedResponse, error) }
VtctldServer is the server API for Vtctld service.