onlineddl

package
v0.15.1 Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2022 License: Apache-2.0 Imports: 50 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrExecutorNotWritableTablet  is generated when executor is asked to run gh-ost on a read-only server
	ErrExecutorNotWritableTablet = errors.New("cannot run migration on non-writable tablet")
	// ErrExecutorMigrationAlreadyRunning is generated when an attempt is made to run an operation that conflicts with a running migration
	ErrExecutorMigrationAlreadyRunning = errors.New("cannot run migration since a migration is already running")
	// ErrMigrationNotFound is returned by readMigration when given UUI cannot be found
	ErrMigrationNotFound = errors.New("migration not found")
)
View Source 
var ApplyDDL = []string{
	sqlCreateSidecarDB,
	sqlCreateSchemaMigrationsTable,
	alterSchemaMigrationsTableRetries,
	alterSchemaMigrationsTableTablet,
	alterSchemaMigrationsTableArtifacts,
	alterSchemaMigrationsTableTabletFailure,
	alterSchemaMigrationsTableTabletFailureIndex,
	alterSchemaMigrationsTableProgress,
	alterSchemaMigrationsTableContext,
	alterSchemaMigrationsTableDDLAction,
	alterSchemaMigrationsTableMessage,
	alterSchemaMigrationsTableTableCompleteIndex,
	alterSchemaMigrationsTableETASeconds,
	alterSchemaMigrationsTableRowsCopied,
	alterSchemaMigrationsTableTableRows,
	alterSchemaMigrationsTableAddedUniqueKeys,
	alterSchemaMigrationsTableRemovedUniqueKeys,
	alterSchemaMigrationsTableLogFile,
	alterSchemaMigrationsTableRetainArtifacts,
	alterSchemaMigrationsTablePostponeCompletion,
	alterSchemaMigrationsTableContextIndex,
	alterSchemaMigrationsTableRemovedUniqueNames,
	alterSchemaMigrationsTableRemovedNoDefaultColNames,
	alterSchemaMigrationsTableExpandedColNames,
	alterSchemaMigrationsTableRevertibleNotes,
	alterSchemaMigrationsTableAllowConcurrent,
	alterSchemaMigrationsTableRevertedUUID,
	alterSchemaMigrationsTableRevertedUUIDIndex,
	alterSchemaMigrationsTableIsView,
	alterSchemaMigrationsTableReadyToComplete,
	alterSchemaMigrationsTableStowawayTable,
	alterSchemaMigrationsTableVreplLivenessIndicator,
	alterSchemaMigrationsTableUserThrottleRatio,
	alterSchemaMigrationsTableSpecialPlan,
	alterSchemaMigrationsLastThrottled,
	alterSchemaMigrationsComponentThrottled,
	alterSchemaMigrationsCancelledTimestamp,
	alterSchemaMigrationsTablePostponeLaunch,
}

ApplyDDL ddls to be applied at the start

Functions

func GhostBinaryFileName 

func GhostBinaryFileName() (fileName string, isOverride bool)

GhostBinaryFileName returns the full path+name of the gh-ost binary

func PTOSCFileName 

func PTOSCFileName() (fileName string, isOverride bool)

PTOSCFileName returns the full path+name of the pt-online-schema-change binary Note that vttablet does not include pt-online-schema-change

func RandomHash 

func RandomHash() string

RandomHash returns a 64 hex character random string

func ReadableTimestamp 

func ReadableTimestamp() string

ReadableTimestamp returns a timestamp, in seconds resolution, that is human readable (as opposed to unix timestamp which is just a number), and which corresponds to the time now. Example: for Aug 25 2020, 16:04:25 we return "20200825160425"

func ToReadableTimestamp 

func ToReadableTimestamp(t time.Time) string

ToReadableTimestamp returns a timestamp, in seconds resolution, that is human readable (as opposed to unix timestamp which is just a number) Example: for Aug 25 2020, 16:04:25 we return "20200825160425"

Types

type Executor 

type Executor struct {
	// contains filtered or unexported fields
}

Executor wraps and manages the execution of a gh-ost migration.

func NewExecutor 

