View Source Ecto.Adapter.Migration behaviour (Ecto SQL v3.11.1)
Specifies the adapter migrations API.
Summary
Types
All migration commands
A struct that represents a table or index in a database schema.
All commands allowed within the block passed to table/2
Callbacks
Executes migration commands.
Locks the migrations table and emits the locked versions for callback execution.
Checks if the adapter supports ddl transaction.
Types
@type adapter_meta() :: Ecto.Adapter.adapter_meta()
@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
@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.
@type drop_mode() :: :restrict | :cascade
@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, type :: Ecto.Type.t() | Ecto.Migration.Reference.t() | binary()}
All commands allowed within the block passed to table/2
Callbacks
@callback execute_ddl(adapter_meta(), command(), options :: Keyword.t()) :: {:ok, [{Logger.level(), Logger.message(), Logger.metadata()}]}
Executes migration commands.
@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.
@callback supports_ddl_transaction?() :: boolean()
Checks if the adapter supports ddl transaction.