Immudb (immudb_elixir v0.2.0)

@spec change_password(Immudb.Socket.t(),
  user: String.t(),
  old_password: String.t(),
  new_password: String.t()
) :: {:error, String.t() | atom()} | {:ok, String.t()}

change_permission(socket, list)

@spec change_permission(Immudb.Socket.t(),
  action: :GRANT | :REVOKE,
  username: String.t(),
  database: String.t(),
  permission: atom()
) :: {:error, String.t()} | {:ok, nil}

compact_index(socket)

@spec compact_index(Immudb.Socket.t()) :: {:error, String.t()} | {:ok, nil}

count(socket, prefix)

@spec count(Immudb.Socket.t(), [binary()]) ::
  {:error, String.t() | atom()} | {:ok, Immudb.Schemas.EntryCount.t()}

count_all(socket)

@spec count_all(Immudb.Socket.t()) ::
  {:error, String.t() | atom()} | {:ok, Immudb.Schemas.EntryCount.t()}

create_database(socket, database_name)

@spec create_database(Immudb.Socket.t(), binary()) ::
  {:error, String.t() | atom()} | {:ok, nil}

create_user(socket, list)

@spec create_user(Immudb.Socket.t(),
  user: String.t(),
  password: String.t(),
  database: String.t(),
  permission: atom()
) :: {:error, String.t() | atom()} | {:ok, nil}

current_state(socket)

@spec current_state(Immudb.Socket.t()) :: {:error, String.t() | atom()} | {:ok, nil}

describe_table(socket, table_name)

@spec describe_table(Immudb.Socket.t(), String.t()) ::
  {:error, String.t()} | {:ok, nil}

get(socket, key)

@spec get(Immudb.Socket.t(), binary()) ::
  {:error, String.t() | atom()} | {:ok, Immudb.Schemas.Entry.t()}

get_all(socket, keys)

@spec get_all(Immudb.Socket.t(), [binary()]) ::
  {:error, String.t() | atom()} | {:ok, Immudb.Schemas.Entries.t()}

health(socket)

@spec health(Immudb.Socket.t()) :: {:error, String.t() | atom()} | {:ok, nil}

history(socket, key, list)

@spec history(Immudb.Socket.t(), binary(),
  offset: integer(),
  limit: integer(),
  desc: boolean(),
  since_tx: integer()
) :: {:error, String.t() | atom()} | {:ok, Immudb.Schemas.Entries.t()}

list_databases(socket)

@spec list_databases(Immudb.Socket.t()) :: {:error, String.t() | atom()} | {:ok, nil}

list_tables(socket)

@spec list_tables(Immudb.Socket.t()) :: {:error, String.t()} | {:ok, nil}

list_users(socket)

@spec list_users(Immudb.Socket.t()) ::
  {:error, String.t() | atom()} | {:ok, [User.t()]}

logout(socket)

@spec logout(Immudb.Socket.t()) :: {:error, String.t() | atom()} | {:ok, nil}

new(v)

@spec new([{:url, String.t()}]) :: {:ok, Immudb.Socket.t()} | {:error, String.t()}

@spec new(
  host: String.t(),
  port: integer(),
  username: String.t(),
  password: String.t(),
  database: String.t()
) :: {:ok, Immudb.Socket.t()} | {:error, String.t()}

scan(socket, list)

@spec scan(Immudb.Socket.t(),
  seek_key: binary(),
  prefix: binary(),
  desc: binary(),
  limit: integer(),
  since_tx: binary(),
  no_wait: boolean()
) :: {:error, String.t() | atom()} | {:ok, Immudb.Schemas.Entries.t()}

set(socket, key, value)

@spec set(Immudb.Socket.t(), binary(), binary()) ::
  {:error, String.t() | atom()} | {:ok, Immudb.Schemas.TxMetaData.t()}

set_active_user(socket, list)

@spec set_active_user(Immudb.Socket.t(), active: boolean(), username: String.t()) ::
  {:error, String.t()} | {:ok, nil}

set_all(socket, kvs)

@spec set_all(Immudb.Socket.t(), [{binary(), binary()}]) ::
  {:error, String.t() | atom()} | {:ok, Immudb.Schemas.TxMetaData.t()}

set_reference(socket, list)

@spec set_reference(Immudb.Socket.t(),
  key: binary(),
  referenced_key: binary(),
  at_tx: integer(),
  bound_ref: boolean(),
  no_wait: boolean()
) :: {:error, String.t() | atom()} | {:ok, Immudb.Schemas.TxMetaData.t()}

@spec set_reference(Immudb.Socket.t(),
  key: binary(),
  referenced_key: binary(),
  at_tx: integer(),
  bound_ref: boolean(),
  no_wait: boolean(),
  prove_since_tx: integer()
) :: {:error, String.t() | atom()} | {:ok, Immudb.Schemas.VerifiableTx.t()}

