Module leo_backend_db_bitcask

Description
Function Index
Function Details

Handling database operation for bitcask.

References

https://github.com/leo-project/leo_backend_db/blob/master/src/leo_backend_db_bitcask.erl

Description

Handling database operation for bitcask

Function Index

close/1	Close a bitcask data store and flush any pending writes to disk.
delete/2	Delete an object from bitcask.
first/1	Retrieve a first record from bitcask.
get/2	Retrieve an object from bitcask.
open/1	Open a new or existing bitcask datastore for read-only access.
open/2
prefix_search/4	Retrieve an objects from bitcask by the keyword and the function.
put/3	Insert an object into bitcask.

Function Details

close/1

close(Handler) -> ok

Handler = reference()

Close a bitcask data store and flush any pending writes to disk

delete/2

delete(Handler, Key) -> ok | {error, any()}

Handler = reference()
Key = binary()

Delete an object from bitcask.

first/1

first(Handler) -> {ok, any()} | not_found | {error, any()}

Handler = reference()

Retrieve a first record from bitcask

get/2

get(Handler, Key) -> not_found | {ok, binary()} | {error, any()}

Handler = reference()
Key = binary()

Retrieve an object from bitcask.

open/1

open(Path) -> {ok, pid()} | {error, any()}

Path = string()

Open a new or existing bitcask datastore for read-only access

open/2

open(Path, Options) -> {ok, pid()} | {error, any()}

Path = string()
Options = list()

prefix_search/4

prefix_search(Handler, Key, Fun, MaxKeys) -> {ok, [any()]} | not_found | {error, any()}

Handler = reference()
Key = binary()
Fun = function()
MaxKeys = pos_integer()

Retrieve an objects from bitcask by the keyword and the function

put/3

put(Handler, Key, Value) -> ok | {error, any()}

Handler = reference()
Key = binary()
Value = binary()

Insert an object into bitcask.

Generated by EDoc