backup

Documentation

Index

• Constants
• Variables
• func AddTableToBackup(ch *clickhouse.ClickHouse, backupName string, diskList []clickhouse.Disk, ...) (map[string][]metadata.Part, map[string]int64, error)
• func CopyPartHashes(cfg config.Config, tablePattern string, backupName string) error
• func CreateBackup(cfg *config.Config, backupName, tablePattern string, ...) error
• func GetRemoteBackups(cfg *config.Config) ([]new_storage.Backup, error)
• func GetTables(cfg *config.Config) ([]clickhouse.Table, error)
• func IsInformationSchema(database string) bool
• func NewBackupName() string
• func PrintAllBackups(cfg *config.Config, format string) error
• func PrintLocalBackups(cfg *config.Config, format string) error
• func PrintRemoteBackups(cfg *config.Config, format string) error
• func PrintTables(cfg *config.Config, printAll bool) error
• func RemoveBackupLocal(cfg *config.Config, backupName string) error
• func RemoveBackupRemote(cfg *config.Config, backupName string) error
• func RemoveOldBackupsLocal(cfg *config.Config, keepLastBackup bool) error
• func Restore(cfg *config.Config, backupName string, tablePattern string, ...) error
• func RestoreData(cfg *config.Config, ch *clickhouse.ClickHouse, backupName string, ...) error
• func RestoreSchema(ch *clickhouse.ClickHouse, backupName string, tablePattern string, ...) error
• type BackupLocal
  • func GetBackupsToDelete(backups []BackupLocal, keep int) []BackupLocal
  • func GetLocalBackups(cfg *config.Config) ([]BackupLocal, error)
• type BackupOptions
• type Backuper
  • func NewBackuper(cfg *config.Config) *Backuper
  • func (b *Backuper) CreateToRemote(backupName, tablePattern, diffFrom string, schemaOnly, rbac, backupConfig bool, ...) error
  • func (b *Backuper) Download(backupName string, tablePattern string, schemaOnly bool) error
  • func (b *Backuper) ReadBackupMetadata(backupName string) (*metadata.BackupMetadata, error)
  • func (b *Backuper) RestoreFromRemote(backupName string, tablePattern string, ...) error
  • func (b *Backuper) Upload(backupName, tablePattern, diffFrom string, schemaOnly bool) error
• type RestoreTables
  • func (rt RestoreTables) Sort(dropTable bool)

Constants

const (
	// TimeFormatForBackup - default backup name format
	TimeFormatForBackup = "2006-01-02T15-04-05"

	MetaFileName = "metadata.json"
)

Variables

var (
	ErrBackupIsAlreadyExists = errors.New("backup is already exists")
)

var (
	// ErrUnknownClickhouseDataPath -
	ErrUnknownClickhouseDataPath = errors.New("clickhouse data path is unknown, you can set data_path in config file")
)

Functions

func AddTableToBackup

func AddTableToBackup(ch *clickhouse.ClickHouse, backupName string, diskList []clickhouse.Disk, table *clickhouse.Table) (map[string][]metadata.Part, map[string]int64, error)

func CopyPartHashes

func CopyPartHashes(cfg config.Config, tablePattern string, backupName string) error

CopyPartHashes - Copy data parts hashes by tablePattern

func CreateBackup

func CreateBackup(cfg *config.Config, backupName, tablePattern string, schemaOnly, rbacOnly, configsOnly bool, version string) error

CreateBackup - create new backup of all tables matched by tablePattern If backupName is empty string will use default backup name

func GetRemoteBackups

func GetRemoteBackups(cfg *config.Config) ([]new_storage.Backup, error)

GetRemoteBackups - get all backups stored on remote storage

func GetTables

func GetTables(cfg *config.Config) ([]clickhouse.Table, error)

GetTables - get all tables for use by PrintTables and API

func IsInformationSchema

func IsInformationSchema(database string) bool

func NewBackupName

func NewBackupName() string

NewBackupName - return default backup name

func PrintAllBackups

func PrintAllBackups(cfg *config.Config, format string) error

func PrintLocalBackups

func PrintLocalBackups(cfg *config.Config, format string) error

PrintLocalBackups - print all backups stored locally

func PrintRemoteBackups

func PrintRemoteBackups(cfg *config.Config, format string) error

PrintRemoteBackups - print all backups stored on remote storage

func PrintTables

func PrintTables(cfg *config.Config, printAll bool) error

PrintTables - print all tables suitable for backup

func RemoveBackupLocal

func RemoveBackupLocal(cfg *config.Config, backupName string) error

func RemoveBackupRemote

func RemoveBackupRemote(cfg *config.Config, backupName string) error

func RemoveOldBackupsLocal

func RemoveOldBackupsLocal(cfg *config.Config, keepLastBackup bool) error

func Restore

func Restore(cfg *config.Config, backupName string, tablePattern string, schemaOnly, dataOnly, dropTable, rbacOnly, configsOnly bool) error

Restore - restore tables matched by tablePattern from backupName

func RestoreData

func RestoreData(cfg *config.Config, ch *clickhouse.ClickHouse, backupName string, tablePattern string) error

RestoreData - restore data for tables matched by tablePattern from backupName

func RestoreSchema

func RestoreSchema(ch *clickhouse.ClickHouse, backupName string, tablePattern string, dropTable bool) error

RestoreSchema - restore schemas matched by tablePattern from backupName

Types

type BackupLocal

type BackupLocal struct {
	metadata.BackupMetadata
	Legacy bool
	Broken string
}

func GetBackupsToDelete

func GetBackupsToDelete(backups []BackupLocal, keep int) []BackupLocal

func GetLocalBackups

func GetLocalBackups(cfg *config.Config) ([]BackupLocal, error)

GetLocalBackups - return slice of all backups stored locally

type BackupOptions

type BackupOptions struct {
	BackupName        string
	TablePattern      string
	DiffFrom          string
	SchemaOnly        bool
	DataOnly          bool
	DropBeforeRestore bool
}

type Backuper

type Backuper struct {
	Version         string
	DiskMap         map[string]string
	DefaultDataPath string
	// contains filtered or unexported fields
}

func NewBackuper

func NewBackuper(cfg *config.Config) *Backuper

func (*Backuper) CreateToRemote

func (b *Backuper) CreateToRemote(backupName, tablePattern, diffFrom string, schemaOnly, rbac, backupConfig bool, version string) error

func (*Backuper) Download

func (b *Backuper) Download(backupName string, tablePattern string, schemaOnly bool) error

func (*Backuper) ReadBackupMetadata

func (b *Backuper) ReadBackupMetadata(backupName string) (*metadata.BackupMetadata, error)

func (*Backuper) RestoreFromRemote

func (b *Backuper) RestoreFromRemote(backupName string, tablePattern string, schemaOnly, dataOnly, dropTable, rbacOnly, configsOnly bool) error

func (*Backuper) Upload

func (b *Backuper) Upload(backupName, tablePattern, diffFrom string, schemaOnly bool) error

type RestoreTables

type RestoreTables []metadata.TableMetadata

RestoreTables - slice of RestoreTable

func (RestoreTables) Sort

func (rt RestoreTables) Sort(dropTable bool)

Sort - sorting BackupTables slice orderly by name