Skip to main contentCrate fathomdb
Source - admin_ffi
- JSON-based FFI surface for admin-plane operations that need richer
serde shapes than a flat string list.
- search_ffi
- JSON-based FFI surface for adaptive and fallback text search.
- ActionHandle
- Handle returned when an action is added to a
WriteRequestBuilder. - ActionInsert
- An action to be inserted in a
WriteRequest. - ActionRow
- A single action row returned from a query.
- AdminHandle
- Thread-safe handle to the shared
AdminService. - BootstrapReport
- ChunkHandle
- Handle returned when a chunk is added to a
WriteRequestBuilder. - ChunkInsert
- A text chunk to be inserted in a
WriteRequest. - 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.
- EdgeExpansionRootRows
- Edge-expansion results for a single root node within a grouped query.
- EdgeExpansionSlotRows
- All edge-expansion results for a single named slot across all roots.
- EdgeHandle
- Handle returned when an edge is added to a
WriteRequestBuilder. - EdgeInsert
- An edge to be inserted in a
WriteRequest. - EdgeRetire
- An edge to be retired (soft-deleted) in a
WriteRequest. - EdgeRow
- A single edge row surfaced during edge-projecting traversal.
- Engine
- Top-level handle to a fathomdb graph database.
- EngineOptions
- Configuration for opening an
Engine instance. - EngineRuntime
- Core engine runtime.
- ExecutionCoordinator
- Manages a pool of read-only
SQLite connections and executes compiled queries. - ExecutionHints
- ExpansionRootRows
- Expansion results for a single root node within a grouped query.
- ExpansionSlot
- A named expansion slot that traverses edges per root result.
- ExpansionSlotRows
- All expansion results for a single named slot across all roots.
- FallbackSearchBuilder
- Tethered two-shape fallback search builder returned from
Engine::fallback_search. - FeedbackConfig
- Timing configuration for the feedback system.
- FtsPropertyPathSpec
- A single registered property-FTS path with its extraction mode.
- FtsPropertySchemaRecord
- A registered FTS property projection schema for a node kind.
- GroupedQueryRows
- Result set from executing a grouped compiled query.
- HitAttribution
- Per-hit attribution data produced by the (Phase 5) match attributor.
- LastAccessTouchReport
- Report from a last-access touch operation.
- LastAccessTouchRequest
- Request to update
last_accessed_at timestamps for a batch of nodes. - LogicalPurgeReport
- Report from permanently purging all rows for a logical ID.
- LogicalRestoreReport
- Report from restoring a retired logical ID back to active state.
- Migration
- NodeHandle
- Handle returned when a node is added to a
WriteRequestBuilder. - NodeInsert
- A node to be inserted in a
WriteRequest. - NodeQueryBuilder
- Tethered node query builder.
- NodeRetire
- A node to be retired (soft-deleted) in a
WriteRequest. - NodeRow
- A single node row returned from a query.
- NodeRowLite
- Minimal node-shaped projection attached to every
SearchHit. - OperationalCollectionRecord
- OperationalCompactionReport
- OperationalCurrentRow
- OperationalFilterField
- OperationalHistoryValidationIssue
- OperationalHistoryValidationReport
- OperationalMutationRow
- OperationalPurgeReport
- OperationalReadReport
- OperationalReadRequest
- OperationalRegisterRequest
- OperationalRepairReport
- OperationalRetentionPlanItem
- OperationalRetentionPlanReport
- OperationalRetentionRunItem
- OperationalRetentionRunReport
- OperationalSecondaryIndexField
- OperationalSecondaryIndexRebuildReport
- OperationalTraceReport
- OperationalValidationContract
- OperationalValidationField
- OptionalProjectionTask
- A deferred projection backfill task submitted alongside a write.
- ProjectionRepairReport
- ProvenanceEvent
- A single row from the
provenance_events table. - ProvenancePurgeOptions
- Options controlling provenance event purging behavior.
- ProvenancePurgeReport
- Report from a provenance event purge operation.
- QueryAst
- Abstract syntax tree representing a graph query.
- QueryBuilder
- Fluent builder for constructing a
QueryAst. - QueryEmbedderIdentity
- Identity metadata for a
QueryEmbedder. - QueryPlan
- Execution plan returned by
ExecutionCoordinator::explain_compiled_read. - QueryRows
- Result set from executing a flat (non-grouped) compiled query.
- RebuildProgress
- Public progress snapshot returned from
crate::coordinator::ExecutionCoordinator::get_property_fts_rebuild_progress. - ResponseCycleEvent
- A feedback event emitted during an operation’s lifecycle.
- RunHandle
- Handle returned when a run is added to a
WriteRequestBuilder. - RunInsert
- A run to be inserted in a
WriteRequest. - RunRow
- A single run row returned from a query.
- SafeExportManifest
- Manifest describing a completed safe export.
- SafeExportOptions
- Options controlling how a safe database export is performed.
- SchemaManager
- SchemaVersion
- SearchBuilder
- Tethered unified retrieval builder returned from
NodeQueryBuilder::search. - SearchHit
- A single result row emitted by adaptive text search.
- SearchRows
- Result set returned by an adaptive text-search execution.
- Session
- A lightweight session borrowing an
Engine reference. - ShapeHash
- A deterministic hash of a query’s structural shape, independent of bind values.
- SkippedEdge
- An edge that was skipped during a restore because an endpoint is missing.
- SqliteCacheStatus
- Cumulative
SQLite page-cache counters for a single connection. - StepHandle
- Handle returned when a step is added to a
WriteRequestBuilder. - StepInsert
- A step to be inserted in a
WriteRequest. - StepRow
- A single step row returned from a query.
- TelemetrySnapshot
- Point-in-time snapshot of all telemetry counters.
- TextSearchBuilder
- Tethered text-search builder returned from
NodeQueryBuilder::text_search. - VecInsert
- A vector embedding to attach to an existing chunk.
- VectorRegenerationConfig
- Configuration for regenerating vector embeddings.
- VectorRegenerationReport
- Report from a vector embedding regeneration run.
- VectorSearchBuilder
- Tethered vector-search builder returned from
NodeQueryBuilder::vector_search. - WriteReceipt
- Receipt returned after a successful write transaction.
- WriteRequest
- A batch of graph mutations to be applied atomically in a single
SQLite transaction. - WriteRequestBuilder
- Collects nodes, edges, chunks, runs, steps, actions, and operational writes
into a validated
WriteRequest. - WriterActor
- Single-threaded writer that serializes all mutations through one
SQLite connection.
- 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.
- ChunkPolicy
- Policy for handling existing chunks when upserting a node.
- ChunkRef
- Reference to a chunk by existing ID or by a builder handle.
- ComparisonOp
- Ordered comparison operator for JSON property filters.
- CompileError
- Errors that can occur during query compilation.
- DrivingTable
- EdgeRef
- Reference to an edge by existing logical ID or by a builder handle.
- EmbedderChoice
- Caller-facing selection of the read-time query embedder.
- EmbedderError
- Errors reported by a
QueryEmbedder. - EngineError
- Top-level error type for all engine operations.
- FtsPropertyPathMode
- Extraction mode for a single registered FTS property path.
- NodeRef
- Reference to a node by existing logical ID or by a builder handle.
- OperationalCollectionKind
- OperationalFilterClause
- OperationalFilterFieldType
- OperationalFilterMode
- OperationalFilterValue
- OperationalRetentionActionKind
- OperationalSecondaryIndexDefinition
- OperationalSecondaryIndexValueType
- OperationalValidationFieldType
- OperationalValidationMode
- OperationalWrite
- A mutation to an operational collection submitted as part of a write request.
- Predicate
- A filter predicate applied to candidate nodes.
- ProjectionTarget
- ProvenanceMode
- Controls how missing
source_ref values are handled at write time. - QueryStep
- A single step in the query pipeline.
- ResponseCyclePhase
- Phase of an operation’s lifecycle as reported to an
OperationObserver. - RetrievalModality
- Coarse retrieval-modality classifier for a
SearchHit. - RunRef
- Reference to a run by existing ID or by a builder handle.
- ScalarValue
- A typed scalar value used in query predicates.
- 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. - StepRef
- Reference to a step by existing ID or by a builder handle.
- TelemetryLevel
- Controls how much telemetry the engine collects.
- TextQuery
- A constrained full-text query representation for
FathomDB’s safe search API. - TraverseDirection
- Direction for graph traversal steps and expansion slots.
- OperationObserver
- Observer that receives
ResponseCycleEvents during engine operations. - QueryEmbedder
- A read-time query embedder.
- compile_grouped_query
- Compile a
QueryAst into a CompiledGroupedQuery for grouped execution. - compile_query
- Compile a
QueryAst into a CompiledQuery ready for execution. - compile_query_with_feedback
- Errors
- 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. - new_id
- Generate a new identifier suitable for use as a
row_id, logical_id, or
chunk/run/step/action id. - new_row_id
- Query