Struct SelfManagedDebugMode

pub struct SelfManagedDebugMode {
    pub(crate) dump_k8s: bool,
    pub(crate) k8s_namespaces: Vec<String>,
    pub(crate) k8s_context: Option<String>,
    pub(crate) k8s_dump_secret_values: bool,
    pub(crate) auto_port_forward: bool,
    pub(crate) port_forward_local_address: String,
    pub(crate) port_forward_local_port: i32,
    pub(crate) mz_connection_url: Option<String>,
}

Fields

dump_k8s: bool

If true, the tool will dump debug information in Kubernetes cluster such as logs, pod describes, etc.

k8s_namespaces: Vec<String>

A list of namespaces to dump.

k8s_context: Option<String>

The kubernetes context to use.

k8s_dump_secret_values: bool

If true, the tool will dump the values of secrets in the Kubernetes cluster.

auto_port_forward: bool

If true, the tool will automatically port-forward the external SQL port in the Kubernetes cluster. If dump_k8s is false however, we will not automatically port-forward.

port_forward_local_address: String

The address to listen on for the port-forward.

port_forward_local_port: i32

The port to listen on for the port-forward.

mz_connection_url: Option<String>

The URL of the Materialize SQL connection used to dump the system catalog. An example URL is postgres://root@127.0.0.1:6875/materialize?sslmode=disable. By default, we will create a connection URL based on port_forward_local_address and port_forward_local_port.

Trait Implementations

impl Args for SelfManagedDebugMode

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 SelfManagedDebugMode

fn clone(&self) -> SelfManagedDebugMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for SelfManagedDebugMode

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 SelfManagedDebugMode

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

Formats the value using the given formatter.

impl FromArgMatches for SelfManagedDebugMode

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 SelfManagedDebugMode

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.