alopex-core 0.5.0

Core storage engine for Alopex DB - LSM-tree, columnar storage, and vector index
Documentation 
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

//! The core crate for AlopexDB, providing low-level storage primitives.

#![deny(missing_docs)]

#[cfg(feature = "async")]
pub mod async_runtime;
pub mod async_util;
pub mod columnar;
pub mod compaction;
pub mod error;
pub mod kv;
pub mod log;
pub mod lsm;
pub mod obs;
pub mod storage;
pub mod txn;
pub mod types;
pub mod vector;

pub use async_util::{BoxFuture, BoxStream, MaybeSend};
pub use columnar::encoding::{
    decode_column, encode_column, Column, Compression, Encoding, LogicalType,
};
pub use columnar::segment::{write_segment, ChunkIter, SegmentMeta, SegmentReader};
#[cfg(feature = "tokio")]
pub use columnar::AsyncColumnarReaderAdapter;
#[cfg(feature = "async")]
pub use columnar::{AsyncColumnarReader, ColumnId, RowBatch, Segment, SegmentId};
pub use error::{Error, Result};
pub use kv::memory::{MemoryKV, MemoryStats, MemoryTransaction, MemoryTxnManager};
pub use kv::storage::{StorageFactory, StorageMode};
#[cfg(feature = "async")]
pub use kv::{AsyncKVStore, AsyncKVTransaction};
#[cfg(feature = "tokio")]
pub use kv::{AsyncKVStoreAdapter, AsyncKVTransactionAdapter};
pub use kv::{KVStore, KVTransaction};
#[cfg(feature = "s3")]
pub use kv::{S3Config, S3KV};
pub use storage::large_value::{
    LargeValueChunkInfo, LargeValueKind, LargeValueMeta, LargeValueReader, LargeValueWriter,
    DEFAULT_CHUNK_SIZE,
};
pub use txn::TxnManager;
pub use types::{Key, TxnId, TxnMode, Value};
pub use vector::columnar::{
    AppendResult, EncodedColumn, SearchStats, VectorSearchParams, VectorSearchResult,
    VectorSegment, VectorStoreConfig, VectorStoreManager,
};
pub use vector::flat::{search_flat, ScoredItem};
pub use vector::hnsw::{HnswConfig, HnswIndex, HnswSearchResult, HnswStats};
pub use vector::simd::{select_kernel, DistanceKernel, ScalarKernel};
#[cfg(feature = "tokio")]
pub use vector::AsyncVectorStoreAdapter;
pub use vector::{score, validate_dimensions, Metric, VectorType};
#[cfg(feature = "async")]
pub use vector::{AsyncHnswIndex, AsyncVectorStore};