Skip to main content

Module storage

Module storage 

Source

Modules§

edge
Edge Storage Module
memory_watermark
Process-wide memory watermark coordinator.
migration_history
mvcc_visibility
Unified MVCC visibility helper.
stats
Storage statistics helpers: HyperLogLog cardinality estimator.
stats_reader
Column Statistics Snapshot Reader

Structs§

AutoCommitBatchWindow
A shared auto-commit batch window.
CatalogLockDiagnostic
ChangeLog
Batch of schema changes for a single label
CheckpointDiagnostics
CheckpointStats
ColumnStatsSnapshot
Immutable point-in-time statistics for one property column of a vertex tag or an edge type.
EdgeColumnBatch
A column-major edge batch produced by EdgeCursor::next_column_batch.
FlatVertexRecord
A vertex row read from the storage columns without Vertex/HashMap boxing.
GenerationBuildState
Persisted tracking data for one native index generation build. Stored alongside the index metadata so it survives crashes.
GraphStorage
IndexManifest
The persisted routing table for one immutable index generation.
IndexScanPlan
Immutable physical index scan contract.
IndexShard
An immutable half-open ordered-key range. None represents infinity.
LabelVersionHistory
Version history for a single label (vertex or edge type)
ManifestCatalog
Publishes immutable manifests and fences reclamation with reader handles.
ManifestCatalogStats
ManifestHandle
A cursor-owned pin that prevents reclamation of a generation’s physical files.
MemoryAccounting
Thread-safe accounting shared by storage components.
MemoryBudget
Validated memory limits for one storage instance.
MemoryReservation
RAII handle for temporary background memory.
MemoryUsage
MetricsStorage
MigrationHistoryManager
In-memory manager for migration history. Persisted as JSON.
MigrationHistoryRecord
One row of the migration_history table.
PersistenceConfig
PersistenceDiagnostics
PredicateRange
A merged value range over one column, derived from pushed scan predicates. Used for zone-map pruning: a storage chunk whose min/max bounds cannot overlap this range cannot contain matching rows.
PropertyChange
Property change event - represents a single property schema modification
PropertyColumn
One property column of a column-major vertex batch.
PropertyGraphConfig
RequiredProperty
Carries resolved metadata so that scan operators and storage cursors no longer rely on alias/name heuristics. The schema_version binds the identity to a specific catalog generation, preventing stale reuse after schema changes.
ResourceConfig
Resource and maintenance limits shared by the storage engine components.
ResourceSnapshot
Point-in-time resource information suitable for logs and metrics exports.
ScanOptions
Unified scan options that configure cursor behavior.
ShardSlice
One slice of every shard’s local-id space, selected by partition index.
SnapshotHandle
Snapshot handle for MVCC - identifies a consistent snapshot at a specific timestamp
SnapshotStats
StagedWriteMark
Boundary of storage-staged (not yet undo-logged) writes captured at savepoint creation.
StorageError
Storage layer error type
StorageOperationContext
Immutable context bound to one storage operation scope.
StoragePropertyDef
Storage-level property definition. Combines features from both vertex and edge property definitions.
StorageStats
Storing statistical information
SyncWrapper
Decorator that wraps a StorageClient to provide automatic index synchronization.
TtlPurgeEntry
Physical-deletion result for one TTL schema scanned by a purge.
VecEdgeCursor
Edge cursor backed by a pre-materialized Vec<Edge>.
VecVertexCursor
Vertex cursor backed by a pre-materialized Vec<Vertex>.
VertexColumnBatch
A column-major vertex batch produced by VertexCursor::next_column_batch.
WalMetrics
WriteGateStats
Cumulative gate admission statistics (acquisitions and total wait time).

Enums§

ChangeDetails
Detailed information about schema modifications
ColumnValues
Raw decoded values for one property column, in column-major order.
GenerationState
Persistent state of a native index generation rebuild. Written to durable storage before each phase so that crash recovery can determine whether the partial build can be resumed or must restart.
IndexPredicate
Predicate understood by native index cursors.
IndexRow
MemoryCategory
Memory ownership categories used by the storage engine.
MigrationStatus
Status of a migration execution.
PartitionSelector
PersistenceFaultPoint
PurgeTarget
Target schema of a StorageAdmin::purge_expired call: a single tag or edge type by name. None passed instead means “every TTL-configured schema in the space”.
ScanPredicate
A single-column comparison predicate pushed from the query layer into a physical scan.
ScanTarget
Identifies what kind of scan is being performed.
SchemaObjectType
Type identifier for change tracking - distinguishes between vertex and edge schema changes
StorageEvent
Storage engine lifecycle notification.

Traits§

AutoCommitBatchOps
Operations for running a run of auto-commit DML statements inside a shared batch window.
AutoCommitGroupOps
Group-commit operations on top of an AutoCommitBatchWindow. The window is shared with AutoCommitBatchOps; bind_auto_commit_statement is mode-aware: bound inside a group window it reuses the shared write timestamp and undo log, so no separate bind method is needed.
CatalogStore
Catalog and schema access used by query planning and DDL execution.
ColumnStatsReader
Reader capability for optimizer-facing column statistics snapshots.
EdgeCursor
A cursor that yields edges in batches.
GraphStore
Logical graph data access used by query execution.
IndexCursor
A cursor that yields index entries (row IDs or covering rows) in batches.
QueryStorage
Minimal combined capability required by the query crate.
StorageAdmin
Administrative operations: stats, maintenance, optional components.
StorageAuthOps
Authentication and authorization operations.
StorageClient
Combined storage interface with full read/write/schema/auth/admin capabilities.
StorageCommitOps
StorageGcOps
Index GC operations.
StorageMaintenance
Maintenance-only capabilities used by server initialization and administration.
StorageOperationContextOps
Creates an immutable storage handle bound to a single operation context.
StoragePersistenceOps
Persistence operations for flushing, checkpointing, and compaction.
StorageReader
Read-only data and schema operations.
StorageRecoveryOps
WAL recovery operations.
StorageSchemaContextOps
Access to persistent schema context shared with higher-level components.
StorageSchemaOps
Schema/space/tag/edge-type/index DDL operations.
StorageSnapshotOps
Background freeze operations.
StorageSyncContextOps
Access to sync runtime context shared with higher-level components.
StorageTtlPurgeOps
Background TTL purge operations.
StorageWriter
Write operations for vertex and edge data.
UndoTarget
Target for undo operations
VertexCursor
A cursor that yields vertices in batches.

Functions§

open_edge_scan
Open an edge scan cursor through a storage client.
open_index_cursor
Open an index scan cursor through a storage client.
open_vertex_scan
Open a vertex scan cursor through a storage client.

Type Aliases§

GcEventSink
Observer for reclaimed-entry counts, forwarded by GC managers to the persistence coordinator which fans out StorageEvent::GcRun.
StorageEventCallback
Runtime observer for storage events.