vtadminv16grpc

package
v1.3.0-20231211191728-... Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: unknown License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	VTAdmin_CreateKeyspace_FullMethodName                 = "/vitess.vtadmin.v16.VTAdmin/CreateKeyspace"
	VTAdmin_CreateShard_FullMethodName                    = "/vitess.vtadmin.v16.VTAdmin/CreateShard"
	VTAdmin_DeleteKeyspace_FullMethodName                 = "/vitess.vtadmin.v16.VTAdmin/DeleteKeyspace"
	VTAdmin_DeleteShards_FullMethodName                   = "/vitess.vtadmin.v16.VTAdmin/DeleteShards"
	VTAdmin_DeleteTablet_FullMethodName                   = "/vitess.vtadmin.v16.VTAdmin/DeleteTablet"
	VTAdmin_EmergencyFailoverShard_FullMethodName         = "/vitess.vtadmin.v16.VTAdmin/EmergencyFailoverShard"
	VTAdmin_FindSchema_FullMethodName                     = "/vitess.vtadmin.v16.VTAdmin/FindSchema"
	VTAdmin_GetBackups_FullMethodName                     = "/vitess.vtadmin.v16.VTAdmin/GetBackups"
	VTAdmin_GetCellInfos_FullMethodName                   = "/vitess.vtadmin.v16.VTAdmin/GetCellInfos"
	VTAdmin_GetCellsAliases_FullMethodName                = "/vitess.vtadmin.v16.VTAdmin/GetCellsAliases"
	VTAdmin_GetClusters_FullMethodName                    = "/vitess.vtadmin.v16.VTAdmin/GetClusters"
	VTAdmin_GetFullStatus_FullMethodName                  = "/vitess.vtadmin.v16.VTAdmin/GetFullStatus"
	VTAdmin_GetGates_FullMethodName                       = "/vitess.vtadmin.v16.VTAdmin/GetGates"
	VTAdmin_GetKeyspace_FullMethodName                    = "/vitess.vtadmin.v16.VTAdmin/GetKeyspace"
	VTAdmin_GetKeyspaces_FullMethodName                   = "/vitess.vtadmin.v16.VTAdmin/GetKeyspaces"
	VTAdmin_GetSchema_FullMethodName                      = "/vitess.vtadmin.v16.VTAdmin/GetSchema"
	VTAdmin_GetSchemas_FullMethodName                     = "/vitess.vtadmin.v16.VTAdmin/GetSchemas"
	VTAdmin_GetShardReplicationPositions_FullMethodName   = "/vitess.vtadmin.v16.VTAdmin/GetShardReplicationPositions"
	VTAdmin_GetSrvVSchema_FullMethodName                  = "/vitess.vtadmin.v16.VTAdmin/GetSrvVSchema"
	VTAdmin_GetSrvVSchemas_FullMethodName                 = "/vitess.vtadmin.v16.VTAdmin/GetSrvVSchemas"
	VTAdmin_GetTablet_FullMethodName                      = "/vitess.vtadmin.v16.VTAdmin/GetTablet"
	VTAdmin_GetTablets_FullMethodName                     = "/vitess.vtadmin.v16.VTAdmin/GetTablets"
	VTAdmin_GetTopologyPath_FullMethodName                = "/vitess.vtadmin.v16.VTAdmin/GetTopologyPath"
	VTAdmin_GetVSchema_FullMethodName                     = "/vitess.vtadmin.v16.VTAdmin/GetVSchema"
	VTAdmin_GetVSchemas_FullMethodName                    = "/vitess.vtadmin.v16.VTAdmin/GetVSchemas"
	VTAdmin_GetVtctlds_FullMethodName                     = "/vitess.vtadmin.v16.VTAdmin/GetVtctlds"
	VTAdmin_GetWorkflow_FullMethodName                    = "/vitess.vtadmin.v16.VTAdmin/GetWorkflow"
	VTAdmin_GetWorkflows_FullMethodName                   = "/vitess.vtadmin.v16.VTAdmin/GetWorkflows"
	VTAdmin_PingTablet_FullMethodName                     = "/vitess.vtadmin.v16.VTAdmin/PingTablet"
	VTAdmin_PlannedFailoverShard_FullMethodName           = "/vitess.vtadmin.v16.VTAdmin/PlannedFailoverShard"
	VTAdmin_RebuildKeyspaceGraph_FullMethodName           = "/vitess.vtadmin.v16.VTAdmin/RebuildKeyspaceGraph"
	VTAdmin_RefreshState_FullMethodName                   = "/vitess.vtadmin.v16.VTAdmin/RefreshState"
	VTAdmin_RefreshTabletReplicationSource_FullMethodName = "/vitess.vtadmin.v16.VTAdmin/RefreshTabletReplicationSource"
	VTAdmin_ReloadSchemas_FullMethodName                  = "/vitess.vtadmin.v16.VTAdmin/ReloadSchemas"
	VTAdmin_ReloadSchemaShard_FullMethodName              = "/vitess.vtadmin.v16.VTAdmin/ReloadSchemaShard"
	VTAdmin_RemoveKeyspaceCell_FullMethodName             = "/vitess.vtadmin.v16.VTAdmin/RemoveKeyspaceCell"
	VTAdmin_RunHealthCheck_FullMethodName                 = "/vitess.vtadmin.v16.VTAdmin/RunHealthCheck"
	VTAdmin_SetReadOnly_FullMethodName                    = "/vitess.vtadmin.v16.VTAdmin/SetReadOnly"
	VTAdmin_SetReadWrite_FullMethodName                   = "/vitess.vtadmin.v16.VTAdmin/SetReadWrite"
	VTAdmin_StartReplication_FullMethodName               = "/vitess.vtadmin.v16.VTAdmin/StartReplication"
	VTAdmin_StopReplication_FullMethodName                = "/vitess.vtadmin.v16.VTAdmin/StopReplication"
	VTAdmin_TabletExternallyPromoted_FullMethodName       = "/vitess.vtadmin.v16.VTAdmin/TabletExternallyPromoted"
	VTAdmin_Validate_FullMethodName                       = "/vitess.vtadmin.v16.VTAdmin/Validate"
	VTAdmin_ValidateKeyspace_FullMethodName               = "/vitess.vtadmin.v16.VTAdmin/ValidateKeyspace"
	VTAdmin_ValidateSchemaKeyspace_FullMethodName         = "/vitess.vtadmin.v16.VTAdmin/ValidateSchemaKeyspace"
	VTAdmin_ValidateShard_FullMethodName                  = "/vitess.vtadmin.v16.VTAdmin/ValidateShard"
	VTAdmin_ValidateVersionKeyspace_FullMethodName        = "/vitess.vtadmin.v16.VTAdmin/ValidateVersionKeyspace"
	VTAdmin_ValidateVersionShard_FullMethodName           = "/vitess.vtadmin.v16.VTAdmin/ValidateVersionShard"
	VTAdmin_VTExplain_FullMethodName                      = "/vitess.vtadmin.v16.VTAdmin/VTExplain"
)

