package
3.0.0-rc.3+incompatible
Repository: https://github.com/vitessio/vitess.git
Documentation: pkg.go.dev
# Packages
Package topovalidator contains a workflow that validates the topology data.
# Functions
AvailableFactories returns a map with the names of the available factories as keys and 'true' as value.
NewCheckpointWriter creates a CheckpointWriter.
NewManager creates an initialized Manager.
NewNode is a helper function to create new UI Node struct.
NewNodeManager returns a new NodeManager.
NewParallelRunner returns a new ParallelRunner.
Register lets implementations register Factory objects.
StartManager starts a manager.
Unregister removes a factory object.
VerifyAllTasksDone checks that all tasks are done in a workflow.
# Constants
ActionStateDisabled is for when the action is disabled.
ActionStateEnabled is for when the action is enabled.
ActionStateUnknown is an unknown value and should never be set.
ActionStyleNormal will just trigger the action.
ActionStyleTriggered is a state where the button is greyed out and cannot be pressed.
ActionStyleUnknown is an unknown value and should never be set.
ActionStyleWaiting highlights to the user that the process is waiting on the execution of the action.
ActionStyleWarning will display a warning dialog to confirm action with Action.Message.
NodeDisplayDeterminate is a progress bar driven by the Progress field.
NodeDisplayIndeterminate is a progress bar that doesn't have a current value, but just shows movement.
NodeDisplayNone shows no progress bar or status.
NodeDisplayUnknown is an unknown value and should never be set.
Parallel means that the tasks will run in parallel.
Sequential means that the tasks will run sequentially.
# Structs
Action must match node.ts Action.
ActionParameters describe an action initiated by the user.
CheckpointWriter saves the checkpoint data into topology server.
Manager is the main Workflow manager object.
Node is the UI representation of a Workflow toplevel object, or of a Workflow task.
NodeManager manages the Node tree.
ParallelRunner is used to control executing tasks concurrently.
SleepWorkflow implements the Workflow interface.
SleepWorkflowData is the data structure serialized as JSON in Workflow.Data.
SleepWorkflowFactory is the factory to register the Sleep workflows.
Update is the data structure we send on the websocket or on the long-polling HTTP connection to the clients.
# Interfaces
ActionListener is an interface for receiving notifications about actions triggered from workflow UI.
Factory can create the initial version of a Workflow, or instantiate them from a serialized version.
Workflow is a running instance of a job.
# Type aliases
ActionState constants need to match node.ts.ActionState.
ActionStyle constants need to match node.ts.ActionStyle.
NodeDisplay constants need to match node.ts.Display.
PhaseType is used to store the phase name in a workflow.