Struct PgRestoreBuilder

pub struct PgRestoreBuilder { /* private fields */ }

pg_restore restores a PostgreSQL database from an archive created by pg_dump.

Implementations

impl PgRestoreBuilder

pub fn new() -> Self

Create a new PgRestoreBuilder

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

Create a new PgRestoreBuilder from Settings

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

Location of the program binary

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

connect to database name

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

output file name (- for stdout)

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

backup file format (should be automatic)

pub fn list(self) -> Self

print summarized TOC of the archive

pub fn verbose(self) -> Self

verbose mode

pub fn version(self) -> Self

output version information, then exit

pub fn help(self) -> Self

show help, then exit

pub fn data_only(self) -> Self

restore only the data, no schema

pub fn clean(self) -> Self

clean (drop) database objects before recreating

pub fn create(self) -> Self

create the target database

pub fn exit_on_error(self) -> Self

exit on error, default is to continue

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

restore named index

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

use this many parallel jobs to restore

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

use table of contents from this file for selecting/ordering output

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

restore only objects in this schema

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

do not restore objects in this schema

pub fn no_owner(self) -> Self

skip restoration of object ownership

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

restore named function

pub fn schema_only(self) -> Self

restore only the schema, no data

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

superuser user name to use for disabling triggers

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

restore named relation (table, view, etc.)

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

restore named trigger

pub fn no_privileges(self) -> Self

skip restoration of access privileges (grant/revoke)

pub fn single_transaction(self) -> Self

restore as a single transaction

pub fn disable_triggers(self) -> Self

disable triggers during data-only restore

pub fn enable_row_security(self) -> Self

enable row security

pub fn if_exists(self) -> Self

use IF EXISTS when dropping objects

pub fn no_comments(self) -> Self

do not restore comments

pub fn no_data_for_failed_tables(self) -> Self

do not restore data of tables that could not be created

pub fn no_publications(self) -> Self

do not restore publications

pub fn no_security_labels(self) -> Self

do not restore security labels

pub fn no_subscriptions(self) -> Self

do not restore subscriptions

pub fn no_table_access_method(self) -> Self

do not restore table access methods

pub fn no_tablespaces(self) -> Self

do not restore tablespace assignments

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

restore named section (pre-data, data, or post-data)

pub fn strict_names(self) -> Self

require table and/or schema include patterns to match at least one entity each

pub fn use_set_session_authorization(self) -> Self

use SET SESSION AUTHORIZATION commands instead of ALTER OWNER commands to set ownership

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

database server host or socket directory

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

database server port number

pub fn username<S: AsRef<OsStr>>(self, name: 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

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

do SET ROLE before restore

Trait Implementations

impl Clone for PgRestoreBuilder

fn clone(&self) -> PgRestoreBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandBuilder for PgRestoreBuilder

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 PgRestoreBuilder

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

Formats the value using the given formatter.

impl Default for PgRestoreBuilder

fn default() -> PgRestoreBuilder

Returns the “default value” for a type.