Struct postgresql_commands::pg_dump::PgDumpBuilder

pub struct PgDumpBuilder { /* private fields */ }

pg_dump dumps a database as a text file or to other formats.

Implementations

impl PgDumpBuilder

pub fn new() -> Self

Create a new PgDumpBuilder

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

Create a new PgDumpBuilder from Settings

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

Location of the program binary

pub fn data_only(self) -> Self

Dump only the data, not the schema

pub fn large_objects(self) -> Self

Dump large objects in binary format

pub fn no_large_objects(self) -> Self

Do not dump large objects

pub fn clean(self) -> Self

Output commands to clean (drop) database objects prior to outputting the commands for creating them

pub fn create(self) -> Self

Output commands to create the database objects (data definition)

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

Dump data for the named extension

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

Dump data in encoding ENCODING

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

Set the output file or directory name

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

Set the output file format (custom, directory, tar, plain text (default))

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

Use this many parallel jobs to dump

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

Dump data for the named schema(s) only

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

Do not output commands to set ownership of objects to match the original database

pub fn no_owner(self) -> Self

Do not output commands to set ownership of objects to match the original database

pub fn no_reconnect(self) -> Self

Do not reconnect to the database

pub fn schema_only(self) -> Self

Dump only the schema, no data

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

Dump data as a superuser

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

Dump data for the named table(s) only

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

Do not output commands to create the table(s) containing the data

pub fn verbose(self) -> Self

Enable verbose mode

pub fn version(self) -> Self

Output version information, then exit

pub fn no_privileges(self) -> Self

Do not output commands to set object privileges

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

Set the compression level to use

pub fn binary_upgrade(self) -> Self

Dump data in a format suitable for binary upgrade

pub fn column_inserts(self) -> Self

Dump data as INSERT commands with column names

pub fn attribute_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 enable_row_security(self) -> Self

Dump data with row security enabled

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

Dump data for the named table(s) but exclude data for their child tables

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 include_foreign_data<S: AsRef<OsStr>>( self, include_foreign_data: S, ) -> Self

Include foreign-data wrappers in the dump

pub fn inserts(self) -> Self

Dump data as INSERT commands

pub fn load_via_partition_root(self) -> Self

Load data via the partition root table

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

Fail after waiting TIMEOUT for a table lock

pub fn no_comments(self) -> Self

Do not output comments

pub fn no_publications(self) -> Self

Do not output publications

pub fn no_security_labels(self) -> Self

Do not output security labels

pub fn no_subscriptions(self) -> Self

Do not output subscriptions

pub fn no_table_access_method(self) -> Self

Do not output table access method

pub fn no_tablespaces(self) -> Self

Do not output tablespace assignments

pub fn no_toast_compression(self) -> Self

Do not output TOAST table compression

pub fn no_unlogged_table_data(self) -> Self

Do not output 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(self, rows_per_insert: u64) -> Self

Set the number of rows per INSERT

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

Dump data for the named section(s) only

pub fn serializable_deferrable(self) -> Self

Dump data as a serializable transaction

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

Use a snapshot with the specified name

pub fn strict_names(self) -> Self

Use strict SQL identifier syntax

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

Dump data for the named table(s) and their children

pub fn use_set_session_authorization(self) -> Self

Use SET SESSION AUTHORIZATION commands instead of ALTER OWNER

pub fn help(self) -> Self

Show help, then exit

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

database to connect to

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

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

database user name

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

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

Specifies a role name to be used to create the dump

Trait Implementations

impl Clone for PgDumpBuilder

fn clone(&self) -> PgDumpBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandBuilder for PgDumpBuilder

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 PgDumpBuilder

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

Formats the value using the given formatter.

impl Default for PgDumpBuilder

fn default() -> PgDumpBuilder

Returns the “default value” for a type.