Struct CrossJoinSpec 

pub struct CrossJoinSpec {
    pub arrays: Vec<String>,
    pub prefix: bool,
    pub keep_parent: bool,
    pub on_empty: OnEmpty,
    pub drop_arrays: bool,
    pub max_product: usize,
}

Available on crate feature transform-cross-join only.

User-facing cross_join config.

Fields

arrays: Vec<String>

Sibling array fields to cross (≥2). Each element is expected to be an object; a scalar element is wrapped under the array’s name.

prefix: bool

Prefix each produced column with its array name (jobs → jobs_title). Avoids collisions between arrays that share field names. Default false.

keep_parent: bool

Keep the record’s non-array scalar fields on every output row. Default true.

on_empty: OnEmpty

Behavior when a crossed array is empty. Default skip.

drop_arrays: bool

Remove the source array fields from the output rows after expansion. Default true.

max_product: usize

Fail (rather than OOM) if a single record’s cartesian product would exceed this many rows. Default DEFAULT_MAX_PRODUCT.

Implementations

impl CrossJoinSpec

pub fn compile(&self) -> Result<CompiledCrossJoin, FaucetError>

Validate the spec, returning a reusable CompiledCrossJoin.

pub fn into_stage(&self) -> Result<TransformStage, FaucetError>

Compile and wrap as a TransformStage::PageFn (1→0..N per record, fallible on product overflow).

Trait Implementations

impl Clone for CrossJoinSpec

fn clone(&self) -> CrossJoinSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CrossJoinSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CrossJoinSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for CrossJoinSpec

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

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

Generates a JSON Schema for this type.

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.

impl PartialEq for CrossJoinSpec

fn eq(&self, other: &CrossJoinSpec) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for CrossJoinSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CrossJoinSpec