vtadmin

README

VTAdmin

VTAdmin is in alpha, you may use it if you wish, but should not treat it as stable. It does not meet the standard Vitess backwards compatibility guarantees, and is subject to change at any time.

Documentation

Index

• type API
  • func NewAPI(clusters []*cluster.Cluster, opts grpcserver.Options, ...) *API
  • func (api *API) FindSchema(ctx context.Context, req *vtadminpb.FindSchemaRequest) (*vtadminpb.Schema, error)
  • func (api *API) GetBackups(ctx context.Context, req *vtadminpb.GetBackupsRequest) (*vtadminpb.GetBackupsResponse, error)
  • func (api *API) GetClusters(ctx context.Context, req *vtadminpb.GetClustersRequest) (*vtadminpb.GetClustersResponse, error)
  • func (api *API) GetGates(ctx context.Context, req *vtadminpb.GetGatesRequest) (*vtadminpb.GetGatesResponse, error)
  • func (api *API) GetKeyspace(ctx context.Context, req *vtadminpb.GetKeyspaceRequest) (*vtadminpb.Keyspace, error)
  • func (api *API) GetKeyspaces(ctx context.Context, req *vtadminpb.GetKeyspacesRequest) (*vtadminpb.GetKeyspacesResponse, error)
  • func (api *API) GetSchema(ctx context.Context, req *vtadminpb.GetSchemaRequest) (*vtadminpb.Schema, error)
  • func (api *API) GetSchemas(ctx context.Context, req *vtadminpb.GetSchemasRequest) (*vtadminpb.GetSchemasResponse, error)
  • func (api *API) GetSrvVSchema(ctx context.Context, req *vtadminpb.GetSrvVSchemaRequest) (*vtadminpb.SrvVSchema, error)
  • func (api *API) GetSrvVSchemas(ctx context.Context, req *vtadminpb.GetSrvVSchemasRequest) (*vtadminpb.GetSrvVSchemasResponse, error)
  • func (api *API) GetTablet(ctx context.Context, req *vtadminpb.GetTabletRequest) (*vtadminpb.Tablet, error)
  • func (api *API) GetTablets(ctx context.Context, req *vtadminpb.GetTabletsRequest) (*vtadminpb.GetTabletsResponse, error)
  • func (api *API) GetVSchema(ctx context.Context, req *vtadminpb.GetVSchemaRequest) (*vtadminpb.VSchema, error)
  • func (api *API) GetVSchemas(ctx context.Context, req *vtadminpb.GetVSchemasRequest) (*vtadminpb.GetVSchemasResponse, error)
  • func (api *API) GetWorkflow(ctx context.Context, req *vtadminpb.GetWorkflowRequest) (*vtadminpb.Workflow, error)
  • func (api *API) GetWorkflows(ctx context.Context, req *vtadminpb.GetWorkflowsRequest) (*vtadminpb.GetWorkflowsResponse, error)
  • func (api *API) ListenAndServe() error
  • func (api *API) VTExplain(ctx context.Context, req *vtadminpb.VTExplainRequest) (*vtadminpb.VTExplainResponse, error)

Types

type API

type API struct {
	vtadminpb.UnimplementedVTAdminServer
	// contains filtered or unexported fields
}

API is the main entrypoint for the vtadmin server. It implements vtadminpb.VTAdminServer.

func NewAPI

func NewAPI(clusters []*cluster.Cluster, opts grpcserver.Options, httpOpts vtadminhttp.Options) *API

NewAPI returns a new API, configured to service the given set of clusters, and configured with the given gRPC and HTTP server options.

If opts.Services is nil, NewAPI will automatically add "vtadmin.VTAdminServer" to the list of services queryable in the healthcheck service. Callers can opt-out of this behavior by explicitly setting this value to the empty slice.

func (*API) FindSchema

func (api *API) FindSchema(ctx context.Context, req *vtadminpb.FindSchemaRequest) (*vtadminpb.Schema, error)

FindSchema is part of the vtadminpb.VTAdminServer interface.

func (*API) GetBackups

func (api *API) GetBackups(ctx context.Context, req *vtadminpb.GetBackupsRequest) (*vtadminpb.GetBackupsResponse, error)

