dbbackup

type BinlogPosition struct {
	File     string `json:"file"`
	Position int64  `json:"position"`
}

type BinlogPrevious struct {
	BinlogPosition
	RunID    string `json:"run_id,omitempty"`
	Snapshot string `json:"snapshot,omitempty"`
}

type Config struct {
	// SpoolDir receives the dumps before upload (default <data_dir>/spool)
	SpoolDir string `yaml:"spool_dir,omitempty" json:"spool_dir,omitempty"`
	// StateDir keeps per-job state such as the last MySQL binlog position (default <data_dir>/state/db)
	StateDir string `yaml:"state_dir,omitempty" json:"state_dir,omitempty"`
	// MinFreeBytes must be free on the spool filesystem before and during a run (default 1 GiB)
	MinFreeBytes int64 `yaml:"min_free_bytes,omitempty" json:"min_free_bytes,omitempty"`
	// SizeSafetyFactor scales the server's size estimate for the disk check (default 1.2)
	SizeSafetyFactor float64 `yaml:"size_safety_factor,omitempty" json:"size_safety_factor,omitempty"`
	// KillGrace is the SIGTERM → SIGKILL grace period for client tools (default 20s)
	KillGrace time.Duration `yaml:"kill_grace,omitempty" json:"kill_grace,omitempty"`
	// KeepFailedSpool leaves the spool directory in place when a run fails (debugging)
	KeepFailedSpool bool `yaml:"keep_failed_spool,omitempty" json:"keep_failed_spool,omitempty"`
	// Checksums records a sha256 per spooled file in the manifest (default true)
	Checksums *bool                        `yaml:"checksums,omitempty" json:"checksums,omitempty"`
	Tools     ToolConfig                   `yaml:"tools,omitempty" json:"tools"`
	Profiles  map[string]CredentialProfile `yaml:"profiles,omitempty" json:"profiles,omitempty"`
}

type CredentialProfile struct {
	Engine   string `yaml:"engine" json:"engine"`
	User     string `yaml:"user,omitempty" json:"user,omitempty"`
	Password string `yaml:"password,omitempty" json:"-"`
	// PasswordFile is read at run time (trailing newline trimmed)
	PasswordFile string  `yaml:"password_file,omitempty" json:"password_file,omitempty"`
	Host         string  `yaml:"host,omitempty" json:"host,omitempty"`
	Port         int     `yaml:"port,omitempty" json:"port,omitempty"`
	TLS          TLSSpec `yaml:"tls,omitempty" json:"tls"`
}

type Credentials struct {
	User     string
	Password string
	Host     string
	Port     int
	TLS      TLSSpec
	// Source records where the password came from ("job", "profile:<name>", "none",
	// or "local:<method>" for the agent's passwordless fallback on the database host)
	Source string
	// RunAs names the OS user the client tools run as, for peer / socket authentication
	// on the database host (PostgreSQL: postgres); "" is the agent's own user. Only the
	// agent's local fallback sets it, never a job or profile.
	RunAs string
}

type DatabaseEntry struct {
	Name       string `json:"name"`
	File       string `json:"file,omitempty"`
	Format     string `json:"format,omitempty"`
	SizeBytes  int64  `json:"size_bytes"`
	SHA256     string `json:"sha256,omitempty"`
	DurationMS int64  `json:"duration_ms"`
}

type FileEntry struct {
	Path      string `json:"path"`
	SizeBytes int64  `json:"size_bytes"`
	SHA256    string `json:"sha256,omitempty"`
	Kind      string `json:"kind,omitempty"`
}

type JobState struct {
	JobID       string          `json:"job_id"`
	Engine      string          `json:"engine"`
	LastSuccess *JobStateRecord `json:"last_success,omitempty"`
}

type JobStateRecord struct {
	RunID       string         `json:"run_id"`
	Snapshot    string         `json:"snapshot"`
	CompletedAt time.Time      `json:"completed_at"`
	MySQL       *MySQLState    `json:"mysql,omitempty"`
	Postgres    *PostgresState `json:"postgres,omitempty"`
	MSSQL       *MSSQLState    `json:"mssql,omitempty"`
}

