Enum Command 

pub enum Command {
    Cache {
        instance_name: InstanceName,
        command: CacheCommand,
    },
    ContainerPsql {
        instance_name: InstanceName,
    },
    List,
    ContainerSchemaDump {
        instance_name: InstanceName,
    },
    ContainerShell {
        instance_name: InstanceName,
    },
    IntegrationServer {
        instance_name: InstanceName,
        result_fd: RawFd,
        control_fd: RawFd,
    },
    Psql {
        instance_name: InstanceName,
    },
    RunEnv {
        instance_name: InstanceName,
        command: String,
        arguments: Vec<String>,
    },
    Platform {
        command: PlatformCommand,
    },
}

Variants

Cache

Cache related commands

Fields

instance_name: InstanceName

Target instance name

command: CacheCommand

ContainerPsql

Run interactive psql session on the container

Fields

instance_name: InstanceName

Target instance name

List

List defined instances

ContainerSchemaDump

Run schema dump from the container

Fields

instance_name: InstanceName

Target instance name

ContainerShell

Run interactive shell on the container

Fields

instance_name: InstanceName

Target instance name

IntegrationServer

Run integration server

Intent to be used for automation with other languages wrapping pg-ephemeral.

After successful boot connects to the inherited pipe file descriptors, writes a single JSON line with connection details to –result-fd, then waits for EOF on –control-fd before shutting down.

Fields

instance_name: InstanceName

Target instance name

result_fd: RawFd

File descriptor for writing the result JSON

control_fd: RawFd

File descriptor for reading the control signal (EOF = shutdown)

Psql

Run interactive psql on the host

Fields

instance_name: InstanceName

Target instance name

RunEnv

Run shell command with environment variables for PostgreSQL connection

Sets all PostgreSQL-related environment variables:

• libpq-style PG* environment variables (PGHOST, PGPORT, PGUSER, PGDATABASE, PGPASSWORD, PGSSLMODE, etc.)
• DATABASE_URL in PostgreSQL URL format

Fields

instance_name: InstanceName

Target instance name

command: String

The command to run

arguments: Vec<String>

Arguments to pass to the command

Platform

Platform related commands

Fields

command: PlatformCommand

Implementations

impl Command

pub async fn run(&self, instance_map: &InstanceMap) -> Result<(), Error>

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Command

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Command

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

Formats the value using the given formatter.

impl Default for Command

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for Command

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Command

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Subcommand for Command

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand