config

Documentation

Index

• type Database
• type DatabaseAliases
• type DatabaseAnalyze
• type DatabaseDB
• type DatabaseDBDrop
• type DatabaseDBList
• type DatabaseDisableJob
• type DatabaseDump
• type DatabaseExec
• type DatabaseFile
• type DatabaseFilter
• type DatabasePassword
• type DatabasePort
• type DatabaseRestore
• type DatabaseTables
• type DatabaseUsername
• type Dump
• type Exec
• type Files
• type Global
• type Kubernetes
• type PortForward
• type Restore

Types

type Database

type Database interface {
	Name() string
	PodFilters() filter.Filter
}

type DatabaseAliases

type DatabaseAliases interface {
	Aliases() []string
}

type DatabaseAnalyze

type DatabaseAnalyze interface {
	AnalyzeQuery() string
}

type DatabaseDB

type DatabaseDB interface {
	DatabaseEnvNames() kubernetes.ConfigLookups
}

type DatabaseDBDrop

type DatabaseDBDrop interface {
	DropDatabaseQuery(database string) string
}

type DatabaseDBList

type DatabaseDBList interface {
	ListDatabasesQuery() string
}

type DatabaseDisableJob

type DatabaseDisableJob interface {
	DisableJob() bool
}

type DatabaseDump

type DatabaseDump interface {
	Database
	DumpCommand(conf Dump) *command.Builder
	DatabaseFile
}

type DatabaseExec

type DatabaseExec interface {
	Database
	ExecCommand(conf Exec) *command.Builder
}

type DatabaseFile

type DatabaseFile interface {
	Formats() map[sqlformat.Format]string
}

type DatabaseFilter

type DatabaseFilter interface {
	FilterPods(ctx context.Context, client kubernetes.KubeClient, pods []v1.Pod) ([]v1.Pod, error)
}

type DatabasePassword

type DatabasePassword interface {
	PasswordEnvNames(conf Global) kubernetes.ConfigLookups
}

type DatabasePort

type DatabasePort interface {
	DefaultPort() uint16
	PortEnvNames() kubernetes.ConfigLookups
}

type DatabaseRestore

type DatabaseRestore interface {
	Database
	RestoreCommand(conf Restore, inputFormat sqlformat.Format) *command.Builder
	DatabaseFile
}

type DatabaseTables

type DatabaseTables interface {
	ListTablesQuery() string
}

type DatabaseUsername

type DatabaseUsername interface {
	UserEnvNames() kubernetes.ConfigLookups
	DefaultUser() string
}

type Dump

type Dump struct {
	Global `mapstructure:",squash"`
	Files
	Directory        string
	IfExists         bool
	Clean            bool
	NoOwner          bool
	Tables           []string
	ExcludeTable     []string
	ExcludeTableData []string
	Spinner          string
}

type Exec

type Exec struct {
	Global         `mapstructure:",squash"`
	DisableHeaders bool
	Command        string
}

type Files

type Files struct {
	Filename string `mapstructure:"name"`
	Format   sqlformat.Format
}

type Global

type Global struct {
	Kubernetes
	Client  kubernetes.KubeClient
	Dialect Database `mapstructure:"-"`

	Job    *batchv1.Job
	JobPod v1.Pod `mapstructure:"-"`
	DBPod  v1.Pod `mapstructure:"-"`

	Host       string
	Port       uint16
	Database   string
	Username   string
	Password   string
	Quiet      bool
	RemoteGzip bool `mapstructure:"remote-gzip"`
}

type Kubernetes

type Kubernetes struct {
	Kubeconfig string
	Context    string
	Namespace  string
	Client     kubernetes.KubeClient
}

type PortForward

type PortForward struct {
	Global    `mapstructure:",squash"`
	Addresses []string
	LocalPort uint16
}

type Restore

type Restore struct {
	Global `mapstructure:",squash"`
	Files
	SingleTransaction bool
	Clean             bool
	NoOwner           bool
	Force             bool
	Spinner           string
	HaltOnError       bool
}