fathomdb_engine/
lib.rs

1#[macro_use]
2mod trace_support;
3
4mod admin;
5mod coordinator;
6mod database_lock;
7mod embedder;
8mod ids;
9mod operational;
10mod projection;
11pub mod rebuild_actor;
12mod runtime;
13mod sqlite;
14mod telemetry;
15mod writer;
16
17pub use admin::{
18    AdminHandle, AdminService, FtsPropertyPathMode, FtsPropertyPathSpec, FtsPropertySchemaRecord,
19    IntegrityReport, LogicalPurgeReport, LogicalRestoreReport, ProvenancePurgeOptions,
20    ProvenancePurgeReport, SafeExportManifest, SafeExportOptions, SemanticReport, SkippedEdge,
21    TraceReport, VectorRegenerationConfig, VectorRegenerationReport,
22    load_vector_regeneration_config,
23};
24pub use coordinator::{
25    ActionRow, ExecutionCoordinator, ExpansionRootRows, ExpansionSlotRows, GroupedQueryRows,
26    NodeRow, ProvenanceEvent, QueryPlan, QueryRows, RunRow, StepRow,
27};
28#[cfg(feature = "default-embedder")]
29pub use embedder::BuiltinBgeSmallEmbedder;
30pub use embedder::{EmbedderError, QueryEmbedder, QueryEmbedderIdentity};
31pub use ids::{new_id, new_row_id};
32pub use operational::{
33    OperationalCollectionKind, OperationalCollectionRecord, OperationalCompactionReport,
34    OperationalCurrentRow, OperationalFilterClause, OperationalFilterField,
35    OperationalFilterFieldType, OperationalFilterMode, OperationalFilterValue,
36    OperationalHistoryValidationIssue, OperationalHistoryValidationReport, OperationalMutationRow,
37    OperationalPurgeReport, OperationalReadReport, OperationalReadRequest,
38    OperationalRegisterRequest, OperationalRepairReport, OperationalRetentionActionKind,
39    OperationalRetentionPlanItem, OperationalRetentionPlanReport, OperationalRetentionRunItem,
40    OperationalRetentionRunReport, OperationalSecondaryIndexDefinition,
41    OperationalSecondaryIndexField, OperationalSecondaryIndexRebuildReport,
42    OperationalSecondaryIndexValueType, OperationalTraceReport, OperationalValidationContract,
43    OperationalValidationField, OperationalValidationFieldType, OperationalValidationMode,
44};
45pub use projection::{ProjectionRepairReport, ProjectionService, ProjectionTarget};
46pub use rebuild_actor::{RebuildMode, RebuildProgress, RebuildStateRow};
47pub use runtime::EngineRuntime;
48pub use sqlite::{SharedSqlitePolicy, shared_sqlite_policy};
49pub use telemetry::{
50    SqliteCacheStatus, TelemetryCounters, TelemetryLevel, TelemetrySnapshot, read_db_cache_status,
51};
52pub use writer::{
53    ActionInsert, ChunkInsert, ChunkPolicy, EdgeInsert, EdgeRetire, LastAccessTouchReport,
54    LastAccessTouchRequest, NodeInsert, NodeRetire, OperationalWrite, OptionalProjectionTask,
55    ProvenanceMode, RunInsert, StepInsert, VecInsert, WriteReceipt, WriteRequest, WriterActor,
56};
57
58use thiserror::Error;
59
60/// Top-level error type for all engine operations.
61#[derive(Debug, Error)]
62pub enum EngineError {
63    #[error("sqlite error: {0}")]
64    Sqlite(#[from] rusqlite::Error),
65    #[error("schema error: {0}")]
66    Schema(#[from] fathomdb_schema::SchemaError),
67    #[error("io error: {0}")]
68    Io(#[from] std::io::Error),
69    #[error("writer actor rejected request: {0}")]
70    WriterRejected(String),
71    #[error("write timed out (may still commit): {0}")]
72    WriterTimedOut(String),
73    #[error("invalid write request: {0}")]
74    InvalidWrite(String),
75    #[error("bridge error: {0}")]
76    Bridge(String),
77    #[error("capability missing: {0}")]
78    CapabilityMissing(String),
79    #[error("database locked: {0}")]
80    DatabaseLocked(String),
81    #[error("invalid configuration: {0}")]
82    InvalidConfig(String),
83    #[error(
84        "embedder not configured: call Engine::open with a non-None EmbedderChoice to regenerate vector embeddings"
85    )]
86    EmbedderNotConfigured,
87}
fathomdb_engine/lib.rs

fathomdb_engine/
lib.rs
