Re-exports§
pub use cached_object_store::stats as cached_object_store_stats;pub use compactor::CompactorBuilder;pub use config::Settings;pub use config::SstBlockSize;pub use db_cache::stats as db_cache_stats;pub use filter::BloomFilter;pub use filter_policy::BloomFilterPolicy;pub use filter_policy::Filter;pub use filter_policy::FilterBuilder;pub use filter_policy::FilterContext;pub use filter_policy::FilterPolicy;pub use filter_policy::FilterQuery;pub use manifest::VersionedManifest;pub use prefix_extractor::PrefixExtractor;pub use prefix_extractor::PrefixTarget;pub use bytes;pub use fail_parallel;pub use object_store;
Modules§
- admin
- cached_
object_ store - clock
- This module contains utility methods and structs for handling time.
- compactor
- Compactor Orchestration and Naming Overview
- config
- Configuration options for SlateDB.
- db_
cache - DB Cache
- db_
stats - filter
- filter_
policy - garbage_
collector_ stats - instrumented_
object_ store_ stats - manifest
- prefix_
extractor - seq_
tracker - size_
tiered_ compaction
Structs§
- Block
Stats - Per-block statistics.
- Checkpoint
- Checkpoint
Create Result - Db
- DbBuilder
- A builder for creating a new Db instance.
- DbIterator
- DbRand
- A shareable, lock-free random number generator (RNG).
- DbReader
- Read-only interface for accessing a database from either the latest persistent state or from an arbitrary checkpoint.
- DbReader
Builder - Builder for creating new DbReader instances.
- DbRecency
Iterator - See
crate::Db::scan_prefix_by_recencyfor the full contract. - DbSnapshot
- DbStatus
- Current status of the database, exposed via
crate::Db::subscribe. - DbTransaction
- A database transaction that provides atomic read-write operations with configurable isolation levels. This is the main interface for transactional operations in SlateDB.
- Error
- Represents a public error that can be returned to the user.
- Garbage
Collector Builder - Builder for creating new GarbageCollector instances.
- KeyValue
- Represents a key-value pair known not to be a tombstone.
- RowEntry
- Represents a key-value pair that may be a tombstone.
- SstFile
- A single compacted SST file with accessors for metadata, stats, and index.
- SstFile
Metadata - Represents the metadata of an SST file in the compacted directory.
- SstReader
- Opens compacted SST files for read-only inspection.
- SstStats
- Per-SST statistics collected during SST building.
- Versioned
Compactions - A compactions snapshot paired with its version ID for monotonic ordering.
- WalFile
- Represents a single WAL file stored in object storage and provides methods to inspect and read its contents.
- WalFile
Iterator - Iterator over entries in a WAL file.
- WalFile
Metadata - WalReader
- Reads WAL files in object storage for a specific database.
- Write
Batch - A batch of write operations (puts and/or deletes). All operations in the batch are applied atomically to the database. If multiple operations appear for a a single key, the last operation will be applied. The others will be dropped.
- Write
Handle - Handle returned from write operations, containing metadata about the write. This structure is designed to be extensible for future enhancements.
Enums§
- Cache
Target - Cache content that
DbCacheManagerOps::warm_sstshould populate. - Close
Reason - Represents the reason that a database instance has been closed.
- Error
Kind - Represents the kind of public errors that can be returned to the user.
- Isolation
Level - Isolation level for database transactions.
- Iteration
Order - Merge
Operator Error - Value
Deletable - Represents a value for a key.
Traits§
- Block
Transformer - Trait for transforming block data before storage and after retrieval.
- DbCache
Manager Ops - Trait for block-cache warming and eviction operations.
- DbMetadata
Ops - Trait for database metadata operations.
- DbRead
Ops - Trait for read-only database operations.
- DbTransaction
Ops - Trait for transactional database operations.
- DbWrite
Ops - Trait for write-side database operations.
- Merge
Operator - A trait for implementing custom merge operations in SlateDB.