View Source erlfdb (erlfdb v0.1.0)

Summary

Functions

Types

-type atomic_mode() :: erlfdb_nif:atomic_mode().
-type atomic_operand() :: erlfdb_nif:atomic_operand().
-type cluster_filename() :: binary().
-type database() :: erlfdb_nif:database().
-type database_option() :: erlfdb_nif:database_option().
-type error() :: erlfdb_nif:error().
-type error_predicate() :: erlfdb_nif:error_predicate().
-type fold_future() :: {fold_info, #fold_st{}, future()}.
-type fold_option() ::
    {reverse, boolean() | integer()} |
    {limit, non_neg_integer()} |
    {target_bytes, non_neg_integer()} |
    {streaming_mode, atom()} |
    {iteration, pos_integer()} |
    {snapshot, boolean()} |
    {mapper, binary()}.
-type future() :: erlfdb_nif:future().
-type key() :: erlfdb_nif:key().
-type key_selector() :: erlfdb_nif:key_selector().
-type mapper() :: tuple().
-type result() :: erlfdb_nif:future_result().
-type snapshot() :: {erlfdb_snapshot, transaction()}.
-type tenant() :: erlfdb_nif:tenant().
-type tenant_name() :: binary().
-type transaction() :: erlfdb_nif:transaction().
-type transaction_option() :: erlfdb_nif:transaction_option().
-type value() :: erlfdb_nif:value().
-type version() :: erlfdb_nif:version().
-type wait_option() :: {timeout, non_neg_integer() | infinity}.

Functions

-spec add(database() | transaction() | snapshot(), key(), atomic_operand()) -> ok.
Link to this function

add_conflict_range(Tx, StartKey, EndKey, Type)

View Source
-spec add_conflict_range(transaction() | snapshot(), key(), key(), read | write) -> ok.
Link to this function

add_read_conflict_key(TxObj, Key)

View Source
-spec add_read_conflict_key(transaction() | snapshot(), key()) -> ok.
Link to this function

add_read_conflict_range(TxObj, StartKey, EndKey)

View Source
-spec add_read_conflict_range(transaction() | snapshot(), key(), key()) -> ok.
Link to this function

add_write_conflict_key(TxObj, Key)

View Source
-spec add_write_conflict_key(transaction() | snapshot(), key()) -> ok.
Link to this function

add_write_conflict_range(TxObj, StartKey, EndKey)

View Source
-spec add_write_conflict_range(transaction() | snapshot(), key(), key()) -> ok.
Link to this function

atomic_op(Db, Key, Param, Op)

View Source
-spec atomic_op(database() | transaction() | snapshot(), key(), atomic_operand(), atomic_mode()) -> ok.
Link to this function

bit_and(DbOrTx, Key, Param)

View Source
-spec bit_and(database() | transaction() | snapshot(), key(), atomic_operand()) -> ok.
Link to this function

bit_or(DbOrTx, Key, Param)

View Source
-spec bit_or(database() | transaction() | snapshot(), key(), atomic_operand()) -> ok.
Link to this function

bit_xor(DbOrTx, Key, Param)

View Source
-spec bit_xor(database() | transaction() | snapshot(), key(), atomic_operand()) -> ok.
Link to this function

block_until_ready(Future)

View Source
-spec block_until_ready(future()) -> ok.
Link to this function

byte_max(DbOrTx, Key, Param)

View Source
-spec byte_max(database() | transaction() | snapshot(), key(), atomic_operand()) -> ok.
Link to this function

byte_min(DbOrTx, Key, Param)

View Source
-spec byte_min(database() | transaction() | snapshot(), key(), atomic_operand()) -> ok.
-spec cancel(fold_future() | future() | transaction()) -> ok.
Link to this function

cancel(FoldInfo, Options)

View Source
-spec cancel(fold_future() | future(), [{flush, boolean()}] | []) -> ok.
-spec clear(database() | transaction() | snapshot(), key()) -> ok.
Link to this function

clear_and_watch(Db, Key)

View Source
-spec clear_and_watch(database(), key()) -> future().
Link to this function

clear_range(Db, StartKey, EndKey)

View Source
-spec clear_range(database() | transaction() | snapshot(), key(), key()) -> ok.
Link to this function

clear_range_startswith(Db, Prefix)

View Source
-spec clear_range_startswith(database() | transaction() | snapshot(), key()) -> ok.
-spec commit(transaction()) -> future().
-spec create_transaction(database()) -> transaction().
Link to this function

error_predicate(Predicate, ErrorCode)

View Source
-spec error_predicate(error_predicate(), error() | integer()) -> boolean().
Link to this function

fold_range(DbOrTx, StartKey, EndKey, Fun, Acc)

View Source
-spec fold_range(database() | transaction(), key(), key(), function(), any()) -> any().
Link to this function

fold_range(Db, StartKey, EndKey, Fun, Acc, Options)

View Source
-spec fold_range(database() | transaction(), key(), key(), function(), any(), [fold_option()]) -> any().
Link to this function

fold_range_future(Tx, StartKey, EndKey, Options)

View Source
-spec fold_range_future(transaction() | snapshot(), key(), key(), [fold_option()]) -> fold_future().
Link to this function

fold_range_wait(Tx, FI, Fun, Acc)

View Source
-spec fold_range_wait(transaction(), fold_future(), function(), any()) -> any().
-spec get(future()) -> any().
-spec get(database() | transaction() | snapshot(), key()) -> future().
Link to this function

get_addresses_for_key(Db, Key)

View Source
-spec get_addresses_for_key(database() | transaction() | snapshot(), key()) -> future() | result().
-spec get_and_watch(database(), key()) -> {result(), future()}.
Link to this function

get_approximate_size(Tx)

View Source
-spec get_approximate_size(transaction() | snapshot()) -> non_neg_integer().
Link to this function

get_committed_version(Tx)

View Source
-spec get_committed_version(transaction() | snapshot()) -> version().
Link to this function

get_conflicting_keys(Tx)

View Source
-spec get_conflicting_keys(transaction()) -> future().
-spec get_error(future()) -> error().
Link to this function

get_error_string(ErrorCode)

View Source
-spec get_error_string(integer()) -> binary().
Link to this function

get_estimated_range_size(Tx, StartKey, EndKey)

View Source
-spec get_estimated_range_size(transaction() | snapshot(), key(), key()) -> future().
-spec get_key(database() | transaction() | snapshot(), key_selector()) -> future().
-spec get_key_ss(transaction(), key_selector()) -> future().
-spec get_last_error() -> error() | undefined.
Link to this function

get_mapped_range(DbOrTx, StartKey, EndKey, Mapper)

View Source
-spec get_mapped_range(database() | transaction(), key(), key(), mapper()) -> future().
Link to this function

get_mapped_range(DbOrTx, StartKey, EndKey, Mapper, Options)

View Source
-spec get_mapped_range(database() | transaction(), key(), key(), mapper(), [fold_option()]) -> future().
-spec get_next_tx_id(transaction() | snapshot()) -> non_neg_integer().
Link to this function

get_range(DbOrTx, StartKey, EndKey)

View Source
-spec get_range(database() | transaction(), key(), key()) -> future().
Link to this function

get_range(Db, StartKey, EndKey, Options)

View Source
-spec get_range(database() | transaction(), key(), key(), [fold_option()]) -> future().
Link to this function

get_range_startswith(DbOrTx, Prefix)

View Source
-spec get_range_startswith(database() | transaction(), key()) -> future().
Link to this function

get_range_startswith(DbOrTx, Prefix, Options)

View Source
-spec get_range_startswith(database() | transaction(), key(), [fold_option()]) -> future().
-spec get_read_version(transaction() | snapshot()) -> future().
-spec get_ss(transaction() | snapshot(), key()) -> future().
-spec get_versionstamp(transaction() | snapshot()) -> future().
-spec get_writes_allowed(transaction() | snapshot()) -> boolean().
-spec has_watches(transaction() | snapshot()) -> boolean().
-spec is_read_only(transaction() | snapshot()) -> boolean().
-spec is_ready(future()) -> boolean().
-spec max(database() | transaction() | snapshot(), key(), atomic_operand()) -> ok.
-spec min(database() | transaction() | snapshot(), key(), atomic_operand()) -> ok.
-spec on_error(transaction() | snapshot(), error() | integer()) -> future().
-spec open() -> database().
-spec open(cluster_filename()) -> database().
Link to this function

open_tenant(Db, TenantName)

View Source
-spec open_tenant(database(), tenant_name()) -> tenant().
-spec reset(transaction()) -> ok.
-spec set(database() | transaction() | snapshot(), key(), value()) -> future().
Link to this function

set_and_watch(Db, Key, Value)

View Source
-spec set_and_watch(database(), key(), value()) -> future().
Link to this function

set_option(DbOrTx, Option)

View Source
-spec set_option(database() | transaction(), database_option() | transaction_option()) -> ok.
Link to this function

set_option(Db, DbOption, Value)

View Source
-spec set_option(database() | transaction(), database_option() | transaction_option(), binary()) -> ok.
Link to this function

set_read_version(Tx, Version)

View Source
-spec set_read_version(transaction() | snapshot(), version()) -> ok.
Link to this function

set_versionstamped_key(DbOrTx, Key, Param)

View Source
-spec set_versionstamped_key(database() | transaction() | snapshot(), key(), atomic_operand()) -> ok.
Link to this function

set_versionstamped_value(DbOrTx, Key, Param)

View Source
-spec set_versionstamped_value(database() | transaction() | snapshot(), key(), atomic_operand()) -> ok.
-spec snapshot(transaction() | snapshot()) -> snapshot().
Link to this function

tenant_create_transaction(Tenant)

View Source
-spec tenant_create_transaction(tenant()) -> transaction().
Link to this function

transactional(Db, UserFun)

View Source
-spec transactional(database() | tenant() | transaction() | snapshot(), function()) -> any().
-spec wait(future() | result()) -> result().
-spec wait(future() | any(), [wait_option()]) -> any().
-spec wait_for_all([future()]) -> list().
Link to this function

wait_for_all(Futures, Options)

View Source
-spec wait_for_all([future()], [wait_option()]) -> list().
-spec wait_for_any([future()]) -> any().
Link to this function

wait_for_any(Futures, Options)

View Source
-spec wait_for_any([future()], [wait_option()]) -> any().
-spec watch(database() | transaction() | snapshot(), key()) -> future().