Struct postgresql_commands::vacuumdb::VacuumDbBuilder

pub struct VacuumDbBuilder { /* private fields */ }

vacuumdb cleans and analyzes a PostgreSQL database.

Implementations

impl VacuumDbBuilder

vacuumdb cleans and analyzes a PostgreSQL database.

pub fn new() -> Self

Create a new VacuumDbBuilder

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

Create a new VacuumDbBuilder from Settings

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

Location of the program binary

pub fn all(self) -> Self

vacuum all databases

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

size of ring buffer used for vacuum

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

database to vacuum

pub fn disable_page_skipping(self) -> Self

disable all page-skipping behavior

pub fn echo(self) -> Self

show the commands being sent to the server

pub fn full(self) -> Self

do full vacuuming

pub fn freeze(self) -> Self

freeze row transaction information

pub fn force_index_cleanup(self) -> Self

always remove index entries that point to dead tuples

pub fn jobs(self, jobs: u32) -> Self

use this many concurrent connections to vacuum

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

minimum multixact ID age of tables to vacuum

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

minimum transaction ID age of tables to vacuum

pub fn no_index_cleanup(self) -> Self

don’t remove index entries that point to dead tuples

pub fn no_process_main(self) -> Self

skip the main relation

pub fn no_process_toast(self) -> Self

skip the TOAST table associated with the table to vacuum

pub fn no_truncate(self) -> Self

don’t truncate empty pages at the end of the table

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

vacuum tables in the specified schema(s) only

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

do not vacuum tables in the specified schema(s)

pub fn parallel(self, parallel: u32) -> Self

use this many background workers for vacuum, if available

pub fn quiet(self) -> Self

don’t write any messages

pub fn skip_locked(self) -> Self

skip relations that cannot be immediately locked

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

vacuum specific table(s) only

pub fn verbose(self) -> Self

write a lot of output

pub fn version(self) -> Self

output version information, then exit

pub fn analyze(self) -> Self

update optimizer statistics

pub fn analyze_only(self) -> Self

only update optimizer statistics; no vacuum

pub fn analyze_in_stages(self) -> Self

only update optimizer statistics, in multiple stages for faster results; no vacuum

pub fn help(self) -> Self

show help, then exit

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

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

alternate maintenance database

Trait Implementations

impl Clone for VacuumDbBuilder

fn clone(&self) -> VacuumDbBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandBuilder for VacuumDbBuilder

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 VacuumDbBuilder

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

Formats the value using the given formatter.

impl Default for VacuumDbBuilder

fn default() -> VacuumDbBuilder

Returns the “default value” for a type.