{
  "id": "add-postgres-full-text-search",
  "type": "playbooks",
  "category": "playbooks",
  "locale": "es",
  "url": "/es/playbooks/add-postgres-full-text-search",
  "title": "Prompt-to-PR: Añadir búsqueda de texto completo en PostgreSQL",
  "description": "Procedimiento operativo estándar para añadir búsqueda de texto completo nativa de PostgreSQL con tsvector, índice GIN, ts_rank y una API de búsqueda de Next.js — sin necesidad de un servicio de búsqueda de terceros.",
  "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 búsqueda de texto completo integrada de PostgreSQL maneja la mayoría de las necesidades de búsqueda de productos sin Elasticsearch ni Algolia. Este manual añade una columna `tsvector`, un índice GIN y una consulta de búsqueda clasificada detrás de una ruta API de Next.js.\n\n## 1. Requisito\n\nAñadir búsqueda de texto completo sobre una tabla `posts` (columnas: `title`, `body`, `tags`). La búsqueda debe devolver resultados clasificados por relevancia con resaltados de fragmentos. La implementación debe usar una columna `tsvector` generada (no calculada al momento de la consulta) para que se utilice el índice GIN.\n\n## 2. Primer Prompt\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. Cambios de archivo esperados\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. Lista de verificación\n\n- `GENERATED ALWAYS AS ... STORED` — la columna se almacena (no es virtual), por lo que se puede usar el índice GIN. Confirma que la palabra clave `STORED` está presente.\n- Se usa `websearch_to_tsquery` (no `to_tsquery`) — maneja consultas de varias palabras y frases desde entradas no confiables sin errores de sintaxis.\n- La consulta proporcionada por el usuario se pasa como un parámetro SQL, nunca se interpola.\n- `ts_rank` ordena los resultados — no alfabéticamente ni por orden de inserción.\n- La longitud de `ts_headline` está limitada (MaxWords=30) para evitar devolver fragmentos enormes.\n- El nombre del índice GIN es explícito — más fácil de eliminar/volver a crear si es necesario.\n- La ruta API valida una longitud mínima de consulta (2 caracteres) para evitar tsqueries que escaneen toda la tabla como `'a':*`.\n- Se establece `Cache-Control: public, max-age=60` en la respuesta — los resultados de búsqueda se pueden almacenar en caché de corta duración.\n\n## 5. Comandos de prueba\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. Fallos comunes\n\n- **Escaneo secuencial en lugar de escaneo por índice** — columna `VIRTUAL` (no `STORED`). Solo las columnas generadas `STORED` se pueden indexar en PostgreSQL. Confirma que la migración usa `STORED`.\n- **`to_tsquery` lanza error con entrada de varias palabras** — `to_tsquery('english', 'quick brown')` es un error de sintaxis. Siempre usa `websearch_to_tsquery` para cadenas proporcionadas por el usuario.\n- **`ts_headline` devuelve todo el cuerpo** — `HighlightAll=true` accidentalmente establecido, o `MaxWords` no establecido. Verifica la cadena de opciones.\n- **El índice GIN no se usa para consultas `LIKE`** — asegúrate de que la cláusula WHERE usa el operador `@@`, no `LIKE` o `ILIKE`. La búsqueda de texto completo y `LIKE` son independientes.\n- **La migración falla en datos existentes** — la columna `GENERATED` se puebla al crearla; en tablas grandes esto puede ser lento. Ejecuta en una transacción con una verificación de progreso.\n\n## 7. Prompt de corrección\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. Descripción del 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```"
}