Struct StateArgs

pub struct StateArgs {
    pub(crate) shard_id: String,
    pub(crate) consensus_uri: SensitiveUrl,
    pub(crate) blob_uri: SensitiveUrl,
}

Arguments for viewing the current state of a given shard

Fields

shard_id: String

Shard to view

consensus_uri: SensitiveUrl

Consensus to use.

When connecting to a deployed environment’s consensus table, the Postgres/CRDB connection string must contain the database name and options=--search_path=consensus.

When connecting to Cockroach Cloud, use the following format:

postgresql://<user>:$COCKROACH_PW@<hostname>:<port>/environment_<environment-id>
  ?sslmode=verify-full
  &sslrootcert=/path/to/cockroach-cloud/certs/cluster-ca.crt
  &options=--search_path=consensus

blob_uri: SensitiveUrl

Blob to use

When connecting to a deployed environment’s blob, the necessary connection glue must be in place. e.g. for S3, sign into SSO, set AWS_PROFILE and AWS_REGION appropriately, with a blob URI scoped to the environment’s bucket prefix.

Implementations

impl StateArgs

pub(crate) fn shard_id(&self) -> ShardId

pub(crate) async fn open(&self) -> Result<StateVersions, Error>

Trait Implementations

impl Args for StateArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

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

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

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

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

impl Clone for StateArgs

fn clone(&self) -> StateArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for StateArgs

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 StateArgs

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

Formats the value using the given formatter.

impl FromArgMatches for StateArgs

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( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for StateArgs

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.