package
0.15.7
Repository: https://github.com/mdibaiee/vitess.git
Documentation: pkg.go.dev

# Packages

Package azblobbackupstorage implements the BackupStorage interface for Azure Blob Storage.
Package backupstats provides a Stats interface for backup and restore operations in the mysqlctl package.
Package backupstorage contains the interface and file system implementation of the backup system.
Package cephbackupstorage implements the BackupStorage interface for Ceph Cloud Storage.
Package filebackupstorage implements the BackupStorage interface for a local filesystem (which can be an NFS mount).
Package gcsbackupstorage implements the BackupStorage interface for Google Cloud Storage.
Package grpcmysqlctlclient contains the gRPC1 version of the mysqlctl client protocol.
Package grpcmysqlctlserver contains the gRPC implementation of the server side of the remote execution of mysqlctl commands.
Package mysqlctlclient contains the generic client side of the remote mysqlctl protocol.
Package mysqlctlproto provides utility functions for working with data structures in mysqlctl.proto.
Package s3backupstorage implements the BackupStorage interface for AWS S3.
Package tmutils contains helper methods to deal with the tabletmanagerdata proto3 structures.

# Functions

Backup is the main entry point for a backup: - uses the BackupStorage service to store a new backup - shuts down Mysqld during the backup - remember if we were replicating, restore the exact same state.
ChooseBinlogsForIncrementalBackup chooses which binary logs need to be backed up in an incremental backup, given a list of known binary logs, a function that returns the "Previous GTIDs" per binary log, and a position from which to backup (normally the position of last known backup) The function returns an error if the request could not be fulfilled: whether backup is not at all possible, or is empty.
CreateMysqldAndMycnf returns a Mysqld and a Mycnf object to use for working with a MySQL installation that hasn't been set up yet.
DefaultTabletDirAtRoot returns the default directory for a tablet given a UID and a VtDataRoot variable.
FindBackupToRestore returns a path, a sequence of backup handles, to be restored.
FindPITRPath evaluates the shortest path to recover a restoreToGTIDSet.
FindPITRToTimePath evaluates the shortest path to recover a restoreToGTIDSet.
FindReplicas gets IP addresses for all currently connected replicas.
No description provided by the author
GenerateInitialBinlogEntry is used to create a binlog entry when a primary comes up and we need to get a MySQL position so that we can set it as the starting position for replicas to start MySQL Replication from.
GetBackupDir returns the directory where backups for the given keyspace/shard are (or will be) stored.
GetBackupEngine returns the BackupEngine implementation that should be used to create new backups.
GetBackupManifest returns the common fields of the MANIFEST file for a given backup.
No description provided by the author
GetColumnsList returns the column names for a given table/view, using a query generating function.
GetPermissions lists the permissions on the mysqld.
GetPrimaryKeyEquivalentColumns can be used if the table has no defined PRIMARY KEY.
GetRestoreEngine returns the RestoreEngine implementation to restore a given backup.
GetVersionString runs mysqld --version and returns its output as a string.
IsValidIncrementalBakcup determines whether the given manifest can be used to extend a backup based on baseGTIDSet.
MycnfFile returns the default location of the my.cnf file.
NewFakeMysqlDaemon returns a FakeMysqlDaemon where mysqld appears to be running, based on a fakesqldb.DB.
No description provided by the author
NewMycnf fills the Mycnf structure with vt root paths and derived values.
NewMycnfFromFlags creates a Mycnf object from the command line flags.
NewMysqld creates a Mysqld object based on the provided configuration and connection parameters.
OpenMysqldAndMycnf returns a Mysqld and a Mycnf object to use for working with a MySQL installation that already exists.
ParseBackupName parses the backup name for a given dir/name, according to the format generated by mysqlctl.Backup.
No description provided by the author
No description provided by the author
ParseVersionString parses the output of mysqld --version into a flavor and version.
PopulateReparentJournal returns the SQL command to use to populate the reparent_journal table, as well as the time_created_ns value used.
ReadMycnf will read an existing my.cnf from disk, and update the passed in Mycnf object with values from the my.cnf on disk.
RegisterFlags registers the command line flags for specifying the values of a mycnf config file.
ResolveTables returns a list of actual tables+views matching a list of regexps.
Restore is the main entry point for backup restore.
RestoreWasInterrupted tells us whether a previous restore was interrupted and we are now retrying it.
ShouldRestore checks whether a database with tables already exists and returns whether a restore action should be performed.
TabletDir returns the default directory for a tablet.
TopLevelDirs returns the list of directories in the toplevel tablet directory that might be located in a different place.
WaitForReplicationStart waits until the deadline for replication to start.

# Constants

No description provided by the author
No description provided by the author
BackupTimestampFormat is the format in which we save BackupTime and FinishedTime.
No description provided by the author
No description provided by the author
DbaGrantWaitTime is the amount of time to wait for the grants to have applied.
No description provided by the author
No description provided by the author
Flavor constants define the type of mysql flavor being used.
Flavor constants define the type of mysql flavor being used.
Flavor constants define the type of mysql flavor being used.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RestoreState is the name of the sentinel file used to detect whether a previous restore terminated abnormally.
No description provided by the author

# Variables

BackupRestoreEngineMap contains the registered implementations for BackupEngine and RestoreEngine.
BuiltinBackupMysqldTimeout is how long ExecuteBackup should wait for response from mysqld.Shutdown.
CompressionEngineName specifies which compressor/decompressor to use.
DbaIdleTimeout is how often we will refresh the DBA connpool connections.
DisableActiveReparents is a flag to disable active reparents for safety reasons.
No description provided by the author
ErrNoBackup is returned when there is no backup.
ErrNoCompleteBackup is returned when there is at least one backup, but none of them are complete.
No description provided by the author
ExternalCompressorCmd / ExternalDecompressorCmd specify the external commands compress/decompress the backups.
No description provided by the author
No description provided by the author
No description provided by the author
PoolDynamicHostnameResolution is whether we should retry DNS resolution of hostname targets and reconnect if necessary.

# Structs

BackupManifest defines the common fields in the MANIFEST file.
BackupParams is the struct that holds all params passed to ExecuteBackup.
BuiltinBackupEngine encapsulates the logic of the builtin engine it implements the BackupEngine interface and contains all the logic required to implement a backup/restore by copying files from and to the correct location / storage bucket.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FakeMysqlDaemon implements MysqlDaemon and allows the user to fake everything.
FileEntry is one file to backup.
IncrementalBackupDetails lists some incremental backup specific information.
ManifestHandleMap is a utility container to map manifests to handles, making it possible to search for, and iterate, handles based on manifests.
Mycnf is a memory structure that contains a bunch of interesting parameters to start mysqld.
Mysqld is the object that represents a mysqld daemon running on this server.
RestoreParams is the struct that holds all params passed to ExecuteRestore.
RestorePath is an ordered sequence of backup handles & manifests, that can be used to restore from backup.
No description provided by the author
XtrabackupEngine encapsulates the logic of the xtrabackup engine it implements the BackupEngine interface and contains all the logic required to implement a backup/restore by invoking xtrabackup with the appropriate parameters.

# Interfaces

BackupEngine is the interface to take a backup with a given engine.
BackupRestoreEngine is a combination of BackupEngine and RestoreEngine.
MysqlDaemon is the interface we use for abstracting Mysqld.
RestoreEngine is the interface to restore a backup with a given engine.

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author