Orm Best Practices

ORM Best Practices

概要

Drizzle ORMを活用したデータベース操作のベストプラクティスを提供するスキル。型安全なスキーマ定義、クエリビルダーの効果的な使用、パフォーマンスを考慮した実装パターンを提供します。このスキルはデータベース設計段階から運用まで、ORMの最適な活用方法をガイドします。

詳細な手順や背景は references/basics.md を参照してください。

ワークフロー

Phase 1: スキーマ設計

目的: 型安全なスキーマ定義とリレーション設計

アクション:

1. references/basics.md でDrizzle ORM基礎を確認
2. references/schema-definition.md でテーブル定義パターンを参照
3. references/relation-mapping.md でリレーション設計を検討

Task: agents/design-schema.md を参照

Phase 2: クエリ実装

目的: パフォーマンスを考慮したクエリ構築

アクション:

1. references/query-builder-patterns.md でクエリパターンを確認
2. references/performance-patterns.md でN+1問題対策を検討
3. 型安全なクエリビルダーを実装

Task: agents/implement-queries.md を参照

Phase 3: 検証と最適化

目的: スキーマとクエリの品質確保

アクション:

1. scripts/validate-schema.mjs でスキーマの型安全性を確認
2. インデックス戦略とクエリ計画を検証
3. scripts/log_usage.mjs を実行して使用記録を保存

Task: agents/validate-optimize.md を参照

Task仕様（ナビゲーション）

詳細仕様: 各Taskの詳細は agents/ ディレクトリの対応ファイルを参照

ベストプラクティス

すべきこと

• スキーマ設計: テーブルリレーションと外部キー制約を明確に定義してから実装を開始
• 型安全性: Drizzle ORMの型推論を活用し、TypeScriptの型チェックで実行時エラーを防止
• クエリ設計: クエリビルダーを使用し、手書きSQLではなく型安全なクエリを構築
• パフォーマンス: N+1問題を常に意識し、不要なクエリの重複実行を避ける
• テスト: スキーマ定義とクエリロジックをテストし、リグレッションを防止
• ドキュメント: スキーマの意図、リレーション、パフォーマンスへの配慮をコメントで記録

避けるべきこと

• 手書きSQL: 文字列ベースのSQLではなく、クエリビルダーを使用して型安全性を確保
• スキーマ無視: スキーマ定義を軽視し、後からエンティティマッピングを修正
• 複雑なJOIN: 過度に複雑なJOINはReadability と Maintainability を低下させるため、適切に分割
• キャッシング無視: パフォーマンスクリティカルなクエリにおいてキャッシング戦略を未検討
• マイグレーション無計画: スキーマ変更時にマイグレーション計画を立てず、本番で問題を引き起こす
• インデックス設計無視: 検索や結合に使用するカラムにインデックスを設定しない

リソース参照

references/（詳細知識）

agents/（Task仕様）

assets/（テンプレート）

変更履歴