Variables

View Source
var VTAdmin_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "vitess.vtadmin.v16.VTAdmin",
	HandlerType: (*VTAdminServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateKeyspace",
			Handler:    _VTAdmin_CreateKeyspace_Handler,
		},
		{
			MethodName: "CreateShard",
			Handler:    _VTAdmin_CreateShard_Handler,
		},
		{
			MethodName: "DeleteKeyspace",
			Handler:    _VTAdmin_DeleteKeyspace_Handler,
		},
		{
			MethodName: "DeleteShards",
			Handler:    _VTAdmin_DeleteShards_Handler,
		},
		{
			MethodName: "DeleteTablet",
			Handler:    _VTAdmin_DeleteTablet_Handler,
		},
		{
			MethodName: "EmergencyFailoverShard",
			Handler:    _VTAdmin_EmergencyFailoverShard_Handler,
		},
		{
			MethodName: "FindSchema",
			Handler:    _VTAdmin_FindSchema_Handler,
		},
		{
			MethodName: "GetBackups",
			Handler:    _VTAdmin_GetBackups_Handler,
		},
		{
			MethodName: "GetCellInfos",
			Handler:    _VTAdmin_GetCellInfos_Handler,
		},
		{
			MethodName: "GetCellsAliases",
			Handler:    _VTAdmin_GetCellsAliases_Handler,
		},
		{
			MethodName: "GetClusters",
			Handler:    _VTAdmin_GetClusters_Handler,
		},
		{
			MethodName: "GetFullStatus",
			Handler:    _VTAdmin_GetFullStatus_Handler,
		},
		{
			MethodName: "GetGates",
			Handler:    _VTAdmin_GetGates_Handler,
		},
		{
			MethodName: "GetKeyspace",
			Handler:    _VTAdmin_GetKeyspace_Handler,
		},
		{
			MethodName: "GetKeyspaces",
			Handler:    _VTAdmin_GetKeyspaces_Handler,
		},
		{
			MethodName: "GetSchema",
			Handler:    _VTAdmin_GetSchema_Handler,
		},
		{
			MethodName: "GetSchemas",
			Handler:    _VTAdmin_GetSchemas_Handler,
		},
		{
			MethodName: "GetShardReplicationPositions",
			Handler:    _VTAdmin_GetShardReplicationPositions_Handler,
		},
		{
			MethodName: "GetSrvVSchema",
			Handler:    _VTAdmin_GetSrvVSchema_Handler,
		},
		{
			MethodName: "GetSrvVSchemas",
			Handler:    _VTAdmin_GetSrvVSchemas_Handler,
		},
		{
			MethodName: "GetTablet",
			Handler:    _VTAdmin_GetTablet_Handler,
		},
		{
			MethodName: "GetTablets",
			Handler:    _VTAdmin_GetTablets_Handler,
		},
		{
			MethodName: "GetTopologyPath",
			Handler:    _VTAdmin_GetTopologyPath_Handler,
		},
		{
			MethodName: "GetVSchema",
			Handler:    _VTAdmin_GetVSchema_Handler,
		},
		{
			MethodName: "GetVSchemas",
			Handler:    _VTAdmin_GetVSchemas_Handler,
		},
		{
			MethodName: "GetVtctlds",
			Handler:    _VTAdmin_GetVtctlds_Handler,
		},
		{
			MethodName: "GetWorkflow",
			Handler:    _VTAdmin_GetWorkflow_Handler,
		},
		{
			MethodName: "GetWorkflows",
			Handler:    _VTAdmin_GetWorkflows_Handler,
		},
		{
			MethodName: "PingTablet",
			Handler:    _VTAdmin_PingTablet_Handler,
		},
		{
			MethodName: "PlannedFailoverShard",
			Handler:    _VTAdmin_PlannedFailoverShard_Handler,
		},
		{
			MethodName: "RebuildKeyspaceGraph",
			Handler:    _VTAdmin_RebuildKeyspaceGraph_Handler,
		},
		{
			MethodName: "RefreshState",
			Handler:    _VTAdmin_RefreshState_Handler,
		},
		{
			MethodName: "RefreshTabletReplicationSource",
			Handler:    _VTAdmin_RefreshTabletReplicationSource_Handler,
		},
		{
			MethodName: "ReloadSchemas",
			Handler:    _VTAdmin_ReloadSchemas_Handler,
		},
		{
			MethodName: "ReloadSchemaShard",
			Handler:    _VTAdmin_ReloadSchemaShard_Handler,
		},
		{
			MethodName: "RemoveKeyspaceCell",
			Handler:    _VTAdmin_RemoveKeyspaceCell_Handler,
		},
		{
			MethodName: "RunHealthCheck",
			Handler:    _VTAdmin_RunHealthCheck_Handler,
		},
		{
			MethodName: "SetReadOnly",
			Handler:    _VTAdmin_SetReadOnly_Handler,
		},
		{
			MethodName: "SetReadWrite",
			Handler:    _VTAdmin_SetReadWrite_Handler,
		},
		{
			MethodName: "StartReplication",
			Handler:    _VTAdmin_StartReplication_Handler,
		},
		{
			MethodName: "StopReplication",
			Handler:    _VTAdmin_StopReplication_Handler,
		},
		{
			MethodName: "TabletExternallyPromoted",
			Handler:    _VTAdmin_TabletExternallyPromoted_Handler,
		},
		{
			MethodName: "Validate",
			Handler:    _VTAdmin_Validate_Handler,
		},
		{
			MethodName: "ValidateKeyspace",
			Handler:    _VTAdmin_ValidateKeyspace_Handler,
		},
		{
			MethodName: "ValidateSchemaKeyspace",
			Handler:    _VTAdmin_ValidateSchemaKeyspace_Handler,
		},
		{
			MethodName: "ValidateShard",
			Handler:    _VTAdmin_ValidateShard_Handler,
		},
		{
			MethodName: "ValidateVersionKeyspace",
			Handler:    _VTAdmin_ValidateVersionKeyspace_Handler,
		},
		{
			MethodName: "ValidateVersionShard",
			Handler:    _VTAdmin_ValidateVersionShard_Handler,
		},
		{
			MethodName: "VTExplain",
			Handler:    _VTAdmin_VTExplain_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "vitess/vtadmin/v16/vtadmin.proto",
}

