Elasticsearch Eloquent 2.x
This package allows you to interact with Elasticsearch as you interact with Eloquent models in Laravel.
Requirements
- PHP >= 8.0
- Elasticsearch >= 7.0
Install
Via Composer
$ composer require isswp101/elasticsearch-eloquent
Usage
Create a new model
You should override index and type properties to determine the document path.
use Isswp101\Persimmon\Models\BaseElasticsearchModel;
use Isswp101\Persimmon\Persistence\Persistence;
use Isswp101\Persimmon\Contracts\PersistenceContract;
class Product extends BaseElasticsearchModel
{
protected string $index = 'index';
protected string|null $type = 'type'; // optional
// If you have a pre-configured Elasticsearch client you can pass it here (optional)
public function createPersistence(): PersistenceContract
{
return new Persistence($client);
}
}
Use the static create() method to create the document in Elasticsearch:
$product = Product::create([
'id' => 1,
'name' => 'Product',
'price' => 10
]);
Save the model
$product = new Product();
$product->id = 1;
$product->name = 'Product';
$product->price = 10;
$product->save();
Use save() method to store model data in Elasticsearch. Let's see how this looks in Elasticsearch:
{
"_index": "index",
"_type": "type",
"_id": "1",
"_version": 1,
"_source": {
"id": 1,
"name": "Product",
"price": 10,
"created_at": "2021-03-27T11:24:15+00:00",
"updated_at": "2021-03-27T11:24:15+00:00"
}
}
Fields created_at and updated_at were created automatically.
Find existing model
$product = Product::find(1);
If you have big data in Elasticsearch you can specify certain fields to retrieve:
$product = Product::find(1, ['name']);
There are the following methods:
findOrFail()returnsModelNotFoundExceptionexception if no result found.
Cache
There is a smart model cache when you use methods like find(), findOrFail() and so on.
$product = Product::find(1, ['name']); // from elasticsearch
$product = Product::find(1, ['name']); // from cache
$product = Product::find(1, ['price']); // from elasticsearch
$product = Product::find(1, ['price']); // from cache
$product = Product::find(1, ['name']); // from cache
$product = Product::find(1); // from elasticsearch
$product = Product::find(1); // from cache
$product = Product::find(1, ['name']); // from cache
$product = Product::find(1, ['price']); // from cache
Partial update
You can use the partial update to update specific fields quickly.
$product = Product::find(1, ['name']);
$product->name = 'Name';
$product->save(['name']);
Delete models
$product = Product::find(1);
$product->delete();
You can use the static method:
Product::destroy(1);
Model events
Out of the box you are provided with a simple implementation of events.
You can override the following methods to define events:
saving()is called before saving, updating, creating the modelsaved()is called after saving, updating, creating the modeldeleting()is called before deleting the modeldeleted()is called after deleting the modelsearching()is called after searching modelssearched()is called after searching models
For example:
use Isswp101\Persimmon\Models\BaseElasticsearchModel;
class Product extends BaseElasticsearchModel
{
protected function saving(): bool
{
// Disable update if it's free
return $this->price <= 0;
}
protected function deleting(): bool
{
if ($this->user_id != 1) {
throw new DomainException('No permissions to delete this model');
}
return true;
}
}
Basic search
There are helpers to search documents:
The first($query) method returns the first document according to the query or null.
$product = Product::first($query);
The firstOrFail($query) method returns ModelNotFoundException exception if first($query) returns null.
$product = Product::firstOrFail($query);
The search($query) method returns documents according to the query.
$products = Product::search($query);
The all($query) method returns all documents (default 50 items per request) according to the query.
$products = Product::all($query);
If $query is not passed the query will be as match_all query.
Query Builder
Consider using these packages:
Testing
$ composer test
License
The MIT License (MIT).
720 Jan 3, 2023
1.3k Jan 4, 2023
996 Dec 28, 2022
88 Dec 27, 2022
25 Aug 31, 2022
592 Dec 25, 2022
2 Jan 14, 2022
1.5k Jan 7, 2023
3.6k Dec 30, 2022
1.2k Dec 22, 2022
690 Nov 27, 2022
955 Dec 25, 2022
1.3k Dec 31, 2022
67 Dec 7, 2022
100 Oct 16, 2022
40 Jun 5, 2022
25 Dec 14, 2022
2.2k Jan 9, 2023
28 Dec 18, 2022
2.2k Jan 3, 2023
6.3k Jan 5, 2023
1.1k Dec 20, 2022
49 Jan 4, 2023
5 Apr 21, 2022
17 Feb 12, 2022
111 Dec 19, 2022