Crate fathomdb_query

Structs§

CompiledGroupedQuery: A compiled grouped query containing a root query and expansion slots.
CompiledQuery: A fully compiled query ready for execution against SQLite.
CompiledRetrievalPlan: A compiled unified retrieval plan for the Phase 12 search() entry point.
CompiledSearch: A compiled adaptive-search plan ready for the coordinator to execute.
CompiledSearchPlan: A two-branch compiled search plan ready for the coordinator to execute.
CompiledVectorSearch: A compiled vector-only search plan ready for the coordinator to execute.
ExecutionHints
ExpansionSlot: A named expansion slot that traverses edges per root result.
HitAttribution: Per-hit attribution data produced by the (Phase 5) match attributor.
NodeRowLite: Minimal node-shaped projection attached to every SearchHit.
QueryAst: Abstract syntax tree representing a graph query.
QueryBuilder: Fluent builder for constructing a QueryAst.
SearchHit: A single result row emitted by adaptive text search.
SearchRows: Result set returned by an adaptive text-search execution.
ShapeHash: A deterministic hash of a query’s structural shape, independent of bind values.

BindValue: A typed bind value for a compiled SQL query parameter.
BuilderValidationError: Errors raised by tethered search builders when a caller opts into a fused filter variant whose preconditions are not satisfied.
ComparisonOp: Ordered comparison operator for JSON property filters.
CompileError: Errors that can occur during query compilation.
DrivingTable
Predicate: A filter predicate applied to candidate nodes.
QueryStep: A single step in the query pipeline.
RetrievalModality: Coarse retrieval-modality classifier for a SearchHit.
ScalarValue: A typed scalar value used in query predicates.
SearchBranch: Which branch of the adaptive text-search policy produced a given result set or was used to construct a given CompiledSearch.
SearchHitSource: Source of a SearchHit within the FTS surface.
SearchMatchMode: Whether a SearchHit was produced by the strict user query or by a relaxed (Phase 2+) fallback branch.
TextQuery: A constrained full-text query representation for FathomDB’s safe search API.
TraverseDirection: Direction for graph traversal steps and expansion slots.

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 pins K = 1, collapsing the rule to “run relaxed iff strict was empty,” but the coordinator still computes the min(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.”

compile_grouped_query: Compile a QueryAst into a CompiledGroupedQuery for grouped execution.
compile_query: Compile a QueryAst into a CompiledQuery ready for execution.
compile_retrieval_plan: Compile a QueryAst containing a QueryStep::Search into a CompiledRetrievalPlan describing the bounded set of retrieval branches the Phase 12 planner may run.
compile_search: Compile a QueryAst into a CompiledSearch describing an adaptive text-search execution.
compile_search_plan_from_queries: Compile a caller-provided strict/relaxed TextQuery pair into a CompiledSearchPlan against a QueryAst that supplies the kind root, filters, and limit.
compile_vector_search: Compile a QueryAst into a CompiledVectorSearch describing 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 WHERE clause.
partition_search_filters: Partition Filter predicates following a search step into fusable and residual sets, preserving source order within each set.
render_text_query_fts5: Render a TextQuery as an FTS5-safe MATCH expression.