common

Documentation

Index

• Variables
• func AddCommonCreateFlags(cmd *cobra.Command)
• func AddCommonFlags(cmd *cobra.Command)
• func AddCommonSwitchTrafficFlags(cmd *cobra.Command, initializeTargetSequences bool)
• func AddShardSubsetFlag(cmd *cobra.Command, shardsOption *[]string)
• func CanRestartWorkflow(keyspace, workflow string) error
• func GetCancelCommand(opts *SubCommandsOpts) *cobra.Command
• func GetClient() vtctldclient.VtctldClient
• func GetCommandCtx() context.Context
• func GetCompleteCommand(opts *SubCommandsOpts) *cobra.Command
• func GetMirrorTrafficCommand(opts *SubCommandsOpts) *cobra.Command
• func GetOutputFormat(cmd *cobra.Command) (string, error)
• func GetReverseTrafficCommand(opts *SubCommandsOpts) *cobra.Command
• func GetShowCommand(opts *SubCommandsOpts) *cobra.Command
• func GetStartCommand(opts *SubCommandsOpts) *cobra.Command
• func GetStatusCommand(opts *SubCommandsOpts) *cobra.Command
• func GetStopCommand(opts *SubCommandsOpts) *cobra.Command
• func GetSwitchTrafficCommand(opts *SubCommandsOpts) *cobra.Command
• func GetTabletSelectionPreference(cmd *cobra.Command) tabletmanagerdatapb.TabletSelectionPreference
• func OutputStatusResponse(resp *vtctldatapb.WorkflowStatusResponse, format string) error
• func ParseAndValidateCreateOptions(cmd *cobra.Command) error
• func ParseCells(cmd *cobra.Command) error
• func ParseConfigOverrides(overrides []string) (map[string]string, error)
• func ParseTabletTypes(cmd *cobra.Command) error
• func RegisterCommandHandler(command string, handler func(cmd *cobra.Command))
• func RegisterCommands(root *cobra.Command)
• func SetClient(c vtctldclient.VtctldClient)
• func SetCommandCtx(ctx context.Context)
• func ValidateShards(shards []string) error
• type SubCommandsOpts

Variables

var (
	MaxReplicationLagDefault = 30 * time.Second

	BaseOptions = struct {
		Workflow       string
		TargetKeyspace string
		Format         string
	}{}

	CreateOptions = struct {
		Cells                        []string
		AllCells                     bool
		TabletTypes                  []topodatapb.TabletType
		TabletTypesInPreferenceOrder bool
		OnDDL                        string
		DeferSecondaryKeys           bool
		AutoStart                    bool
		StopAfterCopy                bool
		MySQLServerVersion           string
		TruncateUILen                int
		TruncateErrLen               int
		ReferenceTables              []string
		ConfigOverrides              []string
	}{}
)

var CancelOptions = struct {
	KeepData         bool
	KeepRoutingRules bool
	Shards           []string
}{}

var CompleteOptions = struct {
	KeepData         bool
	KeepRoutingRules bool
	RenameTables     bool
	DryRun           bool
	Shards           []string
}{}

var MirrorTrafficOptions = struct {
	DryRun      bool
	Percent     float32
	TabletTypes []topodatapb.TabletType
}{}

var ShowOptions = struct {
	IncludeLogs bool
	Shards      []string
}{}

var StatusOptions = struct {
	Shards []string
}{}

var SwitchTrafficOptions = struct {
	Cells                     []string
	TabletTypes               []topodatapb.TabletType
	Timeout                   time.Duration
	MaxReplicationLagAllowed  time.Duration
	EnableReverseReplication  bool
	DryRun                    bool
	Direction                 workflow.TrafficSwitchDirection
	InitializeTargetSequences bool
	Shards                    []string
	Force                     bool
}{}

Functions

func AddCommonCreateFlags

func AddCommonCreateFlags(cmd *cobra.Command)

func AddCommonFlags

func AddCommonFlags(cmd *cobra.Command)

func AddCommonSwitchTrafficFlags

func AddCommonSwitchTrafficFlags(cmd *cobra.Command, initializeTargetSequences bool)

func AddShardSubsetFlag

func AddShardSubsetFlag(cmd *cobra.Command, shardsOption *[]string)

func CanRestartWorkflow

func CanRestartWorkflow(keyspace, workflow string) error

CanRestartWorkflow validates that, for an atomic copy workflow, none of the streams are still in the copy phase. Since we copy all tables in a single snapshot, we cannot restart a workflow which broke before all tables were copied.

func GetCancelCommand

func GetCancelCommand(opts *SubCommandsOpts) *cobra.Command

func GetClient

func GetClient() vtctldclient.VtctldClient

func GetCommandCtx

func GetCommandCtx() context.Context

func GetCompleteCommand

func GetCompleteCommand(opts *SubCommandsOpts) *cobra.Command

func GetMirrorTrafficCommand

func GetMirrorTrafficCommand(opts *SubCommandsOpts) *cobra.Command

func GetOutputFormat

func GetOutputFormat(cmd *cobra.Command) (string, error)

func GetReverseTrafficCommand

func GetReverseTrafficCommand(opts *SubCommandsOpts) *cobra.Command

func GetShowCommand

func GetShowCommand(opts *SubCommandsOpts) *cobra.Command

func GetStartCommand

func GetStartCommand(opts *SubCommandsOpts) *cobra.Command

func GetStatusCommand

func GetStatusCommand(opts *SubCommandsOpts) *cobra.Command

func GetStopCommand

func GetStopCommand(opts *SubCommandsOpts) *cobra.Command

func GetSwitchTrafficCommand

func GetSwitchTrafficCommand(opts *SubCommandsOpts) *cobra.Command

func GetTabletSelectionPreference

func GetTabletSelectionPreference(cmd *cobra.Command) tabletmanagerdatapb.TabletSelectionPreference

func OutputStatusResponse

func OutputStatusResponse(resp *vtctldatapb.WorkflowStatusResponse, format string) error

func ParseAndValidateCreateOptions

func ParseAndValidateCreateOptions(cmd *cobra.Command) error

func ParseCells

func ParseCells(cmd *cobra.Command) error

func ParseConfigOverrides

func ParseConfigOverrides(overrides []string) (map[string]string, error)

ParseConfigOverrides converts a slice of key=value strings into a map of config overrides. The slice is passed as a flag to the command, and the key=value pairs are used to override the default vreplication config values.

func ParseTabletTypes

func ParseTabletTypes(cmd *cobra.Command) error

func RegisterCommandHandler

func RegisterCommandHandler(command string, handler func(cmd *cobra.Command))

func RegisterCommands

func RegisterCommands(root *cobra.Command)

func SetClient

func SetClient(c vtctldclient.VtctldClient)

func SetCommandCtx

func SetCommandCtx(ctx context.Context)

func ValidateShards

func ValidateShards(shards []string) error

ValidateShards checks if the provided shard names are valid key ranges.

Types

type SubCommandsOpts

type SubCommandsOpts struct {
	SubCommand string
	Workflow   string // Used to specify an example workflow name for the Examples section of the help output.
}