Skip to main content

Module schema

Module schema 

Source
Expand description

Definitions and functions to create and manipulate kernel schema

Modules§

derive_macro_utilsinternal-api
Utility traits that support the delta_kernel_derive::ToSchema macro.

Macros§

lazy_schema_refinternal-api
Sugar for LazyLock::new(|| schema_ref! { ... }), yielding a lazy SchemaRef.
schemainternal-api
Builds a StructType from a JSON-shaped description that freely mixes literal structure with interpolated runtime values, in the spirit of serde_json::json!.
schema_refinternal-api
Sugar for Arc::new(schema! { ... }), yielding a SchemaRef. Convenient for the LazyLock<SchemaRef> statics that pervade the action and stats schemas.
try_schemainternal-api
Like [schema], but validates field names at every level of the schema (each struct, including nested ones, is built via StructType::try_new and yields DeltaResult<StructType>. Use when field names are runtime values that could duplicate in ways the macro cannot see.

Structs§

ArrayType
ColumnDefault
A column-level default parsed from the CURRENT_DEFAULT metadata key of a StructField.
ColumnNamesAndTypesinternal-api
Helper for RowVisitor implementations
DecimalType
GeographyTypegeo-type-in-dev
Geography column type with an associated CRS and edge interpolation algorithm.
GeometryTypegeo-type-in-dev
A geometry column type with an associated coordinate reference system (CRS).
MapType
StructField
StructFieldIntoIter
An iterator that yields owned StructFields from a StructType.
StructFieldRefIter
An iterator that yields references to StructFields from a StructType.
StructType
A struct is used to represent both the top-level schema of the table as well as struct columns that contain nested columns.
StructTypeBuilder

Enums§

ColumnMetadataKey
DataType
EdgeInterpolationAlgorithmgeo-type-in-dev
Algorithm used to interpolate edges between two vertices of a geography path.
MetadataColumnSpec
Enumeration of metadata columns recognized by Delta Kernel.
MetadataValue
PrimitiveType

Traits§

ToSchemainternal-api
Converts a type to a Schema that represents that type. Derivable for struct types using the delta_kernel_derive::ToSchema derive macro.
ToSchemaFieldinternal-api
Converts field interpolation inputs in [schema!] and [try_schema!] to StructField.

Type Aliases§

Schema
SchemaRef
SchemaStructPatchBuilder
A StructPatchBuilder whose emitted items are schema fields, lowered into an output StructType directly from an input schema via build.