View Source Ecto.Adapter.Migration behaviour (Ecto SQL v3.12.0)

Specifies the adapter migrations API.

Summary

Types

adapter_meta()

command()

All migration commands

ddl_object()

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

drop_mode()

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, options, fun)

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

supports_ddl_transaction?()

Checks if the adapter supports ddl transaction.

Types

adapter_meta()

@type adapter_meta() :: Ecto.Adapter.adapter_meta()

command()

@type 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_mode()}
  | {:drop_if_exists, Ecto.Migration.Table.t(), drop_mode()}
  | {:create, Ecto.Migration.Index.t()}
  | {:create_if_not_exists, Ecto.Migration.Index.t()}
  | {:drop, Ecto.Migration.Index.t(), drop_mode()}
  | {:drop_if_exists, Ecto.Migration.Index.t(), drop_mode()}
  | {:create, Ecto.Migration.Constraint.t()}
  | {:drop, Ecto.Migration.Constraint.t(), drop_mode()}
  | {:drop_if_exists, Ecto.Migration.Constraint.t(), drop_mode()}

All migration commands

ddl_object()

@type 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.

drop_mode()

@type drop_mode() :: :restrict | :cascade

table_subcommand()

@type table_subcommand() ::
  {:add, field :: atom(),
   type :: Ecto.Type.t() | Ecto.Migration.Reference.t() | binary(), Keyword.t()}
  | {:add_if_not_exists, field :: atom(),
     type :: Ecto.Type.t() | Ecto.Migration.Reference.t() | binary(),
     Keyword.t()}
  | {:modify, field :: atom(),
     type :: Ecto.Type.t() | Ecto.Migration.Reference.t() | binary(),
     Keyword.t()}
  | {:remove, field :: atom(),
     type :: Ecto.Type.t() | Ecto.Migration.Reference.t() | binary(),
     Keyword.t()}
  | {:remove, field :: atom()}
  | {:remove_if_exists, field :: atom(),
     type :: Ecto.Type.t() | Ecto.Migration.Reference.t() | binary()}
  | {:remove_if_exists, field :: atom()}

All commands allowed within the block passed to table/2

Callbacks

execute_ddl(adapter_meta, command, options)

@callback execute_ddl(adapter_meta(), command(), options :: Keyword.t()) ::
  {:ok, [{Logger.level(), Logger.message(), Logger.metadata()}]}

Executes migration commands.

lock_for_migrations(adapter_meta, options, fun)

@callback lock_for_migrations(adapter_meta(), options :: Keyword.t(), fun) :: result
when fun: (-> 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.

supports_ddl_transaction?()

@callback supports_ddl_transaction?() :: boolean()

Checks if the adapter supports ddl transaction.