Struct postgresql_commands::psql::PsqlBuilder

pub struct PsqlBuilder { /* private fields */ }

psql is the PostgreSQL interactive terminal.

Implementations

impl PsqlBuilder

pub fn new() -> Self

Create a new PsqlBuilder

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

Create a new PsqlBuilder from Settings

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

Location of the program binary

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

run only single command (SQL or internal) and exit

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

database name to connect to

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

execute commands from file, then exit

pub fn list(self) -> Self

list available databases, then exit

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

set psql variable NAME to VALUE (e.g., -v ON_ERROR_STOP=1)

pub fn version(self) -> Self

output version information, then exit

pub fn no_psqlrc(self) -> Self

do not read startup file (~/.psqlrc)

pub fn single_transaction(self) -> Self

execute as a single transaction (if non-interactive)

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

show help, then exit Possible values: [options, commands, variables]

pub fn echo_all(self) -> Self

echo all input from script

pub fn echo_errors(self) -> Self

echo failed commands

pub fn echo_queries(self) -> Self

echo commands sent to server

pub fn echo_hidden(self) -> Self

display queries that internal commands generate

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

send session log to file

pub fn no_readline(self) -> Self

disable enhanced command line editing (readline)

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

send query results to file (or |pipe)

pub fn quiet(self) -> Self

run quietly (no messages, only query output)

pub fn single_step(self) -> Self

single-step mode (confirm each query)

pub fn single_line(self) -> Self

single-line mode (end of line terminates SQL command)

pub fn no_align(self) -> Self

unaligned table output mode

pub fn csv(self) -> Self

CSV (Comma-Separated Values) table output mode

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

field separator for unaligned output (default: “|”)

pub fn html(self) -> Self

HTML table output mode

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

set printing option VAR to ARG (see \pset command)

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

record separator for unaligned output (default: newline)

pub fn tuples_only(self) -> Self

print rows only

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

set HTML table tag attributes (e.g., width, border)

pub fn expanded(self) -> Self

turn on expanded table output

pub fn field_separator_zero(self) -> Self

set field separator for unaligned output to zero byte

pub fn record_separator_zero(self) -> Self

set record separator for unaligned output to zero byte

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

Trait Implementations

impl Clone for PsqlBuilder

fn clone(&self) -> PsqlBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandBuilder for PsqlBuilder

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 PsqlBuilder

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

Formats the value using the given formatter.

impl Default for PsqlBuilder

fn default() -> PsqlBuilder

Returns the “default value” for a type.