Struct photondb::photon::Table

pub struct Table(_);

A reference to a latch-free, log-structured table that stores sorted key-value entries.

This is the same as raw::Table with the Photon environment.

Implementations

impl Table

pub async fn open<P: AsRef<Path>>(path: P, options: TableOptions) -> Result<Self>

Opens a table in the path with the given options.

This is the same as raw::Table::open with the Photon environment.

pub async fn close(self) -> Result<(), Self>

Closes the table if this is the only reference to it.

This is the same as raw::Table::close with the Photon environment.

Methods from Deref<Target = Table<Photon>>

pub fn pin(&self) -> Guard<'_, E>

Returns a Guard that pins the table for user operations.

pub async fn get(&self, key: &[u8], lsn: u64) -> Result<Option<Vec<u8>>>

Gets the value corresponding to the key.

pub async fn put(&self, key: &[u8], lsn: u64, value: &[u8]) -> Result<()>

Puts a key-value entry to the table.

pub async fn delete(&self, key: &[u8], lsn: u64) -> Result<()>

Deletes the entry corresponding to the key from the table.

pub fn stats(&self) -> TableStats

Returns the statistics of the table.

pub fn safe_lsn(&self) -> u64

Returns the minimal LSN that the table can safely read with.

The table guarantees that entries visible to the returned LSN are retained for reads.

pub fn set_safe_lsn(&self, lsn: u64)

Updates the minimal LSN that the table can safely read with.

The safe LSN must be increasing, so updating it with a smaller value has no effect. When the safe LSN is advanced, the table will gradually drop entries that are not visible to the LSN anymore.

pub async fn flush(&self, opts: &FlushOptions)

Flush all write buffer data.

pub async fn wait_for_reclaiming(&self)

Wait all pending reclaiming to finish.

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Table

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for Table

type Target = Table<Photon>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.