Expand description
Definitions and functions to create and manipulate kernel schema
Modules§
- derive_
macro_ utils internal-api - Utility traits that support the
delta_kernel_derive::ToSchemamacro.
Macros§
- lazy_
schema_ ref internal-api - Sugar for
LazyLock::new(||schema_ref!{ ... }), yielding a lazySchemaRef. - schema
internal-api - Builds a
StructTypefrom a JSON-shaped description that freely mixes literal structure with interpolated runtime values, in the spirit ofserde_json::json!. - schema_
ref internal-api - Sugar for
Arc::new(schema!{ ... }), yielding aSchemaRef. Convenient for theLazyLock<SchemaRef>statics that pervade the action and stats schemas. - try_
schema internal-api - Like [
schema], but validates field names at every level of the schema (each struct, including nested ones, is built viaStructType::try_newand yieldsDeltaResult<StructType>. Use when field names are runtime values that could duplicate in ways the macro cannot see.
Structs§
- Array
Type - Column
Default - A column-level default parsed from the
CURRENT_DEFAULTmetadata key of aStructField. - Column
Names AndTypes internal-api - Helper for RowVisitor implementations
- Decimal
Type - Geography
Type geo-type-in-dev - Geography column type with an associated CRS and edge interpolation algorithm.
- Geometry
Type geo-type-in-dev - A geometry column type with an associated coordinate reference system (CRS).
- MapType
- Struct
Field - Struct
Field Into Iter - An iterator that yields owned
StructFields from aStructType. - Struct
Field RefIter - An iterator that yields references to
StructFields from aStructType. - Struct
Type - A struct is used to represent both the top-level schema of the table as well as struct columns that contain nested columns.
- Struct
Type Builder
Enums§
- Column
Metadata Key - Data
Type - Edge
Interpolation Algorithm geo-type-in-dev - Algorithm used to interpolate edges between two vertices of a geography path.
- Metadata
Column Spec - Enumeration of metadata columns recognized by Delta Kernel.
- Metadata
Value - Primitive
Type
Traits§
- ToSchema
internal-api - Converts a type to a
Schemathat represents that type. Derivable for struct types using thedelta_kernel_derive::ToSchemaderive macro. - ToSchema
Field internal-api - Converts field interpolation inputs in [
schema!] and [try_schema!] toStructField.
Type Aliases§
- Schema
- Schema
Ref - Schema
Struct Patch Builder - A
StructPatchBuilderwhose emitted items are schema fields, lowered into an outputStructTypedirectly from an input schema viabuild.