Struct native_db::Database

pub struct Database<'a> { /* private fields */ }

The database instance. Allows you to create rw_transaction and r_transaction, watch queries, and unwatch etc.

Example

use native_db::*;

fn main() -> Result<(), db_type::Error> {
   let models = Models::new();
   // Define models ...
   let db = Builder::new().create_in_memory(&models)?;
   // Open transactions
   // Watch data
   // Create snapshots
   // etc...
   Ok(())
}

Implementations

impl Database<'_>

pub fn rw_transaction(&self) -> Result<RwTransaction<'_>>

Creates a new read-write transaction. This transaction allows you to read and write data.

• Write operations:
  • insert - Insert a item.
  • update - Update a item.
  • remove - Remove a item.
  • migrate - Migrate a model, affect all items.
  • commit - Commit the transaction.
  • abort - Abort the transaction.
• Read operations:
  • get - Get a item.
  • scan - Scan items.
  • len - Get the number of items.

pub fn r_transaction(&self) -> Result<RTransaction<'_>>

Creates a new read-only transaction. This transaction allows you to read data.

• Read operations:
  • get - Get a item.
  • scan - Scan items.
  • len - Get the number of items.

impl Database<'_>

pub fn watch(&self) -> Watch<'_>

Watch queries.

• get - Watch a item.
• scan - Watch items.

pub fn unwatch(&self, id: u64) -> Result<bool>

Unwatch the given id. You can get the id from the return value of watch. If the id is not valid anymore, this function will do nothing and return false. If the id is valid, the corresponding watcher will be removed and return true. If the id is valid but the watcher is already removed, this function will return false.

impl<'a> Database<'a>

pub fn redb_stats(&self) -> Result<Stats>

impl Database<'_>

pub fn snapshot<'a>( &self, models: &'a Models, path: &Path, ) -> Result<Database<'a>>