View Source EctoPSQLExtras behaviour (ecto_psql_extras v0.8.3)

The entry point for each function.

Summary

Types

repo()

Callbacks

info()

query()

Functions

all_locks(repo, opts \\ [])

Run all_locks query on repo, in the given format.

bloat(repo, opts \\ [])

Run bloat query on repo, in the given format.

blocking(repo, opts \\ [])

Run blocking query on repo, in the given format.

cache_hit(repo, opts \\ [])

Run cache_hit query on repo, in the given format.

calls(repo, opts \\ [])

Run calls query on repo, in the given format.

connections(repo, opts \\ [])

Run connections query on repo, in the given format.

db_settings(repo, opts \\ [])

Run db_settings query on repo, in the given format.

diagnose(repo, opts \\ [])

Run diagnose query on repo, in the given format.

duplicate_indexes(repo, opts \\ [])

Run duplicate_indexes query on repo, in the given format.

extensions(repo, opts \\ [])

Run extensions query on repo, in the given format.

index_cache_hit(repo, opts \\ [])

Run index_cache_hit query on repo, in the given format.

index_size(repo, opts \\ [])

Run index_size query on repo, in the given format.

index_usage(repo, opts \\ [])

Run index_usage query on repo, in the given format.

kill_all(repo, opts \\ [])

Run kill_all query on repo, in the given format.

locks(repo, opts \\ [])

Run locks query on repo, in the given format.

long_running_queries(repo, opts \\ [])

Run long_running_queries query on repo, in the given format.

mandelbrot(repo, opts \\ [])

Run mandelbrot query on repo, in the given format.

null_indexes(repo, opts \\ [])

Run null_indexes query on repo, in the given format.

outliers(repo, opts \\ [])

Run outliers query on repo, in the given format.

pg_stat_statements_version(repo)

queries(repo \\ nil)

Returns all queries and their modules.

query(name, repo, opts \\ [log: false])

Run a query with name, on repo, in the given format.

records_rank(repo, opts \\ [])

Run records_rank query on repo, in the given format.

seq_scans(repo, opts \\ [])

Run seq_scans query on repo, in the given format.

ssl_info_enabled(repo)

ssl_used(repo, opts \\ [])

Run ssl_used query on repo, in the given format.

table_cache_hit(repo, opts \\ [])

Run table_cache_hit query on repo, in the given format.

table_indexes_size(repo, opts \\ [])

Run table_indexes_size query on repo, in the given format.

table_size(repo, opts \\ [])

Run table_size query on repo, in the given format.

total_index_size(repo, opts \\ [])

Run total_index_size query on repo, in the given format.

total_table_size(repo, opts \\ [])

Run total_table_size query on repo, in the given format.

unused_indexes(repo, opts \\ [])

Run unused_indexes query on repo, in the given format.

vacuum_stats(repo, opts \\ [])

Run vacuum_stats query on repo, in the given format.

Types

repo()

@type repo() :: module() | {module(), node()}

Callbacks

info()

@callback info() :: %{
  :title => binary(),
  :columns => [%{name: atom(), type: atom()}],
  optional(:order_by) => [{atom(), :asc | :desc}],
  optional(:index) => integer(),
  optional(:default_args) => list(),
  optional(:args_for_select) => list()
}

query()

@callback query() :: binary()

Functions

all_locks(repo, opts \\ [])

Run all_locks query on repo, in the given format.

format is either :ascii or :raw

bloat(repo, opts \\ [])

Run bloat query on repo, in the given format.

format is either :ascii or :raw

blocking(repo, opts \\ [])

Run blocking query on repo, in the given format.

format is either :ascii or :raw

cache_hit(repo, opts \\ [])

Run cache_hit query on repo, in the given format.

format is either :ascii or :raw

calls(repo, opts \\ [])

Run calls query on repo, in the given format.

format is either :ascii or :raw

connections(repo, opts \\ [])

Run connections query on repo, in the given format.

format is either :ascii or :raw

db_settings(repo, opts \\ [])

Run db_settings query on repo, in the given format.

format is either :ascii or :raw

diagnose(repo, opts \\ [])

Run diagnose query on repo, in the given format.

format is either :ascii or :raw

duplicate_indexes(repo, opts \\ [])

Run duplicate_indexes query on repo, in the given format.

format is either :ascii or :raw

extensions(repo, opts \\ [])

Run extensions query on repo, in the given format.

format is either :ascii or :raw

index_cache_hit(repo, opts \\ [])

Run index_cache_hit query on repo, in the given format.

format is either :ascii or :raw

index_size(repo, opts \\ [])

Run index_size query on repo, in the given format.

format is either :ascii or :raw

index_usage(repo, opts \\ [])

Run index_usage query on repo, in the given format.

format is either :ascii or :raw

kill_all(repo, opts \\ [])

Run kill_all query on repo, in the given format.

format is either :ascii or :raw

locks(repo, opts \\ [])

Run locks query on repo, in the given format.

format is either :ascii or :raw

long_running_queries(repo, opts \\ [])

Run long_running_queries query on repo, in the given format.

format is either :ascii or :raw

mandelbrot(repo, opts \\ [])

Run mandelbrot query on repo, in the given format.

format is either :ascii or :raw

null_indexes(repo, opts \\ [])

Run null_indexes query on repo, in the given format.

format is either :ascii or :raw

outliers(repo, opts \\ [])

Run outliers query on repo, in the given format.

format is either :ascii or :raw

pg_stat_statements_version(repo)

queries(repo \\ nil)

@spec queries(repo() | nil) :: map()

Returns all queries and their modules.

If a repository is given, it will be queried for extensions support and special queries will be included if available.

query(name, repo, opts \\ [log: false])

Run a query with name, on repo, in the given format.

The repo can be a module name or a tuple like {module, node}.

Options

:format - The format that results will return. Accepts :ascii or :raw. If :raw a result struct will be returned. Otherwise it returns a nice table printed in ASCII - a string. This option is required.
:args - Overwrites the default arguments for the given query. You can check the defaults of each query in its modules defined in this project.
:query_opts - Overwrites the default options for the Ecto query. Defaults to [log: false]

records_rank(repo, opts \\ [])

Run records_rank query on repo, in the given format.

format is either :ascii or :raw

seq_scans(repo, opts \\ [])

Run seq_scans query on repo, in the given format.

format is either :ascii or :raw

ssl_info_enabled(repo)

ssl_used(repo, opts \\ [])

Run ssl_used query on repo, in the given format.

format is either :ascii or :raw

table_cache_hit(repo, opts \\ [])

Run table_cache_hit query on repo, in the given format.

format is either :ascii or :raw

table_indexes_size(repo, opts \\ [])

Run table_indexes_size query on repo, in the given format.

format is either :ascii or :raw

table_size(repo, opts \\ [])

Run table_size query on repo, in the given format.

format is either :ascii or :raw

total_index_size(repo, opts \\ [])

Run total_index_size query on repo, in the given format.

format is either :ascii or :raw

total_table_size(repo, opts \\ [])

Run total_table_size query on repo, in the given format.

format is either :ascii or :raw

unused_indexes(repo, opts \\ [])

Run unused_indexes query on repo, in the given format.

format is either :ascii or :raw

vacuum_stats(repo, opts \\ [])

Run vacuum_stats query on repo, in the given format.

format is either :ascii or :raw