Skip to main content

Catalog

Struct Catalog 

Source
pub struct Catalog { /* private fields */ }
Expand description

The main database catalog.

Manages all metadata about the database schema including:

  • Labels (node categories)
  • Property keys (property names)
  • Edge types (relationship types)
  • Index definitions

Implementations§

Source§

impl Catalog

Source

pub fn new() -> Self

Creates a new empty catalog.

Source

pub fn with_schema() -> Self

Creates a new catalog with schema constraints enabled.

Source

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

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

Source

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

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

Source

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

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

Source

pub fn label_count(&self) -> usize

Returns the number of distinct labels.

Source

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

Returns all label names.

Source

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

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

Source

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

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

Source

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.

Source

pub fn property_key_count(&self) -> usize

Returns the number of distinct property keys.

Source

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

Returns all property key names.

Source

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

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

Source

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

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

Source

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.

Source

pub fn edge_type_count(&self) -> usize

Returns the number of distinct edge types.

Source

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

Returns all edge type names.

Source

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

Creates a new index on a label and property key.

Source

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

Drops an index by ID.

Source

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

Gets the index definition for an index ID.

Source

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

Finds indexes for a given label.

Source

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

Finds indexes for a given label and property key.

Source

pub fn index_count(&self) -> usize

Returns the number of indexes.

Source

pub fn has_schema(&self) -> bool

Returns whether schema constraints are enabled.

Source

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.

Source

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.

Source

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

Checks if a property is required for a label.

Source

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

Checks if a property must be unique for a label.

Trait Implementations§

Source§

impl Default for Catalog

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more