Structs§
- Compiled
Grouped Query - A compiled grouped query containing a root query and expansion slots.
- Compiled
Query - A fully compiled query ready for execution against
SQLite. - Compiled
Retrieval Plan - A compiled unified retrieval plan for the Phase 12
search()entry point. - Compiled
Search - A compiled adaptive-search plan ready for the coordinator to execute.
- Compiled
Search Plan - A two-branch compiled search plan ready for the coordinator to execute.
- Compiled
Vector Search - A compiled vector-only search plan ready for the coordinator to execute.
- Execution
Hints - Expansion
Slot - A named expansion slot that traverses edges per root result.
- HitAttribution
- Per-hit attribution data produced by the (Phase 5) match attributor.
- Node
RowLite - Minimal node-shaped projection attached to every
SearchHit. - Query
Ast - Abstract syntax tree representing a graph query.
- Query
Builder - Fluent builder for constructing a
QueryAst. - Search
Hit - A single result row emitted by adaptive text search.
- Search
Rows - Result set returned by an adaptive text-search execution.
- Shape
Hash - A deterministic hash of a query’s structural shape, independent of bind values.
Enums§
- Bind
Value - A typed bind value for a compiled SQL query parameter.
- Comparison
Op - Ordered comparison operator for JSON property filters.
- Compile
Error - Errors that can occur during query compilation.
- Driving
Table - Predicate
- A filter predicate applied to candidate nodes.
- Query
Step - A single step in the query pipeline.
- Retrieval
Modality - Coarse retrieval-modality classifier for a
SearchHit. - Scalar
Value - A typed scalar value used in query predicates.
- Search
Branch - Which branch of the adaptive text-search policy produced a given result
set or was used to construct a given
CompiledSearch. - Search
HitSource - Source of a
SearchHitwithin the FTS surface. - Search
Match Mode - Whether a
SearchHitwas produced by the strict user query or by a relaxed (Phase 2+) fallback branch. - Text
Query - A constrained full-text query representation for
FathomDB’s safe search API. - Traverse
Direction - Direction for graph traversal steps and expansion slots.
Constants§
- FALLBACK_
TRIGGER_ K - Fallback trigger threshold. The relaxed branch runs when the strict branch
returned fewer than
min(FALLBACK_TRIGGER_K, limit)hits. Phase 3 pinsK = 1, collapsing the rule to “run relaxed iff strict was empty,” but the coordinator still computes themin(K, limit)form explicitly so a future policy change is a single constant bump. - RELAXED_
BRANCH_ CAP - Maximum number of alternatives the relaxed OR-branch may hold before it is truncated. Phase 3 caps at 4; truncation marks the plan “degraded.”
Functions§
- compile_
grouped_ query - Compile a
QueryAstinto aCompiledGroupedQueryfor grouped execution. - compile_
query - Compile a
QueryAstinto aCompiledQueryready for execution. - compile_
retrieval_ plan - Compile a
QueryAstcontaining aQueryStep::Searchinto aCompiledRetrievalPlandescribing the bounded set of retrieval branches the Phase 12 planner may run. - compile_
search - Compile a
QueryAstinto aCompiledSearchdescribing an adaptive text-search execution. - compile_
search_ plan_ from_ queries - Compile a caller-provided strict/relaxed
TextQuerypair into aCompiledSearchPlanagainst aQueryAstthat supplies the kind root, filters, and limit. - compile_
vector_ search - Compile a
QueryAstinto aCompiledVectorSearchdescribing a vector-only retrieval execution. - derive_
relaxed - Derive the relaxed-branch query for a strict
TextQuery. - is_
fusable - Whether a predicate can be fused into a search CTE’s
WHEREclause. - partition_
search_ filters - Partition
Filterpredicates following a search step into fusable and residual sets, preserving source order within each set. - render_
text_ query_ fts5 - Render a
TextQueryas an FTS5-safeMATCHexpression.