{
  "id": "add-postgres-full-text-search",
  "type": "playbooks",
  "category": "playbooks",
  "locale": "fr",
  "url": "/fr/playbooks/add-postgres-full-text-search",
  "title": "De l'invite à la PR : Ajouter la recherche plein texte PostgreSQL",
  "description": "Procédure opérationnelle standard (SOP) pour ajouter la recherche plein texte native PostgreSQL avec tsvector, index GIN, ts_rank et une API de recherche Next.js — aucun service de recherche tiers nécessaire.",
  "tools": [
    "Cursor",
    "Claude Code",
    "Codex",
    "Windsurf"
  ],
  "stack": [
    "Next.js",
    "PostgreSQL",
    "TypeScript"
  ],
  "tags": [
    "postgres",
    "nextjs",
    "typescript",
    "search",
    "sql"
  ],
  "difficulty": "hard",
  "updated": "2026-06-08",
  "markdown": "La recherche plein texte intégrée de PostgreSQL répond à la plupart des besoins de recherche de produits sans Elasticsearch ou Algolia. Ce guide ajoute une colonne `tsvector`, un index GIN et une requête de recherche classée derrière une route API Next.js.\n\n## 1. Exigence\n\nAjouter la recherche plein texte sur une table `posts` (colonnes : `title`, `body`, `tags`). La recherche doit renvoyer les résultats classés par pertinence avec des extraits mis en évidence. L'implémentation doit utiliser une colonne `tsvector` générée (non calculée au moment de la requête) afin que l'index GIN soit utilisé.\n\n## 2. Première invite\n\n```txt title=\"First Prompt\"\nAdd native PostgreSQL full-text search to the posts table in this project.\n\nDatabase: PostgreSQL. ORM/query builder: [Drizzle / postgres.js — use whichever\nis already in src/db/].\n\nStep 1 — migration:\n  Create a migration file (or Drizzle schema change) that:\n  a. Adds a generated column:\n       search_vector tsvector GENERATED ALWAYS AS (\n         setweight(to_tsvector('english', coalesce(title, '')), 'A') ||\n         setweight(to_tsvector('english', coalesce(body, '')), 'B') ||\n         setweight(to_tsvector('english', coalesce(tags, '')), 'C')\n       ) STORED;\n  b. Creates a GIN index on search_vector:\n       CREATE INDEX posts_search_idx ON posts USING gin(search_vector);\n\nStep 2 — query function:\n  Create `src/lib/queries/search.ts` exporting `searchPosts(q: string, limit = 10)`.\n  The query must:\n  - Convert the user query to a tsquery: `websearch_to_tsquery('english', $1)`.\n  - Filter: `search_vector @@ query`.\n  - Rank: `ts_rank(search_vector, query) DESC`.\n  - Return: id, title, ts_headline('english', body, query,\n      'MaxWords=30, MinWords=15, ShortWord=3, HighlightAll=false') AS snippet.\n  - Use parameterized query (no string interpolation of the user input).\n\nStep 3 — API route:\n  Create `src/app/api/search/route.ts` (GET). Read `q` from URL search params.\n  Return 400 if q is empty or shorter than 2 chars. Return JSON array of results.\n  Add cache-control: public, max-age=60.\n\nStep 4 — do not touch any UI components.\n```\n\n## 3. Modifications de fichiers attendues\n\n```txt\nsrc/db/migrations/<timestamp>_add_search_vector.sql   (new — or Drizzle migration)\nsrc/db/schema.ts                                       (search_vector column if Drizzle)\nsrc/lib/queries/search.ts                              (new — searchPosts function)\nsrc/app/api/search/route.ts                            (new — GET endpoint)\n```\n\n## 4. Liste de vérification\n\n- `GENERATED ALWAYS AS ... STORED` — la colonne est stockée (non virtuelle), donc l'index GIN peut être utilisé. Confirmez la présence du mot-clé `STORED`.\n- `websearch_to_tsquery` est utilisé (pas `to_tsquery`) — gère les requêtes multi-mots et les phrases à partir d'une entrée non fiable sans erreurs de syntaxe.\n- La requête fournie par l'utilisateur est passée comme paramètre SQL, jamais interpolée.\n- `ts_rank` ordonne les résultats — pas par ordre alphabétique ou d'insertion.\n- La longueur de `ts_headline` est limitée (MaxWords=30) pour éviter de renvoyer des extraits énormes.\n- Le nom de l'index GIN est explicite — plus facile à supprimer/recréer si nécessaire.\n- La route API valide une longueur minimale de requête (2 caractères) pour éviter les tsqueries de parcours complet de table comme `'a':*`.\n- `Cache-Control: public, max-age=60` est défini sur la réponse — les résultats de recherche peuvent être mis en cache de courte durée.\n\n## 5. Commandes de test\n\n```bash\n# Run the migration\nnpx drizzle-kit migrate\n# or: psql $DATABASE_URL < migration.sql\n\n# Verify the generated column and index exist\npsql $DATABASE_URL -c \"\\d posts\" | grep search_vector\npsql $DATABASE_URL -c \"\\di posts_search_idx\"\n\n# Query performance — confirm index scan, not seq scan\npsql $DATABASE_URL -c \"\n  EXPLAIN ANALYZE\n  SELECT id FROM posts\n  WHERE search_vector @@ websearch_to_tsquery('english', 'your test query')\n  LIMIT 10;\n\" | grep \"Index Scan\"\n\n# Test the API endpoint\nbun dev &\ncurl \"http://localhost:3000/api/search?q=your+test+query\" | jq .\n\n# Confirm empty query returns 400\ncurl -o /dev/null -w \"%{http_code}\" \"http://localhost:3000/api/search?q=\"\n# Expect: 400\n```\n\n## 6. Échecs courants\n\n- **Analyse séquentielle au lieu d'analyse d'index** — colonne `VIRTUAL` (pas `STORED`). Seules les colonnes générées `STORED` peuvent être indexées dans PostgreSQL. Confirmez que la migration utilise `STORED`.\n- **`to_tsquery` échoue sur une entrée multi-mots** — `to_tsquery('english', 'quick brown')` est une erreur de syntaxe. Utilisez toujours `websearch_to_tsquery` pour les chaînes fournies par l'utilisateur.\n- **`ts_headline` renvoie le corps entier** — `HighlightAll=true` défini par erreur, ou `MaxWords` non défini. Vérifiez la chaîne d'options.\n- **L'index GIN n'est pas utilisé pour les requêtes `LIKE`** — assurez-vous que la clause WHERE utilise l'opérateur `@@`, pas `LIKE` ou `ILIKE`. La recherche plein texte et `LIKE` sont distincts.\n- **La migration échoue sur les données existantes** — la colonne `GENERATED` se remplit lors de la création ; sur les grandes tables, cela peut être lent. Exécutez dans une transaction avec une vérification de progression.\n\n## 7. Invite de correction\n\n```txt title=\"Fix Prompt\"\nEXPLAIN ANALYZE shows a sequential scan instead of an index scan on the\nposts table. The search_vector column was added as VIRTUAL (or without\nthe STORED keyword) so PostgreSQL cannot create a GIN index on it.\n\nFix the migration:\n  ALTER TABLE posts DROP COLUMN search_vector;\n  ALTER TABLE posts ADD COLUMN search_vector tsvector\n    GENERATED ALWAYS AS (\n      setweight(to_tsvector('english', coalesce(title, '')), 'A') ||\n      setweight(to_tsvector('english', coalesce(body, '')), 'B')\n    ) STORED;\n  CREATE INDEX posts_search_idx ON posts USING gin(search_vector);\n\nConfirm the word STORED appears in the column definition.\n```\n\n## 8. Description de la PR\n\n```md title=\"PR description\"\n## Feature: PostgreSQL native full-text search on posts\n\n- Generated `tsvector` column (`STORED`) with weighted fields:\n  title (A), body (B), tags (C)\n- GIN index `posts_search_idx` — index scans confirmed via `EXPLAIN ANALYZE`\n- `searchPosts(q, limit)` uses `websearch_to_tsquery` (safe for user input)\n  and `ts_rank` for relevance ordering\n- `ts_headline` snippets (max 30 words) with matched terms highlighted\n- GET `/api/search?q=` — validates query length, returns ranked JSON,\n  `Cache-Control: public, max-age=60`\n\nNo third-party search dependency added.\n```"
}