View Source erlfdb_nif (erlfdb v0.3.1)

-type atomic_mode() ::
          add | bit_and | bit_or | bit_xor | append_if_fits | max | min | byte_min | byte_max |
          set_versionstamped_key | set_versionstamped_value.

atomic_operand()

-type atomic_operand() :: integer() | binary().

conflict_type()

-type conflict_type() :: read | write.

database()

-type database() :: {erlfdb_database, reference()}.

database_option()

-type database_option() :: location_cache_size | max_watches | machine_id | datacenter_id.

error()

-type error() :: {erlfdb_error, Code :: integer()}.

error_predicate()

-type error_predicate() :: retryable | maybe_committed | retryable_not_committed.

future()

-type future() :: {erlfdb_future, reference(), reference()}.

future_result()

-type future_result() ::
          database() |
          integer() |
          value() |
          {[{key(), value()}], integer(), boolean()} |
          not_found | [] |
          [{key(), value()}] |
          [{{key(), value()}, {key(), key()}, [{key(), value()}]}] |
          ok.

key()

-type key() :: binary().

key_selector()

-type key_selector() ::
          {Key :: binary(), lt | lteq | gt | gteq} |
          {Key :: binary(), OrEqual :: boolean(), Offset :: integer()}.

option_value()

-type option_value() :: integer() | binary().

streaming_mode()

-type streaming_mode() ::
          stream_want_all | stream_iterator | stream_exact | stream_small | stream_medium |
          stream_large | stream_serial.

tenant()

-type tenant() :: {erlfdb_tenant, reference()}.

transaction()

-type transaction() :: {erlfdb_transaction, reference()}.

transaction_option()

-type transaction_option() ::
          causal_write_risky | causal_read_risky | causal_read_disable |
          next_write_no_write_conflict_range | read_your_writes_disable | read_ahead_disable |
          durability_datacenter | durability_risky | durability_dev_null_is_web_scale |
          priority_system_immediate | priority_batch | initialize_new_database | access_system_keys |
          read_system_keys | debug_retry_logging | transaction_logging_enable | timeout | retry_limit |
          max_retry_delay | snapshot_ryw_enable | snapshot_ryw_disable | lock_aware |
          used_during_commit_protection_disable | read_lock_aware | size_limit | allow_writes |
          disallow_writes.

value()

-type value() :: binary().

version()

-type version() :: integer().

Functions

create_database(ClusterFilePath)

-spec create_database(ClusterFilePath :: binary()) -> database().

database_create_transaction/1

-spec database_create_transaction(database()) -> transaction().

database_open_tenant/2

-spec database_open_tenant(database(), TenantName :: binary()) -> tenant().

database_set_option(Database, Option)

-spec database_set_option(database(), Option :: database_option()) -> ok.

database_set_option/3

-spec database_set_option(database(), Option :: database_option(), Value :: option_value()) -> ok.

error_predicate(Predicate, Error)

-spec error_predicate(Predicate :: error_predicate(), Error :: integer()) -> boolean().

future_cancel/1

-spec future_cancel(future()) -> ok.

future_get/1

-spec future_get(future()) -> future_result().

future_get_error/1

-spec future_get_error(future()) -> error().

future_is_ready/1

-spec future_is_ready(future()) -> boolean().

future_silence/1

-spec future_silence(future()) -> ok.

get_error(Error)

-spec get_error(integer()) -> binary().

get_max_api_version()

-spec get_max_api_version() -> {ok, integer()}.

ohai()

tenant_create_transaction/1

-spec tenant_create_transaction(tenant()) -> transaction().

transaction_add_conflict_range/4

-spec transaction_add_conflict_range(transaction(),
                                     StartKey :: binary(),
                                     EndKey :: binary(),
                                     ConflictType :: conflict_type()) ->
                                        ok.

transaction_atomic_op/4

-spec transaction_atomic_op(transaction(),
                            Key :: binary(),
                            Operand :: atomic_operand(),
                            Mode :: atomic_mode()) ->
                               ok.

transaction_cancel/1

-spec transaction_cancel(transaction()) -> ok.

transaction_clear/2

-spec transaction_clear(transaction(), Key :: binary()) -> ok.

transaction_clear_range/3

-spec transaction_clear_range(transaction(), StartKey :: binary(), EndKey :: binary()) -> ok.

transaction_commit/1

-spec transaction_commit(transaction()) -> future().

transaction_get/3

-spec transaction_get(transaction(), Key :: binary(), Snapshot :: boolean()) -> future().

transaction_get_addresses_for_key/2

-spec transaction_get_addresses_for_key(transaction(), Key :: binary()) -> future().

transaction_get_approximate_size/1

-spec transaction_get_approximate_size(transaction()) -> non_neg_integer().

transaction_get_committed_version/1

-spec transaction_get_committed_version(transaction()) -> integer().

transaction_get_estimated_range_size/3

-spec transaction_get_estimated_range_size(transaction(), StartKey :: binary(), EndKey :: binary()) ->
                                              future().

transaction_get_key/3

-spec transaction_get_key(transaction(), KeySelector :: key_selector(), Snapshot :: boolean()) ->
                             future().

transaction_get_mapped_range/10

-spec transaction_get_mapped_range(transaction(),
                                   StartKeySelector :: key_selector(),
                                   EndKeySelector :: key_selector(),
                                   Mapper :: binary(),
                                   Limit :: non_neg_integer(),
                                   TargetBytes :: non_neg_integer(),
                                   StreamingMode :: streaming_mode(),
                                   Iteration :: non_neg_integer(),
                                   Snapshot :: boolean(),
                                   Reverse :: integer()) ->
                                      future().

transaction_get_next_tx_id/1

-spec transaction_get_next_tx_id(transaction()) -> non_neg_integer().

transaction_get_range/9

-spec transaction_get_range(transaction(),
                            StartKeySelector :: key_selector(),
                            EndKeySelector :: key_selector(),
                            Limit :: non_neg_integer(),
                            TargetBytes :: non_neg_integer(),
                            StreamingMode :: streaming_mode(),
                            Iteration :: non_neg_integer(),
                            Snapshot :: boolean(),
                            Reverse :: integer()) ->
                               future().

transaction_get_range_split_points/4

-spec transaction_get_range_split_points(transaction(),
                                         StartKey :: binary(),
                                         EndKey :: binary(),
                                         ChunkSize :: non_neg_integer()) ->
                                            future().

transaction_get_read_version/1

-spec transaction_get_read_version(transaction()) -> future().

transaction_get_versionstamp/1

-spec transaction_get_versionstamp(transaction()) -> future().

transaction_get_writes_allowed/1

-spec transaction_get_writes_allowed(transaction()) -> true | false.

transaction_has_watches/1

-spec transaction_has_watches(transaction()) -> true | false.

transaction_is_read_only/1

-spec transaction_is_read_only(transaction()) -> true | false.

transaction_on_error/2

-spec transaction_on_error(transaction(), Error :: integer()) -> future().

transaction_reset/1

-spec transaction_reset(transaction()) -> ok.

transaction_set/3

-spec transaction_set(transaction(), Key :: binary(), Val :: binary()) -> ok.

transaction_set_option(Transaction, Option)

-spec transaction_set_option(transaction(), Option :: transaction_option()) -> ok.

transaction_set_option/3

-spec transaction_set_option(transaction(), Option :: transaction_option(), Value :: option_value()) ->
                                ok.

transaction_set_read_version/2

-spec transaction_set_read_version(transaction(), Version :: integer()) -> ok.

transaction_watch/2

-spec transaction_watch(transaction(), Key :: binary()) -> future().