Current section

Files

Jump to
ecto lib ecto adapters postgres connection.ex
Raw

lib/ecto/adapters/postgres/connection.ex

if Code.ensure_loaded?(Postgrex.Connection) do
defmodule Ecto.Adapters.Postgres.Connection do
@moduledoc false
@default_port 5432
@behaviour Ecto.Adapters.Worker
@behaviour Ecto.Adapters.SQL.Query
## Connection
def connect(opts) do
extensions = [{Ecto.Adapters.Postgres.DateTime, []}]
opts =
opts
|> Keyword.update(:extensions, extensions, &(&1 ++ extensions))
|> Keyword.update(:port, @default_port, &normalize_port/1)
Postgrex.Connection.start_link(opts)
end
def disconnect(conn) do
try do
Postgrex.Connection.stop(conn)
catch
:exit, {:noproc, _} -> :ok
end
:ok
end
def query(conn, sql, params, opts) do
params = Enum.map params, fn
%Ecto.Query.Tagged{value: value} -> value
value -> value
end
case Postgrex.Connection.query(conn, sql, params, opts) do
{:ok, %Postgrex.Result{} = result} -> {:ok, Map.from_struct(result)}
{:error, %Postgrex.Error{}} = err -> err
end
end
defp normalize_port(port) when is_binary(port), do: String.to_integer(port)
defp normalize_port(port) when is_integer(port), do: port
## Transaction
def begin_transaction do
"BEGIN"
end
def rollback do
"ROLLBACK"
end
def commit do
"COMMIT"
end
def savepoint(savepoint) do
"SAVEPOINT " <> savepoint
end
def rollback_to_savepoint(savepoint) do
"ROLLBACK TO SAVEPOINT " <> savepoint
end
## Query
alias Ecto.Query.SelectExpr
alias Ecto.Query.QueryExpr
alias Ecto.Query.JoinExpr
def all(query) do
sources = create_names(query)
distinct = query.distinct
distinct_exprs = distinct_exprs(distinct, sources)
from = from(sources)
select = select(query.select, distinct, distinct_exprs, sources)
join = join(query.joins, sources)
where = where(query.wheres, sources)
group_by = group_by(query.group_bys, sources)
having = having(query.havings, sources)
order_by = order_by(query.order_bys, distinct_exprs, sources)
limit = limit(query.limit, sources)
offset = offset(query.offset, sources)
lock = lock(query.lock)
assemble([select, from, join, where, group_by, having, order_by, limit, offset, lock])
end
def update_all(query, values) do
sources = create_names(query)
{table, name, _model} = elem(sources, 0)
zipped_sql = Enum.map_join(values, ", ", fn {field, expr} ->
"#{quote_name(field)} = #{expr(expr, sources)}"
end)
update = update_expr(query.joins, table, name)
join = update_all_join(query.joins, sources)
where = where(query.wheres, sources)
assemble([update, "SET", zipped_sql, join, where])
end
def delete_all(query) do
sources = create_names(query)
{table, name, _model} = elem(sources, 0)
join = using(query.joins, sources)
where = delete_all_where(query.joins, query.wheres, sources)
assemble(["DELETE FROM #{quote_table(table)} AS #{name}", join, where])
end
def insert(table, fields, returning) do
values =
if fields == [] do
"DEFAULT VALUES"
else
"(" <> Enum.map_join(fields, ", ", &quote_name/1) <> ") " <>
"VALUES (" <> Enum.map_join(1..length(fields), ", ", &"$#{&1}") <> ")"
end
"INSERT INTO #{quote_table(table)} " <> values <> returning(returning)
end
def update(table, fields, filters, returning) do
{fields, count} = Enum.map_reduce fields, 1, fn field, acc ->
{"#{quote_name(field)} = $#{acc}", acc + 1}
end
{filters, _count} = Enum.map_reduce filters, count, fn field, acc ->
{"#{quote_name(field)} = $#{acc}", acc + 1}
end
"UPDATE #{quote_table(table)} SET " <> Enum.join(fields, ", ") <>
" WHERE " <> Enum.join(filters, " AND ") <>
returning(returning)
end
def delete(table, filters, returning) do
{filters, _} = Enum.map_reduce filters, 1, fn field, acc ->
{"#{quote_name(field)} = $#{acc}", acc + 1}
end
"DELETE FROM #{quote_table(table)} WHERE " <>
Enum.join(filters, " AND ") <> returning(returning)
end
## Query generation
binary_ops =
[==: "=", !=: "!=", <=: "<=", >=: ">=", <: "<", >: ">",
and: "AND", or: "OR",
ilike: "ILIKE", like: "LIKE"]
@binary_ops Keyword.keys(binary_ops)
Enum.map(binary_ops, fn {op, str} ->
defp handle_call(unquote(op), 2), do: {:binary_op, unquote(str)}
end)
defp handle_call(fun, _arity), do: {:fun, Atom.to_string(fun)}
defp select(%SelectExpr{fields: fields}, distinct, distinct_exprs, sources) do
"SELECT " <>
distinct(distinct, distinct_exprs) <>
Enum.map_join(fields, ", ", &expr(&1, sources))
end
defp distinct_exprs(%QueryExpr{expr: exprs}, sources) when is_list(exprs) do
Enum.map_join(exprs, ", ", &expr(&1, sources))
end
defp distinct_exprs(_, _), do: ""
defp distinct(nil, _sources), do: ""
defp distinct(%QueryExpr{expr: true}, _exprs), do: "DISTINCT "
defp distinct(%QueryExpr{expr: false}, _exprs), do: ""
defp distinct(_query, exprs), do: "DISTINCT ON (" <> exprs <> ") "
defp from(sources) do
{table, name, _model} = elem(sources, 0)
"FROM #{quote_table(table)} AS #{name}"
end
defp using([], _sources), do: []
defp using(joins, sources) do
Enum.map_join(joins, " ", fn
%JoinExpr{on: %QueryExpr{expr: expr}, ix: ix} ->
{table, name, _model} = elem(sources, ix)
where = expr(expr, sources)
"USING #{quote_name(table)} AS #{name} WHERE " <> where
end)
end
defp update_expr([], table, name) do
"UPDATE #{quote_name(table)} AS #{name}"
end
defp update_expr(_joins, table, _name) do
"UPDATE #{quote_name(table)}"
end
defp update_all_join([], _sources), do: []
defp update_all_join(joins, sources) do
from(sources) <> " " <> join(joins, sources)
end
defp join([], _sources), do: []
defp join(joins, sources) do
Enum.map_join(joins, " ", fn
%JoinExpr{on: %QueryExpr{expr: expr}, qual: qual, ix: ix} ->
{table, name, _model} = elem(sources, ix)
on = expr(expr, sources)
qual = join_qual(qual)
"#{qual} JOIN #{quote_table(table)} AS #{name} ON " <> on
end)
end
defp join_qual(:inner), do: "INNER"
defp join_qual(:left), do: "LEFT OUTER"
defp join_qual(:right), do: "RIGHT OUTER"
defp join_qual(:full), do: "FULL OUTER"
defp delete_all_where([], wheres, sources), do: where(wheres, sources)
defp delete_all_where(_joins, wheres, sources) do
boolean("AND", wheres, sources)
end
defp where(wheres, sources) do
boolean("WHERE", wheres, sources)
end
defp having(havings, sources) do
boolean("HAVING", havings, sources)
end
defp group_by(group_bys, sources) do
exprs =
Enum.map_join(group_bys, ", ", fn
%QueryExpr{expr: expr} ->
Enum.map_join(expr, ", ", &expr(&1, sources))
end)
case exprs do
"" -> []
_ -> "GROUP BY " <> exprs
end
end
defp order_by(order_bys, distinct_exprs, sources) do
exprs =
Enum.map_join(order_bys, ", ", fn
%QueryExpr{expr: expr} ->
Enum.map_join(expr, ", ", &order_by_expr(&1, sources))
end)
case {distinct_exprs, exprs} do
{_, ""} ->
[]
{"", _} ->
"ORDER BY " <> exprs
{_, _} ->
"ORDER BY " <> distinct_exprs <> ", " <> exprs
end
end
defp order_by_expr({dir, expr}, sources) do
str = expr(expr, sources)
case dir do
:asc -> str
:desc -> str <> " DESC"
end
end
defp limit(nil, _sources), do: []
defp limit(%Ecto.Query.QueryExpr{expr: expr}, sources) do
"LIMIT " <> expr(expr, sources)
end
defp offset(nil, _sources), do: []
defp offset(%Ecto.Query.QueryExpr{expr: expr}, sources) do
"OFFSET " <> expr(expr, sources)
end
defp lock(nil), do: []
defp lock(lock_clause), do: lock_clause
defp boolean(_name, [], _sources), do: []
defp boolean(name, query_exprs, sources) do
name <> " " <>
Enum.map_join(query_exprs, " AND ", fn
%QueryExpr{expr: expr} ->
"(" <> expr(expr, sources) <> ")"
end)
end
defp expr({:^, [], [ix]}, _sources) do
"$#{ix+1}"
end
defp expr({{:., _, [{:&, _, [idx]}, field]}, _, []}, sources) when is_atom(field) do
{_, name, _} = elem(sources, idx)
"#{name}.#{quote_name(field)}"
end
defp expr({:&, _, [idx]}, sources) do
{_table, name, model} = elem(sources, idx)
fields = model.__schema__(:fields)
Enum.map_join(fields, ", ", &"#{name}.#{quote_name(&1)}")
end
defp expr({:in, _, [_left, []]}, _sources) do
"false"
end
defp expr({:in, _, [left, right]}, sources) when is_list(right) do
args = Enum.map_join right, ",", &expr(&1, sources)
expr(left, sources) <> " IN (" <> args <> ")"
end
defp expr({:in, _, [left, {:^, _, [ix, length]}]}, sources) do
args = Enum.map_join ix+1..ix+length, ",", &"$#{&1}"
expr(left, sources) <> " IN (" <> args <> ")"
end
defp expr({:is_nil, _, [arg]}, sources) do
"#{expr(arg, sources)} IS NULL"
end
defp expr({:not, _, [expr]}, sources) do
"NOT (" <> expr(expr, sources) <> ")"
end
defp expr({:fragment, _, parts}, sources) do
Enum.map_join(parts, "", fn
{:raw, part} -> part
{:expr, expr} -> expr(expr, sources)
end)
end
defp expr({fun, _, args}, sources) when is_atom(fun) and is_list(args) do
case handle_call(fun, length(args)) do
{:binary_op, op} ->
[left, right] = args
op_to_binary(left, sources) <>
" #{op} "
<> op_to_binary(right, sources)
{:fun, fun} ->
"#{fun}(" <> Enum.map_join(args, ", ", &expr(&1, sources)) <> ")"
end
end
defp expr(list, sources) when is_list(list) do
"ARRAY[" <> Enum.map_join(list, ",", &expr(&1, sources)) <> "]"
end
defp expr(%Ecto.Query.Tagged{value: binary, type: :binary}, _sources) when is_binary(binary) do
hex = Base.encode16(binary, case: :lower)
"'\\x#{hex}'::bytea"
end
defp expr(%Ecto.Query.Tagged{value: other, type: type}, sources) do
expr(other, sources) <> "::" <> ecto_to_db(type)
end
defp expr(nil, _sources), do: "NULL"
defp expr(true, _sources), do: "TRUE"
defp expr(false, _sources), do: "FALSE"
defp expr(literal, _sources) when is_binary(literal) do
"'#{escape_string(literal)}'"
end
defp expr(literal, _sources) when is_integer(literal) do
String.Chars.Integer.to_string(literal)
end
defp expr(literal, _sources) when is_float(literal) do
String.Chars.Float.to_string(literal) <> "::float"
end
defp op_to_binary({op, _, [_, _]} = expr, sources) when op in @binary_ops do
"(" <> expr(expr, sources) <> ")"
end
defp op_to_binary(expr, sources) do
expr(expr, sources)
end
defp returning([]),
do: ""
defp returning(returning),
do: " RETURNING " <> Enum.map_join(returning, ", ", &quote_name/1)
defp create_names(%{sources: sources}) do
create_names(sources, 0, tuple_size(sources)) |> List.to_tuple()
end
defp create_names(sources, pos, limit) when pos < limit do
{table, model} = elem(sources, pos)
name = String.first(table) <> Integer.to_string(pos)
[{table, name, model}|create_names(sources, pos + 1, limit)]
end
defp create_names(_sources, pos, pos) do
[]
end
# DDL
alias Ecto.Migration.Table
alias Ecto.Migration.Index
alias Ecto.Migration.Reference
def ddl_exists(%Table{name: name}) do
"""
SELECT count(1) FROM pg_class c
JOIN pg_namespace n ON n.oid = c.relnamespace
WHERE c.relkind IN ('r','v','m')
AND c.relname = '#{escape_string(to_string(name))}'
AND n.nspname = ANY (current_schemas(false))
"""
end
def ddl_exists(%Index{name: name}) do
"""
SELECT count(1) FROM pg_class c
JOIN pg_namespace n ON n.oid = c.relnamespace
WHERE c.relkind IN ('i')
AND c.relname = '#{escape_string(to_string(name))}'
AND n.nspname = ANY (current_schemas(false))
"""
end
def execute_ddl({:create, %Table{}=table, columns}) do
"CREATE TABLE #{quote_table(table.name)} (#{column_definitions(columns)})"
end
def execute_ddl({:drop, %Table{name: name}}) do
"DROP TABLE #{quote_table(name)}"
end
def execute_ddl({:alter, %Table{}=table, changes}) do
"ALTER TABLE #{quote_table(table.name)} #{column_changes(changes)}"
end
def execute_ddl({:create, %Index{}=index}) do
fields = Enum.map_join(index.columns, ", ", &index_expr/1)
assemble(["CREATE",
if_do(index.unique, "UNIQUE"),
"INDEX",
if_do(index.concurrently, "CONCURRENTLY"),
quote_name(index.name),
"ON",
quote_table(index.table),
if_do(index.using, "USING #{index.using}"),
"(#{fields})"])
end
def execute_ddl({:drop, %Index{}=index}) do
assemble(["DROP",
"INDEX",
if_do(index.concurrently, "CONCURRENTLY"),
quote_name(index.name)])
end
def execute_ddl(default) when is_binary(default), do: default
defp column_definitions(columns) do
Enum.map_join(columns, ", ", &column_definition/1)
end
defp column_definition({:add, name, type, opts}) do
assemble([quote_name(name), column_type(type, opts), column_options(opts)])
end
defp column_changes(columns) do
Enum.map_join(columns, ", ", &column_change/1)
end
defp column_change({:add, name, type, opts}) do
assemble(["ADD COLUMN", quote_name(name), column_type(type, opts), column_options(opts)])
end
defp column_change({:modify, name, type, opts}) do
assemble(["ALTER COLUMN", quote_name(name), "TYPE", column_type(type, opts)])
end
defp column_change({:remove, name}), do: "DROP COLUMN #{quote_name(name)}"
defp column_options(opts) do
default = Keyword.get(opts, :default)
null = Keyword.get(opts, :null)
pk = Keyword.get(opts, :primary_key)
[default_expr(default), null_expr(null), pk_expr(pk)]
end
defp pk_expr(true), do: "PRIMARY KEY"
defp pk_expr(_), do: []
defp null_expr(false), do: "NOT NULL"
defp null_expr(true), do: "NULL"
defp null_expr(_), do: []
defp default_expr(nil),
do: []
defp default_expr(literal) when is_binary(literal),
do: "DEFAULT '#{escape_string(literal)}'"
defp default_expr(literal) when is_number(literal) or is_boolean(literal),
do: "DEFAULT #{literal}"
defp default_expr({:fragment, expr}),
do: "DEFAULT #{expr}"
defp index_expr(literal) when is_binary(literal),
do: literal
defp index_expr(literal),
do: quote_name(literal)
defp column_type(%Reference{} = ref, opts),
do: "#{reference_column_type(ref.type, opts)} REFERENCES " <>
"#{quote_name(ref.table)}(#{quote_name(ref.column)})"
defp column_type({:array, type}, opts),
do: column_type(type, opts) <> "[]"
defp column_type(type, opts) do
size = Keyword.get(opts, :size)
precision = Keyword.get(opts, :precision)
scale = Keyword.get(opts, :scale)
type_name = ecto_to_db(type)
cond do
size -> "#{type_name}(#{size})"
precision -> "#{type_name}(#{precision},#{scale || 0})"
type == :string -> "#{type_name}(255)"
true -> "#{type_name}"
end
end
# A reference pointing to a serial column becomes integer in postgres
defp reference_column_type(:serial, _opts), do: "integer"
defp reference_column_type(type, opts), do: column_type(type, opts)
## Helpers
defp quote_name(name) when is_atom(name), do: quote_name(Atom.to_string(name))
defp quote_name(name) do
if String.contains?(name, "\"") do
raise ArgumentError, "bad field name #{inspect name}"
end
<<?", name::binary, ?">>
end
defp quote_table(name) when is_atom(name), do: quote_table(Atom.to_string(name))
defp quote_table(name) do
if String.contains?(name, "\"") do
raise ArgumentError, "bad table name #{inspect name}"
end
<<?", String.replace(name, ".", "\".\"")::binary, ?">>
end
defp assemble(list) do
list
|> List.flatten
|> Enum.join(" ")
end
defp if_do(condition, value) do
if condition, do: value, else: []
end
defp escape_string(value) when is_binary(value) do
:binary.replace(value, "'", "''", [:global])
end
defp ecto_to_db({:array, t}), do: ecto_to_db(t) <> "[]"
defp ecto_to_db(:id), do: "integer"
defp ecto_to_db(:binary_id), do: "uuid"
defp ecto_to_db(:string), do: "varchar"
defp ecto_to_db(:datetime), do: "timestamp"
defp ecto_to_db(:binary), do: "bytea"
defp ecto_to_db(other), do: Atom.to_string(other)
end
end