dlex v0.5.0 Dlex.Adapter behaviour

Link to this section Summary

Link to this section Types

Specs

conn() :: term()

Specs

host() :: String.t() | atom()

Specs

json_lib() :: module()

Specs

opts() :: keyword()
Link to this type

port_number()

Specs

port_number() :: integer()

Specs

request() :: %{}

Specs

result() :: %{}
Link to this type

transaction()

Specs

transaction() :: %{}

Link to this section Functions

Link to this macro

__using__(_)

(macro)

Use Dlex.Adapter to set the behaviour.

Link to this function

alter(adapter, conn, request, json_lib, opts)

Link to this function

commit_or_abort(adapter, conn, request, json_lib, opts)

Link to this function

connect(adapter, host, port, opts)

Link to this function

disconnect(adapter, conn)

Link to this function

mutate(adapter, conn, request, json_lib, opts)

Link to this function

ping(adapter, conn)

Link to this function

query(adapter, conn, request, json_lib, opts)

Link to this section Callbacks

Link to this callback

alter(conn, request, json_lib, opts)

Specs

alter(conn(), request(), json_lib(), opts()) ::
  {:ok, result()} | {:error, term()}
Link to this callback

commit_or_abort(conn, transaction, json_lib, opts)

Specs

commit_or_abort(conn(), transaction(), json_lib(), opts()) ::
  {:ok, transaction()} | {:error, term()}
Link to this callback

connect(host, port_number, opts)

Specs

connect(host(), port_number(), opts()) :: {:ok, conn()} | {:error, term()}
Link to this callback

disconnect(conn)

Specs

disconnect(conn()) :: :ok | {:error, term()}
Link to this callback

mutate(conn, request, json_lib, opts)

Specs

mutate(conn(), request(), json_lib(), opts()) ::
  {:ok, result()} | {:error, term()}

Specs

ping(conn()) :: :ok | {:error, term()}
Link to this callback

query(conn, request, json_lib, opts)

Specs

query(conn(), request(), json_lib(), opts()) ::
  {:ok, result()} | {:error, term()}