Règles de codage IA pour les applications PostgreSQL
Règles AGENTS.md pour les applications basées sur PostgreSQL couvrant la sécurité des requêtes, la discipline de migration, les conventions d'indexation et la prévention des agents contre l'écriture de requêtes N+1.
CursorClaude CodeCodexWindsurf PostgreSQLTypeScriptNext.js
Déposez ce fichier à la racine de votre dépôt sous le nom AGENTS.md. Il s’applique à tout projet où PostgreSQL est le stockage de données principal, qu’il soit accédé via Prisma, Drizzle, postgres.js ou SQL brut.
AGENTS.md
# Project Rules — PostgreSQL Apps
## Hard rules — data safety- NEVER generate SQL that concatenates user input into a query string. Always use parameterised queries (`$1`, `$2` placeholders) or the ORM's parameter binding. SQL injection via agent-generated queries is a real attack vector.- NEVER run `DROP TABLE`, `TRUNCATE`, or `DELETE FROM <table>` without a `WHERE` clause in application code. These must be wrapped in a transaction that can be rolled back, and must require explicit developer confirmation before execution.- NEVER write a migration that removes a column without first deploying a version of the application that stops reading that column. Column removal is a two-deploy operation: (1) stop reading; (2) drop.- All schema changes must be applied via migration files (Drizzle Kit, Flyway, `migrate`, or Prisma Migrate). Never apply schema changes by running `ALTER TABLE` directly against production.
## Query conventions- Every query that returns a list MUST have a `LIMIT`. There is no acceptable reason for a user-facing endpoint to return an unbounded result set.- Use `EXPLAIN ANALYZE` to check query plans for new queries on tables with more than 10,000 rows before merging. Agents should output the plan in a comment block when writing a non-trivial query.- Avoid `SELECT *`. Name every column you need. This makes queries self-documenting and prevents accidental exposure of sensitive columns (hashed passwords, tokens).- N+1 patterns are forbidden. If you load a list of records and then query related data per row in a loop, refactor to a single JOIN query or a batched `IN` query.- Use `JOIN` instead of correlated subqueries for relation lookups — correlated subqueries run once per row and are almost always slower.
## Indexing rules- Every foreign key column MUST have an index. PostgreSQL does not create these automatically (unlike MySQL). Missing FK indexes cause sequential scans on join.- Columns used in `WHERE` clauses on high-read tables should have indexes. When adding a query that filters by a new column, check whether an index exists and add one in the same migration if it does not.- Use partial indexes (`WHERE deleted_at IS NULL`) for soft-delete patterns — they are far smaller and faster than full-table indexes when most rows are soft-deleted.- Never create an index on a column with very low cardinality (e.g. a boolean `is_active` with 90% `true`). PostgreSQL will ignore the index and scan anyway.
## Connection and pooling- Import the database client from `src/lib/db.ts` (the singleton or pool). Never instantiate a new client per request — this exhausts connections instantly under load.- In serverless environments (Next.js API routes, Edge Functions), use a connection pooler (PgBouncer, Neon connection pooling, Supabase pgbouncer mode) between the application and PostgreSQL. Direct connections from serverless are not sustainable.- Set `statement_timeout` and `lock_timeout` on the connection or session for long-running operations to prevent them from blocking the entire application.
## Transactions- Any operation that writes to more than one table must be wrapped in a transaction. Partial writes leave the database in an inconsistent state.- Keep transactions as short as possible. Do not make network requests (HTTP calls, external APIs) inside a transaction — this holds locks for the duration of the network call.
## Definition of done- No string-interpolated SQL in the codebase (`grep -r "query\`" src/` should return only parameterised template tag usage, not concatenation).- All new tables have primary key and foreign key indexes.- All `findMany` / `SELECT` queries have `LIMIT`.- Migration files are committed and named descriptively.- `tsc --noEmit` passes (typed query results match schema types).Pourquoi ces règles
- Pas de SQL concaténé avec des chaînes, jamais est la règle fondamentale. Les requêtes paramétrées ne sont pas seulement une bonne pratique — elles sont la seule défense contre l’injection SQL, et les agents sous pression temporelle concatèneront lorsqu’ils ne savent pas comment exprimer une requête avec la syntaxe de paramètres d’un ORM spécifique.
- La suppression de colonne est une opération en deux déploiements évite l’erreur de migration sans temps d’arrêt la plus courante. Si l’application lit encore une colonne lorsque la migration la supprime, chaque requête en cours au moment de la migration échoue. Les agents ne raisonnent pas naturellement sur les fenêtres de déploiement lorsqu’ils génèrent des modifications de schéma.
Bonne adéquation
- Toute application de production utilisant PostgreSQL où l’intégrité des données et les performances des requêtes sont importantes : applications SaaS, plateformes de contenu, backends e-commerce, pipelines d’analyse.
Pas adapté
- Applications basées sur SQLite ou projets où la base de données est véritablement éphémère (fixtures de test, graines de développement local) — la discipline de migration et les règles d’indexation sont une surcharge inutile.