Struct Catalog 

pub struct Catalog { /* private fields */ }

The database’s schema dictionary - maps names to compact internal IDs.

You rarely interact with this directly. The query processor uses it to resolve names like “Person” and “name” to internal IDs.

Implementations

impl Catalog

pub fn new() -> Self

Creates a new empty catalog with schema support enabled.

pub fn with_schema() -> Self

Creates a new catalog with schema constraints enabled.

This is now equivalent to new() since schema is always enabled.

pub fn get_or_create_label(&self, name: &str) -> LabelId

Gets or creates a label ID for the given label name.

pub fn get_label_id(&self, name: &str) -> Option<LabelId>

Gets the label ID for a label name, if it exists.

pub fn get_label_name(&self, id: LabelId) -> Option<Arc<str>>

Gets the label name for a label ID, if it exists.

pub fn label_count(&self) -> usize

Returns the number of distinct labels.

pub fn all_labels(&self) -> Vec<Arc<str>>

Returns all label names.

pub fn get_or_create_property_key(&self, name: &str) -> PropertyKeyId

Gets or creates a property key ID for the given property key name.

pub fn get_property_key_id(&self, name: &str) -> Option<PropertyKeyId>

Gets the property key ID for a property key name, if it exists.

pub fn get_property_key_name(&self, id: PropertyKeyId) -> Option<Arc<str>>

Gets the property key name for a property key ID, if it exists.

pub fn property_key_count(&self) -> usize

Returns the number of distinct property keys.

pub fn all_property_keys(&self) -> Vec<Arc<str>>

Returns all property key names.

pub fn get_or_create_edge_type(&self, name: &str) -> EdgeTypeId

Gets or creates an edge type ID for the given edge type name.

pub fn get_edge_type_id(&self, name: &str) -> Option<EdgeTypeId>

Gets the edge type ID for an edge type name, if it exists.

pub fn get_edge_type_name(&self, id: EdgeTypeId) -> Option<Arc<str>>

Gets the edge type name for an edge type ID, if it exists.

pub fn edge_type_count(&self) -> usize

Returns the number of distinct edge types.

pub fn all_edge_types(&self) -> Vec<Arc<str>>

Returns all edge type names.

pub fn create_index( &self, name: &str, label: LabelId, property_key: PropertyKeyId, index_type: IndexType, ) -> IndexId

Creates a new index on a label and property key.

pub fn drop_index(&self, id: IndexId) -> bool

Drops an index by ID.

pub fn find_index_by_name(&self, name: &str) -> Option<IndexId>

Finds an index by its user-defined name.

pub fn get_index(&self, id: IndexId) -> Option<IndexDefinition>

Gets the index definition for an index ID.

pub fn indexes_for_label(&self, label: LabelId) -> Vec<IndexId>

Finds indexes for a given label.

pub fn indexes_for_label_property( &self, label: LabelId, property_key: PropertyKeyId, ) -> Vec<IndexId>

Finds indexes for a given label and property key.

pub fn all_indexes(&self) -> Vec<IndexDefinition>

Returns all index definitions.

pub fn index_count(&self) -> usize

Returns the number of indexes.

pub fn has_schema(&self) -> bool

Returns whether schema constraints are enabled.

pub fn add_unique_constraint( &self, label: LabelId, property_key: PropertyKeyId, ) -> Result<(), CatalogError>

Adds a uniqueness constraint.

Returns an error if schema is not enabled or constraint already exists.

Errors

Returns CatalogError::SchemaNotEnabled if schema is disabled, or a schema-specific error if the operation fails (e.g. duplicate constraint).

pub fn add_required_property( &self, label: LabelId, property_key: PropertyKeyId, ) -> Result<(), CatalogError>

Adds a required property constraint (NOT NULL).

Returns an error if schema is not enabled or constraint already exists.

Errors

Returns CatalogError::SchemaNotEnabled if schema is disabled, or a schema-specific error if the operation fails (e.g. duplicate constraint).

pub fn is_property_required( &self, label: LabelId, property_key: PropertyKeyId, ) -> bool

Checks if a property is required for a label.

pub fn is_property_unique( &self, label: LabelId, property_key: PropertyKeyId, ) -> bool

