Struct PgDumpAllBuilder 

pub struct PgDumpAllBuilder { /* private fields */ }

pg_dumpall extracts a PostgreSQL database cluster into an SQL script file.

Implementations

impl PgDumpAllBuilder

pub fn new() -> Self

Create a new PgDumpAllBuilder

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

Create a new PgDumpAllBuilder from Settings

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

Location of the program binary

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

output file name

pub fn verbose(self) -> Self

verbose mode

pub fn version(self) -> Self

output version information, then exit

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

fail after waiting TIMEOUT for a table lock

pub fn help(self) -> Self

show help, then exit

pub fn data_only(self) -> Self

dump only the data, not the schema

pub fn clean(self) -> Self

clean (drop) database objects before recreating them

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

encoding for the dump

pub fn globals_only(self) -> Self

dump only global objects, not database-specific objects

pub fn no_owner(self) -> Self

do not output commands to set object ownership

pub fn roles_only(self) -> Self

dump only the roles, not the role memberships or privileges

pub fn schema_only(self) -> Self

dump only the object definitions (schema), not data

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

superuser user name to use in the dump

pub fn tablespaces_only(self) -> Self

dump only the tablespace definitions

pub fn no_privileges(self) -> Self

do not dump object privileges (grant/revoke commands)

pub fn binary_upgrade(self) -> Self

dump in a format suitable for binary upgrade

pub fn column_inserts(self) -> Self

dump data as INSERT commands with column names

pub fn disable_dollar_quoting(self) -> Self

disable dollar quoting, use SQL standard quoting

pub fn disable_triggers(self) -> Self

disable triggers during data-only restore

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

exclude the named database from the dump

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

set the number of digits displayed for floating-point values

pub fn if_exists(self) -> Self

use IF EXISTS when dropping objects

pub fn inserts(self) -> Self

dump data as proper INSERT commands

pub fn load_via_partition_root(self) -> Self

load data via the partition root table

pub fn no_comments(self) -> Self

do not dump comments

pub fn no_publications(self) -> Self

do not dump publications

pub fn no_role_passwords(self) -> Self

do not dump passwords for roles

pub fn no_security_labels(self) -> Self

do not dump security labels

pub fn no_subscriptions(self) -> Self

do not dump subscriptions

pub fn no_sync(self) -> Self

do not wait for changes to be written safely to disk

pub fn no_table_access_method(self) -> Self

do not dump table access method information

pub fn no_tablespaces(self) -> Self

do not dump tablespace assignments

pub fn no_toast_compression(self) -> Self

do not dump TOAST compression information

pub fn no_unlogged_table_data(self) -> Self

do not dump unlogged table data

pub fn on_conflict_do_nothing(self) -> Self

use ON CONFLICT DO NOTHING for INSERTs

pub fn quote_all_identifiers(self) -> Self

quote all identifiers, even if not key words

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

set the number of rows per INSERT command

pub fn use_set_session_authorization(self) -> Self

use SET SESSION AUTHORIZATION commands instead of ALTER OWNER

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

database name to connect to

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

database server host or socket directory

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

database name to connect to

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

database server port number

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

user name to connect as

pub fn no_password(self) -> Self

never prompt for password

pub fn password(self) -> Self

force password prompt

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

user password

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

role name to use in the dump

Trait Implementations

impl Clone for PgDumpAllBuilder

fn clone(&self) -> PgDumpAllBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandBuilder for PgDumpAllBuilder

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 PgDumpAllBuilder

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

Formats the value using the given formatter.

impl Default for PgDumpAllBuilder

fn default() -> PgDumpAllBuilder

Returns the “default value” for a type.