sql_exec(socket, sql)

@spec sql_exec(Immudb.Socket.t(), String.t()) :: {:error, String.t()} | {:ok, nil}

sql_exec(socket, sql, kvs)

@spec sql_exec(Immudb.Socket.t(), String.t(), [{String.t(), String.t()}]) ::
  {:error, String.t()} | {:ok, nil}

sql_query(socket, sql, kvs)

@spec sql_query(Immudb.Socket.t(), String.t(), [{String.t(), String.t()}]) ::
  {:error, String.t()} | {:ok, nil}

stream_get(socket, list)

@spec stream_get(Immudb.Socket.t(),
  key: String.t(),
  at_tx: integer(),
  since_tx: integer()
) ::
  {:error, String.t() | atom()} | {:ok, nil}

stream_history(socket, key, list)

@spec stream_history(Immudb.Socket.t(), binary(),
  offset: integer(),
  limit: integer(),
  desc: boolean(),
  since_tx: integer()
) :: {:error, String.t() | atom()} | {:ok, Immudb.Schemas.Entries.t()}

stream_scan(socket, list)

@spec stream_scan(Immudb.Socket.t(),
  seek_key: binary(),
  prefix: binary(),
  desc: binary(),
  limit: integer(),
  since_tx: binary(),
  no_wait: boolean()
) :: {:error, String.t() | atom()} | {:ok, Immudb.Schemas.Entries.t()}

stream_verifiable_get(socket, list)

@spec stream_verifiable_get(Immudb.Socket.t(),
  key: String.t(),
  at_tx: integer(),
  since_tx: integer(),
  prove_since_tx: integer()
) :: {:error, String.t() | atom()} | {:ok, nil}

tx_by_id(socket, tx)

@spec tx_by_id(Immudb.Socket.t(), binary()) ::
  {:error, String.t() | atom()} | {:ok, nil}

tx_scan(socket, list)

@spec tx_scan(Immudb.Socket.t(),
  initial_tx: integer(),
  limit: integer(),
  desc: boolean()
) ::
  {:error, String.t() | atom()} | {:ok, Immudb.Schemas.TxList.t()}

use_database(socket, database_name)

@spec use_database(Immudb.Socket.t(), [{:database_name, String.t()}]) ::
  {:error, String.t()} | {:ok, String.t()}

use_snapshot(socket, since_tx, as_before_tx)

@spec use_snapshot(Immudb.Socket.t(), integer(), integer()) ::
  {:error, String.t() | atom()} | {:ok, nil}

verifiable_get(socket, key)

@spec verifiable_get(Immudb.Socket.t(), binary()) ::
  {:error, String.t() | atom()} | {:ok, Immudb.Schemas.VerifiableEntry.t()}

verifiable_set(socket, key, value)

@spec verifiable_set(Immudb.Socket.t(), binary(), binary()) ::
  {:error, String.t() | atom()} | {:ok, Immudb.Schemas.VerifiableTx.t()}

verifiable_set_reference(socket, list)

verifiable_sql_get(socket, params)

@spec verifiable_sql_get(Immudb.Socket.t(), map()) ::
  {:error, String.t()} | {:ok, nil}

verifiable_tx_by_id(socket, tx, prove_since_tx)

@spec verifiable_tx_by_id(Immudb.Socket.t(), binary(), binary()) ::
  {:error, String.t() | atom()} | {:ok, nil}

Settings Immudb (immudb_elixir v0.2.0)

Link to this section Summary

Functions

Link to this section Functions

change_password(socket, list)

change_permission(socket, list)

compact_index(socket)

count(socket, prefix)

count_all(socket)

create_database(socket, database_name)

create_user(socket, list)

current_state(socket)

describe_table(socket, table_name)

get(socket, key)

get_all(socket, keys)

health(socket)

history(socket, key, list)

list_databases(socket)

list_tables(socket)

list_users(socket)

login(socket, user, password)

logout(socket)

new(v)

scan(socket, list)

set(socket, key, value)

set_active_user(socket, list)

set_all(socket, kvs)

set_reference(socket, list)

sql_exec(socket, sql)

sql_exec(socket, sql, kvs)

sql_query(socket, sql, kvs)

stream_get(socket, list)

stream_history(socket, key, list)

stream_scan(socket, list)

stream_verifiable_get(socket, list)

tx_by_id(socket, tx)

tx_scan(socket, list)

use_database(socket, database_name)

use_snapshot(socket, since_tx, as_before_tx)

verifiable_get(socket, key)

verifiable_set(socket, key, value)

verifiable_set_reference(socket, list)

verifiable_sql_get(socket, params)

verifiable_tx_by_id(socket, tx, prove_since_tx)

Immudb (immudb_elixir v0.2.0)