Expand description
§grafeo-engine
The engine behind Grafeo. You’ll find everything here for creating databases, running queries, and managing transactions.
Most users should start with the main grafeo crate, which re-exports the
key types. If you’re here directly, GrafeoDB is your entry point.
§Modules
database- Create and manage databases withGrafeoDBsession- Lightweight handles for concurrent accessconfig- Tune memory, threads, and durability settingstransaction- MVCC transaction management (snapshot isolation)query- The full query pipeline: parsing, planning, optimization, executioncatalog- Schema metadata: labels, property keys, indexesadmin- Admin API types for inspection, backup, and maintenance
Re-exports§
pub use admin::AdminService;pub use admin::CompactionStats;pub use admin::DatabaseInfo;pub use admin::DatabaseMode;pub use admin::DatabaseStats;pub use admin::DumpFormat;pub use admin::DumpMetadata;pub use admin::IndexInfo;pub use admin::LpgSchemaInfo;pub use admin::RdfSchemaInfo;pub use admin::SchemaInfo;pub use admin::ValidationError;pub use admin::ValidationResult;pub use admin::ValidationWarning;pub use admin::WalStatus;pub use auth::Grant;pub use auth::Identity;pub use auth::Role;pub use auth::StatementKind;pub use catalog::Catalog;pub use catalog::CatalogError;pub use catalog::IndexDefinition;pub use catalog::IndexType;pub use config::AccessMode;pub use config::Config;pub use config::ConfigError;pub use config::DurabilityMode;pub use config::GraphModel;pub use database::GrafeoDB;pub use memory_usage::MemoryUsage;pub use query::executor::stream::OwnedResultStream;pub use query::executor::stream::OwnedRowIterator;pub use query::executor::stream::ResultStream;pub use query::executor::stream::RowIterator;pub use session::Session;pub use transaction::CommitInfo;pub use transaction::PreparedCommit;
Modules§
- admin
- Admin API types for database inspection, backup, and maintenance.
- auth
- Role-based access control for Grafeo sessions.
- catalog
- Schema metadata - what labels, properties, and indexes exist.
- config
- Database configuration.
- database
- The main database struct and operations.
- execution
- Engine-level execution utilities.
- export
- Graph export serializers (GEXF, GraphML).
- memory_
usage - Hierarchical memory usage breakdown for the database.
- query
- The complete query processing pipeline.
- session
- Lightweight handles for database interaction.
- transaction
- Transaction management with MVCC and configurable isolation levels.
Structs§
- Projection
Spec - Defines which nodes and edges are included in a projection.
Constants§
- VERSION
- The version of the grafeo-engine crate (from Cargo.toml).
Traits§
- Graph
Store - Read-only graph operations used by the query engine.
- Graph
Store Mut - Write operations for graph mutation.