Skip to main content

macrame/
lib.rs

1pub mod connection;
2pub mod error;
3pub mod graph;
4pub mod integrity;
5pub mod metrics;
6pub mod schema;
7pub mod temporal;
8pub mod util;
9pub mod vector;
10
11// `CHUNK_BUDGET` is re-exported at the root because four modules already write
12// `[`crate::CHUNK_BUDGET`]` in their rustdoc — an intra-doc link that resolved
13// to nothing, since the const lives in `connection`. The bound is the crate's
14// one cross-cutting number; the root is where a reader looks for it.
15pub use connection::{
16    Annotation, CadencePolicy, CheckpointReport, ConceptUpsert, Database, Tuning,
17    WalCheckpointPolicy, CHUNK_BUDGET,
18};
19pub use error::{DbError, Overlap, Result};
20
21pub mod prelude {
22    pub use crate::connection::{
23        chunk_rows, estimated_bulk_hold, Annotation, CadencePolicy, CheckpointReport,
24        ConceptUpsert, Database, Tuning, WalCheckpointPolicy, BULK_ATOMIC_WARN_HOLD, CHUNK_BUDGET,
25        MAX_ARCHIVE_SESSIONS,
26    };
27    pub use crate::error::{DbError, Overlap, Result};
28    pub use crate::graph::{
29        AttributeMode, CandidateCount, CostEstimate, CostEstimator, EdgeAssertion,
30        FilteredVectorSearch, TraversalBuilder, VectorFilterStrategy,
31    };
32    pub use crate::integrity::{audit_current, rebuild_current, RebuildReport};
33    pub use crate::metrics::CommandKind;
34    #[cfg(feature = "metrics")]
35    pub use crate::metrics::{KindSnapshot, MetricsSnapshot};
36    pub use crate::temporal::{
37        archive, query_as_of_edges, reconstruct, ArchiveReport, Interval, MaterializedState,
38        SnapshotCadence,
39    };
40    pub use crate::util::{Clock, FakeClock, SystemClock};
41    pub use crate::vector::{
42        declared_dimension, escape_fts5_query, keyword_search, reciprocal_rank_fusion,
43        register_model, registered_models, search_vector, upsert_embedding, EmbeddingCodec,
44        HybridHit, HybridSearch, ModelName, VectorSearchResult, RRF_K,
45    };
46}