Checks if a property must be unique for a label.

pub fn schema(&self) -> Option<&SchemaCatalog>

Returns a reference to the schema catalog.

pub fn register_node_type( &self, def: NodeTypeDefinition, ) -> Result<(), CatalogError>

Registers a node type definition.

Errors

• CatalogError::SchemaNotEnabled if schema is disabled.
• CatalogError::TypeAlreadyExists if a type with the same name exists.

pub fn register_or_replace_node_type(&self, def: NodeTypeDefinition)

Registers or replaces a node type definition.

pub fn drop_node_type(&self, name: &str) -> Result<(), CatalogError>

Drops a node type definition.

Errors

• CatalogError::SchemaNotEnabled if schema is disabled.
• CatalogError::TypeNotFound if the type does not exist.

pub fn get_node_type(&self, name: &str) -> Option<NodeTypeDefinition>

Gets a node type definition by name.

pub fn resolved_node_type(&self, name: &str) -> Option<NodeTypeDefinition>

Gets a resolved node type with inherited properties from parents.

pub fn all_node_type_names(&self) -> Vec<String>

Returns all registered node type names.

pub fn all_edge_type_names(&self) -> Vec<String>

Returns all registered edge type definition names.

pub fn register_edge_type_def( &self, def: EdgeTypeDefinition, ) -> Result<(), CatalogError>

Registers an edge type definition.

Errors

• CatalogError::SchemaNotEnabled if schema is disabled.
• CatalogError::TypeAlreadyExists if an edge type with the same name exists.

pub fn register_or_replace_edge_type_def(&self, def: EdgeTypeDefinition)

Registers or replaces an edge type definition.

pub fn drop_edge_type_def(&self, name: &str) -> Result<(), CatalogError>

Drops an edge type definition.

Errors

• CatalogError::SchemaNotEnabled if schema is disabled.
• CatalogError::TypeNotFound if the edge type does not exist.

pub fn get_edge_type_def(&self, name: &str) -> Option<EdgeTypeDefinition>

Gets an edge type definition by name.

pub fn register_graph_type( &self, def: GraphTypeDefinition, ) -> Result<(), CatalogError>

Registers a graph type definition.

Errors

• CatalogError::SchemaNotEnabled if schema is disabled.
• CatalogError::TypeAlreadyExists if a graph type with the same name exists.

pub fn drop_graph_type(&self, name: &str) -> Result<(), CatalogError>

Drops a graph type definition.

Errors

• CatalogError::SchemaNotEnabled if schema is disabled.
• CatalogError::TypeNotFound if the graph type does not exist.

pub fn all_graph_type_names(&self) -> Vec<String>

Returns all registered graph type names.

pub fn get_graph_type_def(&self, name: &str) -> Option<GraphTypeDefinition>

Gets a graph type definition by name.

pub fn register_schema_namespace( &self, name: String, ) -> Result<(), CatalogError>

Registers a schema namespace.

Errors

• CatalogError::SchemaNotEnabled if schema is disabled.
• CatalogError::SchemaAlreadyExists if the namespace already exists.

pub fn drop_schema_namespace(&self, name: &str) -> Result<(), CatalogError>

Drops a schema namespace.

Errors

• CatalogError::SchemaNotEnabled if schema is disabled.
• CatalogError::SchemaNotFound if the namespace does not exist.

pub fn schema_exists(&self, name: &str) -> bool

Checks whether a schema namespace exists.

pub fn schema_names(&self) -> Vec<String>

Returns all registered schema namespace names.

pub fn add_constraint_to_type( &self, label: &str, constraint: TypeConstraint, ) -> Result<(), CatalogError>

Adds a constraint to an existing node type, creating a minimal type if needed.

Errors

Returns CatalogError::SchemaNotEnabled if schema is disabled.

pub fn alter_node_type_add_property( &self, type_name: &str, property: TypedProperty, ) -> Result<(), CatalogError>

Adds a property to a node type.

Errors

• CatalogError::SchemaNotEnabled if schema is disabled.
• CatalogError::TypeNotFound if the node type does not exist.
• CatalogError::TypeAlreadyExists if the property already exists on the type.

