Selecto.Diagnostics (Selecto v0.4.5)

Copy Markdown

Query diagnostics helpers (EXPLAIN / EXPLAIN ANALYZE).

Summary

Types

explain_result()

Functions

build_explain_sql(query_sql, opts \\ [])

Build the explain SQL wrapper.

explain(selecto, opts \\ [])

Run EXPLAIN for a Selecto query.

explain_analyze(selecto, opts \\ [])

Run EXPLAIN ANALYZE for a Selecto query.

Types

explain_result()

@type explain_result() :: %{
  explain_sql: String.t(),
  query_sql: String.t(),
  params: list(),
  columns: [String.t()],
  rows: list(),
  plan_lines: [String.t()]
}

Functions

build_explain_sql(query_sql, opts \\ [])

@spec build_explain_sql(
  String.t(),
  keyword()
) :: String.t()

Build the explain SQL wrapper.

explain(selecto, opts \\ [])

@spec explain(
  Selecto.t(),
  keyword()
) :: {:ok, explain_result()} | {:error, Selecto.Error.t()}

Run EXPLAIN for a Selecto query.

explain_analyze(selecto, opts \\ [])

@spec explain_analyze(
  Selecto.t(),
  keyword()
) :: {:ok, explain_result()} | {:error, Selecto.Error.t()}

Run EXPLAIN ANALYZE for a Selecto query.