VTAdmin_ServiceDesc is the grpc.ServiceDesc for VTAdmin service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterVTAdminServer

func RegisterVTAdminServer(s grpc.ServiceRegistrar, srv VTAdminServer)

Types

type UnimplementedVTAdminServer

type UnimplementedVTAdminServer struct {
}

UnimplementedVTAdminServer should be embedded to have forward compatible implementations.

func (UnimplementedVTAdminServer) CreateKeyspace

func (UnimplementedVTAdminServer) CreateShard

func (UnimplementedVTAdminServer) DeleteKeyspace

func (UnimplementedVTAdminServer) DeleteShards

func (UnimplementedVTAdminServer) DeleteTablet

func (UnimplementedVTAdminServer) EmergencyFailoverShard

func (UnimplementedVTAdminServer) FindSchema

func (UnimplementedVTAdminServer) GetBackups

func (UnimplementedVTAdminServer) GetCellInfos

func (UnimplementedVTAdminServer) GetCellsAliases

func (UnimplementedVTAdminServer) GetClusters

func (UnimplementedVTAdminServer) GetFullStatus

func (UnimplementedVTAdminServer) GetGates

func (UnimplementedVTAdminServer) GetKeyspace

func (UnimplementedVTAdminServer) GetKeyspaces

func (UnimplementedVTAdminServer) GetSchema

func (UnimplementedVTAdminServer) GetSchemas

func (UnimplementedVTAdminServer) GetShardReplicationPositions

func (UnimplementedVTAdminServer) GetSrvVSchema

func (UnimplementedVTAdminServer) GetSrvVSchemas

func (UnimplementedVTAdminServer) GetTablet

func (UnimplementedVTAdminServer) GetTablets

func (UnimplementedVTAdminServer) GetTopologyPath

func (UnimplementedVTAdminServer) GetVSchema

func (UnimplementedVTAdminServer) GetVSchemas

func (UnimplementedVTAdminServer) GetVtctlds

func (UnimplementedVTAdminServer) GetWorkflow

func (UnimplementedVTAdminServer) GetWorkflows

