metadata

Documentation

Index

• type BackupMetadata
  • func (bm *BackupMetadata) Save(location string) error
• type DatabasesMeta
• type FunctionsMeta
• type MutationMetadata
• type Part
• type SplitPartFiles
• type TableMetadata
  • func (tm *TableMetadata) Load(location string) (uint64, error)
  • func (tm *TableMetadata) Save(location string, metadataOnly bool) (uint64, error)
• type TableTitle

Types

type BackupMetadata

type BackupMetadata struct {
	BackupName              string            `json:"backup_name"`
	Disks                   map[string]string `json:"disks"`      // "default": "/var/lib/clickhouse"
	DiskTypes               map[string]string `json:"disk_types"` // "default": "local"
	ClickhouseBackupVersion string            `json:"version"`
	CreationDate            time.Time         `json:"creation_date"`
	Tags                    string            `json:"tags,omitempty"` // "regular,embedded"
	ClickHouseVersion       string            `json:"clickhouse_version,omitempty"`
	DataSize                uint64            `json:"data_size,omitempty"`
	MetadataSize            uint64            `json:"metadata_size"`
	RBACSize                uint64            `json:"rbac_size,omitempty"`
	ConfigSize              uint64            `json:"config_size,omitempty"`
	CompressedSize          uint64            `json:"compressed_size,omitempty"`
	Databases               []DatabasesMeta   `json:"databases,omitempty"`
	Tables                  []TableTitle      `json:"tables"`
	Functions               []FunctionsMeta   `json:"functions"`
	DataFormat              string            `json:"data_format"`
	RequiredBackup          string            `json:"required_backup,omitempty"`
}

func (*BackupMetadata) Save

func (bm *BackupMetadata) Save(location string) error

type DatabasesMeta

type DatabasesMeta struct {
	Name   string `json:"name"`
	Engine string `json:"engine"`
	Query  string `json:"query"`
}

type FunctionsMeta

type FunctionsMeta struct {
	Name        string `json:"name"`
	CreateQuery string `json:"create_query"`
}

type MutationMetadata

type MutationMetadata struct {
	MutationId string `json:"mutation_id" ch:"mutation_id"`
	Command    string `json:"command" ch:"command"`
}

type Part

type Part struct {
	Name           string `json:"name"`
	Required       bool   `json:"required,omitempty"`
	RebalancedDisk string `json:"rebalanced_disk,omitempty"`
	// @todo remove legacy backup fields
	// Path                              string    `json:"path"`              // TODO: make it relative? look like useless now, can be calculated from Name
	HashOfAllFiles                    string     `json:"hash_of_all_files,omitempty"` // ???
	HashOfUncompressedFiles           string     `json:"hash_of_uncompressed_files,omitempty"`
	UncompressedHashOfCompressedFiles string     `json:"uncompressed_hash_of_compressed_files,omitempty"` // ???
	PartitionID                       string     `json:"partition_id,omitempty"`
	ModificationTime                  *time.Time `json:"modification_time,omitempty"`
	Size                              int64      `json:"size,omitempty"`
}

type SplitPartFiles

type SplitPartFiles struct {
	Prefix string
	Files  []string
}

type TableMetadata

type TableMetadata struct {
	Files                map[string][]string `json:"files,omitempty"`
	RebalancedFiles      map[string]string   `json:"rebalanced_files,omitempty"`
	Table                string              `json:"table"`
	Database             string              `json:"database"`
	Parts                map[string][]Part   `json:"parts"`
	Query                string              `json:"query"`
	Size                 map[string]int64    `json:"size"`                  // how much size on each disk
	TotalBytes           uint64              `json:"total_bytes,omitempty"` // total table size
	DependenciesTable    string              `json:"dependencies_table,omitempty"`
	DependenciesDatabase string              `json:"dependencies_database,omitempty"`
	Mutations            []MutationMetadata  `json:"mutations,omitempty"`
	MetadataOnly         bool                `json:"metadata_only"`
	LocalFile            string              `json:"local_file,omitempty"`
}

func (*TableMetadata) Load

func (tm *TableMetadata) Load(location string) (uint64, error)

func (*TableMetadata) Save

func (tm *TableMetadata) Save(location string, metadataOnly bool) (uint64, error)

type TableTitle

type TableTitle struct {
	Database string `json:"database"`
	Table    string `json:"table"`
}