laravel lucene search
1.0.0
Paquete Laravel 5.5 para búsqueda de texto completo en modelos Eloquent basados en ZendSearch Lucene.
Solicite este paquete en su compositor.json y ejecute la actualización del compositor:
{
"require" : {
"nqxcode/laravel-lucene-search" : " 2.4.* "
}
} Después de actualizar Composer, agregue ServiceProvider a la matriz de proveedores en config/app.php
' providers ' => [
Nqxcode LuceneSearch ServiceProvider ::class,
], Si desea utilizar la fachada para buscar, agregue esto a sus fachadas en config/app.php :
' aliases ' => [
' Search ' => Nqxcode LuceneSearch Facade ::class,
],Publique el archivo de configuración en su proyecto ejecutando:
php artisan vendor:publish --provider= " NqxcodeLuceneSearchServiceProvider "En el archivo de configuración publicado, agregue descripciones de los modelos que deben indexarse, por ejemplo:
' 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
]
],
// ...
],También puede indexar valores de campos opcionales (campos dinámicos). Para habilitar la indexación de campos opcionales:
' optional_attributes ' => true
// or
' optional_attributes ' => [
' accessor ' => ' custom_name ' // with specifying of accessor name
]field-name => field-value . De forma predeterminada, se utilizará el descriptor de acceso getOptionalAttributesAttribute . En caso de que el nombre de acceso especificado en la configuración se utilice el acceso getCustomNameAttribute .Ejemplo:
En el archivo de configuración:
namespace FirstModel ::class => [
' fields ' => [
' name ' , ' full_description ' , // fixed fields for indexing
],
' optional_attributes ' => true // enable indexing for dynamic fields
],En el modelo agregue el siguiente descriptor de acceso:
public function getOptionalAttributesAttribute ()
{
return [
' optional_attribute1 ' => ' value1 ' ,
' optional_attribute2 ' => ' value2 ' ,
];
}Ver detalles sobre Apache Lucene - Puntuación.
Este es un aumento del nivel de documento en la terminología de Apache Lucene. Por defecto, todos los modelos tienen un valor de impulso igual a 1 . Para cambiar este comportamiento, personalice el impulso para los modelos necesarios como en los siguientes ejemplos.
' boost ' => true
// or
' boost ' => [
' accessor ' => ' custom_name ' // with specifying of accessor name
]En el modelo agregue el siguiente descriptor de acceso:
public function getBoostAttribute ()
{
return 0.5 ; // customize boost value for model
}getBoostAttribute . En caso de que se utilice el nombre de acceso especificado en la configuración, se utilizará el acceso getCustomNameAttribute .Ejemplo:
En el archivo de configuración:
namespace FirstModel ::class => [
' fields ' => [
' name ' , ' full_description ' ,
],
' boost ' => true // enable boosting for model
],En el modelo agregue el siguiente descriptor de acceso:
public function getBoostAttribute ()
{
return 0.5 ; // customize boost value for model
}Este es el nivel de campo del documento que mejora la terminología de Apache Lucene. De forma predeterminada, el impulso se establece en 1 para cada campo. Para cambiar este comportamiento, establezca un impulso para los campos necesarios como en los siguientes ejemplos.
En el archivo de configuración:
namespace FirstModel ::class => [
' fields ' => [
' name ' , // field with default boost
' full_description ' => [ ' boost ' => 0.2 ], // customize boost value
],
],O/y en el descriptor de acceso del modelo:
public function getOptionalAttributesAttribute ()
{
return [
' optional_attribute1 ' => ' value1 ' , // field with default boost
' optional_attribute2 ' => [ ' boost ' => 0.5 , ' value ' => ' value2 ' ], // customize boost value
];
}De forma predeterminada, se utilizan los siguientes filtros en la búsqueda:
Estos filtros se pueden eliminar o reemplazar por otros.
' analyzer ' => [
' filters ' => [
// Default stemming filter.
Nqxcode Stemming TokenFilterEnRu ::class,
],
// List of paths to files with stopwords.
' stopwords ' => Nqxcode LuceneSearch Analyzer Stopwords Files :: get (),
],Para crear un índice de búsqueda, ejecute:
php artisan search:rebuild --verbosePara borrar la ejecución del índice de búsqueda:
php artisan search:clear Para filtrar modelos en los resultados de búsqueda, la clase de cada modelo puede implementar SearchableInterface . Por ejemplo:
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 registrar los eventos necesarios (guardar/actualizar/eliminar), use NqxcodeLuceneSearchModelSearchTrait en el modelo de destino:
use Illuminate Database Eloquent Model ;
use Nqxcode LuceneSearch Model SearchableInterface ;
use Nqxcode LuceneSearch Model SearchTrait ;
class Dummy extends Model implements SearchableInterface
{
use SearchTrait ;
// ...
} Si desea evitar activar la indexación, incluya las operaciones necesarias en el método withoutSyncingToSearch() de su modelo:
Product :: withoutSyncingToSearch ( function () {
// mass update position for product, e.g.
foreach ( Product :: all () as $ i => $ product ) {
$ product -> update ([ ' position ' => $ i )]);
}
});Cree una consulta de varias maneras:
De forma predeterminada, se crean consultas que ejecutarán la búsqueda en la frase por completo .
$ 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 los métodos query y where es posible configurar las siguientes opciones:
Encuentre todos los modelos en los que algún campo contenga una frase como 'frase compuesta uno dos':
$ query = Search :: query ( ' composite phrase ' , ' * ' , [ ' proximity ' => 2 ]);Busque por cada palabra en 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 consultas construidas están disponibles las siguientes acciones:
$ models = $ query -> get (); $ count = $ query -> count (); $ models = $ query -> limit ( 5 , 10 )-> get (); // Limit = 5 and offset = 10 $ paginator = $ query -> paginate ( 50 );El resaltado de coincidencias está disponible para cualquier fragmento html codificado en utf-8 y se ejecuta solo para la última solicitud ejecutada.
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>' Paquete con licencia MIT.
