vtctl

Documentation

Overview

Package vtctl contains the implementation of all the Vitess management commands.

Index

• Variables
• func MarshalJSON(obj any) (data []byte, err error)
• func PrintAllCommands(logger logutil.Logger)
• func PrintDoubleDashDeprecationNotice(wr *wrangler.Wrangler)
• func RunCommand(ctx context.Context, wr *wrangler.Wrangler, args []string) error
• type JSONTopologyDecoder
• type PlainTopologyDecoder
• type ProtoTopologyDecoder
• type TopologyDecoder
• type VDiffListing
  • func (vdl *VDiffListing) String() string
• type VReplicationWorkflowAction

Variables

var (
	HealthCheckTopologyRefresh = flag.Duration("vtctl_healthcheck_topology_refresh", 30*time.Second, "refresh interval for re-reading the topology")
	HealthcheckRetryDelay      = flag.Duration("vtctl_healthcheck_retry_delay", 5*time.Second, "delay before retrying a failed healthcheck")
	HealthCheckTimeout         = flag.Duration("vtctl_healthcheck_timeout", time.Minute, "the health check timeout period")
)

Flags are exported for use in go/vt/vtctld.

var (
	// ErrUnknownCommand is returned for an unknown command
	ErrUnknownCommand = errors.New("unknown command")
)

var (
	// WorkflowManager contains our manager. It needs to be set or else all
	// commands will be disabled.
	WorkflowManager *workflow.Manager
)

Functions

func MarshalJSON

func MarshalJSON(obj any) (data []byte, err error)

MarshalJSON marshals "obj" to a JSON string. It uses the "jsonpb" marshaler or Go's standard one.

We use jsonpb for protobuf messages because it is the only supported way to marshal protobuf messages to JSON. In addition to that, it's the only way to emit zero values in the JSON output. Unfortunately, jsonpb works only for protobuf messages. Therefore, we use the default marshaler for the remaining structs (which are possibly mixed protobuf and non-protobuf).

TODO(mberlin): Switch "EnumAsInts" to "false" once the frontend is

updated and mixed types will use jsonpb as well.

func PrintAllCommands

func PrintAllCommands(logger logutil.Logger)

PrintAllCommands will print the list of commands to the logger

func PrintDoubleDashDeprecationNotice

func PrintDoubleDashDeprecationNotice(wr *wrangler.Wrangler)

func RunCommand

func RunCommand(ctx context.Context, wr *wrangler.Wrangler, args []string) error

RunCommand will execute the command using the provided wrangler. It will return the actionPath to wait on for long remote actions if applicable.

Types

type JSONTopologyDecoder

type JSONTopologyDecoder struct{}

JSONTopologyDecoder exports topo node as JSON

type PlainTopologyDecoder

type PlainTopologyDecoder struct{}

PlainTopologyDecoder exports topo node as plain text

type ProtoTopologyDecoder

type ProtoTopologyDecoder struct{}

ProtoTopologyDecoder exports topo node as a proto

type TopologyDecoder

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

TopologyDecoder interface for exporting out a leaf node in a readable form

type VDiffListing

type VDiffListing struct {
	UUID, Workflow, Keyspace, Shard, State string
}

func (*VDiffListing) String

func (vdl *VDiffListing) String() string

type VReplicationWorkflowAction

type VReplicationWorkflowAction string

VReplicationWorkflowAction defines subcommands passed to vtctl for movetables or reshard