{"id":25751935,"url":"https://github.com/ionews/cakephp-pg-search","last_synced_at":"2026-05-14T21:04:00.924Z","repository":{"id":62489696,"uuid":"356690099","full_name":"ionews/cakephp-pg-search","owner":"ionews","description":"Plugin to extend CakePHP Postgres drivers to support Full Text Search","archived":false,"fork":false,"pushed_at":"2022-02-07T21:56:49.000Z","size":84,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-15T04:08:12.746Z","etag":null,"topics":["cakephp","fulltext-search","postgresql"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ionews.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-10T20:43:09.000Z","updated_at":"2022-01-17T19:10:18.000Z","dependencies_parsed_at":"2022-11-02T11:15:46.719Z","dependency_job_id":null,"html_url":"https://github.com/ionews/cakephp-pg-search","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/ionews/cakephp-pg-search","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionews%2Fcakephp-pg-search","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionews%2Fcakephp-pg-search/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionews%2Fcakephp-pg-search/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionews%2Fcakephp-pg-search/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ionews","download_url":"https://codeload.github.com/ionews/cakephp-pg-search/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionews%2Fcakephp-pg-search/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33043249,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T13:14:54.681Z","status":"online","status_checked_at":"2026-05-14T02:00:06.663Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cakephp","fulltext-search","postgresql"],"created_at":"2025-02-26T14:18:43.980Z","updated_at":"2026-05-14T21:04:00.888Z","avatar_url":"https://github.com/ionews.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Busca Textual com PostgreSQL no CakePHP\n\n[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE) \n[![CI](https://github.com/ionews/cakephp-pg-search/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ionews/cakephp-pg-search/actions/workflows/ci.yml)\n[![Coverage](https://img.shields.io/codecov/c/github/ionews/cakephp-pg-search?style=flat-square)](https://codecov.io/gh/ionews/cakephp-pg-search/branch/main)\n[![Downloads](https://img.shields.io/packagist/dt/autopage/pg-search.svg?style=flat-square)](https://packagist.org/packages/autopage/pg-search)\n[![Latest Stable](https://img.shields.io/packagist/v/autopage/pg-search.svg?style=flat-square\u0026label=stable)](https://packagist.org/packages/autopage/pg-search)\n\nAdicione suporte a [Full Text Search do Postgres](https://www.postgresql.org/docs/current/textsearch.html) em sua aplicação CakePHP.\n\n## Requisitos\n\n - PHP 7.2+\n - CakePHP 4.2.2+\n - PostgreSQL 9.6+\n\n## Instalar\n\nInclua o plugin como dependência\n\n```\ncomposer require autopage/pg-search\n```\n\n## Uso\n\nPara ter todos os recursos disponíveis, você deve configurar sua aplicação para usar o `Driver` fornecido aqui na conexão com o banco de dados. Ele habilitará o uso do `TableSchema` e `PostgresSchemaDialect` incluidos no plugin que estendem as versões padrão do CakePHP para implementar o tipo de coluna `tsvector` e aos índices do tipo `gin` e `gist`.\n\n### Configuração\n\nNo seu `app_local.php`:\n\n```php\n    // ...\n    'Datasources' =\u003e [\n        'default' =\u003e [\n            'className' =\u003e \\Cake\\Database\\Connection::class,\n            'driver' =\u003e \\Autopage\\PgSearch\\Database\\Driver\\Postgres::class,\n            // O restante da sua configuração vem normalmente\n            // ...\n        ],\n    // ...\n```\n\nOutra configuração importante, mas opcional, é definir qual [_configuração de busca_](https://www.postgresql.org/docs/current/textsearch-configuration.html) o PostgreSQL deve usar na hora de indexar ou buscar um campo do tipo `tsvector`.\n\nVocê pode configurar ela com a chave `PgSearch.config_name`. Supondo que você criou no seu banco de dados uma configuração de nome **portuguese**, o seu `app_local.php` ficaria:\n\n```php\n    // ...\n    'PgSearch' =\u003e [\n        'config_name' =\u003e 'portuguese',\n    ],\n    // ...\n```\n\n### SearchableBehavior\n\nAssocie as tabelas que deseja tornar pesquisável ao behavior, desta forma, sempre que um registro for criado/editado/excluído, as informações serão propagadas para a tabela de busca.\n\n```php\n    /**\n     * Método de inicialização da Table\n     *\n     * @param array $config The configuration for the Table.\n     * @return void\n     */\n    public function initialize(array $config): void\n    {\n        parent::initialize($config);\n\n        $this-\u003eaddBehavior('Searchable', [\n            'foreign_key' =\u003e 'origem_id',\n            'mapper' =\u003e function ($entidade) {\n                return [\n                    'origem_id' =\u003e $entidade-\u003eid,\n                    'conteudo' =\u003e $entidade-\u003edescricao,\n                ];\n            },\n        ]);\n    }\n```\n\n#### Configurações disponíveis\n\n - **target**: `string`. Nome do repositório (`Table`) que deve ser usada para persistir os registros de forma pesquisável. Por padrão usa uma `Table` com nome igual a que está vinculada ao `Behavior`, adicionado o sufixo _'Searches'_. Exemplo: `Posts` -\u003e `PostsSearches`.\n - **foreign_key**: `string`. Nome da coluna em **target** que referencia o registro original. Por padrão usa o nome da tabela no singular adicionado o sufixo _'\\_id'_. Exemplo: `Posts` -\u003e `post_id`\n - **mapper**: `callable`. Método/função que converte uma entidade do repositório original para uma de _target_. Por padrão, ele copia todos os campos da entidade original na entidade nova e associa a chave estrangeira da nova a chave primária da original.\n - **doIndex**: `bool|callable`. Se deve ou não indexar o registro. Permite um controle individual. Por padrão o valor é `true`.\n - **doDeindex**: `bool|callable`. Se deve ou não desindexar o registro. Permite um  controle individual e suporte a remoção lógica (_soft-delete_). Por padrão o valor é `false`.\n\n#### Finder FTS\n\nO _behavior_ disponibiliza o _finder_ de nome `fts`. Como todo _finder_, ele recebe uma _query_ e também retorna uma _query_. Dessa forma, você pode usar ele para preparar uma _query_ antes ou depois de chamar ele, estendendo as condições e qualquer outra operação possível em uma _query_.\n\nOs parâmetros especiais desse _finder_ são:\n\n - **field**: `string` (_obrigatório_). Nome do campo do tipo tsvector onde a busca será feita\n - **value**: `string` (_obrigatório_). Valor que deve ser comparado com o campo\n - **highlight**: `boolean`. Flag indicando se deve ou não incluir destaque nos termos encontrados. Por padrão é desativado.\n - **highlight_field**: `string` (_obrigatório_ apenas se **highlight** for `true`). Nome do campo textual onde o highlight será aplicado\n - **exact**: `boolean`. Se a comparação será do tipo exata ou aproximada. Por padrão é aproximada (`false`).\n - **ts_function**: `string`. Caso seja necessário utilizar uma função diferente da aproximada ou exata para parseamento.\n - **configuration**: `string`. Nome da configuração de busca usada na comparação. Por padrão, usa a mesma definida em `PgSearch.config_name`.\n - **ranked**: `boolean`. Flag indicando se a _query_ deve ser ordenada por _score_.\n\n## FAQ\n\n### Preciso mesmo usar o driver do plugin na minha aplicação?\n\nNão, não precisa. Mas ao não usar, você terá de dizer em cada `Table` que possui coluna `tsvector` qual é essa coluna.\n\nNos seus testes unitários, também não será possível criar `Fixture` com esse tipo de coluna ou um dos índices `gin` e `gist`.\n\nEm resumo: não precisa, mas deveria.\n\n### Por que usar uma tabela separada para indexar?\n\nÉ uma decisão pessoal, tirada após trabalhar com sistemas que migram de backend de busca/indexação ao longo do tempo. Separar as tabelas te fornece mais flexibilidade. E o _tradeoff_ é o uso um pouco maior de disco.\n\nEssa tabela indexada pode ser uma versão desnormalizada de outra, permitindo que você faça várias consultas que exigiriam `joins` e `subqueries` de outra maneira. Em um segundo momento, quando passar a ter bilhões de registros, você pode querer desacoplar essa tabela do banco principal e passar para uma outra instância, ou mesmo para um serviço especializado como Elasticsearch, Solr e Sphinx.\n\n### Entendi, mas posso usar a mesma tabela do registro principal?\n\nAté pode, mas você ganharia apenas o `finder` como vantagem - os recursos de sincronização ficam desativados.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fionews%2Fcakephp-pg-search","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fionews%2Fcakephp-pg-search","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fionews%2Fcakephp-pg-search/lists"}