{
  "id": "add-postgres-full-text-search",
  "type": "playbooks",
  "category": "playbooks",
  "locale": "pt",
  "url": "/pt/playbooks/add-postgres-full-text-search",
  "title": "Prompt-para-PR: Adicionar Pesquisa de Texto Completo no PostgreSQL",
  "description": "POP para adicionar pesquisa de texto completo nativa do PostgreSQL com tsvector, índice GIN, ts_rank e uma API de busca Next.js — sem necessidade de serviço de terceiros.",
  "tools": [
    "Cursor",
    "Claude Code",
    "Codex",
    "Windsurf"
  ],
  "stack": [
    "Next.js",
    "PostgreSQL",
    "TypeScript"
  ],
  "tags": [
    "postgres",
    "nextjs",
    "typescript",
    "search",
    "sql"
  ],
  "difficulty": "hard",
  "updated": "2026-06-08",
  "markdown": "A pesquisa de texto completo embutida do PostgreSQL atende à maioria das necessidades de busca de produtos sem Elasticsearch ou Algolia. Este guia adiciona uma coluna `tsvector`, um índice GIN e uma consulta de busca ranqueada por trás de uma rota de API Next.js.\n\n## 1. Requisito\n\nAdicionar pesquisa de texto completo em uma tabela `posts` (colunas: `title`, `body`, `tags`). A busca deve retornar resultados ranqueados por relevância com destaque de trechos. A implementação deve usar uma coluna `tsvector` gerada (não computada no momento da consulta) para que o índice GIN seja utilizado.\n\n## 2. Primeiro 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. Alterações de Arquivos Esperadas\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 Verificação\n\n- `GENERATED ALWAYS AS ... STORED` — a coluna é armazenada (não virtual), para que o índice GIN possa ser usado. Confirme que a palavra-chave `STORED` está presente.\n- `websearch_to_tsquery` é usado (não `to_tsquery`) — lida com consultas de múltiplas palavras e frases a partir de entrada não confiável sem erros de sintaxe.\n- A consulta fornecida pelo usuário é passada como um parâmetro SQL, nunca interpolada.\n- `ts_rank` ordena os resultados — não por ordem alfabética ou de inserção.\n- `ts_headline` tem comprimento limitado (MaxWords=30) para evitar retornar trechos enormes.\n- O nome do índice GIN é explícito — mais fácil de remover/recriar se necessário.\n- A rota da API valida o comprimento mínimo da consulta (2 caracteres) para evitar consultas tsquery com varredura completa da tabela como `'a':*`.\n- `Cache-Control: public, max-age=60` é definido na resposta — resultados de busca podem ser armazenados em cache por curta duração.\n\n## 5. Comandos de Teste\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. Falhas Comuns\n\n- **Varredura sequencial em vez de varredura por índice** — coluna `VIRTUAL` (não `STORED`). Apenas colunas geradas `STORED` podem ser indexadas no PostgreSQL. Confirme que a migração usa `STORED`.\n- **`to_tsquery` lança erro para entrada com múltiplas palavras** — `to_tsquery('english', 'quick brown')` é um erro de sintaxe. Sempre use `websearch_to_tsquery` para strings fornecidas pelo usuário.\n- **`ts_headline` retorna o corpo inteiro** — `HighlightAll=true` acidentalmente definido, ou `MaxWords` não definido. Verifique a string de opções.\n- **Índice GIN não usado para consultas `LIKE`** — garanta que a cláusula WHERE use o operador `@@`, não `LIKE` ou `ILIKE`. Pesquisa de texto completo e `LIKE` são separados.\n- **Migração falha em dados existentes** — a coluna `GENERATED` é populada na criação; em tabelas grandes isso pode ser lento. Execute em uma transação com verificação de progresso.\n\n## 7. Prompt de Correção\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. Descrição do 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```"
}