Struct PgAmCheckBuilder

Source
pub struct PgAmCheckBuilder { /* private fields */ }
Expand description

pg_amcheck checks objects in a PostgreSQL database for corruption.

Implementations§

Source§

impl PgAmCheckBuilder

Source

pub fn new() -> Self

Create a new PgAmCheckBuilder

Source

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

Create a new PgAmCheckBuilder from Settings

Source

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

Location of the program binary

Source

pub fn all(self) -> Self

check all databases

Source

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

check matching database(s)

Source

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

do NOT check matching database(s)

Source

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

check matching index(es)

Source

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

do NOT check matching index(es)

Source

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

check matching relation(s)

Source

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

do NOT check matching relation(s)

Source

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

check matching schema(s)

Source

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

do NOT check matching schema(s)

Source

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

check matching table(s)

Source

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

do NOT check matching table(s)

Source

pub fn no_dependent_indexes(self) -> Self

do NOT expand list of relations to include indexes

Source

pub fn no_dependent_toast(self) -> Self

do NOT expand list of relations to include TOAST tables

Source

pub fn no_strict_names(self) -> Self

do NOT require patterns to match objects

Source

pub fn exclude_toast_pointers(self) -> Self

do NOT follow relation TOAST pointers

Source

pub fn on_error_stop(self) -> Self

stop checking at end of first corrupt page

Source

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

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

Source

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

begin checking table(s) at the given block number

Source

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

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

Source

pub fn heap_all_indexed(self) -> Self

check that all heap tuples are found within indexes

Source

pub fn parent_check(self) -> Self

check index parent/child relationships

Source

pub fn root_descend(self) -> Self

search from root page to refind tuples

Source

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

database server host or socket directory

Source

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

database server port

Source

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

user name to connect as

Source

pub fn no_password(self) -> Self

never prompt for password

Source

pub fn password(self) -> Self

force password prompt

Source

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

user password

Source

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

alternate maintenance database

Source

pub fn echo(self) -> Self

show the commands being sent to the server

Source

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

use this many concurrent connections to the server

Source

pub fn progress(self) -> Self

show progress information

Source

pub fn verbose(self) -> Self

write a lot of output

Source

pub fn version(self) -> Self

output version information, then exit

Source

pub fn install_missing(self) -> Self

install missing extensions

Source

pub fn help(self) -> Self

show help, then exit

Trait Implementations§

Source§

impl Clone for PgAmCheckBuilder

Source§

fn clone(&self) -> PgAmCheckBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl CommandBuilder for PgAmCheckBuilder

Source§

fn get_program(&self) -> &'static OsStr

Get the program name

Source§

fn get_program_dir(&self) -> &Option<PathBuf>

Location of the program binary

Source§

fn get_args(&self) -> Vec<OsString>

Get the arguments for the command

Source§

fn get_envs(&self) -> Vec<(OsString, OsString)>

Get the environment variables for the command

Source§

fn env<S: AsRef<OsStr>>(self, key: S, value: S) -> Self

Set an environment variable for the command

Source§

fn get_program_file(&self) -> PathBuf

Fully qualified path to the program binary
Source§

fn build(self) -> Command
where Self: Sized,

Build a standard Command
Source§

impl Debug for PgAmCheckBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PgAmCheckBuilder

Source§

fn default() -> PgAmCheckBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more