Struct BackfillArgs 

pub struct BackfillArgs {

    pub config: Option<PathBuf>,
    pub from: Option<String>,
    pub to: Option<String>,
    pub window: Option<String>,
    pub from_bookmark: Option<String>,
    pub to_bookmark: Option<String>,
    pub bookmark_field: Option<String>,
    pub concurrency: Option<usize>,
    pub timezone: Option<String>,
    pub row: Option<String>,
    pub into: Option<String>,
    pub dry_run: bool,
    pub resume: bool,
    pub restart: bool,
    pub json: bool,
    pub env_file: Option<PathBuf>,
    pub no_env_file: bool,
    pub profile: Option<String>,
}

faucet backfill arguments.

Fields

config: Option<PathBuf>

Path to a .yaml, .yml, or .json pipeline config. If omitted, auto-discover faucet.yaml / faucet.yml / faucet.json in cwd.

from: Option<String>

Window start (inclusive): RFC3339 (2026-06-01T00:00:00Z) or a date (2026-06-01, midnight in –timezone). Requires –to.

to: Option<String>

Window end (exclusive): RFC3339 or a date.

window: Option<String>

Chunk the range into windows of this duration (45s, 30m, 6h, 1d, 1w) so each chunk is an independent, resumable unit. Defaults to the config’s backfill.window; omitted = one unit for the whole range.

from_bookmark: Option<String>

Replay from this explicit bookmark value instead of a wall-clock range (seeded into the backfill’s scoped state key; the source’s own incremental logic reads forward from it). JSON or a bare string.

to_bookmark: Option<String>

Upper bookmark bound: records whose –bookmark-field orders after this value are dropped before the sink.

bookmark_field: Option<String>

Record field the –to-bookmark bound applies to.

concurrency: Option<usize>

Max concurrently-running window units. Defaults to the config’s backfill.concurrency, else 1 (sequential).

timezone: Option<String>

IANA timezone for date boundaries and ${now.*} rendering. Defaults to the config’s backfill.timezone, else UTC.

row: Option<String>

Root row of the config to backfill. Defaults to the only root.

into: Option<String>

Redirect writes to this named sink template under pipeline.sinks (backfill into a staging table first).

dry_run: bool

Print the planned units without running anything.

resume: bool

Continue a previously-interrupted backfill of the same range: skip units already done, re-run failed and pending ones.

restart: bool

Discard a previous progress marker for this range and start over.

json: bool

Emit a machine-readable JSON report instead of the human summary.

env_file: Option<PathBuf>

Path to a .env file to load for ${env:VAR} interpolation. Defaults to .env in cwd if present.

no_env_file: bool

Skip auto-loading .env from cwd.

profile: Option<String>

Select a named overlay from the config’s profiles: block. Overrides the FAUCET_PROFILE env var.

Trait Implementations

impl Args for BackfillArgs

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 BackfillArgs

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 BackfillArgs

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

Formats the value using the given formatter.

impl FromArgMatches for BackfillArgs

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 BackfillArgs

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.