laravel lucene search
1.0.0
Pacote Laravel 5.5 para pesquisa de texto completo em modelos Eloquent baseados em ZendSearch Lucene.
Solicite este pacote em seu compositor.json e execute a atualização do compositor:
{
"require" : {
"nqxcode/laravel-lucene-search" : " 2.4.* "
}
} Após atualizar o compositor, adicione o ServiceProvider ao array de provedores em config/app.php
' providers ' => [
Nqxcode LuceneSearch ServiceProvider ::class,
], Se você quiser usar a fachada para pesquisar, adicione isto às suas fachadas em config/app.php :
' aliases ' => [
' Search ' => Nqxcode LuceneSearch Facade ::class,
],Publique o arquivo de configuração em seu projeto executando:
php artisan vendor:publish --provider= " NqxcodeLuceneSearchServiceProvider "No arquivo de configuração publicado, adicione descrições para modelos que precisam ser indexados, por exemplo:
' index ' => [
// ...
namespace FirstModel ::class => [
' fields ' => [
' name ' , ' full_description ' , // fields for indexing
]
],
namespace SecondModel ::class => [
' fields ' => [
' name ' , ' short_description ' , // fields for indexing
]
],
namespace ModelWithCustomPrimaryKey ::class => [
// You can also define your primary key (if you use something else than "id")
' primary_key ' => ' my_custom_field_name ' ,
' fields ' => [
' username ' , ' short_description ' , // fields for indexing
]
],
// ...
],Você também pode indexar valores de campos opcionais (campos dinâmicos). Para ativar a indexação para campos opcionais:
' optional_attributes ' => true
// or
' optional_attributes ' => [
' accessor ' => ' custom_name ' // with specifying of accessor name
]field-name => field-value . Por padrão, o acessador getOptionalAttributesAttribute será usado. Caso o nome do acessador especificado na configuração, o acessador getCustomNameAttribute será usado.Exemplo:
No arquivo de configuração:
namespace FirstModel ::class => [
' fields ' => [
' name ' , ' full_description ' , // fixed fields for indexing
],
' optional_attributes ' => true // enable indexing for dynamic fields
],No modelo adicione o seguinte acessador:
public function getOptionalAttributesAttribute ()
{
return [
' optional_attribute1 ' => ' value1 ' ,
' optional_attribute2 ' => ' value2 ' ,
];
}Veja detalhes sobre Apache Lucene - Pontuação.
Este é o aumento do nível do documento na terminologia do Apache Lucene. Por padrão, todos os modelos possuem valor de boost igual a 1 . Para alterar este comportamento personalize o boost para os modelos necessários como nos exemplos a seguir.
' boost ' => true
// or
' boost ' => [
' accessor ' => ' custom_name ' // with specifying of accessor name
]No modelo adicione o seguinte acessador:
public function getBoostAttribute ()
{
return 0.5 ; // customize boost value for model
}getBoostAttribute será usado. Caso o nome do acessador especificado na configuração, o acessador getCustomNameAttribute será usado.Exemplo:
No arquivo de configuração:
namespace FirstModel ::class => [
' fields ' => [
' name ' , ' full_description ' ,
],
' boost ' => true // enable boosting for model
],No modelo adicione o seguinte acessador:
public function getBoostAttribute ()
{
return 0.5 ; // customize boost value for model
}Este é o aumento do nível de campo do documento na terminologia do Apache Lucene. Por padrão, o aumento é definido como 1 para cada campo. Para alterar este comportamento configure boost para os campos necessários como nos exemplos a seguir.
No arquivo de configuração:
namespace FirstModel ::class => [
' fields ' => [
' name ' , // field with default boost
' full_description ' => [ ' boost ' => 0.2 ], // customize boost value
],
],Ou/e no acessador de modelo:
public function getOptionalAttributesAttribute ()
{
return [
' optional_attribute1 ' => ' value1 ' , // field with default boost
' optional_attribute2 ' => [ ' boost ' => 0.5 , ' value ' => ' value2 ' ], // customize boost value
];
}Por padrão, os seguintes filtros são usados na pesquisa:
Esses filtros podem ser excluídos ou substituídos por outros.
' analyzer ' => [
' filters ' => [
// Default stemming filter.
Nqxcode Stemming TokenFilterEnRu ::class,
],
// List of paths to files with stopwords.
' stopwords ' => Nqxcode LuceneSearch Analyzer Stopwords Files :: get (),
],Para construir o índice de pesquisa, execute:
php artisan search:rebuild --verbosePara limpar o índice de pesquisa, execute:
php artisan search:clear Para filtragem de modelos nos resultados da pesquisa, cada classe de modelo pode implementar SearchableInterface . Por exemplo:
use Illuminate Database Eloquent Model ;
use Nqxcode LuceneSearch Model SearchableInterface ;
class Dummy extends Model implements SearchableInterface
{
// ...
/**
* Get id list for all searchable models.
*/
public static function searchableIds ()
{
return self :: wherePublish ( true )-> pluck ( ' id ' );
}
// ...
} Para registro de eventos necessários (salvar/atualizar/excluir) use NqxcodeLuceneSearchModelSearchTrait no modelo alvo:
use Illuminate Database Eloquent Model ;
use Nqxcode LuceneSearch Model SearchableInterface ;
use Nqxcode LuceneSearch Model SearchTrait ;
class Dummy extends Model implements SearchableInterface
{
use SearchTrait ;
// ...
} Se você quiser evitar o acionamento da indexação, envolva as operações necessárias no método withoutSyncingToSearch() em seu modelo:
Product :: withoutSyncingToSearch ( function () {
// mass update position for product, e.g.
foreach ( Product :: all () as $ i => $ product ) {
$ product -> update ([ ' position ' => $ i )]);
}
});Crie uma consulta de várias maneiras:
Por padrão, são criadas consultas que executarão a pesquisa inteiramente na frase .
$ query = Search :: query ( ' clock ' ); // search by all fields.
// or
$ query = Search :: where ( ' name ' , ' clock ' ); // search by 'name' field.
// or
$ query = Search :: query ( ' clock ' ) // search by all fields with
-> where ( ' short_description ' , ' analog ' ); // filter by 'short_description' field.
// or
$ query = Product :: search ( ' clock ' ); // search only in `Product` model by all fields in case when `Product` use `SearchableTrait`. Para métodos query e where é possível definir as seguintes opções:
Encontre todos os modelos em que qualquer campo contém frases como 'composite one twophrase':
$ query = Search :: query ( ' composite phrase ' , ' * ' , [ ' proximity ' => 2 ]);Pesquise por cada palavra na consulta:
$ query = Search :: query ( ' composite phrase ' , ' * ' , [ ' phrase ' => false ]); $ query = Search :: rawQuery ( ' short_description:"analog" ' );
// or
$ rawQuery = QueryParser :: parse ( ' short_description:"analog" ' );
$ query = Search :: rawQuery ( $ rawQuery );Para consulta construída estão disponíveis as seguintes ações:
$ models = $ query -> get (); $ count = $ query -> count (); $ models = $ query -> limit ( 5 , 10 )-> get (); // Limit = 5 and offset = 10 $ paginator = $ query -> paginate ( 50 );O destaque de correspondências está disponível para qualquer fragmento HTML codificado em utf-8 e é executado apenas para a última solicitação executada.
Search :: find ( ' nearly all words must be highlighted ' )-> get ();
$ highlighted = Search :: highlight ( ' all words ' );
// highlighted html:
// '<span class="highlight">all</span> <span class="highlight">words</span>' Pacote licenciado sob a licença MIT.
