Struct RunOptions 

pub struct RunOptions {

    pub selector: Option<String>,
    pub set: Option<String>,
    pub target: Option<String>,
    pub profile: Option<String>,
    pub vars: BTreeMap<String, String>,
    pub output_name: Option<String>,
    pub output_path: Option<String>,
    pub dry_run: bool,
    pub no_deliver: bool,
    pub output_json: Option<PathBuf>,
    pub from_results: Option<PathBuf>,
    pub row_concurrency: Option<usize>,
    pub hold: bool,
    pub retry_failed: Option<String>,
    pub only_keys: Option<Vec<String>>,
    pub limit_rows: Option<usize>,
    pub unmask: bool,
    pub rate: Option<Rate>,
    pub preview: Option<u64>,
    pub accept_schema_change: bool,
    pub interactive: bool,
    pub date: Option<NaiveDate>,
    pub scheduled_at: Option<DateTime<Utc>>,
    pub live_check: bool,
    pub schedule: Option<String>,
    pub timezone: Option<String>,
    pub manifest_checksum: Option<String>,
    pub cancel: CancelToken,
    pub keep_runs: Option<usize>,
    pub threads: Option<usize>,
}

What the caller asked for.

Fields

selector: Option<String>

set: Option<String>

--set <name> or --set all.

target: Option<String>

--target as given; the run’s target is Project::target_name.

profile: Option<String>

--profile: the inherited connection, for every Binding.

vars: BTreeMap<String, String>

output_name: Option<String>

output_path: Option<String>

dry_run: bool

no_deliver: bool

output_json: Option<PathBuf>

Optional isolated run store, plus typed rows under report/binding/query.json.

from_results: Option<PathBuf>

--from-results <DIR>: replay results saved with --output-json instead of running any query (implies no_deliver).

row_concurrency: Option<usize>

--row-concurrency or DRE_ROW_CONCURRENCY: rows of a per-row output at once.

hold: bool

--hold: hold every delivery for dre release.

retry_failed: Option<String>

--retry-failed <run id>: redo that run’s failed and never-started rows of its per-row outputs, from its saved results.

only_keys: Option<Vec<String>>

--only-keys: make only these rows of each per-row output.

limit_rows: Option<usize>

--limit-rows: make at most this many rows of each per-row output.

unmask: bool

--preview --unmask: show per-row values in the preview as they are.

rate: Option<Rate>

--rate: every destination’s rate for this run, over its rate:.

preview: Option<u64>

--preview [N]: row limit per query.

accept_schema_change: bool

interactive: bool

Whether a person is at a terminal to answer prompts.

date: Option<NaiveDate>

run.date (DRE_RUN_DATE).

scheduled_at: Option<DateTime<Utc>>

The instant this run was scheduled for (DRE_RUN_AT): run.now and run.scheduled_at, and run.date in the run’s timezone unless date is set.

live_check: bool

validate --live: check statements instead of executing them.

schedule: Option<String>

--schedule <name>: run exactly the Bindings that schedule targets, with its vars.

timezone: Option<String>

--timezone or DRE_TIMEZONE: above every configured timezone:.

manifest_checksum: Option<String>

SHA-256 of the manifest this command wrote, for run_results.json.

cancel: CancelToken

Stops the run: no further Binding, statement or delivery starts once it’s cancelled.

keep_runs: Option<usize>

--keep-runs or DRE_KEEP_RUNS: above flags: keep_runs.

threads: Option<usize>

--threads or DRE_THREADS: how many Bindings may run at once in the whole run, over each connection’s threads:.

Implementations

impl RunOptions

pub fn params(&self, date: NaiveDate) -> Params

What the run was asked to do, for run_results.json and the log.

Trait Implementations

impl Clone for RunOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunOptions

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

Formats the value using the given formatter.

impl Default for RunOptions

fn default() -> Self

Returns the “default value” for a type.