pub struct SqliteAdapter { /* private fields */ }Expand description
A SQLite database, materialized as an arbor.
Implementations§
Source§impl SqliteAdapter
impl SqliteAdapter
Sourcepub fn open(path: &Path) -> Result<Self, SqliteError>
pub fn open(path: &Path) -> Result<Self, SqliteError>
Open a database file (read-only): the catalog now, each table’s rows on first touch (the connection stays owned by the adapter).
Sourcepub fn open_with_refs(
path: &Path,
refs: &[(String, String)],
) -> Result<Self, SqliteError>
pub fn open_with_refs( path: &Path, refs: &[(String, String)], ) -> Result<Self, SqliteError>
[open], with a declared-references document: each (field, container) pair supplies the edge the schema does not
declare (see quarb_relational::parse_refs).
Sourcepub fn open_filtered(
path: &Path,
table: &str,
where_sql: &str,
) -> Result<Self, SqliteError>
pub fn open_filtered( path: &Path, table: &str, where_sql: &str, ) -> Result<Self, SqliteError>
[open], with one table’s fetch filtered by a WHERE clause
(partial pushdown; the engine re-applies the predicates).
Sourcepub fn open_filtered_with_refs(
path: &Path,
table: &str,
where_sql: &str,
refs: &[(String, String)],
) -> Result<Self, SqliteError>
pub fn open_filtered_with_refs( path: &Path, table: &str, where_sql: &str, refs: &[(String, String)], ) -> Result<Self, SqliteError>
[open_filtered], with a declared-references document.
Sourcepub fn from_bytes(bytes: &[u8]) -> Result<Self, SqliteError>
pub fn from_bytes(bytes: &[u8]) -> Result<Self, SqliteError>
Open a database held entirely in memory — the bytes of a
.db file that never touched a filesystem (the browser’s
uploaded files). Deserializes read-only, then materializes
eagerly, as SqliteAdapter::load does.
Sourcepub fn load(conn: &Connection) -> Result<Self, SqliteError>
pub fn load(conn: &Connection) -> Result<Self, SqliteError>
Materialize every user table of an open connection, eagerly (in-memory databases, tests).
Sourcepub fn load_with_refs(
conn: &Connection,
refs: &[(String, String)],
) -> Result<Self, SqliteError>
pub fn load_with_refs( conn: &Connection, refs: &[(String, String)], ) -> Result<Self, SqliteError>
[load], with a declared-references document.
Sourcepub fn prefetch(&self, table: &str) -> Result<(), String>
pub fn prefetch(&self, table: &str) -> Result<(), String>
A human-readable locator: /table/key for rows.
Surface a filtered fetch’s error now (see
RelationalModel::prefetch): the partial-pushdown caller
falls back to the scan instead of answering empty.
pub fn locator(&self, node: NodeId) -> String
Trait Implementations§
Source§impl AstAdapter for SqliteAdapter
impl AstAdapter for SqliteAdapter
Source§fn children(&self, node: NodeId) -> Vec<NodeId>
fn children(&self, node: NodeId) -> Vec<NodeId>
node, in document order. Read moreSource§fn children_named(&self, node: NodeId, name: &str) -> Vec<NodeId>
fn children_named(&self, node: NodeId, name: &str) -> Vec<NodeId>
node whose edge name is exactly name —
the engine’s fast path for name-matcher child hops. The
default filters children; an adapter
whose containers cannot be enumerated (permission-scoped or
unbounded remote trees) overrides this with a direct,
name-addressed lookup. Must be observationally identical to
the default wherever enumeration works. The adapter owns the
name test: it may deliberately alias — resolve a name to a
node whose edge name differs (git revision syntax landing on
a hash-named commit) — and the engine will not re-filter.
Container-scoped resolution like that stays child-axis only;
per-node spelling aliases belong in
answers_to, which this default
consults.Source§fn name(&self, node: NodeId) -> Option<String>
fn name(&self, node: NodeId) -> Option<String>
node — the label of its incoming tree edge. Read moreSource§fn property(&self, node: NodeId, name: &str) -> Option<Value>
fn property(&self, node: NodeId, name: &str) -> Option<Value>
node — ::prop. None if absent.Source§fn default_value(&self, node: NodeId) -> Option<Value>
fn default_value(&self, node: NodeId) -> Option<Value>
node — bare ::, adapter-specific
(a filesystem adapter returns file content).Source§fn metadata(&self, node: NodeId, key: &str) -> Option<Value>
fn metadata(&self, node: NodeId, key: &str) -> Option<Value>
::::key (a filesystem adapter’s
size, modified, permissions, …). None if absent.Source§fn resolve(
&self,
node: NodeId,
property: &str,
hint: Option<&str>,
) -> Option<NodeId>
fn resolve( &self, node: NodeId, property: &str, hint: Option<&str>, ) -> Option<NodeId>
::property-->hint maps node’s
property (a value that references another node) to its target,
with an optional adapter-specific hint (a relation type such as
an html rel, or a target container such as a table). A JSON
adapter resolves a $ref JSON Pointer; None if unresolvable.Source§fn links(&self, node: NodeId) -> Vec<(String, NodeId)>
fn links(&self, node: NodeId) -> Vec<(String, NodeId)>
node, as (label, target) pairs,
for -> navigation (a filesystem adapter’s symlinks).Source§fn backlinks(&self, node: NodeId) -> Vec<(String, NodeId)>
fn backlinks(&self, node: NodeId) -> Vec<(String, NodeId)>
node, as (label, source) pairs, for
<- navigation. May be expensive (an adapter that does not
precompute edges must search for referrers).Source§fn reverse_resolve(
&self,
node: NodeId,
property: Option<&str>,
hint: Option<&str>,
) -> Option<Vec<NodeId>>
fn reverse_resolve( &self, node: NodeId, property: Option<&str>, hint: Option<&str>, ) -> Option<Vec<NodeId>>
property (or, when None, own reference
property) resolves to node, in document order — the
reverse index behind <--. None keeps the engine’s walk
of the whole arbor; Some is the adapter’s complete answer.Source§fn can_refer_to(&self, source: NodeId, target: NodeId) -> Option<bool>
fn can_refer_to(&self, source: NodeId, target: NodeId) -> Option<bool>
source — a catalog key, a
model ref, a reference property the format defines — can
land in target’s container. A question of the schema, never
of the data; None where nothing is declared at the node.
The default: a node with a reference property of its own can
refer anywhere (an href may point at any element).Source§fn prefetch_links(&self, nodes: &[NodeId], dir: LinkDir)
fn prefetch_links(&self, nodes: &[NodeId], dir: LinkDir)
dir
crosslinks from every node in nodes. An adapter backed by
a store may fetch them in one statement; semantics are
unchanged either way.Source§fn index_referrers(
&self,
scope: &str,
property: &str,
label: Option<&str>,
target: NodeId,
) -> Option<Vec<NodeId>>
fn index_referrers( &self, scope: &str, property: &str, label: Option<&str>, target: NodeId, ) -> Option<Vec<NodeId>>
property resolves (under the
relation label, when given) to target, from the same index;
None when no declaration covers the pair.Source§fn reference_properties(&self, source: NodeId, target: NodeId) -> Vec<String>
fn reference_properties(&self, source: NodeId, target: NodeId) -> Vec<String>
source that can land
in target’s container: a catalog’s key columns into the
target’s table, the fields of a model’s refs, the node’s
own reference property. What t<-- and t<--(SCOPE) read
when the query names no property; empty where none is
declared.Source§fn resolve_needs_label(&self, node: NodeId, property: &str) -> bool
fn resolve_needs_label(&self, node: NodeId, property: &str) -> bool
property of node needs a reference
label, because the property itself declares no target: a
column with no key, or any property of a property graph,
where a value names a node only under a node label. A
label-less ::p--> over such a property is refused with the
remedy, since an empty answer would read as “points nowhere”.Source§fn reverse_label(&self, target: NodeId) -> Option<String>
fn reverse_label(&self, target: NodeId) -> Option<String>
target and
the query writes no label. None (the default): only the
label-less resolution counts. An adapter whose label names a
container (a table, a collection, a node label) returns the
one target stands in, so /authors/1<--(/books/*::author_id)
reads author_id as a key into authors without the query
saying so. The engine derives no label of its own.Source§fn traits(&self, _node: NodeId) -> Vec<String>
fn traits(&self, _node: NodeId) -> Vec<String>
node — its adapter-defined classifications,
used by <trait> navigation filters (e.g. a filesystem
adapter’s <dir>, <code>, <image>).Source§fn properties(&self, _node: NodeId) -> Vec<(String, Value)>
fn properties(&self, _node: NodeId) -> Vec<(String, Value)>
| json, | xml,
| kaiv) merge them with the children, a child winning a
shared name. The default is none: for a reading whose values
are all nodes, the children already say everything.Source§fn walks_for_references(&self) -> bool
fn walks_for_references(&self) -> bool
ref) answers through reverse_resolve
and needs no walk.Source§fn tree_identities(&self) -> Vec<(String, NodeId)>
fn tree_identities(&self) -> Vec<(String, NodeId)>
tree IDENTITY: PATH;) and
automatic for a mount’s own target; the engine reads nothing
inside an identity beyond prefix and separator.Source§fn property_names(&self, node: NodeId) -> Vec<String>
fn property_names(&self, node: NodeId) -> Vec<String>
<--(SCOPE::*). By default its off-tree
properties, its reference property, and its children’s names
(a row’s columns, an object’s keys are properties under the
same names); an adapter whose properties are not children
(an element’s attributes) lists them.Source§fn resolves_references(&self) -> bool
fn resolves_references(&self) -> bool
Source§fn index_lookup(
&self,
_scope: &str,
_property: &str,
_value: &Value,
) -> Option<Vec<NodeId>>
fn index_lookup( &self, _scope: &str, _property: &str, _value: &Value, ) -> Option<Vec<NodeId>>
index SCOPE::prop; — the nodes of the declared scope whose
property holds value, from an index the model keeps; None
when no declaration covers the pair (the walk answers). An
index changes cost, never the answer: the caller still tests
each node it names.Source§fn non_tree_nodes(&self) -> Vec<NodeId>
fn non_tree_nodes(&self) -> Vec<NodeId>
*// reaches them after the tree, in this
order; :::is-non-tree is true on them. The default is
none: every shipped adapter puts every node in the tree.Source§fn child_host(&self, node: NodeId) -> NodeId
fn child_host(&self, node: NodeId) -> NodeId
node
reads. The default is node itself. An adapter whose tree
holds transparent links (a filesystem’s symlink to a
directory) answers the link’s target, so /link/name lands
on the target’s own child — the same node /target/name
reaches. The descendant walk never consults this: it reads
children alone, so a linked subtree is
walked once, under its own parent, and a cycle of links
cannot trap it.Source§fn answers_to(&self, node: NodeId, name: &str) -> bool
fn answers_to(&self, node: NodeId, name: &str) -> bool
node answers to name as a literal spelling
. The default is canonical equality. An adapter
may declare per-node aliases — a social feed spelling a
handle @alice while the stripped alice is the hop name —
and the engine consults this wherever a literal name is
matched, on every axis, so one override keeps /@alice and
//@alice in agreement. :::name stays canonical (locators
and reflection print it; an alias is a way in, never a way
out), and name patterns (~(...), *) test the canonical
name only.Source§fn has_trait(&self, node: NodeId, name: &str) -> bool
fn has_trait(&self, node: NodeId, name: &str) -> bool
node bears name as a trait, as written in a
<...> clause. The default is membership in
traits; an adapter may declare aliases the
way answers_to does for names — a
model file’s alias <chunk> <block>; or
alias <s/^tag://i>; — and the engine consults this
wherever a written trait is matched. Reflection and
serialization print the canonical traits only.Source§fn aliased_metadata(&self, _node: NodeId) -> &'static [&'static str]
fn aliased_metadata(&self, _node: NodeId) -> &'static [&'static str]
:: (ruling
#29), for the given node — per node, because a composite
adapter (a multi-mount, a graft) answers for whichever
document owns it. Only an adapter whose property surface is closed —
fixed by the adapter, never grown by document content — may
declare aliases: a git commit cannot sprout a short field,
where a JSON object can sprout anything. Data always wins:
the engine consults property first and falls through only
when it answers None for that node, so an alias can never
shadow a document. Core metadata (:::) is never aliased —
name, id and index exist on every node, and aliasing
them would change what ::name means wherever a document
happens to lack that field.Source§fn external_ref(
&self,
_node: NodeId,
_property: &str,
_hint: Option<&str>,
) -> Option<ExternalRef>
fn external_ref( &self, _node: NodeId, _property: &str, _hint: Option<&str>, ) -> Option<ExternalRef>
node’s property holds, if any: the
identity of a document outside this arbor and, where the
reference says so, the location within it — both as the
adapter reads them out of its own reference syntax (for html,
the anchor’s absolute URL and its fragment). The engine does
not look inside either string: it asks for the document among
the mounts (the host’s registration, then
document_by_ref), and hands the
location to resolve_fragment on
the document it found. Consulted by ::property--> when
in-document resolution misses; an unmounted document lands
among the run’s unresolved external references for the
host’s acquisition loop. The engine itself never fetches.Source§fn resolve_fragment(&self, _node: NodeId, _fragment: &str) -> Option<NodeId>
fn resolve_fragment(&self, _node: NodeId, _fragment: &str) -> Option<NodeId>
fragment names inside the document node
belongs to — html’s id lookup. The landing rung of a
fragment-carrying external reference, once its document is
mounted.Source§fn ref_property(&self, _node: NodeId) -> Option<String>
fn ref_property(&self, _node: NodeId) -> Option<String>
node’s own reference, for the bare
arrow (//a-->): an html anchor’s href, an iframe’s
src. None for a node that references nothing.Source§fn ref_label(&self, _node: NodeId, _property: &str) -> Option<String>
fn ref_label(&self, _node: NodeId, _property: &str) -> Option<String>
node via
property carries — html’s rel attribute. None falls
back to the property name as the edge label.Source§fn link_property(
&self,
_source: NodeId,
_label: &str,
_target: NodeId,
_name: &str,
) -> Option<Value>
fn link_property( &self, _source: NodeId, _label: &str, _target: NodeId, _name: &str, ) -> Option<Value>
source --label--> target — the
$-::prop read. Adapters whose edges carry data (a property
graph’s relationship properties) override this; None if the
edge is bare or unknown. Where parallel edges share source,
label, and target, the adapter answers for one of them,
consistently.Source§fn document_by_ref(&self, _id: &str) -> Option<NodeId>
fn document_by_ref(&self, _id: &str) -> Option<NodeId>
-->
after the mounted-document table misses. An adapter over a
store of pages answers by URL lookup; the engine performs
no IO either way.Source§fn descendants_named(
&self,
_node: NodeId,
_name: &str,
) -> Option<Vec<(NodeId, usize)>>
fn descendants_named( &self, _node: NodeId, _name: &str, ) -> Option<Vec<(NodeId, usize)>>
node that answer to name, each with
its depth (children are depth 1), in document order — the
fast path behind //name for an adapter whose substrate
indexes names. None keeps the engine’s walk; Some must
be exactly what the walk would find.Source§fn descendants_where(
&self,
_node: NodeId,
_name: &str,
_property: &str,
_value: &Value,
) -> Option<Vec<(NodeId, usize)>>
fn descendants_where( &self, _node: NodeId, _name: &str, _property: &str, _value: &Value, ) -> Option<Vec<(NodeId, usize)>>
node named name whose property
property equals value, each with its depth, in document
order — the fast path behind //name[::property = "value"]
for an adapter that indexes a property (the corpus reading’s
positional index answers //token[::lower = "tom"] from it).
None keeps the engine’s walk and its comparison; Some
must be exactly what the walk would find under the standard
equality, so an adapter answers only the values it can
compare as the engine does (text against text).Source§fn quantifier_bound(&self) -> usize
fn quantifier_bound(&self) -> usize
+, *, {m,}) expand, and the ceiling of any
explicit {m,n} (the effective upper bound is min(n, N_max)).
An adapter whose natural structures run deep may raise it; the
CLI overrides it per run (qua --quantifier-bound).Source§fn allow_shell(&self) -> bool
fn allow_shell(&self) -> bool
sh(...) pipeline stage may run external
commands. False by default — query text stays inert data —
and enabled per run by the CLI (qua --allow-shell) through
the AllowShell wrapper.Source§fn invocation_instant(&self) -> Option<(i64, u32)>
fn invocation_instant(&self) -> Option<(i64, u32)>
now() denotes (spec: The Temporal
Fragment, Determinism): one UTC timeline point bound by the
runner BEFORE evaluation begins — evaluation itself never
reads a clock. None by default (a library run is fully
deterministic; now() reads as null); the CLI binds it at
startup — pinnable with qua --now — through the
WithNow wrapper.Source§fn provenance(&self, _node: NodeId) -> Provenance
fn provenance(&self, _node: NodeId) -> Provenance
node — the :::source /
:::instant / :::dpid / :::provenance core-metadata
keys. Empty by default: an adapter answers only the
components its substrate genuinely records (never the
invocation clock); wrapper adapters fill missing components
from what they know — the mount its target, a graft its
outer leaf, a model its derivation — and forward the rest
inward, so resolution is nearest-ancestor per component.Source§fn has_node(&self, node: NodeId) -> bool
fn has_node(&self, node: NodeId) -> bool
node is an id this adapter minted — the guard
behind the node-id anchor ((!N)), which may name an id
from an earlier run (ids are minted deterministically: the
same source, the same ids). The default probes the id
through parent and name and treats a panic as absence,
so an adapter that indexes by id needs no override; one that
can answer cheaply should.Source§fn provenance_list(&self, node: NodeId) -> ProvenanceList
fn provenance_list(&self, node: NodeId) -> ProvenanceList
node as a list — every source the
substrate records for the datum, and how many it elides.
The default is the singular answer as a one-entry list; an
adapter whose substrate records several (kaiv’s ?a;b;+N)
overrides it, and a wrapper layers each entry.Source§fn unit_scale(&self, expr: &str) -> Option<(f64, String)>
fn unit_scale(&self, expr: &str) -> Option<(f64, String)>
[::range < '50kellicam'] resolves through the
document’s .!units imports.