DBKV (dbkv v0.2.5) View Source

Deletes entries from table where the key is with the specified range. By default, the range is inclusive. The range boundaries can be excluded by setting :min_inclusive or :max_inclusive to false.

delete_by_match_spec(table, match_spec)

Deletes each entry from table such that applying match_spec to the entry returns true. Returns the number of deleted entries.

delete_by_max_key(table, max_key, inclusive \\ true)

Delete all entries from table where the key is less than or equal to max_key. The boundary can be excluded by setting inclusive to false.

delete_by_max_value(table, max_value, inclusive \\ true)

Delete all entries from table where the value is less than or equal to max_value. The boundary can be excluded by setting inclusive to false.

delete_by_min_key(table, min_key, inclusive \\ true)

Delete all entries from table where the key is greater than or equal to min_key. The boundary can be excluded by setting inclusive to false.

delete_by_min_value(table, min_value, inclusive \\ true)

Delete all entries from table where the value is greater than or equal to min_value. The boundary can be excluded by setting inclusive to false.

delete_by_value(table, value)

Delete all entries from table where the value is equal to value.

delete_by_value_range(table, min_value, max_value, opts \\ [])

Deletes entries from table where the valye is with the specified range. By default, the range is inclusive. The range boundaries can be excluded by setting :min_inclusive or :max_inclusive to false.

filename(table)

Returns the name of the file where table is stored.

get(table, key, default \\ nil)

Gets the value for a specific key in table.

has_key?(table, key)

Returns whether the given key exists in table.

increment(table, key, by)

Increments a number field by one.

info(table) deprecated

Returns information about table.

init_table(table, entries)

Replaces the existing entries of table with entries.

keys(table)

Returns all keys from table.

open(opts \\ [])

Opens a table. An empty :dets table is created if no file exists.

open?(table)

Returns whether table is open.

put(table, key, value)

Puts the given value under key in table.

put_new(table, key, value)

Puts the given value under key unless the entry key already exists in table.

reduce(table, acc, reducer)

Calls Function on successive elements of table together with an extra argument acc. The table elements are traversed in unspecified order. reducer must return a new accumulator that is passed to the next call. acc is returned if the table is empty.

select_by_key_range(table, min_key, max_key, opts \\ [])

Returns a specified range of entries from table. By default, the range is inclusive. The range boundaries can be excluded by setting :min_inclusive or :max_inclusive to false.

select_by_match_spec(table, match_spec, n \\ :default)

Returns the results of applying match_spec to all or n entries stored in table.

select_by_max_key(table, max_key, inclusive \\ true)

Returns all entries from table where the key is less than or equal to max_key. The boundary can be excluded by setting inclusive to false.

select_by_max_value(table, max_value, inclusive \\ true)

Returns all entries from table where the value is less than or equal to max_value. The boundary can be excluded by setting inclusive to false.

select_by_min_key(table, min_key, inclusive \\ true)

Returns all entries from table where the key is greater than or equal to min_key. The boundary can be excluded by setting inclusive to false.

select_by_min_value(table, min_value, inclusive \\ true)

Returns all entries from table where the value is greater than or equal to min_value. The boundary can be excluded by setting inclusive to false.

select_by_value(table, value)

Returns all entries from table where the value is equal to value.

select_by_value_range(table, min_value, max_value, opts \\ [])

Returns a specified range of entries from table. By default, the range is inclusive. The range boundaries can be excluded by setting :min_inclusive or :max_inclusive to false.

size(table)

Returns the size of the collection in table.

update(table, key, default, fun)

Updates the key in table with the given function.

values(table)

Returns all values from table.

Link to this section Types

dbkv_options()

Specs

dbkv_options() :: [name: t(), data_dir: binary()]

entry()

Specs

entry() :: {any(), any()}

match_spec()

Specs

match_spec() :: [
  {{:"$1", :"$2"}, [{any(), any(), any()}, ...], [:"$_", ...]},
  ...
]

Match Specifications. See https://erlang.org/doc/man/dets.html#type-match_spec

range_options()

Specs

range_options() :: [min_inclusive: boolean(), max_inclusive: boolean()]

t()

Specs

t() :: atom()

Link to this section Functions

all(table)

Specs

all(t()) :: [entry()] | {:error, any()}

Returns all entries from table.

all(table, fun)

Specs

all(t(), (key :: any(), value :: any() -> any())) :: [any()] | {:error, any()}

Applies fun to each entry stored in table in some unspecified order.

close(table)

Specs

close(t()) :: :ok | {:error, any()}

Closes a table. Only processes that have opened a table are allowed to close it. All open tables must be closed before the system is stopped.

decrement(table, key, by)

Specs

decrement(t(), any(), number()) :: number()

Decrements a number field by one.

delete(table, key)

Specs

delete(t(), any()) :: :ok | {:error, any()}

Deletes the entry in table for a specific key.

delete_all(table)

Specs

delete_all(t()) :: :ok | {:error, any()}

Deletes all entries from table.

delete_by_key_range(table, min_key, max_key, opts \\ [])

Specs

delete_by_key_range(t(), any(), any(), range_options()) ::
  integer() | {:error, any()}

delete_by_match_spec(table, match_spec)

Specs

delete_by_match_spec(t(), match_spec()) :: integer() | {:error, any()}

Deletes each entry from table such that applying match_spec to the entry returns true. Returns the number of deleted entries.

delete_by_max_key(table, max_key, inclusive \\ true)

Specs

