Struct GraphSchema 

pub struct GraphSchema { /* private fields */ }

A complete, optional graph schema.

Implementations

impl GraphSchema

pub fn new() -> Self

pub fn add_node(&mut self, schema: NodeSchema) -> &mut Self

pub fn add_edge(&mut self, schema: EdgeSchema) -> &mut Self

pub fn add_vector(&mut self, schema: VectorSchema) -> &mut Self

pub fn node(&self, label: &str) -> Option<&NodeSchema>

pub fn edge(&self, edge_type: &str) -> Option<&EdgeSchema>

pub fn vector(&self, name: &str) -> Option<&VectorSchema>

pub fn node_schemas_sorted(&self) -> Vec<&NodeSchema>

Node schemas sorted by label (deterministic — for codegen).

pub fn edge_schemas_sorted(&self) -> Vec<&EdgeSchema>

Edge schemas sorted by edge type (deterministic — for codegen).

pub fn vector_schemas_sorted(&self) -> Vec<&VectorSchema>

Vector schemas sorted by name (deterministic — for codegen).

pub fn validate_self(&self) -> Result<()>

Validate the schema’s own internal consistency: every edge’s from/to label and every vector’s bound label must reference a declared node. Run this once after building the schema (HelixQL’s compile-time check).

pub fn validate_node(&self, node: &Node) -> Result<()>

Validate a node against any declared schema for its labels. Labels with no schema pass through (schemaless coexistence).

pub fn validate_edge( &self, edge: &Edge, from_labels: &[String], to_labels: &[String], ) -> Result<()>

Validate an edge given the labels of its endpoints. Undeclared edge types pass through. Pass the actual from/to node labels so direction + endpoint types are checked.

pub fn validate_vector_dims( &self, vector_type: &str, query: &[f32], ) -> Result<&VectorSchema>

Validate that a query vector matches a declared vector type’s dimension.

Trait Implementations

impl Clone for GraphSchema

fn clone(&self) -> GraphSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphSchema

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

Formats the value using the given formatter.

impl Default for GraphSchema

fn default() -> GraphSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GraphSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GraphSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.