Struct IndexerArgs

pub struct IndexerArgs {
    pub first_checkpoint: Option<u64>,
    pub last_checkpoint: Option<u64>,
    pub pipeline: Vec<String>,
    pub skip_watermark: bool,
}

Command-line arguments for the indexer

Fields

first_checkpoint: Option<u64>

Override for the checkpoint to start ingestion from – useful for backfills. By default, ingestion will start just after the lowest checkpoint watermark across all active pipelines.

NOTE: This value is validated against the current watermark for each pipeline. Only sequential pipelines fail to start if –first-checkpoint is in the future. Concurrent pipelines will start and commit data, but they won’t update the watermark.

For testing purposes, you can bypass this check by manually updating the watermarks table in your database:

INSERT INTO watermarks (pipeline, checkpoint_hi_inclusive) VALUES ('<pipeline>', <first_checkpoint> - 1);

However, this is NOT recommended in a production environment as it will create inconsistencies in your indexed data.

last_checkpoint: Option<u64>

Override for the checkpoint to end ingestion at (inclusive) – useful for backfills. By default, ingestion will not stop, and will continue to poll for new checkpoints.

pipeline: Vec<String>

Only run the following pipelines. If not provided, all pipelines found in the configuration file will be run.

skip_watermark: bool

Don’t write to the watermark tables for concurrent pipelines.

Trait Implementations

impl Args for IndexerArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

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

Append to [Command] so it can instantiate Self.

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

Append to [Command] so it can update self.

impl Clone for IndexerArgs

fn clone(&self) -> IndexerArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexerArgs

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

Formats the value using the given formatter.

impl Default for IndexerArgs

fn default() -> IndexerArgs

Returns the “default value” for a type.

impl FromArgMatches for IndexerArgs

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.