Skip to main content

ForEach

Struct ForEach 

Source
pub struct ForEach {
    pub query: Option<Loose<String>>,
    pub key: Option<Loose<OneOf<String, Vec<String>>>>,
    pub concurrency: Option<Loose<u64>>,
    pub on_row_error: Option<Loose<RowErrors>>,
    pub on_orphan_rows: Option<Loose<OrphanRows>>,
    pub max_population_rows: Option<Loose<u64>>,
    pub keep_results: Option<Loose<bool>>,
    pub mask_row_values: Option<Loose<bool>>,
}
Expand description

One copy of the output per row of a driver query (a per-row output): each copy gets only its row’s slice of the results, and the driver row as each.<column> in every template of the output. false turns an inherited for_each off.

Fields§

§query: Option<Loose<String>>

The driver: a query of the report, one row per copy of the output. It isn’t a tab or section of the output itself.

§key: Option<Loose<OneOf<String, Vec<String>>>>

The column (or list of columns) that identifies a row, in the driver and in every query of the output. Use an opaque id, never an email or a name: keys appear in file names and logs.

§concurrency: Option<Loose<u64>>

How many rows render and deliver at once. Default: 4. --row-concurrency and DRE_ROW_CONCURRENCY override it.

§on_row_error: Option<Loose<RowErrors>>

continue (default): a failed row is recorded and the others carry on; the run ends failed. fail: render every row first, and deliver only if all rendered.

§on_orphan_rows: Option<Loose<OrphanRows>>

Rows of a query whose key isn’t in the driver: warn (default) or fail.

§max_population_rows: Option<Loose<u64>>

The most rows across the output’s queries before anything renders. Default: 5,000,000.

§keep_results: Option<Loose<bool>>

Keep the run’s query results in its run folder, for --retry-failed. Default: true.

§mask_row_values: Option<Loose<bool>>

Mask destination values rendered from each.* (addresses, paths) in the console, logs and results. Default: the project’s mask_row_values, true.

Trait Implementations§

Source§

impl<'de> Deserialize<'de> for ForEach

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for ForEach

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.