Struct FulltextIndex 

pub struct FulltextIndex { /* private fields */ }

Incremental inverted index for full-text BM25 search.

Enabled per (label, field) pair via FulltextIndex::enable. Postings store stemmed tokens with per-document position lists for phrase adjacency checking. Doc lengths are tracked separately for BM25 normalization.

BM25 constants

k1 = 1.2, b = 0.75 (Okapi BM25 defaults).

WAL / persistence

The index is NOT stored in the V8 snapshot. It is rebuilt from WAL replay (EnableFulltext / DisableFulltext records + node property re-indexing) at open time via FulltextIndex::rebuild_all. Postings restructuring in v2 has no snapshot format impact.

Implementations

impl FulltextIndex

pub fn new() -> Self

pub fn is_enabled(&self, label: &str, field: &str) -> bool

Whether (label, field) is currently indexed.

pub fn has_label(&self, label: &str) -> bool

Whether any field is enabled for this label.

pub fn field_indexed(&self, field: &str) -> bool

Whether field is indexed for any label.

pub fn field_indexed_by_other(&self, label: &str, field: &str) -> bool

Whether field is indexed by a label OTHER THAN label.

pub fn enabled_pairs(&self) -> impl Iterator<Item = &(String, String)>

Iterate all enabled (label, field) pairs.

pub fn enable(&mut self, label: &str, field: &str) -> bool

Enable full-text indexing for (label, field). Returns true if newly added, false if already present (idempotent for replay safety).

pub fn disable(&mut self, label: &str, field: &str) -> bool

Disable full-text indexing for (label, field). Drops all postings and doc_len entries for that field. Returns true if the pair was present and removed.

pub fn add_tokens(&mut self, node_id: u32, field: &str, value: &Value)

Add stemmed tokens (with positions) for value under (node_id, field). Replaces any existing doc_len entry for this node. Caller is responsible for ensuring (label, field) is enabled.

pub fn remove_node_field(&mut self, node_id: u32, field: &str)

Remove all tokens for node_id in field’s posting list.

pub fn remove_node(&mut self, node_id: u32)

Remove all tokens for node_id across all indexed fields.

pub fn search(&self, field: &str, query: &str, k: usize) -> Vec<(u32, f64)>

Search a field with a v2 query. Returns (node_id, bm25_score) sorted by score descending, ties by node_id ascending. Returns empty if the field is not indexed or the query produces no groups.

BM25 constants: k1 = 1.2, b = 0.75. Scores are summed across matched OR-groups; negated atoms exclude a document; phrase atoms require positional adjacency. If k > 0, only the top-k results are returned.

pub fn rebuild_all( &mut self, ids: &IdMap, labels: &[u32], syms: &Interner, props: ColumnsView<'_>, )

Rebuild the entire index from scratch.

Called once after WAL replay to correct any drift accumulated by incremental add_tokens / remove_node_field calls during per-record apply.

Trait Implementations

impl Clone for FulltextIndex

fn clone(&self) -> FulltextIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FulltextIndex

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

Formats the value using the given formatter.

impl Default for FulltextIndex

fn default() -> FulltextIndex

Returns the “default value” for a type.