Ecto v0.14.3 → Overview → Ecto → Adapters → SQL → Query

Ecto.Adapters.SQL.Query behaviour

Types
Callbacks

Specifies the behaviour to be implemented by the connection for handling all SQL queries.

Source

Types ↑

result :: {:ok, %{rows: nil | [tuple], num_rows: non_neg_integer}} | {:error, Exception.t}

Callbacks

all/1

(callback) # ↑

Specs:

all(Ecto.Query.t) :: String.t

Receives a query and must return a SELECT query.

Source

begin_transaction/0

(callback) # ↑

Specs:

begin_transaction :: String.t

Command to begin transaction.

Source

commit/0

(callback) # ↑

Specs:

commit :: String.t

Command to commit transaction.

Source

ddl_exists/1

(callback) # ↑

Specs:

ddl_exists(Ecto.Adapter.Migration.ddl_object) :: String.t

Receives a DDL object and returns a query that checks its existence.

Source

delete/4

(callback) # ↑

Specs:

delete(prefix :: String.t, table :: String.t, filters :: [atom], returning :: [atom]) :: String.t

Returns a DELETE for the filters returning the given returning.

Source

delete_all/1

(callback) # ↑

Specs:

delete_all(Ecto.Query.t) :: String.t

Receives a query and must return a DELETE query.

Source

execute_ddl/1

(callback) # ↑

Specs:

execute_ddl(Ecto.Adapter.Migration.command) :: String.t

Receives a DDL command and returns a query that executes it.

Source

insert/4

(callback) # ↑

Specs:

insert(prefix :: String.t, table :: String.t, fields :: [atom], returning :: [atom]) :: String.t

Returns an INSERT for the given fields in table returning the given returning.

Source

query/4

(callback) # ↑

Specs:

query(pid, query :: binary, params :: list, opts :: Keyword.t) :: result

Executes the given query with params in connection.

In case of success, it must return an :ok tuple containing a map with at least two keys:

:num_rows - the number of rows affected
:rows - the result set as a list. nil may be returned instead of the list if the command does not yield any row as result (but still yields the number of affected rows, like a delete command without returning would)

Source

rollback/0

(callback) # ↑

Specs:

rollback :: String.t

Command to rollback transaction.

Source

rollback_to_savepoint/1

(callback) # ↑

Specs:

rollback_to_savepoint(savepoint :: String.t) :: String.t

Command to rollback to savepoint.

Source

savepoint/1

(callback) # ↑

Specs:

savepoint(savepoint :: String.t) :: String.t

Command to emit savepoint.

Source

update/5

(callback) # ↑

Specs:

update(prefix :: String.t, table :: String.t, fields :: [atom], filters :: [atom], returning :: [atom]) :: String.t

Returns an UPDATE for the given fields in table filtered by filters returning the given returning.

Source

update_all/1

(callback) # ↑

Specs:

update_all(Ecto.Query.t) :: String.t

Receives a query and values to update and must return an UPDATE query.

Source