Skip to main content

EntityGraph

Struct EntityGraph 

Source
pub struct EntityGraph { /* private fields */ }
Expand description

Core entity graph with bitmap tag indexing and bidirectional ref adjacency.

Implementations§

Source§

impl EntityGraph

Source

pub fn new() -> Self

Create an empty entity graph with standard Haystack fields auto-indexed.

Source

pub fn with_namespace(ns: DefNamespace) -> Self

Create an entity graph with an ontology namespace.

Source

pub fn index_field(&mut self, field: &str)

Register a field for B-Tree value indexing. Enables O(log N) range queries (e.g. temp > 72) for this field. Must be called before entities are added, or followed by rebuild_value_index for existing data.

Source

pub fn rebuild_value_index(&mut self)

Rebuild the value index for all indexed fields from the current entities.

Source

pub fn value_index(&self) -> &ValueIndex

Returns a reference to the value index (for use by the query planner).

Source

pub fn track_column(&mut self, tag: &str)

Register a tag for columnar storage. Enables cache-friendly sequential scans for this tag. Must be called before entities are added, or followed by rebuild_columnar for existing data.

Source

pub fn rebuild_columnar(&mut self)

Rebuild all tracked columnar data from current entities.

Source

pub fn columnar(&self) -> &ColumnarStore

Returns a reference to the columnar store for direct column scans.

Source

pub fn add(&mut self, entity: HDict) -> Result<String, GraphError>

Add an entity to the graph.

The entity must have an id tag that is a Ref. Returns the ref value string on success.

Source

pub fn get(&self, ref_val: &str) -> Option<&HDict>

Get a reference to an entity by ref value.

Source

pub fn update( &mut self, ref_val: &str, changes: HDict, ) -> Result<(), GraphError>

Update an existing entity by merging changes into it.

Tags in changes overwrite existing tags; Kind::Remove tags are deleted. The id tag cannot be changed.

Source

pub fn remove(&mut self, ref_val: &str) -> Result<HDict, GraphError>

Remove an entity from the graph. Returns the removed entity.

Source

pub fn read(&self, filter_expr: &str, limit: usize) -> Result<HGrid, GraphError>

Run a filter expression and return matching entities as a grid.

Source

pub fn read_all( &self, filter_expr: &str, limit: usize, ) -> Result<Vec<&HDict>, GraphError>

Run a filter expression and return matching entities as references.

Source

pub fn refs_from(&self, ref_val: &str, ref_type: Option<&str>) -> Vec<String>

Get ref values that the given entity points to.

Source

pub fn refs_to(&self, ref_val: &str, ref_type: Option<&str>) -> Vec<String>

Get ref values of entities that point to the given entity.

Source

pub fn rebuild_csr(&mut self)

Rebuild the CSR snapshot from the current adjacency. Should be called after a batch of mutations (e.g., import, sync).

Source

pub fn csr_is_stale(&self) -> bool

Returns true if the CSR snapshot is stale (version mismatch).

Source

pub fn all_edges(&self) -> Vec<(String, String, String)>

Return all edges in the graph as (source_ref, ref_tag, target_ref) tuples.

Source

pub fn neighbors( &self, ref_val: &str, hops: usize, ref_types: Option<&[&str]>, ) -> (Vec<&HDict>, Vec<(String, String, String)>)

BFS neighborhood: return entities and edges within hops of ref_val.

ref_types optionally restricts which ref tags are traversed. Returns (entities, edges) where edges are (source, ref_tag, target).

Source

pub fn shortest_path(&self, from: &str, to: &str) -> Vec<String>

BFS shortest path from from to to. Returns ordered ref_vals, or empty vec if no path exists.

Source

pub fn subtree(&self, root: &str, max_depth: usize) -> Vec<(&HDict, usize)>

Return the subtree rooted at root up to max_depth levels.

Walks reverse refs (children referencing parent). Returns entities paired with their depth from root. Root is depth 0.

Source

pub fn entities_fitting(&self, spec_name: &str) -> Vec<&HDict>

Find all entities that structurally fit a spec/type name.

Requires a namespace to be set. Returns empty if no namespace.

Source

pub fn validate(&self) -> Vec<ValidationIssue>

Validate all entities against the namespace and check for dangling refs.

Returns empty if no namespace is set and no dangling refs exist.

Source

pub fn to_grid(&self, filter_expr: &str) -> Result<HGrid, GraphError>

Convert matching entities to a grid.

If filter_expr is empty, exports all entities. Otherwise, delegates to read.

Source

pub fn from_grid( grid: &HGrid, namespace: Option<DefNamespace>, ) -> Result<Self, GraphError>

Build an EntityGraph from a grid.

Rows without a valid id Ref tag are silently skipped.

Source

pub fn changes_since(&self, version: u64) -> Vec<&GraphDiff>

Get changelog entries since a given version.

Source

pub fn version(&self) -> u64

Current graph version (monotonically increasing).

Source

pub fn len(&self) -> usize

Number of entities in the graph.

Source

pub fn is_empty(&self) -> bool

Returns true if the graph has no entities.

Source

pub fn contains(&self, ref_val: &str) -> bool

Returns true if an entity with the given ref value exists.

Source

pub fn all(&self) -> Vec<&HDict>

Returns references to all entities in the graph.

Trait Implementations§

Source§

impl Default for EntityGraph

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.