Référence rapide

Aide-mémoire Phoenix Ecto Migrations

Guide de référence rapide pour les migrations Ecto dans Phoenix : création de tables, types de colonnes, clés étrangères, index et SQL brut.

· Publié le

Ecto.Migration fournit un DSL indépendant de la base de données pour écrire et exécuter des migrations.

Commandes CLI de migration (CLI Migration Commands)

# Generer un fichier de migration
mix ecto.gen.migration add_status_to_orders

# Executer les migrations en attente
mix ecto.migrate

# Annuler la derniere etape de migration
mix ecto.rollback

# Verifier l'etat des migrations
mix ecto.migrations

DSL de définition de table (Table Definition DSL)

defmodule MyApp.Repo.Migrations.CreateDocuments do
  use Ecto.Migration

  def change do
    create table(:documents) do
      add :title, :string, size: 100, null: false
      add :body, :text
      add :price, :decimal, precision: 10, scale: 2
      add :views, :integer, default: 0
      add :active, :boolean, default: true, null: false
      add :metadata, :map # JSON / JSONB
      add :published_at, :utc_datetime

      # Reference de cle etrangere
      add :author_id, references(:users, on_delete: :delete_all), null: false

      # Ajoute inserted_at et updated_at
      timestamps()
    end
  end
end

Modifier des tables existantes (alter)

alter table(:documents) do
  add :subtitle, :string
  modify :title, :string, size: 255
  remove :views
end

Index et contraintes (Indices & Constraints)

# Index unique
create unique_index(:users, [:email])

# Index composite avec creation concurrente (PostgreSQL)
create index(:orders, [:user_id, :status], concurrently: true)

# Supprimer l'index
drop index(:orders, [:status])

Exécution de SQL brut (Raw SQL)

# Executer des commandes SQL personnalisees dans la migration
execute "CREATE EXTENSION IF NOT EXISTS citext;"

References connexes

Sujets associés