Ecto SQL

v3.0.0-rc.1

Ecto SQL v3.0.0-rc.1 Ecto.Adapter.Migration behaviour View Source

Specifies the adapter migrations API.

Link to this section Summary

Types

adapter_meta()
command()

All migration commands

ddl_object()

A struct that represents a table or index in a database schema

table_subcommand()

All commands allowed within the block passed to table/2

Callbacks

execute_ddl(adapter_meta, command, options)

Executes migration commands

lock_for_migrations(adapter_meta, arg1, options, fun)

Locks the migrations table and emits the locked versions for callback execution

supports_ddl_transaction?()

Checks if the adapter supports ddl transaction

Link to this section Types

Link to this type command() View Source 
command() ::
  raw ::
  String.t()
  | {:create, Ecto.Migration.Table.t(), [table_subcommand()]}
  | {:create_if_not_exists, Ecto.Migration.Table.t(), [table_subcommand()]}
  | {:alter, Ecto.Migration.Table.t(), [table_subcommand()]}
  | {:drop, Ecto.Migration.Table.t()}
  | {:drop_if_exists, Ecto.Migration.Table.t()}
  | {:create, Ecto.Migration.Index.t()}
  | {:create_if_not_exists, Ecto.Migration.Index.t()}
  | {:drop, Ecto.Migration.Index.t()}
  | {:drop_if_exists, Ecto.Migration.Index.t()}

All migration commands

Link to this type ddl_object() View Source 
ddl_object() :: Ecto.Migration.Table.t() | Ecto.Migration.Index.t()

A struct that represents a table or index in a database schema.

These database objects can be modified through the use of a Data Definition Language, hence the name DDL object.

Link to this type table_subcommand() View Source 
table_subcommand() ::
  {:add, field :: atom(), type :: Ecto.Type.t() | Ecto.Migration.Reference.t(),
   Keyword.t()}
  | {:modify, field :: atom(),
     type :: Ecto.Type.t() | Ecto.Migration.Reference.t(), Keyword.t()}
  | {:remove, field :: atom(),
     type :: Ecto.Type.t() | Ecto.Migration.Reference.t(), Keyword.t()}
  | {:remove, field :: atom()}

All commands allowed within the block passed to table/2

Link to this section Callbacks

Link to this callback execute_ddl(adapter_meta, command, options) View Source 
execute_ddl(adapter_meta(), command(), options :: Keyword.t()) ::
  {:ok, [{Logger.level(), Logger.message(), Logger.metadata()}]}

Executes migration commands.

Options

  • :timeout - The time in milliseconds to wait for the query call to finish, :infinity will wait indefinitely (default: 15000);
  • :pool_timeout - The time in milliseconds to wait for calls to the pool to finish, :infinity will wait indefinitely (default: 5000);
Link to this callback lock_for_migrations(adapter_meta, arg1, options, fun) View Source 
lock_for_migrations(adapter_meta(), Ecto.Query.t(), options :: Keyword.t(), fun) ::
  result
when fun: (Ecto.Query.t() -> result), result: var

Locks the migrations table and emits the locked versions for callback execution.

It returns the result of calling the given function with a list of versions.

Link to this callback supports_ddl_transaction?() View Source 
supports_ddl_transaction?() :: boolean()

Checks if the adapter supports ddl transaction.