backupstorage

Documentation

Overview

Package backupstorage contains the interface and file system implementation of the backup system.

Index

• Variables
• type BackupHandle
• type BackupStorage
  • func GetBackupStorage() (BackupStorage, error)
• type Params
  • func NoParams() Params

Variables

var (
	// BackupStorageImplementation is the implementation to use
	// for BackupStorage. Exported for test purposes.
	BackupStorageImplementation string
	// FileSizeUnknown is a special value indicating that the file size is not known.
	// This is typically used while creating a file programmatically, where it is
	// impossible to compute the final size on disk ahead of time.
	FileSizeUnknown = int64(-1)
)

var BackupStorageMap = make(map[string]BackupStorage)

BackupStorageMap contains the registered implementations for BackupStorage

Types

type BackupHandle

type BackupHandle interface {
	// Directory is the location of the backup. Will contain keyspace/shard.
	Directory() string

	// Name is the individual name of the backup. Will contain
	// tabletAlias-timestamp.
	Name() string

	// AddFile opens a new file to be added to the backup.
	// Only works for read-write backups (created by StartBackup).
	// filename is guaranteed to only contain alphanumerical
	// characters and hyphens.
	// It should be thread safe, it is possible to call AddFile in
	// multiple go routines once a backup has been started.
	// The context is valid for the duration of the writes, until the
	// WriteCloser is closed.
	// filesize should not be treated as an exact value but rather
	// as an approximate value.
	// A filesize of -1 should be treated as a special value indicating that
	// the file size is unknown.
	AddFile(ctx context.Context, filename string, filesize int64) (io.WriteCloser, error)

	// EndBackup stops and closes a backup. The contents should be kept.
	// Only works for read-write backups (created by StartBackup).
	EndBackup(ctx context.Context) error

	// AbortBackup stops a backup, and removes the contents that
	// have been copied already. It is called if an error occurs
	// while the backup is being taken, and the backup cannot be finished.
	// Only works for read-write backups (created by StartBackup).
	AbortBackup(ctx context.Context) error

	// ReadFile starts reading a file from a backup.
	// Only works for read-only backups (created by ListBackups).
	// The context is valid for the duration of the reads, until the
	// ReadCloser is closed.
	ReadFile(ctx context.Context, filename string) (io.ReadCloser, error)

	// concurrency.ErrorRecorder is embedded here to coordinate reporting and
	// handling of errors among all the components involved in taking a backup.
	concurrency.ErrorRecorder
}

BackupHandle describes an individual backup.

type BackupStorage

type BackupStorage interface {
	// ListBackups returns all the backups in a directory.  The
	// returned backups are read-only (ReadFile can be called, but
	// AddFile/EndBackup/AbortBackup cannot).
	// The backups are string-sorted by Name(), ascending (ends up
	// being the oldest backup first).
	ListBackups(ctx context.Context, dir string) ([]BackupHandle, error)

	// StartBackup creates a new backup with the given name.  If a
	// backup with the same name already exists, it's an error.
	// The returned backup is read-write
	// (AddFile/EndBackup/AbortBackup can all be called, not
	// ReadFile). The provided context is only valid for that
	// function, and should not be stored by the implementation.
	StartBackup(ctx context.Context, dir, name string) (BackupHandle, error)

	// RemoveBackup removes all the data associated with a backup.
	// It will not appear in ListBackups after RemoveBackup succeeds.
	RemoveBackup(ctx context.Context, dir, name string) error

	// Close frees resources associated with an active backup
	// session, such as closing connections. Implementations of
	// BackupStorage must support being reused after Close() is called.
	Close() error

	// WithParams should return a new BackupStorage which is a shared-nothing
	// copy of the current BackupStorage and which uses Params.
	//
	// This method is intended to give BackupStorage implementations logging
	// and metrics mechanisms.
	WithParams(Params) BackupStorage
}

BackupStorage is the interface to the storage system

func GetBackupStorage

func GetBackupStorage() (BackupStorage, error)

GetBackupStorage returns the current BackupStorage implementation. Should be called after flags have been initialized. When all operations are done, call BackupStorage.Close() to free resources.

type Params

type Params struct {
	Logger logutil.Logger
	Stats  backupstats.Stats
}

Params contains common utilities that may be used by BackupStorage and FileHandle components. This gives out-of-three backup/restore plugins mechanisms to log and generate metrics, while keeping policies (metric names and labels, logging destination, etc.) in the control of in-tree components and Vitess users.

func NoParams

func NoParams() Params

NoParams gives BackupStorage components way to log and generate stats without doing nil checking.