Skip to main content

AdminService

Trait AdminService 

Source
pub trait AdminService {
    // Required methods
    fn info(&self) -> DatabaseInfo;
    fn detailed_stats(&self) -> DatabaseStats;
    fn schema(&self) -> SchemaInfo;
    fn validate(&self) -> ValidationResult;
    fn wal_status(&self) -> WalStatus;
    fn wal_checkpoint(&self) -> Result<()>;
}
Expand description

Trait for administrative database operations.

Provides a uniform interface for introspection, validation, and maintenance operations. Used by the CLI, REST API, and bindings to inspect and manage a Grafeo database.

Implemented by GrafeoDB.

Required Methods§

Source

fn info(&self) -> DatabaseInfo

Returns high-level database information (counts, mode, persistence).

Source

fn detailed_stats(&self) -> DatabaseStats

Returns detailed database statistics (memory, disk, indexes).

Source

fn schema(&self) -> SchemaInfo

Returns schema information (labels, edge types, property keys).

Source

fn validate(&self) -> ValidationResult

Validates database integrity, returning errors and warnings.

Source

fn wal_status(&self) -> WalStatus

Returns WAL (Write-Ahead Log) status.

Source

fn wal_checkpoint(&self) -> Result<()>

Forces a WAL checkpoint, flushing pending records to storage.

§Errors

Returns an error if the checkpoint fails.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§

Source§

impl AdminService for GrafeoDB

Available on crate feature lpg only.