Struct PgBaseBackupBuilder

pub struct PgBaseBackupBuilder { /* private fields */ }

pg_basebackup takes a base backup of a running PostgreSQL server.

Implementations

impl PgBaseBackupBuilder

pub fn new() -> Self

Create a new PgBaseBackupBuilder

pub fn from(settings: &dyn Settings) -> Self

Create a new PgBaseBackupBuilder from Settings

pub fn program_dir<P: Into<PathBuf>>(self, path: P) -> Self

Location of the program binary

pub fn pgdata<P: Into<PathBuf>>(self, pgdata: P) -> Self

receive base backup into directory

pub fn format<S: AsRef<OsStr>>(self, format: S) -> Self

output format (plain (default), tar)

pub fn max_rate<S: AsRef<OsStr>>(self, max_rate: S) -> Self

maximum transfer rate to transfer data directory (in kB/s, or use suffix “k” or “M”)

pub fn write_recovery_conf(self) -> Self

write configuration for replication

pub fn target<S: AsRef<OsStr>>(self, target: S) -> Self

backup target (if other than client)

pub fn tablespace_mapping<S: AsRef<OsStr>>(self, tablespace_mapping: S) -> Self

relocate tablespace in OLDDIR to NEWDIR

pub fn waldir<S: AsRef<OsStr>>(self, waldir: S) -> Self

location for the write-ahead log directory

pub fn wal_method<S: AsRef<OsStr>>(self, wal_method: S) -> Self

include required WAL files with specified method

pub fn gzip(self) -> Self

compress tar output

pub fn compress<S: AsRef<OsStr>>(self, compress: S) -> Self

compress on client or server as specified

pub fn checkpoint<S: AsRef<OsStr>>(self, checkpoint: S) -> Self

set fast or spread checkpointing

pub fn create_slot(self) -> Self

create replication slot

pub fn label<S: AsRef<OsStr>>(self, label: S) -> Self

set backup label

pub fn no_clean(self) -> Self

do not clean up after errors

pub fn no_sync(self) -> Self

do not wait for changes to be written safely to disk

pub fn progress(self) -> Self

show progress information

pub fn slot<S: AsRef<OsStr>>(self, slot: S) -> Self

replication slot to use

pub fn verbose(self) -> Self

output verbose messages

pub fn version(self) -> Self

output version information, then exit

pub fn manifest_checksums<S: AsRef<OsStr>>(self, manifest_checksums: S) -> Self

use algorithm for manifest checksums

pub fn manifest_force_encode(self) -> Self

hex encode all file names in manifest

pub fn no_estimate_size(self) -> Self

do not estimate backup size in server side

pub fn no_manifest(self) -> Self

suppress generation of backup manifest

pub fn no_slot(self) -> Self

prevent creation of temporary replication slot

pub fn no_verify_checksums(self) -> Self

do not verify checksums

pub fn help(self) -> Self

show this help, then exit

pub fn dbname<S: AsRef<OsStr>>(self, dbname: S) -> Self

connection string

pub fn host<S: AsRef<OsStr>>(self, host: S) -> Self

database server host or socket directory

pub fn port(self, port: u16) -> Self

database server port number

pub fn status_interval<S: AsRef<OsStr>>(self, status_interval: S) -> Self

time between status packets sent to server (in seconds)

pub fn username<S: AsRef<OsStr>>(self, username: S) -> Self

connect as specified database user

pub fn no_password(self) -> Self

never prompt for password

pub fn password(self) -> Self

force password prompt (should happen automatically)

pub fn pg_password<S: AsRef<OsStr>>(self, pg_password: S) -> Self

user password

Trait Implementations

impl Clone for PgBaseBackupBuilder

fn clone(&self) -> PgBaseBackupBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandBuilder for PgBaseBackupBuilder

fn get_program(&self) -> &'static OsStr

Get the program name

fn get_program_dir(&self) -> &Option<PathBuf>

Location of the program binary

fn get_args(&self) -> Vec<OsString>

Get the arguments for the command

fn get_envs(&self) -> Vec<(OsString, OsString)>

Get the environment variables for the command

fn env<S: AsRef<OsStr>>(self, key: S, value: S) -> Self

Set an environment variable for the command

fn get_program_file(&self) -> PathBuf

Fully qualified path to the program binary

fn build(self) -> Command

where Self: Sized,

Build a standard Command

impl Debug for PgBaseBackupBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PgBaseBackupBuilder

fn default() -> PgBaseBackupBuilder

Returns the “default value” for a type.