GetBackups is part of the vtadminpb.VTAdminServer interface.

func (*API) GetClusters

func (api *API) GetClusters(ctx context.Context, req *vtadminpb.GetClustersRequest) (*vtadminpb.GetClustersResponse, error)

GetClusters is part of the vtadminpb.VTAdminServer interface.

func (*API) GetGates

func (api *API) GetGates(ctx context.Context, req *vtadminpb.GetGatesRequest) (*vtadminpb.GetGatesResponse, error)

GetGates is part of the vtadminpb.VTAdminServer interface.

func (*API) GetKeyspace

func (api *API) GetKeyspace(ctx context.Context, req *vtadminpb.GetKeyspaceRequest) (*vtadminpb.Keyspace, error)

GetKeyspace is part of the vtadminpb.VTAdminServer interface.

func (*API) GetKeyspaces

func (api *API) GetKeyspaces(ctx context.Context, req *vtadminpb.GetKeyspacesRequest) (*vtadminpb.GetKeyspacesResponse, error)

GetKeyspaces is part of the vtadminpb.VTAdminServer interface.

func (*API) GetSchema

func (api *API) GetSchema(ctx context.Context, req *vtadminpb.GetSchemaRequest) (*vtadminpb.Schema, error)

GetSchema is part of the vtadminpb.VTAdminServer interface.

func (*API) GetSchemas

func (api *API) GetSchemas(ctx context.Context, req *vtadminpb.GetSchemasRequest) (*vtadminpb.GetSchemasResponse, error)

GetSchemas is part of the vtadminpb.VTAdminServer interface.

func (*API) GetSrvVSchema

func (api *API) GetSrvVSchema(ctx context.Context, req *vtadminpb.GetSrvVSchemaRequest) (*vtadminpb.SrvVSchema, error)

GetSrvVSchema is part of the vtadminpb.VTAdminServer interface.

func (*API) GetSrvVSchemas

func (api *API) GetSrvVSchemas(ctx context.Context, req *vtadminpb.GetSrvVSchemasRequest) (*vtadminpb.GetSrvVSchemasResponse, error)

GetSrvVSchemas is part of the vtadminpb.VTAdminServer interface.

func (*API) GetTablet

func (api *API) GetTablet(ctx context.Context, req *vtadminpb.GetTabletRequest) (*vtadminpb.Tablet, error)

GetTablet is part of the vtadminpb.VTAdminServer interface.

func (*API) GetTablets

func (api *API) GetTablets(ctx context.Context, req *vtadminpb.GetTabletsRequest) (*vtadminpb.GetTabletsResponse, error)

GetTablets is part of the vtadminpb.VTAdminServer interface.

func (*API) GetVSchema

func (api *API) GetVSchema(ctx context.Context, req *vtadminpb.GetVSchemaRequest) (*vtadminpb.VSchema, error)

GetVSchema is part of the vtadminpb.VTAdminServer interface.

func (*API) GetVSchemas

func (api *API) GetVSchemas(ctx context.Context, req *vtadminpb.GetVSchemasRequest) (*vtadminpb.GetVSchemasResponse, error)

GetVSchemas is part of the vtadminpb.VTAdminServer interface.

func (*API) GetWorkflow

func (api *API) GetWorkflow(ctx context.Context, req *vtadminpb.GetWorkflowRequest) (*vtadminpb.Workflow, error)

GetWorkflow is part of the vtadminpb.VTAdminServer interface.

func (*API) GetWorkflows

func (api *API) GetWorkflows(ctx context.Context, req *vtadminpb.GetWorkflowsRequest) (*vtadminpb.GetWorkflowsResponse, error)

GetWorkflows is part of the vtadminpb.VTAdminServer interface.

func (*API) ListenAndServe

func (api *API) ListenAndServe() error

ListenAndServe starts serving this API on the configured Addr (see grpcserver.Options) until shutdown or irrecoverable error occurs.

func (*API) VTExplain

func (api *API) VTExplain(ctx context.Context, req *vtadminpb.VTExplainRequest) (*vtadminpb.VTExplainResponse, error)

VTExplain is part of the vtadminpb.VTAdminServer interface.