laravel scout postgres
7.3.0
Этот пакет позволяет легко использовать собственные возможности полного текстового поиска PostgreSQL со скаутом Laravel.
Если вы найдете этот пакет полезным, пожалуйста, рассмотрите вопрос о кофе.
Вы можете установить пакет через композитор:
composer require pmatseykanets/laravel-scout-postgresЕсли вы используете Laravel <5,5 или если у вас есть отключенная пакет, вы должны вручную зарегистрировать поставщика услуг:
// config/app.php
' providers ' => [
...
ScoutEngines Postgres PostgresEngineServiceProvider::class,
], Поставщик служб разведчика использует помощника config_path , который не включен в Lumen. Чтобы исправить это, включайте в себя следующий фрагмент непосредственно в bootstrap.app или в вашем автоканальном файле помощников, то есть app/helpers.php .
if (! function_exists ( ' config_path ' )) {
/**
* Get the configuration path.
*
* @param string $path
* @return string
*/
function config_path ( $ path = '' )
{
return app ()-> basePath () . ' /config ' .( $ path ? DIRECTORY_SEPARATOR . $ path : $ path );
}
} Создать файл конфигурации scout.php в папке app/config со следующим содержанием
<?php
return [
' driver ' => env ( ' SCOUT_DRIVER ' , ' pgsql ' ),
' prefix ' => env ( ' SCOUT_PREFIX ' , '' ),
' queue ' => false ,
' pgsql ' => [
' connection ' => ' pgsql ' ,
' maintain_index ' => true ,
' config ' => ' english ' ,
],
];Зарегистрировать поставщики услуг:
// bootstrap/app.php
$ app -> register ( Laravel Scout ScoutServiceProvider::class);
$ app -> configure ( ' scout ' );
$ app -> register ( ScoutEngines Postgres PostgresEngineServiceProvider::class); Укажите подключение к базе данных, которое следует использовать для доступа к индексированным документам в файле конфигурации Scout Scout config/scout.php :
// config/scout.php
. . .
' pgsql ' => [
// Connection to use. See config/database.php
' connection ' => env ( ' DB_CONNECTION ' , ' pgsql ' ),
// You may want to update index documents directly in PostgreSQL (i.e. via triggers).
// In this case you can set this value to false.
' maintain_index ' => true ,
// You can explicitly specify what PostgreSQL text search config to use by scout.
// Use dF in psql to see all available configurations in your database.
' config ' => ' english ' ,
// You may set the default querying method
// Possible values: plainquery, phrasequery, tsquery
// plainquery is used if this option is omitted.
' search_using ' => ' tsquery '
],
... Убедитесь, что соответствующая конфигурация текста по умолчанию установлена Globbaly (в postgresql.conf ), для конкретной базы данных ( ALTER DATABASE ... SET default_text_search_config TO ... ) или альтернативно установить default_text_search_config в каждом сеансе.
Чтобы проверить текущее значение
SHOW default_text_search_config; По умолчанию двигатель ожидает, что проанализированные документы (данные модели) хранятся в той же таблице, что и в модели searchable в столбце tsvector . Вам нужно создать этот столбец и индекс в вашей схеме. Вы можете выбрать между индексами GIN и GiST в PostgreSQL.
class CreatePostsTable extends Migration
{
public function up ()
{
Schema:: create ( ' posts ' , function ( Blueprint $ table ) {
$ table -> increments ( ' id ' );
$ table -> text ( ' title ' );
$ table -> text ( ' content ' )-> nullable ();
$ table -> integer ( ' user_id ' );
$ table -> timestamps ();
});
DB :: statement ( ' ALTER TABLE posts ADD searchable tsvector NULL ' );
DB :: statement ( ' CREATE INDEX posts_searchable_index ON posts USING GIN (searchable) ' );
// Or alternatively
// DB::statement('CREATE INDEX posts_searchable_index ON posts USING GIST (searchable)');
}
public function down ()
{
Schema:: drop ( ' posts ' );
}
}В дополнение к атрибутам модели вы можете принести другие другие данные в индексный документ. Т.е. список тегов для поста.
public function toSearchableArray ()
{
return [
' title ' => $ this -> title ,
' content ' => $ this -> content ,
' author ' => $ this -> user -> name ,
' tags ' => $ this -> tags -> pluck ( ' tag ' )-> implode ( ' ' ),
];
} Вы можете точно настроить поведение двигателя для конкретной модели, внедряя searchableOptions() в вашей модели.
class Post extends Model
{
use Searchable;
// ...
public function searchableOptions ()
{
return [
// You may wish to change the default name of the column
// that holds parsed documents
' column ' => ' indexable ' ,
// You may want to store the index outside of the Model table
// In that case let the engine know by setting this parameter to true.
' external ' => true ,
// If you don't want scout to maintain the index for you
// You can turn it off either for a Model or globally
' maintain_index ' => true ,
// Ranking groups that will be assigned to fields
// when document is being parsed.
// Available groups: A, B, C and D.
' rank ' => [
' fields ' => [
' title ' => ' A ' ,
' content ' => ' B ' ,
' author ' => ' D ' ,
' tags ' => ' C ' ,
],
// Ranking weights for searches.
// [D-weight, C-weight, B-weight, A-weight].
// Default [0.1, 0.2, 0.4, 1.0].
' weights ' => [ 0.1 , 0.2 , 0.4 , 1.0 ],
// Ranking function [ts_rank | ts_rank_cd]. Default ts_rank.
' function ' => ' ts_rank_cd ' ,
// Normalization index. Default 0.
' normalization ' => 32 ,
],
// You can explicitly specify a PostgreSQL text search configuration for the model.
// Use dF in psql to see all available configurationsin your database.
' config ' => ' simple ' ,
];
}
}
. . . Если вы решите сохранить индекс вашей модели за пределами таблицы модели, вы можете сообщить Engine, что вы хотите протолкнуть дополнительные поля в таблице индексов, которые вы можете затем использовать для фильтрации результата, применяя, where() со строительным Builder . В этом случае вам нужно будет реализовать searchableAdditionalArray() в вашей модели. Конечно, схема для внешней таблицы должна включать эти дополнительные столбцы.
public function searchableAdditionalArray ()
{
return [
' user_id ' => $ this -> user_id ,
];
}Вы можете скрыть свой столбец, который можно найти, чтобы он не стоял на вашем пути
protected $ hidden = [
' searchable ' ,
]; // plainto_tsquery()
$ posts = App Post:: search ( ' cat rat ' )
-> usingPlainQuery ()->get()
// phraseto_tsquery()
$ posts = App Post:: search ( ' cat rat ' )
-> usingPhraseQuery ()->get()
// to_tsquery()
$ posts = App Post:: search ( ' fat & (cat | rat) ' )
-> usingTsQuery ()->get()
// websearch_to_tsquery()
// uses web search syntax
$ posts = App Post:: search ( ' "sad cat" or "fat rat" -mouse ' )
-> usingWebSearchQuery ()->get()
// DIY using a callback
use ScoutEngines Postgres TsQuery ToTsQuery ;
$ results = App Post:: search ( ' fat & (cat | rat) ' , function ( $ builder , $ config ) {
return new ToTsQuery ( $ builder -> query , $ config );
})-> get ();Пожалуйста, посмотрите официальную документацию о том, как использовать Laravel Scout.
composer test Если вы обнаружите какие -либо проблемы, связанные с безопасностью, пожалуйста, напишите [email protected] вместо использования трекера выпуска.
Пожалуйста, смотрите ChangeLog для получения дополнительной информации, что изменилось в последнее время.
Пожалуйста, смотрите для получения подробной информации.
Лицензия MIT (MIT). Пожалуйста, смотрите файл лицензии для получения дополнительной информации.