type K8sTarget struct {
	Namespace string `json:"namespace"`
	// Service is the Service the dump pod connects to (<service>.<namespace>.svc);
	// Spec.Host, when set, is used verbatim instead
	Service string `json:"service,omitempty"`
	// SecretName names a Secret in Namespace holding the credentials: PasswordKey
	// (default "password") and optionally UserKey. A password stored on the job wins.
	SecretName  string `json:"secret_name,omitempty"`
	PasswordKey string `json:"password_key,omitempty"`
	UserKey     string `json:"user_key,omitempty"`
	// ToolsImage overrides the client-tools image of the dump pod (default: the agent's
	// per-engine image template with the tag taken from the detected server version)
	ToolsImage string `json:"tools_image,omitempty"`
}

type MSSQLBackupRef struct {
	RunID         string    `json:"run_id"`
	Snapshot      string    `json:"snapshot"`
	Files         []string  `json:"files"`
	BackupSetUUID string    `json:"backup_set_uuid"`
	FirstLSN      string    `json:"first_lsn,omitempty"`
	LastLSN       string    `json:"last_lsn,omitempty"`
	At            time.Time `json:"at"`
}

type MSSQLBackupSet struct {
	Database string `json:"database"`
	// Type is full, differential or log
	Type          string   `json:"type"`
	RecoveryModel string   `json:"recovery_model,omitempty"`
	Files         []string `json:"files"`
	BackupSetUUID string   `json:"backup_set_uuid,omitempty"`
	FirstLSN      string   `json:"first_lsn,omitempty"`
	LastLSN       string   `json:"last_lsn,omitempty"`
	CheckpointLSN string   `json:"checkpoint_lsn,omitempty"`
	// DatabaseBackupLSN is the checkpoint LSN of the full backup this set builds on
	DatabaseBackupLSN string `json:"database_backup_lsn,omitempty"`
	// DifferentialBaseGUID is the backup_set_uuid of the differential's base full
	DifferentialBaseGUID string    `json:"differential_base_guid,omitempty"`
	StartedAt            time.Time `json:"started_at,omitempty"`
	FinishedAt           time.Time `json:"finished_at,omitempty"`
	BackupBytes          int64     `json:"backup_bytes,omitempty"`
	CompressedBytes      int64     `json:"compressed_bytes,omitempty"`
	// Reason says why this type was chosen (auto mode, chain resets)
	Reason string `json:"reason,omitempty"`
}

type MSSQLDBState struct {
	RecoveryModel string          `json:"recovery_model,omitempty"`
	LastFull      *MSSQLBackupRef `json:"last_full,omitempty"`
	LastDiff      *MSSQLBackupRef `json:"last_diff,omitempty"`
	// Logs are the log backups since the newest full or differential, oldest first
	Logs []MSSQLBackupRef `json:"logs,omitempty"`
}

type MSSQLManifest struct {
	Edition        string `json:"edition,omitempty"`
	ProductVersion string `json:"product_version,omitempty"`
	// Mode is the job's mode; every backup set names the type actually taken
	Mode        string           `json:"mode"`
	BackupDir   string           `json:"backup_dir"`
	AgentDir    string           `json:"agent_dir,omitempty"`
	Compression bool             `json:"compression"`
	Checksum    bool             `json:"checksum"`
	CopyOnly    bool             `json:"copy_only,omitempty"`
	BackupSets  []MSSQLBackupSet `json:"backup_sets"`
	// Skipped lists databases that were left out, with the reason
	Skipped []MSSQLSkipped `json:"skipped,omitempty"`
}

