flusso-schema-core 0.9.0

use serde::Serialize;

use crate::common::{FieldName, IndexName};

use super::{ContentHash, Mapping};

/// A fully-resolved mapping for one index: every field typed and ready for a
/// sink to translate into its native mapping format.
///
/// A source produces this from the [`IndexSchema`](super::IndexSchema) — using
/// each field's explicit [`Mapping`] where one is given, and the database's own
/// column types where it is not. The result has a
/// concrete type for every field, which is what a sink needs to create the
/// index up front rather than leaving the destination to guess.
#[derive(Debug, Clone, Serialize)]
pub struct IndexMapping {
    /// The logical index name (the config key) — the pipeline's stable identity.
    pub index: IndexName,
    /// Hash of the parsed index schema. A sink that owns a physical index folds
    /// this into the index's name (e.g. `users_3f2a1b9c`), so a structural
    /// schema change yields a new name — a fresh index that is re-seeded rather
    /// than written into the old shape.
    pub hash: ContentHash,
    pub fields: Vec<ResolvedField>,
}

/// One field within an [`IndexMapping`]: the document key it lands under, its
/// resolved [`Mapping`] (the `mapping_type` is always present), whether the
/// value can be null, and the fields nested under it for `object` / `nested`
/// types.
#[derive(Debug, Clone, Serialize)]
pub struct ResolvedField {
    pub name: FieldName,
    pub mapping: Mapping,
    /// Whether this field's value can be null in the document. Derived by the
    /// source while resolving the mapping — the config does not state it, but the
    /// source knows (a column's `NOT NULL`, a primary key, a `default`, the
    /// arity of a relation, an aggregate's zero-row behavior). A sink ignores it;
    /// it exists for consumers that turn the mapping into typed bindings, where
    /// `nullable` is the difference between `T` and `Option<T>`.
    pub nullable: bool,
    /// Whether this field's value is a flat scalar array (the `mapping_type` is
    /// then the element type — OpenSearch has no array type). True only for
    /// `ids`; a consumer turning the mapping into typed bindings reads it as the
    /// difference between `T` and `Vec<T>`.
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub array: bool,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub children: Vec<ResolvedField>,
}