Elasticsearch driver for Laravel Scout with the power of Elasticsearch's queries.
Via Composer
composer require hilsonxhero/laravel-elastic-vision
You will need the configuration file to define your indexes:
php artisan vendor:publish --tag=elasticvision-config
Also do not forget to follow the installation instructions for Laravel Scout,
and in your Laravel Scout config, set the driver to elastic
.
Be sure to also have a look at the docs to see what is possible!
You may either define the mapping for you index in the config file:
return [
'indexes' => [
'posts_index' => [
'properties' => [
'id' => 'keyword',
'title' => 'text',
],
]
]
];
Or you may define the model for the index, and the rest will be decided for you:
return [
'indexes' => [
\App\Models\Article::class
],
];
In the last case you may implement the Explored
interface and overwrite the mapping with the mappableAs()
function.
Essentially this means that it is up to you whether you like having it all together in the model, or separately in the config file.
- Quickstart
- Connection
- Mapping properties in Elasticsearch
- Sorting search results
- Pagination and search result size
- Debugging
- Testing
- Console commands
- Text analysis
- Preparing data
- Advanced queries
- Advanced index settings
- Index aliases
- Aggregations
The documentation of Laravel Scout states that "more advanced "where" clauses are not currently supported". Only a simple check for ID is possible besides the standard fuzzy term search:
$posts = Post::search('lorem ipsum')->get();
ElasticVision expands your possibilities using query builders to write more complex queries.
For example, to get all posts that:
- are published
- have "lorem" somewhere in the document
- have "ipsum" in the title
- maybe have a tag "featured", if so boost its score by 2
You could execute this search query:
$articles = Article::search('lorem')
->must(new Matching('title', 'ipsum'))
->should(new Terms('tags', ['featured'], 2))
->filter(new Term('published', true))
->get();
Be sure you have configured your indexes first in config/elasticvision.php
and run the Scout commands.