type MSSQLOptions struct {
	// Mode is auto (default), full, differential or log
	Mode string `json:"mode,omitempty"`
	// FullEveryDays is the age after which auto mode takes a new full backup (default 7)
	FullEveryDays int `json:"full_every_days,omitempty"`
	// IncludeLog also backs up the transaction log of FULL/BULK_LOGGED databases right
	// after their full or differential backup (not used in log mode)
	IncludeLog bool `json:"include_log,omitempty"`
	// Compression uses SQL Server's native backup compression. Off by default: PBS
	// deduplicates uncompressed backups far better, and Express cannot compress.
	Compression bool `json:"compression,omitempty"`
	// Checksum adds WITH CHECKSUM (default true)
	Checksum *bool `json:"checksum,omitempty"`
	// CopyOnly takes copy-only backups that do not disturb another tool's chain;
	// differentials cannot be based on them, so it requires mode full or log
	CopyOnly bool `json:"copy_only,omitempty"`
	// BackupDir is the directory as SQL Server sees it (default: the instance's
	// default backup path). The SQL Server service account must be able to write it.
	BackupDir string `json:"backup_dir,omitempty"`
	// AgentDir is the same directory as the agent sees it (a UNC share or a bind
	// mount when SQL Server runs elsewhere or in a container); default BackupDir
	AgentDir string `json:"agent_dir,omitempty"`
	// StripeCount splits each backup over this many files (1..16, default 1)
	StripeCount int `json:"stripe_count,omitempty"`
	// MaxTransferSize is WITH MAXTRANSFERSIZE in bytes (a multiple of 64 KiB up to
	// 4 MiB; 0 = server default)
	MaxTransferSize int `json:"max_transfer_size,omitempty"`
}

type MSSQLSkipped struct {
	Database string `json:"database"`
	Reason   string `json:"reason"`
}

type MSSQLState struct {
	Databases map[string]*MSSQLDBState `json:"databases"`
}

type Manifest struct {
	SchemaVersion int               `json:"schema_version"`
	Generator     ManifestGenerator `json:"generator"`
	Job           ManifestJob       `json:"job"`
	Snapshot      ManifestSnapshot  `json:"snapshot"`
	Engine        string            `json:"engine"`
	StartedAt     time.Time         `json:"started_at"`
	FinishedAt    time.Time         `json:"finished_at"`
	// ConsistentAsOf is the point in time the backup represents
	ConsistentAsOf time.Time         `json:"consistent_as_of"`
	Server         ManifestServer    `json:"server"`
	Tools          map[string]Tool   `json:"tools"`
	Spec           *Spec             `json:"spec"`
	Databases      []DatabaseEntry   `json:"databases"`
	Files          []FileEntry       `json:"files"`
	Warnings       []string          `json:"warnings,omitempty"`
	Notes          []string          `json:"notes,omitempty"`
	Postgres       *PostgresManifest `json:"postgres,omitempty"`
	MySQL          *MySQLManifest    `json:"mysql,omitempty"`
	MongoDB        *MongoManifest    `json:"mongodb,omitempty"`
	MSSQL          *MSSQLManifest    `json:"mssql,omitempty"`
	Restore        Restore           `json:"restore"`
}

type ManifestGenerator struct {
	Agent    string `json:"agent"`
	Version  string `json:"version"`
	Hostname string `json:"hostname"`
}

type ManifestJob struct {
	ID          string `json:"id"`
	Name        string `json:"name,omitempty"`
	RunID       string `json:"run_id,omitempty"`
	BackupRunID string `json:"backup_run_id"`
}

type ManifestServer struct {
	Host       string `json:"host"`
	Port       int    `json:"port"`
	User       string `json:"user,omitempty"`
	Version    string `json:"version,omitempty"`
	VersionNum int    `json:"version_num,omitempty"`
	Flavor     string `json:"flavor,omitempty"`
	IsReplica  bool   `json:"is_replica,omitempty"`
}

type ManifestSnapshot struct {
	Type    string    `json:"type"`
	ID      string    `json:"id"`
	Time    time.Time `json:"time"`
	Archive string    `json:"archive"`
}

type MongoManifest struct {
	Dir            string   `json:"dir"`
	Oplog          bool     `json:"oplog"`
	OplogFile      string   `json:"oplog_file,omitempty"`
	Gzip           bool     `json:"gzip"`
	ReadPreference string   `json:"read_preference,omitempty"`
	Databases      []string `json:"databases,omitempty"`
	PerDatabase    bool     `json:"per_database"`
}

