Struct TurboPersistence

pub struct TurboPersistence<S: ParallelScheduler> { /* private fields */ }

TurboPersistence is a persistent key-value store. It is limited to a single writer at a time using a single write batch. It allows for concurrent reads.

Implementations

impl<S: ParallelScheduler + Default> TurboPersistence<S>

pub fn open(path: PathBuf) -> Result<Self>

Open a TurboPersistence database at the given path. This will read the directory and might performance cleanup when the database was not closed properly. Cleanup only requires to read a few bytes from a few files and to delete files, so it’s fast.

pub fn open_read_only(path: PathBuf) -> Result<Self>

Open a TurboPersistence database at the given path in read only mode. This will read the directory. No Cleanup is performed.

impl<S: ParallelScheduler> TurboPersistence<S>

pub fn open_with_parallel_scheduler( path: PathBuf, parallel_scheduler: S, ) -> Result<Self>

Open a TurboPersistence database at the given path. This will read the directory and might performance cleanup when the database was not closed properly. Cleanup only requires to read a few bytes from a few files and to delete files, so it’s fast.

pub fn open_read_only_with_parallel_scheduler( path: PathBuf, parallel_scheduler: S, ) -> Result<Self>

Open a TurboPersistence database at the given path in read only mode. This will read the directory. No Cleanup is performed.

pub fn is_empty(&self) -> bool

Returns true if the database is empty.

pub fn write_batch<K: StoreKey + Send + Sync + 'static, const FAMILIES: usize>( &self, ) -> Result<WriteBatch<K, S, FAMILIES>>

Starts a new WriteBatch for the database. Only a single write operation is allowed at a time. The WriteBatch need to be committed with TurboPersistence::commit_write_batch. Note that the WriteBatch might start writing data to disk while it’s filled up with data. This data will only become visible after the WriteBatch is committed.

pub fn commit_write_batch<K: StoreKey + Send + Sync + 'static, const FAMILIES: usize>( &self, write_batch: WriteBatch<K, S, FAMILIES>, ) -> Result<()>

Commits a WriteBatch to the database. This will finish writing the data to disk and make it visible to readers.

pub fn full_compact(&self) -> Result<()>

Runs a full compaction on the database. This will rewrite all SST files, removing all duplicate keys and separating all key ranges into unique files.

pub fn compact(&self, compact_config: &CompactConfig) -> Result<bool>

Runs a (partial) compaction. Compaction will only be performed if the coverage of the SST files is above the given threshold. The coverage is the average number of SST files that need to be read to find a key. It also limits the maximum number of SST files that are merged at once, which is the main factor for the runtime of the compaction.

pub fn get<K: QueryKey>( &self, family: usize, key: &K, ) -> Result<Option<ArcSlice<u8>>>

Get a value from the database. Returns None if the key is not found. The returned value might hold onto a block of the database and it should not be hold long-term.

pub fn meta_info(&self) -> Result<Vec<MetaFileInfo>>

pub fn shutdown(&self) -> Result<()>

Shuts down the database. This will print statistics if the print_stats feature is enabled.