barrel_store behaviour (barrel_docdb v1.0.0)

Storage behaviour for barrel_docdb

Defines the interface for storage backends. The default implementation uses RocksDB (barrel_store_rocksdb).

Summary

close/1

delete/2

fold/4

fold_range/5

get/2

open/2

put/3

put/4

write_batch/2

get_backend()

Get the configured storage backend module

-callback close(DbRef :: term()) -> ok.

-callback delete(DbRef :: term(), Key :: binary()) -> ok | {error, term()}.

-callback fold(DbRef :: term(), Prefix :: binary(), Fun :: fun(), Acc :: term()) -> term().

-callback fold_range(DbRef :: term(), StartKey :: binary(), EndKey :: binary(), Fun :: fun(), Acc :: term()) ->
                        term().

-callback get(DbRef :: term(), Key :: binary()) -> {ok, binary()} | not_found | {error, term()}.

-callback open(Path :: string(), Options :: map()) -> {ok, DbRef :: term()} | {error, term()}.

-callback put(DbRef :: term(), Key :: binary(), Value :: binary()) -> ok | {error, term()}.

-callback put(DbRef :: term(), Key :: binary(), Value :: binary(), Options :: list()) ->
                 ok | {error, term()}.

-callback write_batch(DbRef :: term(), Operations :: list()) -> ok | {error, term()}.

-spec get_backend() -> module().

Get the configured storage backend module