type MongoOptions struct {
	// Oplog captures the oplog during the dump (point-in-time, requires a replica set and
	// dumping all databases); default true when no database list is given
	Oplog          *bool  `json:"oplog,omitempty"`
	ReadPreference string `json:"read_preference,omitempty"`
	// AuthSource is the database holding the user (default admin, or $external for
	// the certificate / Kerberos / LDAP / AWS mechanisms)
	AuthSource string `json:"auth_source,omitempty"`
	// AuthMechanism is one of MongoAuthMechanisms; blank = server default (SCRAM)
	AuthMechanism          string   `json:"auth_mechanism,omitempty"`
	ReplicaSet             string   `json:"replica_set,omitempty"`
	NumParallelCollections int      `json:"num_parallel_collections,omitempty"`
	ExtraArgs              []string `json:"extra_args,omitempty"`
}

type MySQLBinlog struct {
	Enabled        bool            `json:"enabled"`
	PositionSource string          `json:"position_source,omitempty"`
	File           string          `json:"file,omitempty"`
	Position       int64           `json:"position,omitempty"`
	GTID           string          `json:"gtid,omitempty"`
	GTIDMode       string          `json:"gtid_mode,omitempty"`
	ServerID       int64           `json:"server_id,omitempty"`
	ServerUUID     string          `json:"server_uuid,omitempty"`
	Previous       *BinlogPrevious `json:"previous,omitempty"`
	Files          []FileEntry     `json:"files,omitempty"`
	CoversFrom     *BinlogPosition `json:"covers_from,omitempty"`
	CoversTo       *BinlogPosition `json:"covers_to,omitempty"`
	ChainReset     bool            `json:"chain_reset"`
	ChainGap       bool            `json:"chain_gap"`
}

type MySQLManifest struct {
	Flavor                 string       `json:"flavor"`
	DumpFiles              []string     `json:"dump_files"`
	AllDatabases           bool         `json:"all_databases"`
	PerDatabase            bool         `json:"per_database"`
	SingleTransaction      bool         `json:"single_transaction"`
	FlushLogs              bool         `json:"flush_logs"`
	NonTransactionalTables int          `json:"non_transactional_tables"`
	Binlog                 *MySQLBinlog `json:"binlog,omitempty"`
}

type MySQLOptions struct {
	SingleTransaction *bool `json:"single_transaction,omitempty"` // default true
	// IncludeBinlogs fetches the binary logs written since the previous successful run
	IncludeBinlogs bool  `json:"include_binlogs,omitempty"`
	FlushLogs      *bool `json:"flush_logs,omitempty"` // default = IncludeBinlogs
	// IncludeSystemSchemas also dumps the mysql schema when an explicit list is given
	IncludeSystemSchemas bool `json:"include_system_schemas,omitempty"`
	// PerDatabase dumps every database to its own file instead of one --all-databases
	// file (the mysql schema included), so a single database can be restored on its
	// own; the dumps are taken one after another and are not mutually consistent.
	// An explicit database or exclude list always dumps per database.
	PerDatabase   bool     `json:"per_database,omitempty"`
	Routines      *bool    `json:"routines,omitempty"` // default true
	Triggers      *bool    `json:"triggers,omitempty"` // default true
	Events        *bool    `json:"events,omitempty"`   // default true
	ExtraDumpArgs []string `json:"extra_dump_args,omitempty"`
}

type MySQLState struct {
	BinlogFile string `json:"binlog_file"`
	BinlogPos  int64  `json:"binlog_pos"`
	GTID       string `json:"gtid,omitempty"`
	ServerID   int64  `json:"server_id,omitempty"`
	ServerUUID string `json:"server_uuid,omitempty"`
}

type PostgresBasebackup struct {
	Dir          string   `json:"dir"`
	Files        []string `json:"files"`
	Label        string   `json:"label"`
	Timeline     int64    `json:"timeline,omitempty"`
	WALStartLSN  string   `json:"wal_start_lsn,omitempty"`
	WALEndLSN    string   `json:"wal_end_lsn,omitempty"`
	WALStartFile string   `json:"wal_start_file,omitempty"`
	WALEndFile   string   `json:"wal_end_file,omitempty"`
	WALSource    string   `json:"wal_source,omitempty"`
	Compression  string   `json:"compression"`
}

