Struct Database 

pub struct Database { /* private fields */ }

Open OXGDB database handle.

Performance

Moving a handle is O(n) for the owned in-memory database state.

Implementations

impl Database

pub fn create(path: impl AsRef<Path>) -> Result<Self, DbError>

Creates a new empty OXGDB database at path.

Errors

Returns DbError::AlreadyExists when a greenfield store already exists, or DbError::Io when creation fails.

Performance

This function is O(path length + empty store bytes).

pub fn open(path: impl AsRef<Path>) -> Result<Self, DbError>

Opens an existing OXGDB database.

Errors

Returns DbError when the store is missing, malformed, or semantically invalid.

Performance

This function is O(serialized database bytes).

pub fn validate_path(path: impl AsRef<Path>) -> Result<(), DbError>

Validates an OXGDB database at path.

Errors

Returns DbError when store or semantic validation fails.

Performance

This function is O(serialized database bytes).

pub fn compact(&mut self) -> Result<(), DbError>

Rewrites the store in the current greenfield format.

Errors

Returns DbError when validation, encoding, writing, or replacement fails.

Performance

This method is O(serialized database bytes).

pub fn validate(&self) -> Result<(), DbError>

Validates this open handle’s store and in-memory state.

Errors

Returns DbError when validation fails.

Performance

This method is O(serialized database bytes).

pub fn status(&self) -> DatabaseStatus

Returns operational status for this handle.

Performance

This method is O(1).

pub fn catalog_summary(&self) -> CatalogSummary

Returns a catalog-size summary.

Performance

This method is O(catalog entry count).

pub fn begin_read(&self) -> ReadTransaction

Starts a read transaction pinned to the current visible generation.

Performance

This method is O(1): the reader shares the committed state through an atomically reference-counted handle rather than copying it. A later committed generation does not disturb a reader already holding its generation’s handle.

pub fn begin_write(&mut self) -> Result<WriteTransaction<'_>, DbError>

Starts the single writer transaction.

Errors

Returns DbError::TransactionIdOverflow when writer IDs are exhausted.

Performance

This method is O(1): the writer shares the committed base through an atomically reference-counted handle and copies it lazily on the first mutation (copy-on-write), so an empty or rolled-back transaction never clones the state.

pub fn prepare( &self, language: QueryLanguage, query: &str, ) -> Result<PreparedQuery, DbError>

Prepares a query against the current catalog.

Errors

Returns DbError when parsing or semantic analysis fails.

Performance

This method is O(query length + catalog lookup cost).