func NewExecutor(env tabletenv.Env, tabletAlias *topodatapb.TabletAlias, ts *topo.Server,
	lagThrottler *throttle.Throttler,
	tabletTypeFunc func() topodatapb.TabletType,
	toggleBufferTableFunc func(cancelCtx context.Context, tableName string, bufferQueries bool),
) *Executor

NewExecutor creates a new gh-ost executor.

func (*Executor) CancelMigration added in v0.10.0 

func (e *Executor) CancelMigration(ctx context.Context, uuid string, message string, issuedByUser bool) (result *sqltypes.Result, err error)

CancelMigration attempts to abort a scheduled or a running migration

func (*Executor) CancelPendingMigrations added in v0.10.0 

func (e *Executor) CancelPendingMigrations(ctx context.Context, message string, issuedByUser bool) (result *sqltypes.Result, err error)

CancelPendingMigrations cancels all pending migrations (that are expected to run or are running) for this keyspace

func (*Executor) CleanupMigration added in v0.13.0 

func (e *Executor) CleanupMigration(ctx context.Context, uuid string) (result *sqltypes.Result, err error)

CleanupMigration sets migration is ready for artifact cleanup. Artifacts are not immediately deleted: all we do is set retain_artifacts_seconds to a very small number (it's actually a negative) so that the next iteration of gcArtifacts() picks up the migration's artifacts and schedules them for deletion

func (*Executor) Close 

func (e *Executor) Close()

Close frees resources

func (*Executor) CompleteMigration added in v0.13.0 

func (e *Executor) CompleteMigration(ctx context.Context, uuid string) (result *sqltypes.Result, err error)

CompleteMigration clears the postpone_completion flag for a given migration, assuming it was set in the first place

func (*Executor) CompletePendingMigrations added in v0.15.0 

func (e *Executor) CompletePendingMigrations(ctx context.Context) (result *sqltypes.Result, err error)

CompletePendingMigrations completes all pending migrations (that are expected to run or are running) for this keyspace

func (*Executor) ExecuteWithGhost 

func (e *Executor) ExecuteWithGhost(ctx context.Context, onlineDDL *schema.OnlineDDL) error

ExecuteWithGhost validates and runs a gh-ost process. Validation included testing the backend MySQL server and the gh-ost binary itself Execution runs first a dry run, then an actual migration

func (*Executor) ExecuteWithPTOSC 

func (e *Executor) ExecuteWithPTOSC(ctx context.Context, onlineDDL *schema.OnlineDDL) error

ExecuteWithPTOSC validates and runs a pt-online-schema-change process. Validation included testing the backend MySQL server and the pt-online-schema-change binary itself Execution runs first a dry run, then an actual migration

func (*Executor) ExecuteWithVReplication added in v0.10.0 

func (e *Executor) ExecuteWithVReplication(ctx context.Context, onlineDDL *schema.OnlineDDL, revertMigration *schema.OnlineDDL) error

ExecuteWithVReplication sets up the grounds for a vreplication schema migration

func (*Executor) InitDBConfig 

func (e *Executor) InitDBConfig(keyspace, shard, dbName string)

InitDBConfig initializes keysapce

func (*Executor) LaunchMigration added in v0.15.0 

func (e *Executor) LaunchMigration(ctx context.Context, uuid string, shardsArg string) (result *sqltypes.Result, err error)

LaunchMigration clears the postpone_launch flag for a given migration, assuming it was set in the first place

func (*Executor) LaunchMigrations added in v0.15.0 

func (e *Executor) LaunchMigrations(ctx context.Context) (result *sqltypes.Result, err error)

LaunchMigrations launches all launch-postponed queued migrations for this keyspace

func (*Executor) OnSchemaMigrationStatus 

func (e *Executor) OnSchemaMigrationStatus(ctx context.Context,
	uuidParam, statusParam, dryrunParam, progressParam, etaParam, rowsCopiedParam, hint string) (err error)

OnSchemaMigrationStatus is called by TabletServer's API, which is invoked by a running gh-ost migration's hooks.

func (*Executor) Open 

func (e *Executor) Open() error

Open opens database pool and initializes the schema

func (*Executor) PrepareForQueryExecutor added in v0.14.0 

func (e *Executor) PrepareForQueryExecutor(ctx context.Context) error

PrepareForQueryExecutor is called by QueryExecutor, possibly before the backing _vt.schema_migrations table has had the chance to be created. This function prepares the schema.

func (*Executor) RetryMigration added in v0.10.0 

func (e *Executor) RetryMigration(ctx context.Context, uuid string) (result *sqltypes.Result, err error)

RetryMigration marks given migration for retry

func (*Executor) ShowMigrationLogs added in v0.11.0 

func (e *Executor) ShowMigrationLogs(ctx context.Context, stmt *sqlparser.ShowMigrationLogs) (result *sqltypes.Result, err error)

ShowMigrationLogs reads the migration log for a given migration

func (*Executor) SubmitMigration added in v0.11.0 

func (e *Executor) SubmitMigration(
	ctx context.Context,
	stmt sqlparser.Statement,
) (result *sqltypes.Result, err error)

SubmitMigration inserts a new migration request

func (*Executor) TabletAliasString added in v0.9.0 

func (e *Executor) TabletAliasString() string

TabletAliasString returns tablet alias as string (duh)

func (*Executor) ThrottleAllMigrations added in v0.14.0 

func (e *Executor) ThrottleAllMigrations(ctx context.Context, expireString string, ratioLiteral *sqlparser.Literal) (result *sqltypes.Result, err error)

ThrottleAllMigrations

func (*Executor) ThrottleMigration added in v0.14.0 

func (e *Executor) ThrottleMigration(ctx context.Context, uuid string, expireString string, ratioLiteral *sqlparser.Literal) (result *sqltypes.Result, err error)

ThrottleMigration

func (*Executor) UnthrottleAllMigrations added in v0.14.0 

func (e *Executor) UnthrottleAllMigrations(ctx context.Context) (result *sqltypes.Result, err error)

UnthrottleAllMigrations

func (*Executor) UnthrottleMigration added in v0.14.0 

func (e *Executor) UnthrottleMigration(ctx context.Context, uuid string) (result *sqltypes.Result, err error)

UnthrottleMigration

func (*Executor) VExec 

func (e *Executor) VExec(ctx context.Context, vx *vexec.TabletVExec) (qr *querypb.QueryResult, err error)

VExec is called by a VExec invocation Implements vitess.io/vitess/go/vt/vttablet/vexec.Executor interface

type SpecialAlterPlan added in v0.14.0 

type SpecialAlterPlan struct {
	// contains filtered or unexported fields
}

func AnalyzeInstantDDL added in v0.14.0 

func AnalyzeInstantDDL(alterTable *sqlparser.AlterTable, createTable *sqlparser.CreateTable, capableOf mysql.CapableOf) (*SpecialAlterPlan, error)

AnalyzeInstantDDL takes declarative CreateTable and AlterTable, as well as a server version, and checks whether it is possible to run the ALTER using ALGORITM=INSTANT for that version. This function is INTENTIONALLY public, even though we do not guarantee that it will remain so.

func NewSpecialAlterOperation added in v0.14.0 

func NewSpecialAlterOperation(operation specialAlterOperation, alterTable *sqlparser.AlterTable, createTable *sqlparser.CreateTable) *SpecialAlterPlan

func (*SpecialAlterPlan) Detail added in v0.14.0 

func (p *SpecialAlterPlan) Detail(key string) string

func (*SpecialAlterPlan) SetDetail added in v0.14.0 

func (p *SpecialAlterPlan) SetDetail(key string, val string) *SpecialAlterPlan

func (*SpecialAlterPlan) String added in v0.14.0 

func (p *SpecialAlterPlan) String() string

type VRepl added in v0.10.0 

type VRepl struct {
	// contains filtered or unexported fields
}

VRepl is an online DDL helper for VReplication based migrations (ddl_strategy="online")

func NewVRepl added in v0.10.0 

func NewVRepl(workflow, keyspace, shard, dbName, sourceTable, targetTable, alterQuery string) *VRepl

NewVRepl creates a VReplication handler for Online DDL

type VReplStream added in v0.10.0 

type VReplStream struct {
	// contains filtered or unexported fields
}

VReplStream represents a row in _vt.vreplication table

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.