Enum GraphStoreHandle 

pub enum GraphStoreHandle {
    Memory(MemoryGraphStore),
    Persistent(PersistentGraphStore),
}

Variants

Memory(MemoryGraphStore)

Persistent(PersistentGraphStore)

Implementations

impl GraphStoreHandle

pub fn from_catalog( catalog: Arc<dyn CatalogFacade>, backend: Arc<dyn PersistentStorageBackend>, ) -> Self

pub fn transaction_mapped<T, E>( &mut self, operation: impl FnOnce(&mut Self) -> Result<T, E>, map_error: impl Fn(GraphStoreError) -> E, ) -> Result<T, E>

where E: Display,

Preserve caller error types while storage checkpoints (or the primary memory store) roll back the complete operation on errors and panics.

pub fn label_registry( &self, graph: &str, ) -> GraphStoreResult<GraphLabelRegistry>

pub fn graph_labels(&self, graph: &str) -> GraphStoreResult<Vec<GraphLabelInfo>>

pub fn graph_label_kind( &self, graph: &str, label: &str, ) -> GraphStoreResult<Option<LabelKind>>

pub fn create_label( &mut self, graph: &str, label: &str, kind: LabelKind, ) -> GraphStoreResult<Option<u32>>

pub fn drop_label( &mut self, graph: &str, label: &str, ) -> GraphStoreResult<Option<(u32, LabelKind)>>

pub fn rename_graph(&mut self, from: &str, to: &str) -> GraphStoreResult<()>

pub fn import_label_registry( &mut self, graph: &str, registry: &GraphLabelRegistry, ) -> GraphStoreResult<()>

pub fn rebuild_label_registry_from_ids( &mut self, graph: &str, ) -> GraphStoreResult<()>

Trait Implementations

impl Clone for GraphStoreHandle

fn clone(&self) -> GraphStoreHandle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GraphStoreHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GraphStoreHandle

fn default() -> Self

Returns the “default value” for a type.

impl GraphStore for GraphStoreHandle

fn vertex_id_page( &self, graph: &str, after: Option<u64>, limit: usize, ) -> GraphStoreResult<Vec<u64>>

Bounded ascending vertex identities, exclusively after the cursor. Durable stores override this with an indexed storage cursor.

fn edge_id_page( &self, graph: &str, after: Option<u64>, limit: usize, ) -> GraphStoreResult<Vec<u64>>

Bounded ascending edge identities without materializing edge payloads.

fn transaction<T>( &mut self, operation: impl FnOnce(&mut Self) -> GraphStoreResult<T>, ) -> GraphStoreResult<T>

Apply a group of mutations atomically. Persistent stores use a storage transaction or savepoint, never a cloned graph as a rollback image. Both errors and unwinding must restore the pre-operation state.

fn create_graph(&mut self, name: &str) -> GraphStoreResult<()>

Create a new named graph. No-op if it already exists.

fn drop_graph(&mut self, name: &str) -> GraphStoreResult<()>

Drop a named graph and all of its membership entries. Vertex / edge records that aren’t referenced by any other graph become unreachable and are released.

fn graph_names(&self) -> GraphStoreResult<Vec<String>>

Return all graph names sorted ascending.

fn has_graph(&self, name: &str) -> GraphStoreResult<bool>

fn union_graphs( &mut self, g1: &str, g2: &str, target: &str, ) -> GraphStoreResult<()>

target := g1 union g2 over vertex and edge sets.

fn intersect_graphs( &mut self, g1: &str, g2: &str, target: &str, ) -> GraphStoreResult<()>

target := g1 intersect g2.

fn difference_graphs( &mut self, g1: &str, g2: &str, target: &str, ) -> GraphStoreResult<()>

target := g1 \ g2.

fn copy_graph(&mut self, source: &str, target: &str) -> GraphStoreResult<()>

fn add_vertex(&mut self, vertex: Vertex, graph: &str) -> GraphStoreResult<()>

fn add_edge(&mut self, edge: Edge, graph: &str) -> GraphStoreResult<()>