func (UnimplementedVTAdminServer) PingTablet

func (UnimplementedVTAdminServer) PlannedFailoverShard

func (UnimplementedVTAdminServer) RebuildKeyspaceGraph

func (UnimplementedVTAdminServer) RefreshState

func (UnimplementedVTAdminServer) RefreshTabletReplicationSource

func (UnimplementedVTAdminServer) ReloadSchemaShard

func (UnimplementedVTAdminServer) ReloadSchemas

func (UnimplementedVTAdminServer) RemoveKeyspaceCell

func (UnimplementedVTAdminServer) RunHealthCheck

func (UnimplementedVTAdminServer) SetReadOnly

func (UnimplementedVTAdminServer) SetReadWrite

func (UnimplementedVTAdminServer) StartReplication

func (UnimplementedVTAdminServer) StopReplication

func (UnimplementedVTAdminServer) TabletExternallyPromoted

func (UnimplementedVTAdminServer) VTExplain

func (UnimplementedVTAdminServer) Validate

func (UnimplementedVTAdminServer) ValidateKeyspace

func (UnimplementedVTAdminServer) ValidateSchemaKeyspace

func (UnimplementedVTAdminServer) ValidateShard

func (UnimplementedVTAdminServer) ValidateVersionKeyspace

func (UnimplementedVTAdminServer) ValidateVersionShard

type UnsafeVTAdminServer

type UnsafeVTAdminServer interface {
	// contains filtered or unexported methods
}

UnsafeVTAdminServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to VTAdminServer will result in compilation errors.

type VTAdminClient

