Struct InitArgs 

pub struct InitArgs {
    pub name: Option<String>,
    pub source: Option<String>,
    pub sink: Option<String>,
    pub output: PathBuf,
    pub force: bool,
    pub interactive: bool,
    pub template: String,
    pub discover: bool,
    pub executable: Option<String>,
}

faucet init arguments.

Fields

name: Option<String>

Name written into the generated file’s name: field. Defaults to my-pipeline when omitted.

source: Option<String>

Source connector kind to scaffold (e.g. rest, postgres, s3). Defaults to rest. Run faucet list to see what is compiled in.

sink: Option<String>

Sink connector kind to scaffold (e.g. jsonl, bigquery). Defaults to jsonl. Run faucet list to see what is compiled in.

output: PathBuf

Output file path. Defaults to pipeline.yaml.

force: bool

Overwrite the output file if it already exists.

interactive: bool

Prompt for the source and sink kinds interactively instead of using --source / --sink. Requires the cli-interactive build feature and a TTY on stdin; falls back to the arg-driven path otherwise.

template: String

Name of the template under which to register the scaffolded source and sink. The generated config uses pipeline.sources.<TEMPLATE> and pipeline.sinks.<TEMPLATE>. Defaults to default so a matrix row without a ref: field still resolves through the new schema.

discover: bool

(singer only) Run <executable> --discover to fetch the tap’s catalog, write it next to the output, and scaffold the config with the discovered streams listed. Requires --source singer and --executable.

executable: Option<String>

(singer only) The Singer tap executable to discover with (used by --discover), e.g. tap-github or /opt/taps/tap-csv.

Trait Implementations

impl Args for InitArgs

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 InitArgs

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 InitArgs

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

Formats the value using the given formatter.

impl FromArgMatches for InitArgs

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 InitArgs

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.