Skip to main content

Crate oxgraph_db

Crate oxgraph_db 

Source
Expand description

Standalone OxGraph-native database engine.

oxgraph-db is a product layer above the topology substrate. It owns durable database identity, cataloged physical projections, properties, indexes, native OxQL execution, and embedded transaction semantics. Foundation crates remain storage- and meaning-neutral.

Modules§

projection
Materialized graph and hypergraph projection views.

Structs§

Bool
Boolean value-type marker (corresponds to PropertyType::Boolean).
Bound
Resolved name→id handles for an applied Schema.
Catalog
Db catalog for names, schemas, projections, and indexes.
CatalogSummary
Catalog-size summary.
CheckpointGeneration
Immutable checkpoint generation identifier.
CommitSeq
Monotonic committed transaction sequence.
Db
Open OXGDB database handle.
Element
An owned element view: id, labels, and all properties in one read.
ElementId
Stable canonical element identifier.
ElementRecord
One visible canonical element.
EqualityIndex
An equality index whose indexed key has value type T.
GraphProjectionDefinition
Graph projection definition.
GraphProjectionSpec
A binary graph-projection declaration over a set of relation types.
HypergraphProjectionDefinition
Hypergraph projection definition.
IncidenceId
Stable canonical incidence identifier.
IncidenceRecord
One visible incidence in canonical database coordinates.
IndexEntry
Catalog entry for one index.
IndexId
Stable catalog index identifier.
Int
Integer value-type marker (corresponds to PropertyType::Integer).
Key
A property key that carries its value type T in the type system.
LabelDefinition
Catalog entry for one element or relation label.
LabelId
Stable catalog label identifier.
PreparedQuery
Prepared query plan.
ProjectionEntry
Catalog entry for one projection.
ProjectionId
Stable catalog projection identifier.
Properties
A typed, owned property bag for one subject.
PropertyKeyDefinition
Catalog entry for one typed property key.
PropertyKeyId
Stable catalog property-key identifier.
QueryResult
Query result materialized for JSON, CLI, and embedded consumers.
QueryRow
One query result row.
RangeIndex
A range index whose indexed key has value type T.
ReadPin
Reader pin identifying the visible database generation.
Reader
Read transaction over a pinned snapshot.
Relation
An owned relation view: id, type, labels, and all properties in one read.
RelationId
Stable canonical relation identifier.
RelationRecord
One visible canonical relation.
RelationTypeDefinition
Catalog entry for one relation type.
RelationTypeId
Stable catalog relation-type identifier.
RoleDefinition
Catalog entry for one structural incidence role.
RoleId
Stable canonical structural role identifier.
Schema
A declarative catalog schema, applied once to obtain a Bound handle bag.
Stats
Snapshot of database status.
Subgraph
A discovered subgraph: nodes in BFS first-discovery order plus the projection edges among them.
Text
Text value-type marker (corresponds to PropertyType::Text).
TransactionId
Monotonic writer transaction identifier.
TraversedEdge
One edge traversed by a walk.
TraversedNode
One node discovered by a walk.
Walk
Bounds for a bounded graph projection walk.
Writer
Single writer transaction.

Enums§

CheckpointPolicy
Auto-checkpoint policy: decides when a dirty commit should fold the delta-log into a fresh base generation, bounding the log tail that recovery must replay.
CommitOutcome
The durable result of a Db::write: whether a frame landed, and at which commit sequence.
DbError
Errors raised by the OxGraph database product.
Direction
Direction a graph navigation expands along.
IndexDefinition
Index definition stored in the catalog.
Match
Lookup input for a cataloged index.
ProjectionDefinition
Physical projection definition stored in the catalog.
PropertyFamily
Subject family accepted by a property key.
PropertySubject
Subject that can own properties.
PropertyType
Supported scalar property types.
PropertyValue
One typed property value.
QueryValue
Query value variants used by OxQL.

Traits§

Assignable
A Rust value that may be assigned to a property of value type T.
Readable
A Rust value that can be read back from a property of value type T.
ValueType
A scalar value type usable as a typed-handle marker.