Struct PgAmCheckBuilder

pub struct PgAmCheckBuilder { /* private fields */ }

pg_amcheck checks objects in a PostgreSQL database for corruption.

Implementations

impl PgAmCheckBuilder

pub fn new() -> Self

Create a new PgAmCheckBuilder

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

Create a new PgAmCheckBuilder from Settings

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

Location of the program binary

pub fn all(self) -> Self

check all databases

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

check matching database(s)

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

do NOT check matching database(s)

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

check matching index(es)

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

do NOT check matching index(es)

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

check matching relation(s)

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

do NOT check matching relation(s)

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

check matching schema(s)

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

do NOT check matching schema(s)

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

check matching table(s)

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

do NOT check matching table(s)

pub fn no_dependent_indexes(self) -> Self

do NOT expand list of relations to include indexes

pub fn no_dependent_toast(self) -> Self

do NOT expand list of relations to include TOAST tables

pub fn no_strict_names(self) -> Self

do NOT require patterns to match objects

pub fn exclude_toast_pointers(self) -> Self

do NOT follow relation TOAST pointers

pub fn on_error_stop(self) -> Self

stop checking at end of first corrupt page

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

do NOT check “all-frozen” or “all-visible” blocks

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

begin checking table(s) at the given block number

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

check table(s) only up to the given block number

pub fn heap_all_indexed(self) -> Self

check that all heap tuples are found within indexes

pub fn parent_check(self) -> Self

check index parent/child relationships

pub fn root_descend(self) -> Self

search from root page to refind tuples

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

pub fn echo(self) -> Self

show the commands being sent to the server

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

use this many concurrent connections to the server

pub fn progress(self) -> Self

show progress information

pub fn verbose(self) -> Self

write a lot of output

pub fn version(self) -> Self

output version information, then exit

pub fn install_missing(self) -> Self

install missing extensions

pub fn help(self) -> Self

show help, then exit

Trait Implementations

impl Clone for PgAmCheckBuilder

fn clone(&self) -> PgAmCheckBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandBuilder for PgAmCheckBuilder

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 PgAmCheckBuilder

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

Formats the value using the given formatter.

impl Default for PgAmCheckBuilder

fn default() -> PgAmCheckBuilder

Returns the “default value” for a type.