Ecto Migration

Étape 2 — Choisir le type de migration

Template — nouvelle colonne

defmodule AgeOnlineApi.Repo.Migrations.NomEnPascalCase do
  use Ecto.Migration

  def change do
    alter table(:nom_table) do
      # Description du champ
      add :nom_colonne, :type, default: valeur, null: false
    end
  end
end

Template — nouvelle table

defmodule AgeOnlineApi.Repo.Migrations.CreateNomTable do
  use Ecto.Migration

  def change do
    create table(:nom_table) do
      add :champ1, :string, null: false
      add :champ2, :integer, default: 0, null: false
      add :owner_id, references(:users, on_delete: :delete_all)
      timestamps()
    end

    create index(:nom_table, [:owner_id])
  end
end

Étape 3 — Mettre à jour le schéma Elixir

Le schéma correspondant se trouve dans backend/age_online_api/lib/age_online_api/.

Trois zones à mettre à jour dans le schéma :

schema "nom_table" do
  # 1. Ajouter le champ ici
  field :nouveau_champ, :type, default: valeur
end

def changeset(struct, attrs) do
  struct
  # 2. Ajouter le champ dans cast/2
  |> cast(attrs, [..., :nouveau_champ])
  # 3. Ajouter dans validate_required/2 si null: false sans default
  |> validate_required([...])
end

Règle null: false sans default

→ Ajouter dans validate_required du changeset.

Règle null: false avec default

→ Ne PAS ajouter dans validate_required, la DB fournit la valeur.

Étape 4 — Vérifier les seeds

Ouvrir backend/age_online_api/priv/repo/seeds.exs.

Adapter si la migration :

• ajoute un champ null: false sans default sur une table peuplée par les seeds
• crée une nouvelle table avec des données initiales requises
• supprime un champ référencé par MapSeeder ou autre module de seed

Laisser intact si :

• addition d'une colonne nullable ou avec default
• modification purement additive sans impact sur les données existantes

Étape 5 — Écrire le test minimal

Le test s'ajoute dans backend/age_online_api/test/api_e2e_test.exs ou dans un nouveau fichier test/<module>_test.exs.

Pattern de test en place :

setup do
  :ok = Ecto.Adapters.SQL.Sandbox.checkout(AgeOnlineApi.Repo)
  Ecto.Adapters.SQL.Sandbox.mode(AgeOnlineApi.Repo, {:shared, self()})
  :ok
end

Cas nominal à couvrir

• Créer/modifier l'entité avec le nouveau champ → vérifier la persistance
• Lire l'entité → vérifier que le champ est présent avec la bonne valeur

Cas d'erreur à couvrir

• Tenter de créer l'entité sans le champ obligatoire → vérifier {:error, changeset}
• Vérifier la contrainte d'unicité si unique_index ajouté

Étape 6 — Vérification finale

Checklist avant de considérer la migration terminée :

• Numéro de migration incrémenté correctement (pas de doublon)
• Nom du module Elixir correspond au nom du fichier en PascalCase
• use Ecto.Migration présent
• Schéma Elixir synchronisé (champ + cast + validate_required si besoin)
• Seeds non cassés (lancer mix run priv/repo/seeds.exs mentalement)
• Test nominal passe
• Test d'erreur passe
• Aucun secret ou credential dans la migration

Commandes utiles

cd backend/age_online_api

# Appliquer la migration
mix ecto.migrate

# Annuler la dernière migration
mix ecto.rollback

# Vérifier l'état des migrations
mix ecto.migrations

# Lancer les tests
mix test

# Réinitialiser complètement (dev uniquement)
mix ecto.reset

Référence : types Ecto courants