Skip to main content

Crate nodedb_client

Crate nodedb_client 

Source
Expand description

NodeDB client SDK: the NodeDb trait, the NodeDbRemote client (native MessagePack via TLS, opt-in via the native feature; pgwire compatibility via the remote feature), and capability negotiation.

For embedded use, depend on nodedb-lite directly. For server use, enable the native feature and connect to a NodeDB Origin node via its native protocol — pgwire compatibility (remote) is provided so existing PostgreSQL drivers can connect for read-mostly workloads, but it is not the long-term ORM target.

Re-exports§

pub use capabilities::Capabilities;
pub use traits::NodeDb;

Modules§

capabilities
Capabilities newtype for typed capability bit-test accessors.
traits
The NodeDb trait: unified query interface for both Origin and Lite.

Structs§

Document
A CRDT-backed document. The primary data unit across all NodeDB engines.
EdgeFilter
Edge filter for graph traversal. Constrains which edges are followed during BFS/DFS.
EdgeId
Identifies a graph edge. Returned by graph_insert_edge.
NodeDbError
Public error type returned by all NodeDb trait methods.
NodeId
Identifies a graph node. Separate from DocumentId because graph nodes can exist independently of documents (e.g., concept nodes in a knowledge graph).
QueryResult
Result of a SQL query or multi-modal query.
SearchResult
Result of a k-NN vector search.
SubGraph
Result of a graph traversal (BFS/DFS).

Enums§

MetadataFilter
Metadata filter for vector search. Applied as a pre-filter (Roaring bitmap) or post-filter depending on selectivity.
Value
A dynamic value that can represent any field type in a document or any parameter in a SQL query.

Type Aliases§

NodeDbResult
Result alias for NodeDb operations.