type VTAdminClient interface {
	// CreateKeyspace creates a new keyspace in the given cluster.
	CreateKeyspace(ctx context.Context, in *v16.CreateKeyspaceRequest, opts ...grpc.CallOption) (*v16.CreateKeyspaceResponse, error)
	// CreateShard creates a new shard in the given cluster and keyspace.
	CreateShard(ctx context.Context, in *v16.CreateShardRequest, opts ...grpc.CallOption) (*v161.CreateShardResponse, error)
	// DeleteKeyspace deletes a keyspace in the given cluster.
	DeleteKeyspace(ctx context.Context, in *v16.DeleteKeyspaceRequest, opts ...grpc.CallOption) (*v161.DeleteKeyspaceResponse, error)
	// DeleteShard deletes one or more shards in the given cluster and keyspace.
	DeleteShards(ctx context.Context, in *v16.DeleteShardsRequest, opts ...grpc.CallOption) (*v161.DeleteShardsResponse, error)
	// DeleteTablet deletes a tablet from the topology
	DeleteTablet(ctx context.Context, in *v16.DeleteTabletRequest, opts ...grpc.CallOption) (*v16.DeleteTabletResponse, error)
	// EmergencyFailoverShard fails over a shard to a new primary. It assumes
	// the old primary is dead or otherwise not responding.
	EmergencyFailoverShard(ctx context.Context, in *v16.EmergencyFailoverShardRequest, opts ...grpc.CallOption) (*v16.EmergencyFailoverShardResponse, error)
	// FindSchema returns a single Schema that matches the provided table name
	// across all specified clusters IDs. Not specifying a set of cluster IDs
	// causes the search to span all configured clusters.
	//
	// An error occurs if either no table exists across any of the clusters with
	// the specified table name, or if multiple tables exist with that name.
	FindSchema(ctx context.Context, in *v16.FindSchemaRequest, opts ...grpc.CallOption) (*v16.Schema, error)
	// GetBackups returns backups grouped by cluster.
	GetBackups(ctx context.Context, in *v16.GetBackupsRequest, opts ...grpc.CallOption) (*v16.GetBackupsResponse, error)
	// GetCellInfos returns the CellInfo objects for the specified clusters.
	//
	// Callers may optionally restrict the set of CellInfos, or restrict the
	// response to include only cell names.
	GetCellInfos(ctx context.Context, in *v16.GetCellInfosRequest, opts ...grpc.CallOption) (*v16.GetCellInfosResponse, error)
	// GetCellsAliases returns the CellsAliases data for the specified clusters.
	GetCellsAliases(ctx context.Context, in *v16.GetCellsAliasesRequest, opts ...grpc.CallOption) (*v16.GetCellsAliasesResponse, error)
	// GetClusters returns all configured clusters.
	GetClusters(ctx context.Context, in *v16.GetClustersRequest, opts ...grpc.CallOption) (*v16.GetClustersResponse, error)
	// GetFullStatus returns the full status of MySQL including the replication information, semi-sync information, GTID information among others
	GetFullStatus(ctx context.Context, in *v16.GetFullStatusRequest, opts ...grpc.CallOption) (*v161.GetFullStatusResponse, error)
	// GetGates returns all gates across all the specified clusters.
	GetGates(ctx context.Context, in *v16.GetGatesRequest, opts ...grpc.CallOption) (*v16.GetGatesResponse, error)
	// GetKeyspace returns a keyspace by name in the specified cluster.
	GetKeyspace(ctx context.Context, in *v16.GetKeyspaceRequest, opts ...grpc.CallOption) (*v16.Keyspace, error)
	// GetKeyspaces returns all keyspaces across the specified clusters.
	GetKeyspaces(ctx context.Context, in *v16.GetKeyspacesRequest, opts ...grpc.CallOption) (*v16.GetKeyspacesResponse, error)
	// GetSchema returns the schema for the specified (cluster, keyspace, table)
	// tuple.
	GetSchema(ctx context.Context, in *v16.GetSchemaRequest, opts ...grpc.CallOption) (*v16.Schema, error)
	// GetSchemas returns all schemas across the specified clusters.
	GetSchemas(ctx context.Context, in *v16.GetSchemasRequest, opts ...grpc.CallOption) (*v16.GetSchemasResponse, error)
	// GetShardReplicationPositions returns shard replication positions grouped
	// by cluster.
	GetShardReplicationPositions(ctx context.Context, in *v16.GetShardReplicationPositionsRequest, opts ...grpc.CallOption) (*v16.GetShardReplicationPositionsResponse, error)
	// GetSrvVSchema returns the SrvVSchema for the given cluster and cell.
	GetSrvVSchema(ctx context.Context, in *v16.GetSrvVSchemaRequest, opts ...grpc.CallOption) (*v16.SrvVSchema, error)
	// GetSrvVSchemas returns all SrvVSchemas across all (or specified) clusters
	// and cells.
	GetSrvVSchemas(ctx context.Context, in *v16.GetSrvVSchemasRequest, opts ...grpc.CallOption) (*v16.GetSrvVSchemasResponse, error)
	// GetTablet looks up a tablet by hostname across all clusters and returns
	// the result.
	GetTablet(ctx context.Context, in *v16.GetTabletRequest, opts ...grpc.CallOption) (*v16.Tablet, error)
	// GetTablets returns all tablets across all the specified clusters.
	GetTablets(ctx context.Context, in *v16.GetTabletsRequest, opts ...grpc.CallOption) (*v16.GetTabletsResponse, error)
	// GetTopologyPath returns the cell located at the specified path in the topology server.
	GetTopologyPath(ctx context.Context, in *v16.GetTopologyPathRequest, opts ...grpc.CallOption) (*v161.GetTopologyPathResponse, error)
	// GetVSchema returns a VSchema for the specified keyspace in the specified
	// cluster.
	GetVSchema(ctx context.Context, in *v16.GetVSchemaRequest, opts ...grpc.CallOption) (*v16.VSchema, error)
	// GetVSchemas returns the VSchemas for all specified clusters.
	GetVSchemas(ctx context.Context, in *v16.GetVSchemasRequest, opts ...grpc.CallOption) (*v16.GetVSchemasResponse, error)
	// GetVtctlds returns the Vtctlds for all specified clusters.
	GetVtctlds(ctx context.Context, in *v16.GetVtctldsRequest, opts ...grpc.CallOption) (*v16.GetVtctldsResponse, error)
	// GetWorkflow returns a single Workflow for a given cluster, keyspace, and
	// workflow name.
	GetWorkflow(ctx context.Context, in *v16.GetWorkflowRequest, opts ...grpc.CallOption) (*v16.Workflow, error)
	// GetWorkflows returns the Workflows for all specified clusters.
	GetWorkflows(ctx context.Context, in *v16.GetWorkflowsRequest, opts ...grpc.CallOption) (*v16.GetWorkflowsResponse, error)
	// PingTablet checks that the specified tablet is awake and responding to
	// RPCs. This command can be blocked by other in-flight operations.
	PingTablet(ctx context.Context, in *v16.PingTabletRequest, opts ...grpc.CallOption) (*v16.PingTabletResponse, error)
	// PlannedFailoverShard fails over the shard to a new primary, or away from
	// an old primary. Both the old and new primaries must be reachable and
	// running.
	//
	// NOTE: A planned failover will not consider replicas outside the current
	// shard primary's cell as promotion candidates unless NewPrimary is
	// explicitly provided in the request.
	PlannedFailoverShard(ctx context.Context, in *v16.PlannedFailoverShardRequest, opts ...grpc.CallOption) (*v16.PlannedFailoverShardResponse, error)
	// RebuildKeyspaceGraph rebuilds the serving data for a keyspace.
	RebuildKeyspaceGraph(ctx context.Context, in *v16.RebuildKeyspaceGraphRequest, opts ...grpc.CallOption) (*v16.RebuildKeyspaceGraphResponse, error)
	// RefreshState reloads the tablet record on the specified tablet.
	RefreshState(ctx context.Context, in *v16.RefreshStateRequest, opts ...grpc.CallOption) (*v16.RefreshStateResponse, error)
	// RefreshTabletReplicationSource performs a `CHANGE REPLICATION SOURCE TO`
	// on a tablet to replicate from the current primary in the shard.
	RefreshTabletReplicationSource(ctx context.Context, in *v16.RefreshTabletReplicationSourceRequest, opts ...grpc.CallOption) (*v16.RefreshTabletReplicationSourceResponse, error)
	// ReloadSchemas reloads the schema definition across keyspaces, shards, or
	// tablets in one or more clusters, depending on the request fields (see
	// ReloadSchemasRequest for details).
	ReloadSchemas(ctx context.Context, in *v16.ReloadSchemasRequest, opts ...grpc.CallOption) (*v16.ReloadSchemasResponse, error)
	// ReloadSchemaShard reloads the schema on all tablets in a shard. This is done on a best-effort basis.
	ReloadSchemaShard(ctx context.Context, in *v16.ReloadSchemaShardRequest, opts ...grpc.CallOption) (*v16.ReloadSchemaShardResponse, error)
	// RemoveKeyspaceCell removes the cell from the Cells list for all shards in the keyspace, and the SrvKeyspace for that keyspace in that cell.
	RemoveKeyspaceCell(ctx context.Context, in *v16.RemoveKeyspaceCellRequest, opts ...grpc.CallOption) (*v16.RemoveKeyspaceCellResponse, error)
	// RunHealthCheck runs a healthcheck on the tablet.
	RunHealthCheck(ctx context.Context, in *v16.RunHealthCheckRequest, opts ...grpc.CallOption) (*v16.RunHealthCheckResponse, error)
	// SetReadOnly sets the tablet to read-only mode.
	SetReadOnly(ctx context.Context, in *v16.SetReadOnlyRequest, opts ...grpc.CallOption) (*v16.SetReadOnlyResponse, error)
	// SetReadWrite sets the tablet to read-write mode.
	SetReadWrite(ctx context.Context, in *v16.SetReadWriteRequest, opts ...grpc.CallOption) (*v16.SetReadWriteResponse, error)
	// StartReplication runs the underlying database command to start
	// replication on a tablet.
	StartReplication(ctx context.Context, in *v16.StartReplicationRequest, opts ...grpc.CallOption) (*v16.StartReplicationResponse, error)
	// StopReplication runs the underlying database command to stop replication
	// on a tablet
	StopReplication(ctx context.Context, in *v16.StopReplicationRequest, opts ...grpc.CallOption) (*v16.StopReplicationResponse, error)
	// TabletExternallyPromoted updates the metadata in a cluster's topology
	// 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.
	//
	// * "orchestrator" here refers to external orchestrator, not the newer,
	// Vitess-aware orchestrator, VTOrc.
	TabletExternallyPromoted(ctx context.Context, in *v16.TabletExternallyPromotedRequest, opts ...grpc.CallOption) (*v16.TabletExternallyPromotedResponse, error)
	// Validate validates all nodes in a cluster that are reachable from the global replication graph,
	// as well as all tablets in discoverable cells, are consistent
	Validate(ctx context.Context, in *v16.ValidateRequest, opts ...grpc.CallOption) (*v161.ValidateResponse, error)
	// ValidateKeyspace validates that all nodes reachable from the specified
	// keyspace are consistent.
	ValidateKeyspace(ctx context.Context, in *v16.ValidateKeyspaceRequest, opts ...grpc.CallOption) (*v161.ValidateKeyspaceResponse, error)
	// ValidateSchemaKeyspace validates that the schema on the primary tablet
	// for shard 0 matches the schema on all of the other tablets in the
	// keyspace.
	ValidateSchemaKeyspace(ctx context.Context, in *v16.ValidateSchemaKeyspaceRequest, opts ...grpc.CallOption) (*v161.ValidateSchemaKeyspaceResponse, error)
	// ValidateShard validates that that all nodes reachable from the specified shard are consistent.
	ValidateShard(ctx context.Context, in *v16.ValidateShardRequest, opts ...grpc.CallOption) (*v161.ValidateShardResponse, error)
	// ValidateVersionKeyspace validates that the version on the primary of
	// shard 0 matches all of the other tablets in the keyspace.
	ValidateVersionKeyspace(ctx context.Context, in *v16.ValidateVersionKeyspaceRequest, opts ...grpc.CallOption) (*v161.ValidateVersionKeyspaceResponse, error)
	// ValidateVersionShard validates that the version on the primary matches all of the replicas.
	ValidateVersionShard(ctx context.Context, in *v16.ValidateVersionShardRequest, opts ...grpc.CallOption) (*v161.ValidateVersionShardResponse, error)
	// VTExplain provides information on how Vitess plans to execute a
	// particular query.
	VTExplain(ctx context.Context, in *v16.VTExplainRequest, opts ...grpc.CallOption) (*v16.VTExplainResponse, error)
}

