laravel scout postgres
7.3.0
이 패키지를 사용하면 Laravel Scout과 함께 기본 PostgreSQL 전문 검색 기능을 쉽게 사용할 수 있습니다.
이 패키지가 유용한 것을 발견하면 커피를 고려하십시오.
작곡가를 통해 패키지를 설치할 수 있습니다.
composer require pmatseykanets/laravel-scout-postgresLaravel <5.5를 사용하고 있거나 패키지 자동 발견이 꺼져있는 경우 서비스 제공 업체를 수동으로 등록해야합니다.
// config/app.php
' providers ' => [
...
ScoutEngines Postgres PostgresEngineServiceProvider::class,
], 스카우트 서비스 제공 업체는 루멘에 포함되지 않은 config_path 헬퍼를 사용합니다. 이 문제를 해결하려면 bootstrap.app 또는 자동로드 된 도우미 파일 IE 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 );
}
} 다음 내용이있는 app/config 폴더에서 scout.php 구성 파일 작성
<?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); Laravel Scout Configuration 파일 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 '
],
... 적절한 기본 텍스트 검색 구성이 특정 데이터베이스 ( ALTER DATABASE ... SET default_text_search_config TO ... )에 대해 GlobBaly ( postgresql.conf )로 설정되어 있는지 확인하거나 각 세션에서 default_text_search_config 설정하십시오.
현재 값을 확인합니다
SHOW default_text_search_config; 기본적으로 엔진은 구문 분석 된 문서 (모델 데이터)가 tsvector 유형 searchable 열의 모델과 동일한 테이블에 저장 될 것으로 예상합니다. 스키마 에서이 열과 색인을 만들어야합니다. PostgreSQL에서 GIN 과 GiST 인덱스 중에서 선택할 수 있습니다.
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 ' );
}
}Model의 속성 외에도 다른 모든 데이터를 인덱스 문서에 가져올 수 있습니다. 즉, 게시물에 대한 태그 목록.
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 ' ,
];
}
}
. . . 모델의 인덱스를 모델 테이블 외부에 유지하기로 결정한 경우 인덱스 테이블에서 추가 필드를 푸시하려는 엔진을 알릴 수 있으며 스카우트 Builder 로 where() 적용하여 결과 세트를 필터링하는 데 사용할 수 있습니다. 이 경우 모델에서 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). 자세한 내용은 라이센스 파일을 참조하십시오.
