Struct StoreContext 

pub struct StoreContext<'a> { /* private fields */ }

The store-backed context for one repo.

Implementations

impl<'a> StoreContext<'a>

pub fn new( conn: &'a Connection, repo_id: &str, semantic: HashMap<String, SemanticVec>, ) -> Self

A context over conn scoped to repo_id, with the query phrases’ vectors for semantic(...) (empty when no provider ran).

pub fn with_now_ms(self, now_ms: i64) -> Self

Resolve the named points of date() (today, now, sow…) at now_ms instead of the wall clock — the Surface’s clock, which OMGBASE_SPEC_CLOCK pins (§1.3, 4.8).

pub fn now_ms(&self) -> i64

The instant date("now") reads in this run.

pub fn statements_run(&self) -> usize

How many statements this context has run (every SELECT, the root scans included). A reach-through to the owner’s identity adds none.

pub fn repo_id(&self) -> &str

The repository this context is scoped to.

pub fn scans_run(&self) -> usize

How many root scans (SELECT … FROM <target> whole) this context has run — at most one per target per run; none for a block whose probes the store indexes answered.

pub fn with_rows_root(self, rows: Vec<Value>) -> Self

Serve rows — target-tagged store rows a plan produced — as the oqx::ROWS_ROOT scan (the residual query’s source). Every other root and every relation, intrinsic and row function still hits the store, so the residual sees exactly what a full scan would.

pub fn with_rows_root_once(self, rows: Vec<Value>) -> Self

Self::with_rows_root for a residual whose ONLY read of oqx::ROWS_ROOT is its source scan (the runner checks the AST: the name appears nowhere else — no ^-reach, no limit/offset, no nested mention): the rows are moved out on that first read instead of deep-copied, and a second read — which cannot happen — would see an empty scan. Same results as Self::with_rows_root, one row copy and one drop fewer.

pub fn take_root_failure(&self) -> Option<OqxError>

The store failure a root scan hit during the run, if any. Every other read fails through the engine’s channel (get / call_method return Err); root has none, so it serves an empty scan and leaves the failure here for the runner to report.

Trait Implementations

impl DataContext for StoreContext<'_>

fn root_object(&self) -> Value

The root scope’s row (oqx 0.18): the repository, so ^$it from a top-level row is the root row and ^$it.docs the docs scan.

fn is_single(&self, value: &Value) -> bool

Row position (spec/oqx §3, 0.20): a lazy root scan is a collection; a store row, a lazy owner, the absent-single marker and any other object are one row.

fn materialize(&self, value: Value) -> Value

A lazy root-scan marker observed as a VALUE is its rows (read once per run); the absent-single marker is absent; everything else is itself. A store row is an object with several columns and the markers have exactly one key, so the common case is one length check.

fn root(&self, name: &str) -> Value

Resolve a named root (the from <name> source / directive receiver). Unknown names are Value::Undefined.

fn get(&self, row: &Value, key: &str) -> Result<Value>

Read a property/relation off a row: a bare identifier (field), a .field segment, or a ^field outer reference all come through here, each against exactly the row of the scope it names. An absent property is Ok(Value::Undefined); the engine never looks elsewhere for it.

fn to_rows(&self, value: &Value) -> Vec<Value>

Coerce a relation/source value into rows.

fn index_for( &self, collection: &Value, path: &[String], ) -> Option<Rc<dyn RowIndex + '_>>

Optional: a pre-built equality index over collection (a value this context served as a root or relation) on the property path path (["customer_id"], ["meta", "id"]; an empty path keys by the row itself). The engine asks before building its own crate::optimize::HashIndex for a correlated equality in a nested block (where id == ^customer_id); None (the default) lets it build one. lookup(value) must return the ascending positions, into to_rows(collection) in order, of the rows whose value at path equals value under OQX equality (SEMANTICS §5). An index may also implement RowIndex::lookup_rows: the engine then probes it for a statically stable receiver BEFORE reading the collection, which is never materialized when the index answers. crate::adapters::indexed::IndexedContext implements the positional form. The Rc lets a context create indexes on demand.

fn identity(&self, row: &Value) -> Value

The identity a row is known by — $key (SEMANTICS §16, since 0.20): what follow cycle detection, the per-step union, follow distinct, distinct over unprojected rows and is compare, and what reading $key on the row returns. The default is the row’s structural value (an entry’s is its key either way, before the context is asked); a store-backed context answers its row id. (The reference spells this identityOf; the Rust name is kept for source compatibility.)

fn call_function(&self, name: &str, args: &[Value]) -> Option<Result<Value>>

Optional custom free function. None = not handled: the engine falls back to the builtin table, then errors if that has no such function.

fn call_method( &self, name: &str, recv: &Value, args: &[Value], ) -> Option<Result<Value>>

Optional custom method (recv.name(args)). None = not handled, as for DataContext::call_function.

fn regex_dialect(&self) -> RegexDialect

The regex dialect matches() compiles against. RegexDialect::Oqx (the default) is the portable baseline the spec tests; RegexDialect::Native hands the pattern to the regex crate as is — implementation-defined, not portable. The engine dispatches matches through DataContext::call_method, so this is read by the context’s own matches (DefaultContext does, via crate::semantics::builtin_method_with); plain crate::semantics::builtin_method is always the baseline.