pub fn alter_node_type_drop_property( &self, type_name: &str, property_name: &str, ) -> Result<(), CatalogError>

Drops a property from a node type.

Errors

• CatalogError::SchemaNotEnabled if schema is disabled.
• CatalogError::TypeNotFound if the node type or property does not exist.

pub fn alter_edge_type_add_property( &self, type_name: &str, property: TypedProperty, ) -> Result<(), CatalogError>

Adds a property to an edge type.

Errors

• CatalogError::SchemaNotEnabled if schema is disabled.
• CatalogError::TypeNotFound if the edge type does not exist.
• CatalogError::TypeAlreadyExists if the property already exists on the type.

pub fn alter_edge_type_drop_property( &self, type_name: &str, property_name: &str, ) -> Result<(), CatalogError>

Drops a property from an edge type.

Errors

• CatalogError::SchemaNotEnabled if schema is disabled.
• CatalogError::TypeNotFound if the edge type or property does not exist.

pub fn alter_graph_type_add_node_type( &self, graph_type_name: &str, node_type: String, ) -> Result<(), CatalogError>

Adds a node type to a graph type.

Errors

Returns CatalogError::SchemaNotEnabled if schema is disabled, or CatalogError::TypeNotFound if the graph type does not exist.

pub fn alter_graph_type_drop_node_type( &self, graph_type_name: &str, node_type: &str, ) -> Result<(), CatalogError>

Drops a node type from a graph type.

Errors

Returns CatalogError::SchemaNotEnabled if schema is disabled, or CatalogError::TypeNotFound if the graph type does not exist.

pub fn alter_graph_type_add_edge_type( &self, graph_type_name: &str, edge_type: String, ) -> Result<(), CatalogError>

Adds an edge type to a graph type.

Errors

Returns CatalogError::SchemaNotEnabled if schema is disabled, or CatalogError::TypeNotFound if the graph type does not exist.

pub fn alter_graph_type_drop_edge_type( &self, graph_type_name: &str, edge_type: &str, ) -> Result<(), CatalogError>

Drops an edge type from a graph type.

Errors

Returns CatalogError::SchemaNotEnabled if schema is disabled, or CatalogError::TypeNotFound if the graph type does not exist.

pub fn bind_graph_type( &self, graph_name: &str, graph_type: String, ) -> Result<(), CatalogError>

Binds a graph instance to a graph type.

Errors

• CatalogError::SchemaNotEnabled if schema is disabled.
• CatalogError::TypeNotFound if the graph type does not exist.

pub fn get_graph_type_binding(&self, graph_name: &str) -> Option<String>

Gets the graph type binding for a graph instance.

pub fn register_procedure( &self, def: ProcedureDefinition, ) -> Result<(), CatalogError>

Registers a stored procedure.

Errors

• CatalogError::SchemaNotEnabled if schema is disabled.
• CatalogError::TypeAlreadyExists if a procedure with the same name exists.

pub fn replace_procedure( &self, def: ProcedureDefinition, ) -> Result<(), CatalogError>

Replaces or creates a stored procedure.

Errors

Returns CatalogError::SchemaNotEnabled if schema is disabled.

pub fn drop_procedure(&self, name: &str) -> Result<(), CatalogError>

Drops a stored procedure.

Errors

• CatalogError::SchemaNotEnabled if schema is disabled.
• CatalogError::TypeNotFound if the procedure does not exist.

pub fn get_procedure(&self, name: &str) -> Option<ProcedureDefinition>

Gets a stored procedure by name.

pub fn all_node_type_defs(&self) -> Vec<NodeTypeDefinition>

Returns all registered node type definitions.

pub fn all_edge_type_defs(&self) -> Vec<EdgeTypeDefinition>

Returns all registered edge type definitions.

pub fn all_graph_type_defs(&self) -> Vec<GraphTypeDefinition>

Returns all registered graph type definitions.

pub fn all_procedure_defs(&self) -> Vec<ProcedureDefinition>

Returns all registered procedure definitions.

pub fn all_graph_type_bindings(&self) -> Vec<(String, String)>

Returns all graph type bindings (graph_name, type_name).

Trait Implementations

impl Default for Catalog

fn default() -> Self

Returns the “default value” for a type.