Module schema 

Structs

Constraint

EdgeTypeMeta

EmbeddingConfig

FullTextIndexConfig

IndexMetadata

Metadata tracking the lifecycle state of an index.

InvertedIndexConfig

JsonFtsIndexConfig

LabelMeta

PropertyMeta

ScalarIndexConfig

Schema

SchemaManager

SchemalessEdgeTypeRegistry

Bidirectional registry for dynamically-assigned schemaless edge type IDs.

SparseVectorIndexConfig

Configuration for a scored sparse-vector (SPLADE / learned-sparse) index.

VectorIndexConfig

Enums

ConstraintTarget

ConstraintType

CrdtType

DataType

DistanceMetric

IndexDefinition

IndexStatus

Lifecycle status of an index.

PointType

ScalarIndexType

SchemaElementState

TokenizerConfig

VectorDimError

Why a value cannot be stored in a declared VECTOR(dim) or multi-vector column.

VectorIndexType

Constants

VIRTUAL_LABEL_ID_SENTINEL

Sentinel “no label” marker, kept distinct from any allocatable ID.

VIRTUAL_LABEL_ID_START

First virtual (catalog-resolved) label ID. Label IDs in VIRTUAL_LABEL_ID_START..VIRTUAL_LABEL_ID_SENTINEL are owned by plugin-registered CatalogProviders and allocated lazily by the planner via PluginRegistry::register_virtual_label. Native label allocation (SchemaManager::add_label) refuses IDs in this range.

Functions

check_dense_vector_value

Checks one dense vector value against a declared dimension count.

datetime_struct_fields

Returns the canonical struct field definitions for DateTime encoding in Arrow.

is_datetime_struct

Detects if an Arrow DataType is the canonical DateTime struct.

is_sparse_vector_struct

Detects if an Arrow DataType is the canonical SparseVector struct.

is_time_struct

Detects if an Arrow DataType is the canonical Time struct.

is_virtual_label_id

Returns true if id is in the virtual (catalog-resolved) range.

raw_bytes_field_metadata

Field metadata marking an Arrow LargeBinary field as a raw DataType::Bytes value rather than a tagged CypherValue/Duration blob.

sparse_vector_struct_fields

The canonical Arrow struct fields for a DataType::SparseVector column: Struct { indices: List<UInt32>, values: List<Float32> }. Two parallel variable-length lists in one struct. Both lists are non-null — an empty sparse vector stores as two empty lists, never null. The write and read sides both route through this one definition so they cannot drift (the same lockstep discipline as the temporal structs above).

time_struct_fields

Returns the canonical struct field definitions for Time encoding in Arrow.

validate_identifier

Validate identifier names to prevent injection and ensure compatibility.

validate_property_name

Reject user-declared property names that collide with internal Arrow column names used by the storage layer.