VTAdminClient is the client API for VTAdmin service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewVTAdminClient

func NewVTAdminClient(cc grpc.ClientConnInterface) VTAdminClient

type VTAdminServer

type VTAdminServer interface {
	// CreateKeyspace creates a new keyspace in the given cluster.
	CreateKeyspace(context.Context, *v16.CreateKeyspaceRequest) (*v16.CreateKeyspaceResponse, error)
	// CreateShard creates a new shard in the given cluster and keyspace.
	CreateShard(context.Context, *v16.CreateShardRequest) (*v161.CreateShardResponse, error)
	// DeleteKeyspace deletes a keyspace in the given cluster.
	DeleteKeyspace(context.Context, *v16.DeleteKeyspaceRequest) (*v161.DeleteKeyspaceResponse, error)
	// DeleteShard deletes one or more shards in the given cluster and keyspace.
	DeleteShards(context.Context, *v16.DeleteShardsRequest) (*v161.DeleteShardsResponse, error)
	// DeleteTablet deletes a tablet from the topology
	DeleteTablet(context.Context, *v16.DeleteTabletRequest) (*v16.DeleteTabletResponse, error)
	// EmergencyFailoverShard fails over a shard to a new primary. It assumes
	// the old primary is dead or otherwise not responding.
	EmergencyFailoverShard(context.Context, *v16.EmergencyFailoverShardRequest) (*v16.EmergencyFailoverShardResponse, error)
	// FindSchema returns a single Schema that matches the provided table name
	// across all specified clusters IDs. Not specifying a set of cluster IDs
	// causes the search to span all configured clusters.
	//
	// An error occurs if either no table exists across any of the clusters with
	// the specified table name, or if multiple tables exist with that name.
	FindSchema(context.Context, *v16.FindSchemaRequest) (*v16.Schema, error)
	// GetBackups returns backups grouped by cluster.
	GetBackups(context.Context, *v16.GetBackupsRequest) (*v16.GetBackupsResponse, error)
	// GetCellInfos returns the CellInfo objects for the specified clusters.
	//
	// Callers may optionally restrict the set of CellInfos, or restrict the
	// response to include only cell names.
	GetCellInfos(context.Context, *v16.GetCellInfosRequest) (*v16.GetCellInfosResponse, error)
	// GetCellsAliases returns the CellsAliases data for the specified clusters.
	GetCellsAliases(context.Context, *v16.GetCellsAliasesRequest) (*v16.GetCellsAliasesResponse, error)
	// GetClusters returns all configured clusters.
	GetClusters(context.Context, *v16.GetClustersRequest) (*v16.GetClustersResponse, error)
	// GetFullStatus returns the full status of MySQL including the replication information, semi-sync information, GTID information among others
	GetFullStatus(context.Context, *v16.GetFullStatusRequest) (*v161.GetFullStatusResponse, error)
	// GetGates returns all gates across all the specified clusters.
	GetGates(context.Context, *v16.GetGatesRequest) (*v16.GetGatesResponse, error)
	// GetKeyspace returns a keyspace by name in the specified cluster.
	GetKeyspace(context.Context, *v16.GetKeyspaceRequest) (*v16.Keyspace, error)
	// GetKeyspaces returns all keyspaces across the specified clusters.
	GetKeyspaces(context.Context, *v16.GetKeyspacesRequest) (*v16.GetKeyspacesResponse, error)
	// GetSchema returns the schema for the specified (cluster, keyspace, table)
	// tuple.
	GetSchema(context.Context, *v16.GetSchemaRequest) (*v16.Schema, error)
	// GetSchemas returns all schemas across the specified clusters.
	GetSchemas(context.Context, *v16.GetSchemasRequest) (*v16.GetSchemasResponse, error)
	// GetShardReplicationPositions returns shard replication positions grouped
	// by cluster.
	GetShardReplicationPositions(context.Context, *v16.GetShardReplicationPositionsRequest) (*v16.GetShardReplicationPositionsResponse, error)
	// GetSrvVSchema returns the SrvVSchema for the given cluster and cell.
	GetSrvVSchema(context.Context, *v16.GetSrvVSchemaRequest) (*v16.SrvVSchema, error)
	// GetSrvVSchemas returns all SrvVSchemas across all (or specified) clusters
	// and cells.
	GetSrvVSchemas(context.Context, *v16.GetSrvVSchemasRequest) (*v16.GetSrvVSchemasResponse, error)
	// GetTablet looks up a tablet by hostname across all clusters and returns
	// the result.
	GetTablet(context.Context, *v16.GetTabletRequest) (*v16.Tablet, error)
	// GetTablets returns all tablets across all the specified clusters.
	GetTablets(context.Context, *v16.GetTabletsRequest) (*v16.GetTabletsResponse, error)
	// GetTopologyPath returns the cell located at the specified path in the topology server.
	GetTopologyPath(context.Context, *v16.GetTopologyPathRequest) (*v161.GetTopologyPathResponse, error)
	// GetVSchema returns a VSchema for the specified keyspace in the specified
	// cluster.
	GetVSchema(context.Context, *v16.GetVSchemaRequest) (*v16.VSchema, error)
	// GetVSchemas returns the VSchemas for all specified clusters.
	GetVSchemas(context.Context, *v16.GetVSchemasRequest) (*v16.GetVSchemasResponse, error)
	// GetVtctlds returns the Vtctlds for all specified clusters.
	GetVtctlds(context.Context, *v16.GetVtctldsRequest) (*v16.GetVtctldsResponse, error)
	// GetWorkflow returns a single Workflow for a given cluster, keyspace, and
	// workflow name.
	GetWorkflow(context.Context, *v16.GetWorkflowRequest) (*v16.Workflow, error)
	// GetWorkflows returns the Workflows for all specified clusters.
	GetWorkflows(context.Context, *v16.GetWorkflowsRequest) (*v16.GetWorkflowsResponse, error)
	// PingTablet checks that the specified tablet is awake and responding to
	// RPCs. This command can be blocked by other in-flight operations.
	PingTablet(context.Context, *v16.PingTabletRequest) (*v16.PingTabletResponse, error)
	// PlannedFailoverShard fails over the shard to a new primary, or away from
	// an old primary. Both the old and new primaries must be reachable and
	// running.
	//
	// NOTE: A planned failover will not consider replicas outside the current
	// shard primary's cell as promotion candidates unless NewPrimary is
	// explicitly provided in the request.
	PlannedFailoverShard(context.Context, *v16.PlannedFailoverShardRequest) (*v16.PlannedFailoverShardResponse, error)
	// RebuildKeyspaceGraph rebuilds the serving data for a keyspace.
	RebuildKeyspaceGraph(context.Context, *v16.RebuildKeyspaceGraphRequest) (*v16.RebuildKeyspaceGraphResponse, error)
	// RefreshState reloads the tablet record on the specified tablet.
	RefreshState(context.Context, *v16.RefreshStateRequest) (*v16.RefreshStateResponse, error)
	// RefreshTabletReplicationSource performs a `CHANGE REPLICATION SOURCE TO`
	// on a tablet to replicate from the current primary in the shard.
	RefreshTabletReplicationSource(context.Context, *v16.RefreshTabletReplicationSourceRequest) (*v16.RefreshTabletReplicationSourceResponse, error)
	// ReloadSchemas reloads the schema definition across keyspaces, shards, or
	// tablets in one or more clusters, depending on the request fields (see
	// ReloadSchemasRequest for details).
	ReloadSchemas(context.Context, *v16.ReloadSchemasRequest) (*v16.ReloadSchemasResponse, error)
	// ReloadSchemaShard reloads the schema on all tablets in a shard. This is done on a best-effort basis.
	ReloadSchemaShard(context.Context, *v16.ReloadSchemaShardRequest) (*v16.ReloadSchemaShardResponse, error)
	// RemoveKeyspaceCell removes the cell from the Cells list for all shards in the keyspace, and the SrvKeyspace for that keyspace in that cell.
	RemoveKeyspaceCell(context.Context, *v16.RemoveKeyspaceCellRequest) (*v16.RemoveKeyspaceCellResponse, error)
	// RunHealthCheck runs a healthcheck on the tablet.
	RunHealthCheck(context.Context, *v16.RunHealthCheckRequest) (*v16.RunHealthCheckResponse, error)
	// SetReadOnly sets the tablet to read-only mode.
	SetReadOnly(context.Context, *v16.SetReadOnlyRequest) (*v16.SetReadOnlyResponse, error)
	// SetReadWrite sets the tablet to read-write mode.
	SetReadWrite(context.Context, *v16.SetReadWriteRequest) (*v16.SetReadWriteResponse, error)
	// StartReplication runs the underlying database command to start
	// replication on a tablet.
	StartReplication(context.Context, *v16.StartReplicationRequest) (*v16.StartReplicationResponse, error)
	// StopReplication runs the underlying database command to stop replication
	// on a tablet
	StopReplication(context.Context, *v16.StopReplicationRequest) (*v16.StopReplicationResponse, error)
	// TabletExternallyPromoted updates the metadata in a cluster's topology
	// 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.
	//
	// * "orchestrator" here refers to external orchestrator, not the newer,
	// Vitess-aware orchestrator, VTOrc.
	TabletExternallyPromoted(context.Context, *v16.TabletExternallyPromotedRequest) (*v16.TabletExternallyPromotedResponse, error)
	// Validate validates all nodes in a cluster that are reachable from the global replication graph,
	// as well as all tablets in discoverable cells, are consistent
	Validate(context.Context, *v16.ValidateRequest) (*v161.ValidateResponse, error)
	// ValidateKeyspace validates that all nodes reachable from the specified
	// keyspace are consistent.
	ValidateKeyspace(context.Context, *v16.ValidateKeyspaceRequest) (*v161.ValidateKeyspaceResponse, error)
	// ValidateSchemaKeyspace validates that the schema on the primary tablet
	// for shard 0 matches the schema on all of the other tablets in the
	// keyspace.
	ValidateSchemaKeyspace(context.Context, *v16.ValidateSchemaKeyspaceRequest) (*v161.ValidateSchemaKeyspaceResponse, error)
	// ValidateShard validates that that all nodes reachable from the specified shard are consistent.
	ValidateShard(context.Context, *v16.ValidateShardRequest) (*v161.ValidateShardResponse, error)
	// ValidateVersionKeyspace validates that the version on the primary of
	// shard 0 matches all of the other tablets in the keyspace.
	ValidateVersionKeyspace(context.Context, *v16.ValidateVersionKeyspaceRequest) (*v161.ValidateVersionKeyspaceResponse, error)
	// ValidateVersionShard validates that the version on the primary matches all of the replicas.
	ValidateVersionShard(context.Context, *v16.ValidateVersionShardRequest) (*v161.ValidateVersionShardResponse, error)
	// VTExplain provides information on how Vitess plans to execute a
	// particular query.
	VTExplain(context.Context, *v16.VTExplainRequest) (*v16.VTExplainResponse, error)
}

VTAdminServer is the server API for VTAdmin service. All implementations should embed UnimplementedVTAdminServer for forward compatibility

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL