Crate fdb

FoundationDB Client API for Tokio

Guide level documentation is on our website. You will find API level documentation here.

A minimal example to get started.

use tokio::runtime::Runtime;

use std::env;
use std::error::Error

fn main() -> Result<(), Box<dyn Error>> {
    let fdb_cluster_file = env::var("FDB_CLUSTER_FILE").expect("FDB_CLUSTER_FILE not defined!");

    unsafe {
        fdb::select_api_version(710);
        fdb::start_network();
    }

    let fdb_database = fdb::open_database(fdb_cluster_file)?;

    let rt = Runtime::new()?;

    let cloned_fdb_database = fdb_database.clone();

    rt.block_on(async {
        let fdb_database = cloned_fdb_database;

        // your main async app here

        Result::<(), Box<dyn Error>>::Ok(())
    })?;

    drop(fdb_database);

    unsafe {
        fdb::stop_network();
    }

    Ok(())
}

Modules

• database
  Provides FdbDatabase type for working with FDB Database.
• error
  Provides FdbError type, FdbResult type alias and error constants.
• future
  Provides FdbFuture, FdbStreamKeyValue types and FdbFutureGet trait for working with FDB Future.
• range
  Provides types for working with FDB range.
• subspace
  Provides a convenient way to define namespaces for different categories of data.
• system_data
  Functions and constants documenting the organization of the reserved keyspace in the database beginning with \xFF.
• tenant
  Provides FdbTenant type for working with FDB Tenants.
• transaction
  Provides types and traits for working with FDB Transactions and Snapshots.
• tuple
  Provides a set of utilities for serializing and deserializing typed data for use in FDB.

Structs

• Key
  Key represents a FDB key, a lexicographically-ordered sequence of bytes.
• KeySelector
  KeySelector identifies a particular key in the database.
• KeyValue
  A key/value pair.
• MappedKeyValue
  A mapped key/value pair.
• Mapper
  Mapper represents the behaviour of a mapped range read.
• Tenant
  Tenant is a named key-space within a database.
• Value
  Value represents a value of an FDB Key and is a sequence of bytes.

Enums

• NetworkOption
  A set of options that can be set globally for the FDB API.

Constants

• FDB_API_VERSION
  Maximum API version supported by the client

Functions

• open_database
  Returns FdbDatabase handle to the FDB cluster identified by the provided cluster file.
• select_api_version^⚠
  Select the version of the client API.
• set_network_option^⚠
  Set global options for the FDB API.
• start_network^⚠
  Initializes FDB network.
• stop_network^⚠
  Stops the FDB networking engine.