type PostgresGlobals struct {
	File                  string `json:"file"`
	RolePasswordsIncluded bool   `json:"role_passwords_included"`
}

type PostgresManifest struct {
	Mode       string              `json:"mode"`
	Globals    *PostgresGlobals    `json:"globals,omitempty"`
	Basebackup *PostgresBasebackup `json:"basebackup,omitempty"`
	// WAL position of the server when the logical dumps were taken
	WALLSN string `json:"wal_lsn,omitempty"`
}

type PostgresOptions struct {
	Mode string `json:"mode,omitempty"`
	// Format is "custom" (default, pg_restore) or "plain" (psql)
	Format string `json:"format,omitempty"`
	// Globals dumps roles and tablespaces with pg_dumpall --globals-only (default true)
	Globals *bool `json:"globals,omitempty"`
	// RolePasswords: "auto" (include when superuser), "include", "omit"
	RolePasswords string   `json:"role_passwords,omitempty"`
	ExtraDumpArgs []string `json:"extra_dump_args,omitempty"`
}

type PostgresState struct {
	WALEndLSN string `json:"wal_end_lsn,omitempty"`
	Timeline  int64  `json:"timeline,omitempty"`
}

type ProfileSummary struct {
	Name   string `json:"name"`
	Engine string `json:"engine"`
	User   string `json:"user,omitempty"`
	Host   string `json:"host,omitempty"`
}

type Restore struct {
	Summary  string   `json:"summary"`
	Commands []string `json:"commands"`
}

type Spec struct {
	Engine string `json:"engine"`
	// Host is a hostname/IP, or a path (leading "/") for a local unix socket; optional
	// for kubernetes targets that name a Service
	Host string `json:"host"`
	Port int    `json:"port,omitempty"`
	User string `json:"user,omitempty"`
	// Password is stored server-side; blank means the agent resolves it from Profile
	Password string `json:"password,omitempty"`
	// HasPassword is set on API responses instead of the password itself
	HasPassword bool `json:"has_password,omitempty"`
	// ClearPassword (request only) removes a stored password on update
	ClearPassword bool `json:"clear_password,omitempty"`
	// Profile names the agent-side credential profile (default: the engine name)
	Profile          string   `json:"profile,omitempty"`
	TLS              TLSSpec  `json:"tls"`
	Databases        []string `json:"databases,omitempty"`
	ExcludeDatabases []string `json:"exclude_databases,omitempty"`
	Compression      string   `json:"compression,omitempty"`
	// BackupID overrides the PBS backup group id (default db-<engine>-<host>)
	BackupID string `json:"backup_id,omitempty"`

	Postgres *PostgresOptions `json:"postgres,omitempty"`
	MySQL    *MySQLOptions    `json:"mysql,omitempty"`
	MongoDB  *MongoOptions    `json:"mongodb,omitempty"`
	MSSQL    *MSSQLOptions    `json:"mssql,omitempty"`

	// Kubernetes is set when the job runs on a kubernetes agent
	Kubernetes *K8sTarget `json:"kubernetes,omitempty"`
}

type TLSSpec struct {
	Mode     string `json:"mode,omitempty" yaml:"mode,omitempty"`
	CAFile   string `json:"ca_file,omitempty" yaml:"ca_file,omitempty"`
	CertFile string `json:"cert_file,omitempty" yaml:"cert_file,omitempty"`
	KeyFile  string `json:"key_file,omitempty" yaml:"key_file,omitempty"`
}

type Tool struct {
	Path    string `json:"path"`
	Version string `json:"version"`
}

type ToolConfig struct {
	PostgresBinDir string `yaml:"postgres_bindir,omitempty" json:"postgres_bindir,omitempty"`
	MySQLBinDir    string `yaml:"mysql_bindir,omitempty" json:"mysql_bindir,omitempty"`
	MongoBinDir    string `yaml:"mongo_bindir,omitempty" json:"mongo_bindir,omitempty"`
}