Download the PHP package devnoiseconsulting/laravel-scout-postgres-tsvector without Composer
On this page you can find all versions of the php package devnoiseconsulting/laravel-scout-postgres-tsvector. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download devnoiseconsulting/laravel-scout-postgres-tsvector
More information about devnoiseconsulting/laravel-scout-postgres-tsvector
Files in devnoiseconsulting/laravel-scout-postgres-tsvector
Package laravel-scout-postgres-tsvector
Short Description PostgreSQL Full Text Search Driver for Laravel Scout
License MIT
Homepage https://github.com/devNoiseConsulting/laravel-scout-postgres-tsvector
Informations about the package laravel-scout-postgres-tsvector
PostgreSQL Full Text Search Engine for Laravel Scout
This package makes it easy to use native PostgreSQL Full Text Search capabilities with Laravel Scout.
Contents
- Installation
- Laravel
- Configuration
- Configuring the Engine
- Configuring PostgreSQL
- Prepare the Schema
- Configuring Searchable Data
- Configuring the Model
- Usage
- Testing
- Security
- Changelog
- Contributing
- Credits
- License
Installation
You can install the package via composer:
Laravel
If you're using Laravel < 5.5 or if you have package auto-discovery turned off you have to manually register the service provider:
Configuration
Configuring the Engine
Specify the database connection that should be used to access indexed documents in the Laravel Scout configuration file config/scout.php
:
Configuring PostgreSQL
Make sure that an appropriate default text search configuration is set globbaly (in postgresql.conf
), for a particular database (ALTER DATABASE ... SET default_text_search_config TO ...
) or alternatively set default_text_search_config
in each session.
To check the current value
Prepare the Schema
By default the engine expects that parsed documents (model data) are stored in the same table as the Model in a column searchable
of type tsvector
. You'd need to create this column and an index in your schema. You can choose between GIN
and GiST
indexes in PostgreSQL.
Configuring Searchable Data
In addition to Model's attributes you can bring other any other data to the index document. I.e. a list of Tags for a Post.
Configuring the Model
You may fine tune the engine behavior for a particular Model by implemeting searchableOptions()
in your Model.
If you decide to keep your Model's index outside of the Model's table you can let engine know that you want to push additional fields in the index table that you can then use to filter the result set by applying where()
with the Scout Builder
. In this case you'd need to implement searchableAdditionalArray()
on your Model. Of course the schema for the external table should include these additional columns.
You may want to make your searchable column hidden so it's not standing in your way
Usage
Please see the official documentation on how to use Laravel Scout.
Testing
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Credits
- Michael Flynn
- Peter Matseykanets
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-scout-postgres-tsvector with dependencies
illuminate/contracts Version ^9|^10
illuminate/database Version ^9|^10
illuminate/support Version ^9|^10
laravel/scout Version ^9|^10