edgestore 1.0.0

Local-first embedded KV + vector database in Rust
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! EdgeStore — local-first embedded KV + vector database.
//!
//! This crate provides the core synchronous engine. Async wrappers live in
//! `edgestore-tokio`. HTTP transport lives in `edgestore-repl`.
//!
//! # Public API Surface
//!
//! | Type | Item | Description |
//! |------|------|-------------|
//! | Engine | [`Engine`] | Main KV engine (open, get, put, delete, range, prefix, flush, snapshot, compact) |
//! | Config | [`EdgestoreConfig`] | Database configuration |
//! | Error | [`EdgestoreError`] | All error variants |
//! | Transaction | [`Transaction`] | Multi-record atomic batch |
//! | Metrics | [`MetricsSnapshot`] | Point-in-time metrics snapshot |
//! | Vector | [`VectorEngine`] trait, [`VectorRecord`], [`Dtype`], [`Metric`] | Vector storage & search |
//! | Text | [`TextEngine`] trait, [`TextSearchResult`], [`SearchOptions`] | Full-text search |
//! | Snapshot | [`Snapshot`], [`SnapshotRegistry`] | Point-in-time reads |
//! | Replication | [`ReplicationProtocol`], [`HostId`], [`SegmentRef`] | Pull-only sync |
//! | Storage | [`StorageBackend`], [`DefaultStorageBackend`], [`MemoryStorageBackend`] | Pluggable I/O |
//! | Compaction | [`Compactor`], [`CompactionStats`] | Deathtime-cohort compaction |
//! | Merkle | [`RangeMerkleTree`] | Anti-entropy probe |

#![warn(missing_docs)]

/// Deathtime-cohort compaction engine.
pub mod compactor;
/// Database configuration.
pub mod config;
/// Error types.
pub mod error;
/// FDP (Flexible Data Placement) storage backends.
pub mod fdp_backend;
/// Range-level Merkle tree for anti-entropy probes.
pub mod merkle;
/// Engine metrics and snapshots.
pub mod metrics;
/// Remote segment store abstraction.
pub mod remote_store;
/// Pull-only replication protocol.
pub mod replication;
/// Point-in-time snapshot reads.
pub mod snapshot;
/// Pluggable storage backend trait.
pub mod storage_backend;
/// Full-text search index and engine.
pub mod text;
/// Core types (Lsn, SegmentMeta, Compression, etc.).
pub mod types;

/// Main KV engine.
pub mod engine;
/// Segment manifest (internal).
pub mod manifest;
/// In-memory table trait and BTree implementation.
pub mod memtable;
/// WAL replay recovery (internal).
pub mod recovery;
/// Segment format, reader, writer, and store (internal).
pub mod segment;
/// Multi-record transaction batch.
pub mod transaction;
/// Write-ahead log format and I/O (internal).
pub mod wal;
/// Vector storage, distance, and search (internal modules with public re-exports).
pub mod vector;

pub use compactor::{CompactionStats, Compactor};
pub use config::EdgestoreConfig;
pub use engine::{Engine, ImportResult};
pub use error::EdgestoreError;
pub use merkle::RangeMerkleTree;
pub use metrics::MetricsSnapshot;
pub use remote_store::RemoteStore;
pub use replication::{HostId, ReplicationProtocol, SegmentRef};
pub use snapshot::{Snapshot, SnapshotRegistry};
pub use fdp_backend::{FdpStorageBackend, MockFdpBackend};
pub use storage_backend::{DefaultStorageBackend, MemoryStorageBackend, PlacementHint, StorageBackend};
pub use transaction::Transaction;
pub use text::engine::{text_namespace, SearchOptions, TextEngine, TextSearchResult};
pub use text::facet::{filter_by_facets, FacetFilter};
pub use text::index::{bm25_score, score_document, InvertedIndex, Posting};
pub use text::tokenizer::{tokenize, Token};
pub use text::typo::{is_one_edit_away, levenshtein};
pub use text::types::{decode_text_record, FacetValue};
pub use vector::api::{vector_namespace, VectorEngine};
pub use vector::distance::{distance, distance_scalar, Metric, total_cmp_f32};
pub use vector::hnsw::HnswIndex;
pub use vector::search::{vector_search, VectorSearchResult};
pub use vector::types::{Dtype, VectorRecord};