ecto-essentials

Ecto の基本

リポジトリの Ecto およびデータベースの規約に従ってください。ビジネスルールはコンテキストまたは純粋なドメインモジュールに置き、Repo の呼び出しは永続化の境界に置いてください。

スキーマとチェンジセット

• 永続化するデータはスキーマでモデル化し、外部入力はチェンジセットで検証してください。
• 外部マップには、フィールドの許可リストを明示して cast/3 を使用してください。信頼できる内部更新には change/2 を使用してください。
• データベース制約を unique_constraint/3、foreign_key_constraint/3、または対応する制約ヘルパーでチェンジセットに関連付け、想定されるデータベースエラーがチェンジセットのエラーとして返されるようにしてください。
• アソシエーションの所有権と削除時の動作は明示してください。ネストされた入力が公開操作の一部である場合にのみ cast_assoc/3 を使用してください。

クエリとアソシエーション

• 名前付きバインディングとパラメーター化された値を使って Ecto.Query のフラグメントを組み立ててください。ユーザー入力を SQL に直接埋め込まないでください。
• 再利用可能なフィルターと並べ替えはクエリ関数に置き、ポリシーとオーケストレーションはコンテキストに置いてください。
• 呼び出し元が必要とするものをプリロードしてください。リストの場合はクエリ数を確認し、行ごとの Repo.get/2 呼び出しよりも結合または一括プリロードを優先してください。
• 呼び出し元が想定する不在時の動作とエラー契約に応じて、Repo.one/1、Repo.all/1、およびバン！バリアントを使い分けてください。

書き込みとトランザクション

• 想定される失敗は {:ok, value} / {:error, changeset_or_reason} を返してください。
• トランザクションに複数の名前付きステップがある場合、または失敗したステップが呼び出し元にとって重要な場合は Ecto.Multi を使用してください。小規模なアトミック処理には通常のトランザクションを使用してください。
• データベーストランザクション内でネットワーク呼び出しや、その他の取り消せない副作用を実行しないでください。
• アップサートでは競合対象を明示し、データベース制約がそれと一致していることを確認してください。

検証

永続化の動作を変更した場合は、テストを追加または更新してください。対象を絞ったテストを実行し、その後、Ecto とマイグレーションを対象とするプロジェクトのチェックを実行してください。より限定的な動作が中心となる場合にのみ、ecto-changeset-patterns、ecto-nested-associations、または ecto-migration を使用してください。