fn remove_vertex(&mut self, vertex_id: u64, graph: &str) -> GraphStoreResult<()>

fn remove_edge(&mut self, edge_id: u64, graph: &str) -> GraphStoreResult<()>

fn neighbors( &self, vertex_id: u64, label: Option<&str>, direction: Direction, graph: &str, ) -> GraphStoreResult<Vec<u64>>

Neighbor vertex ids reached from vertex_id along edges with the given label (or any label when label is None) in the given direction.

fn vertices_by_label( &self, label: &str, graph: &str, ) -> GraphStoreResult<Vec<Vertex>>

fn vertex_ids_by_label( &self, label: &str, graph: &str, ) -> GraphStoreResult<Vec<u64>>

Return only the vertex ids for a label. Stores with a label index should override this to avoid materializing full vertices.

fn vertices_in_graph(&self, graph: &str) -> GraphStoreResult<Vec<Vertex>>

fn edges_in_graph(&self, graph: &str) -> GraphStoreResult<Vec<Edge>>

fn vertex_graphs(&self, vertex_id: u64) -> GraphStoreResult<BTreeSet<String>>

fn edge_graphs(&self, edge_id: u64) -> GraphStoreResult<BTreeSet<String>>

fn edges_by_label( &self, label: &str, graph: &str, ) -> GraphStoreResult<Vec<Edge>>

Read only edges carrying a label. Durable stores push this predicate into their physical label index before fetching any payloads.

fn out_edge_ids( &self, vertex_id: u64, graph: &str, ) -> GraphStoreResult<BTreeSet<u64>>

fn in_edge_ids( &self, vertex_id: u64, graph: &str, ) -> GraphStoreResult<BTreeSet<u64>>

fn edge_ids_by_label( &self, label: &str, graph: &str, ) -> GraphStoreResult<BTreeSet<u64>>

fn vertex_ids_in_graph(&self, graph: &str) -> GraphStoreResult<BTreeSet<u64>>

fn require_vertex_in_graph( &self, vertex_id: u64, graph: &str, ) -> GraphStoreResult<()>

Require an explicit query vertex to be a live member of graph. Implementations may override this with a cheaper membership lookup. Missing query input is distinct from a valid vertex with no edges and must not be reported as an empty neighborhood/path result.

fn degree_distribution( &self, graph: &str, ) -> GraphStoreResult<BTreeMap<u64, u64>>

fn label_degree(&self, label: &str, graph: &str) -> GraphStoreResult<f64>

fn vertex_label_counts( &self, graph: &str, ) -> GraphStoreResult<BTreeMap<String, u64>>

fn get_vertex(&self, vertex_id: u64) -> GraphStoreResult<Option<Vertex>>

Fetch one owned record. A storage implementation must not retain all entities merely to return a borrow, and I/O failures are not absence.

fn get_edge(&self, edge_id: u64) -> GraphStoreResult<Option<Edge>>

fn next_vertex_id(&mut self) -> GraphStoreResult<u64>

Returns and advances the next available vertex id.

fn next_edge_id(&mut self) -> GraphStoreResult<u64>

Returns and advances the next available edge id.

fn allocate_vertex_id( &mut self, label: &str, graph: &str, ) -> GraphStoreResult<u64>

Allocate a vertex id for a new entity with label inside graph. Stores that implement the Apache AGE graphid scheme override this to return (label_id << 48) | sequence; the default falls back to the store-wide counter.

fn allocate_edge_id( &mut self, label: &str, graph: &str, ) -> GraphStoreResult<u64>

Allocate an edge id for a new entity with label inside graph. See GraphStore::allocate_vertex_id.

fn clear(&mut self) -> GraphStoreResult<()>

fn vertices(&self) -> GraphStoreResult<BTreeMap<u64, Vertex>>

Snapshot every vertex in the store, keyed by id. Mirrors the vertices property on the current abstract GraphStore.

fn edges(&self) -> GraphStoreResult<BTreeMap<u64, Edge>>

Snapshot every edge in the store, keyed by id. Mirrors the edges property on the current abstract GraphStore.