Struct surrealkv::Store

pub struct Store { /* private fields */ }

An MVCC-based transactional key-value store.

The store is closed asynchronously when it is dropped. If you need to guarantee that the store is closed before the program continues, use the close method.

Implementations

impl Store

pub fn new(opts: Options) -> Result<Self>

Creates a new MVCC key-value store with the given options.

pub fn begin(&self) -> Result<Transaction>

Begins a new read-write transaction. It creates a new transaction with the core and read-write mode, and sets the read timestamp from the oracle. It returns the transaction.

pub fn begin_with_mode(&self, mode: Mode) -> Result<Transaction>

Begins a new transaction with the given mode. It creates a new transaction with the core and the given mode, and sets the read timestamp from the oracle. It returns the transaction.

pub fn view(&self, f: impl FnOnce(&mut Transaction) -> Result<()>) -> Result<()>

Executes a function in a read-only transaction. It begins a new read-only transaction and executes the function with the transaction. It returns the result of the function.

pub async fn write( self: Arc<Self>, f: impl FnOnce(&mut Transaction) -> Result<()>, ) -> Result<()>

Executes a function in a read-write transaction and commits the transaction. It begins a new read-write transaction, executes the function with the transaction, and commits the transaction. It returns the result of the function.

pub async fn close(&self) -> Result<()>

Closes the inner store

pub async fn compact(&self) -> Result<()>

Trait Implementations

impl Default for Store

fn default() -> Store

Returns the “default value” for a type.

impl Drop for Store

fn drop(&mut self)

Executes the destructor for this type.