Crate mz_foundationdb 

Common FoundationDB utilities for Materialize.

This crate provides shared functionality for FoundationDB-backed implementations across Materialize, including network initialization and URL parsing utilities.

Modules

api

Re-export the foundationdb crate for convenience. Configuration of foundationDB API and Network

directory

Re-export the foundationdb crate for convenience. Directory provides a tool for managing related subspaces.

fdb_keys

Re-export the foundationdb crate for convenience. Definitions of FDBKeys, used in api version 700 and more.

future

Re-export the foundationdb crate for convenience. Most functions in the FoundationDB API are asynchronous, meaning that they may return to the caller before actually delivering their Fdbresult.

mapped_key_values

Re-export the foundationdb crate for convenience. Definitions of MappedKeyValues, used in api version 710 and more.

metrics

Re-export the foundationdb crate for convenience.

options

Re-export the foundationdb crate for convenience. Generated configuration types for use with the various set_option functions

timekeeper

Re-export the foundationdb crate for convenience. There is a key range called TimeKeeper in the system key space which stores a rolling history window of time to version mappings, with one data point every 10 seconds. It is not exposed via any user-facing API, though of course the data can be read by a user. It is not an official database feature and should not be relied on for anything where accuracy is critical as nothing prevents or detects system clock skew on the FDB process logging these data points.

tuple

Re-export the foundationdb crate for convenience.

Structs

Database

Re-export the foundationdb crate for convenience. Represents a FoundationDB database

FdbConfig

Configuration parsed from a FoundationDB URL.

FdbError

Re-export the foundationdb crate for convenience. The Standard Error type of FoundationDB

KeySelector

Re-export the foundationdb crate for convenience. A KeySelector identifies a particular key in the database.

MaybeCommitted

Re-export the foundationdb crate for convenience. Wrapper around the boolean representing whether the previous transaction is still on fly This wrapper prevents the boolean to be copy and force it to be moved instead. This pretty handy when you don’t want to see the Database::run closure capturing the environment.

RangeOption

Re-export the foundationdb crate for convenience. RangeOption represents a query parameters for range scan query.

RetryableTransaction

Re-export the foundationdb crate for convenience. A retryable transaction, generated by Database.run

TransactOption

Re-export the foundationdb crate for convenience. A set of options that controls the behavior of Database::transact.

Transaction

Re-export the foundationdb crate for convenience. In FoundationDB, a transaction is a mutable snapshot of a database.

TransactionCancelled

Re-export the foundationdb crate for convenience. A cancelled transaction

TransactionCommitError

Re-export the foundationdb crate for convenience. A failed to commit transaction.

TransactionCommitted

Re-export the foundationdb crate for convenience. A committed transaction.

TransactionMetrics

Re-export the foundationdb crate for convenience. Tracks metrics for a transaction.

Enums

FdbBindingError

Re-export the foundationdb crate for convenience. This error represent all errors that can be throwed by db.run. Layer developers may use the CustomError.

Statics

FDB_NETWORK 🔒

FoundationDB network handle. The first element is Some if the network is initialized. The second element is true if the network has ever been initialized.

Traits

DatabaseTransact

Re-export the foundationdb crate for convenience.

TransactError

Re-export the foundationdb crate for convenience. A trait that must be implemented to use Database::transact this application error types.

Functions

boot^⚠

Re-export the foundationdb crate for convenience. Initialize the FoundationDB Client API, this can only be called once per process.

default_config_path

Re-export the foundationdb crate for convenience. Returns the default Fdb cluster configuration file path

init_network

Initialize the FoundationDB network.

shutdown_network

Shut down the FoundationDB network.

Type Aliases

FdbResult

Re-export the foundationdb crate for convenience. Alias for Result<..., FdbError>