Struct PlanArgs 

pub struct PlanArgs {
    pub config: Option<PathBuf>,
    pub row: Option<String>,
    pub sample: Option<PathBuf>,
    pub live: bool,
    pub limit: usize,
    pub json: bool,
    pub diff: bool,
    pub resolve_secrets: bool,
    pub profile: Option<String>,
}

faucet plan arguments.

Fields

config: Option<PathBuf>

Path to a .yaml/.yml/.json config (auto-discovered if omitted).

row: Option<String>

Which row to plan (default: the first root row).

sample: Option<PathBuf>

Offline sample of input records (.jsonl or a .json array) to preview the output schema, volume, and sink delta through — no source is touched.

live: bool

Pull a capped, read-only sample from the real source instead of a fixture (bounded by --limit; no bookmark is advanced).

limit: usize

Cap for --live sampling.

json: bool

Emit the plan as JSON.

diff: bool

Show a terraform plan-style diff of the current config against the last recorded run, instead of the resolved-pipeline preview (#374). Requires a catalog: block. Resolves secrets so the diff matches what run records.

resolve_secrets: bool

Resolve secrets-manager directives (needs network/credentials). Off by default so plan works offline like faucet test. Implied by --diff.

profile: Option<String>

Select a profiles: overlay.

Trait Implementations

impl Args for PlanArgs

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 CommandFactory for PlanArgs

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 PlanArgs

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

Formats the value using the given formatter.

impl FromArgMatches for PlanArgs

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 PlanArgs

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.