View Source EctoMySQLExtras behaviour (Ecto MySQL Extras v0.6.2)

Documentation for EctoMySQLExtras.

Summary

Types

repo()

Callbacks

info()

query(args)

Functions

connections(repo, opts \\ [])

db_settings(repo, opts \\ [])

db_status(repo, opts \\ [])

dirty_pages_ratio(repo, opts \\ [])

index_size(repo, opts \\ [])

long_running_queries(repo, opts \\ [])

plugins(repo, opts \\ [])

queries(repo \\ nil)

query(query_name, repo, opts \\ [])

Run a query with name, on repo, in the given format. The repo can be a module name or a tuple like {module, node}.

records_rank(repo, opts \\ [])

table_cache(repo, opts \\ [])

table_indexes_size(repo, opts \\ [])

table_size(repo, opts \\ [])

total_index_size(repo, opts \\ [])

total_table_size(repo, opts \\ [])

unused_indexes(repo, opts \\ [])

waits_for_checkpoint(repo, opts \\ [])

waits_for_redolog(repo, opts \\ [])

Types

repo()

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

Callbacks

info()

@callback info() :: %{
  :title => String.t(),
  :columns => [%{name: atom(), type: atom()}],
  optional(:order_by) => [{atom(), :ASC | :DESC}],
  optional(:args) => [atom()],
  optional(:default_args) => list()
}

query(args)

@callback query(args :: [db: :atom, version: String.t()]) :: binary()

Functions

connections(repo, opts \\ [])

@spec connections(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()

db_settings(repo, opts \\ [])

@spec db_settings(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()

db_status(repo, opts \\ [])

@spec db_status(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()

dirty_pages_ratio(repo, opts \\ [])

@spec dirty_pages_ratio(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()

index_size(repo, opts \\ [])

@spec index_size(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()

long_running_queries(repo, opts \\ [])

@spec long_running_queries(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()

plugins(repo, opts \\ [])

@spec plugins(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()

queries(repo \\ nil)

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

query(query_name, repo, opts \\ [])

@spec query(atom(), repo(), keyword()) :: :ok | MyXQL.Result.t()

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 :ascii a nice table printed in ASCII - a string will be returned. Otherwise a result struct will be returned. 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 \\ [])

@spec records_rank(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()

table_cache(repo, opts \\ [])

@spec table_cache(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()

table_indexes_size(repo, opts \\ [])

@spec table_indexes_size(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()

table_size(repo, opts \\ [])

@spec table_size(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()

total_index_size(repo, opts \\ [])

@spec total_index_size(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()

total_table_size(repo, opts \\ [])

@spec total_table_size(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()

unused_indexes(repo, opts \\ [])

@spec unused_indexes(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()

waits_for_checkpoint(repo, opts \\ [])

@spec waits_for_checkpoint(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()

waits_for_redolog(repo, opts \\ [])

@spec waits_for_redolog(
  repo(),
  keyword()
) :: :ok | MyXQL.Result.t()