delete_by_max_key(t(), any(), boolean()) :: integer() | {:error, any()}

Delete all entries from table where the key is less than or equal to max_key. The boundary can be excluded by setting inclusive to false.

delete_by_max_value(table, max_value, inclusive \\ true)

Specs

delete_by_max_value(t(), any(), boolean()) :: integer() | {:error, any()}

Delete all entries from table where the value is less than or equal to max_value. The boundary can be excluded by setting inclusive to false.

delete_by_min_key(table, min_key, inclusive \\ true)

Specs

delete_by_min_key(t(), any(), boolean()) :: integer() | {:error, any()}

Delete all entries from table where the key is greater than or equal to min_key. The boundary can be excluded by setting inclusive to false.

delete_by_min_value(table, min_value, inclusive \\ true)

Specs

delete_by_min_value(t(), any(), boolean()) :: integer() | {:error, any()}

Delete all entries from table where the value is greater than or equal to min_value. The boundary can be excluded by setting inclusive to false.

delete_by_value(table, value)

Specs

delete_by_value(t(), any()) :: integer() | {:error, any()}

Delete all entries from table where the value is equal to value.

delete_by_value_range(table, min_value, max_value, opts \\ [])

Specs

delete_by_value_range(t(), any(), any(), range_options()) ::
  integer() | {:error, any()}

filename(table)

Specs

filename(t()) :: charlist() | :undefined

Returns the name of the file where table is stored.

get(table, key, default \\ nil)

Specs

get(t(), any(), any()) :: any()

Gets the value for a specific key in table.

has_key?(table, key)

Specs

has_key?(t(), any()) :: boolean()

Returns whether the given key exists in table.

increment(table, key, by)

Specs

increment(t(), any(), number()) :: number()

Increments a number field by one.

info(table)

This function is deprecated. Use :dets.info/1 instead.

Specs

info(t()) :: map() | :undefined

Returns information about table.

init_table(table, entries)

Specs

init_table(t(), [entry()]) :: :ok | {:error, any()}

Replaces the existing entries of table with entries.

keys(table)

Specs

keys(t()) :: [any()] | {:error, any()}

Returns all keys from table.

open(opts \\ [])

Specs

open(dbkv_options()) :: {:ok, t()} | {:error, any()}

Opens a table. An empty :dets table is created if no file exists.

The optional argument is a keyword list of options:

name: a name of the table (defaults to DBKV)
data_dir: the directory path where the database files will be stored (defaults to "tmp")

open?(table)

Specs

open?(t()) :: boolean()

Returns whether table is open.

put(table, key, value)

Specs

put(t(), any(), any()) :: :ok | {:error, any()}

Puts the given value under key in table.

put_new(table, key, value)

Specs

put_new(t(), any(), any()) :: :ok | {:error, any()}

Puts the given value under key unless the entry key already exists in table.

reduce(table, acc, reducer)

Specs

reduce(t(), any(), (entry(), any() -> any())) :: any()

select_by_key_range(table, min_key, max_key, opts \\ [])

Specs

select_by_key_range(t(), any(), any(), range_options()) ::
  [entry()] | {:error, any()}

Returns a specified range of entries from table. By default, the range is inclusive. The range boundaries can be excluded by setting :min_inclusive or :max_inclusive to false.

select_by_match_spec(table, match_spec, n \\ :default)

Specs

select_by_match_spec(t(), match_spec(), non_neg_integer()) ::
  [any()] | {:error, any()}

Returns the results of applying match_spec to all or n entries stored in table.

select_by_max_key(table, max_key, inclusive \\ true)

Specs

select_by_max_key(t(), any(), boolean()) :: [entry()] | {:error, any()}

Returns all entries from table where the key is less than or equal to max_key. The boundary can be excluded by setting inclusive to false.

select_by_max_value(table, max_value, inclusive \\ true)

Specs

select_by_max_value(t(), any(), boolean()) :: [entry()] | {:error, any()}

Returns all entries from table where the value is less than or equal to max_value. The boundary can be excluded by setting inclusive to false.

select_by_min_key(table, min_key, inclusive \\ true)

Specs

select_by_min_key(t(), any(), boolean()) :: [entry()] | {:error, any()}

Returns all entries from table where the key is greater than or equal to min_key. The boundary can be excluded by setting inclusive to false.

select_by_min_value(table, min_value, inclusive \\ true)

Specs

select_by_min_value(t(), any(), boolean()) :: [entry()] | {:error, any()}

Returns all entries from table where the value is greater than or equal to min_value. The boundary can be excluded by setting inclusive to false.

select_by_value(table, value)

Specs

select_by_value(t(), any()) :: [entry()] | {:error, any()}

Returns all entries from table where the value is equal to value.

select_by_value_range(table, min_value, max_value, opts \\ [])

Specs

select_by_value_range(t(), any(), any(), range_options()) ::
  [any()] | {:error, any()}

Returns a specified range of entries from table. By default, the range is inclusive. The range boundaries can be excluded by setting :min_inclusive or :max_inclusive to false.

size(table)

Specs

size(t()) :: integer() | :undefined

Returns the size of the collection in table.

update(table, key, default, fun)

Specs

update(t(), any(), any(), (value :: any() -> any())) :: :ok | {:error, any()}

Updates the key in table with the given function.

If key is present in table then the existing value is passed to fun and its result is used as the updated value of key. If key is not present in table, default is inserted as the value of key. The default value will not be passed through the update function.

values(table)

Specs

values(t()) :: [any()] | {:error, any()}

Returns all values from table.