rxgraph 0.8.0

High-performance graph traversal engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

//! High-performance graph traversal.
//!
//! `rxgraph` provides fast topology queries, stateful path search, and explicit
//! construction APIs for graphs stored in columnar tables.
//!
//! ## Architecture
//!
//! Internally, `rxgraph` stores node and edge tables as Arrow
//! [`RecordBatch`](arrow::record_batch::RecordBatch) values, validates graph
//! identity columns once, and builds compact CSR topology for traversal. The
//! graph schema is deliberately small:
//!
//! - nodes require `id`
//! - edges require `id`, `src`, and `dest`
//! - all identity columns must be either `UInt64` or string
//! - optional `type` columns must be string
//!
//! Use [`Graph::new`] to build a graph, [`TraversalConfigBuilder`] plus
//! [`DslKernel`] for stateful path search, and the convenience methods on
//! [`Graph`] for simple BFS/DFS, shortest path, degree, and component queries.
//!
//! Traversal evaluates a [`DslKernel`] against every candidate edge. The kernel
//! decides whether the edge is accepted, how named path state changes, and
//! whether the accepted path should be returned. Search uses compact internal
//! IDs and materializes external [`GraphId`] values only in returned results.

mod arrow;
pub mod dsl;
pub mod examples;
pub mod graph;
#[cfg(feature = "python")]
mod python;
pub mod traversal;

#[cfg(feature = "python")]
pub use python::register;

pub use dsl::{DslExpr, DslKernel, Scalar, StateRow, Value};
pub use graph::{EdgeId, Graph, GraphId, GraphRepo, NodeId, OwnedGraphId};
pub use traversal::{
    ArrowRow, BoxedRun, EdgeCtx, GraphPath, Kernel, KernelEntry, OwnedGraphPath, OwnedSearchResult,
    ParquetPaths, PayloadField, RunKernel, RunOptions, SearchResult, SearchStats, TraversalConfig,
    TraversalConfigBuilder, TraversalStrategy, TypedKernel, TypedKernelEntry, TypedPayloadCache,
    boxed_run, boxed_typed_run, build_kernel, build_typed_kernel, register_kernel, search_native,
    try_build_kernel, try_build_typed_kernel,
};

// Re-exported so plugin crates can register kernels without their own dependency.
pub use traversal::inventory;