Releases: pdphilip/laravel-elasticsearch
Releases · pdphilip/laravel-elasticsearch
v4.1.0
V4.1.0 Release Notes
This release marks a version bump within the 4.x branch committed to Laravel 10 & 11 compatibility.
Acknowledgements
This release represents a significant advancement in the package's development, primarily driven by PR #32. Key improvements include:
- Comprehensive refactoring of the package
- Introduction of new features
- Extensive coverage with automated tests
- Enhanced compliance with coding standards and type-checking
A sincere thank you to @use-the-fork for their substantial contributions to this release. Their efforts have been instrumental in elevating the quality, reliability and maturity of this package.
Breaking Changes
There's only one breaking change:
$query->orderBy(string $column, string $direction = 'asc', string $mode = null, array $missing = '_last');
// Has been changed back to:
$query->orderBy(string $column, string $direction = 'asc');
// With a new method to add any ES sort parameter to a given column:
$query->withSort(string $col, string $key, mixed $value);- This also applies to
orderByDesc
Examples
$products = Product::orderBy('color.keyword', 'desc', null, '_first')->get();
// Is now:
$products = Product::orderBy('color.keyword', 'desc')->withSort('color.keyword', 'missing', '_first')->get();And:
$products = Product::where('is_active', true)->orderBy('order_values', 'desc', 'avg')->get();
// Is now:
$products = Product::where('is_active', true)->orderBy('order_values', 'desc')->withSort('order_values', 'mode', 'avg')->get();This change is to future-proof for the outlier sorting options that ES offers, ex:
$products = Product::withSort('price', 'unmapped_type', 'long')->get();
$products = Product::withSort('price', 'ignore_unmapped', true')->get();Inspired by #36 via @ildar-developer
Refactor
- Automated tests
- PHPStan compliance
- PINT formatted
- Updated PHPDocs for better IDE support
New Features
1. Cursor Pagination
Given the default limitations of Elasticsearch to paginate beyond 10k records, cursor pagination allows you to paginate indefinitely using search_after given a sort map.
As is the case with core Laravel's cursorPaginate , you can only page next and prev
cursorPaginate($perPage, $columns, $cursorName, $cursor)Example:
Product::orderByDesc('orders')->orderByDesc('price')->cursorPaginate(50)->withQueryString();The accuracy of this method depends on the sort, as would be the case using ES directly. If no sort is provided, it will try to sort by created_at and updated_at if those mappings are found; otherwise, it will throw a MissingOrderException.
2. Bulk Import
insert($values, $returnData = null);
insertWithoutRefresh($values, $returnData = null);These methods use Elasticsearch's Bulk API under the hood, providing efficient ways to insert multiple documents at once.
If the $returnData parameter is null or false, it will return a summary as an array:
{
"success": true,
"timed_out": false,
"took": 7725,
"total": 100000,
"created": 100000,
"modified": 0,
"failed": 0
}Otherwise, it will return an ElasticCollection of all the inserted records.
Performance and Usage:
insert($values, $returnData = null)- Performs a bulk insert and waits for the index to refresh.
- Ensures that inserted documents are immediately available for search.
- Use this when you need the inserted data to be searchable right away.
- Slower than
insertWithoutRefreshbut provides immediate consistency.
insertWithoutRefresh($values, $returnData = null)- Executes bulk inserts without waiting for the index to refresh.
- Offers a significant speed boost compared to
insert(). - The speed increase is due to skipping the index refresh operation, which can be resource-intensive.
- Inserted records may not be immediately available for search
- Use this when you need to insert large amounts of data quickly and can tolerate a slight delay in searchability.
When to use each:
- Use
insert()when:- You need immediate searchability of inserted data.
- You're inserting smaller batches of data where the performance difference is negligible.
- In user-facing applications where real-time data availability is crucial.
- Use
insertWithoutRefresh()when:- You're performing large batch imports where speed is a priority.
- In background jobs or data migration scripts where immediate searchability isn't necessary.
- You can handle a delay between insertion and searchability in your application logic.
3. ElasticCollection
Queries that return collections (get(), search(), insert()) now return them as an ElasticCollection. ElasticCollection is the same as Laravel's Eloquent Collection but with the executed query's metadata embedded in it.
$fetch = Product::where('orders', '>', 100)->limit(50)->orderByDesc('price')->get();
$shards = $fetch->getShards(); // Shards info
$dsl = $fetch->getDsl(); // The full query DSL that was used
$total = $fetch->getTotal(); // Total records in the index if there were hits
$maxScore = $fetch->getMaxScore(); // Max score of the search
$took = $fetch->getTook(); // Time taken for the search in milliseconds
$meta = $fetch->getQueryMetaAsArray(); // All the metadata in an array
return $fetch; //gives your collection of results as alwaysBug fix
- Starting a new query before an existing one has been executed was causing the connection (and queries) to get mixed up. via #36
What's Changed
- Refract/cleanup - Added Test suite / formating etc. by @use-the-fork in #32
Full Changelog: v4.0.4...v4.1.0
Contributors
UseTheFork and ildar-developer
Assets 2
v4.0.4
This unified release includes updates for multiple Laravel versions:
Upgrades
sum(),avg(),min()andmax()can now process multiple fields in one call
Product::where('color','blue')->avg(['orders', 'price']);
//Previously required two separate calls:
Product::where('color','blue')->avg('orders');
Product::where('color','blue')->avg('price');rawSearch(array $bodyParams, bool $returnRaw = false)- a second bool parameter will return data as is (unsanitized) if set to
true
Product::rawSearch($body, true);Bug fixes
- rawAggregation with multiple aggregations now returns all aggs
- Fixed issue when saving fields where the data didn't change threw an error
Full Changelog: v4.0.3...v4.0.4
v4.0.3 - (Unified with v3.9.3 & v3.8.3)
This unified release includes updates for multiple Laravel versions:
New Features
wherePhrasePrefix($field, $phraseWithPrefix)
Method for looking up a specific sequence of words where the last word starts with a particular prefix
Person::wherePhrasePrefix('description', 'loves es')->get();
// returns: loves espresso, loves essays, loves eskimos, etcDocs: https://elasticsearch.pdphilip.com/es-specific#where-phrase-prefix
phrase($field)
Method for searching across multiple fields for a specific phrase (sequence of words in order)
Book::phrase('United States')->orPhrase('United Kingdom')->search();
// Search for books that contain either 'United States' or 'United Kingdom', phrases like 'United Emirates' will not be included.Docs: https://elasticsearch.pdphilip.com/full-text-search#phrase-search-phrase
agg(array $functions,$field)
Optimization method that allows you to call multiple aggregation functions on a single field in one call.
Available aggregation functions: count, avg, min, max, sum, matrix.
Product::where('is_active',true)->agg(['count','avg','min','max','sum'],'sales');https://elasticsearch.pdphilip.com/aggregation#grouped-aggregations
toDsl() (or toSql())
Returns the parsed DSL query from the query builder
Product::whereIn('color', ['red', 'green'])->orderByDesc('sales')->toDsl();Returns
{
"index": "products",
"body": {
"query": {
"terms": {
"color.keyword": [
"red",
"green"
]
}
},
"_source": [
"*"
],
"sort": [
{
"sales": {
"order": "desc"
}
}
]
}
}
Docs: https://elasticsearch.pdphilip.com/es-specific#to-dsl
Tests for new features: https://github.com/pdphilip/laravel-elasticsearch-tests/blob/main/tests/EloquentTests/Update24-01Test.php
Bug fixes
- unset _meta on save. by @use-the-fork in #30
- Now throws an explicit error when trying to use
BelongsToMany()which is not supported (but can be worked around easily)
Upgrades
- Fixed error tracking index for writing ES errors to a dedicated index
// database.php
'elasticsearch' => [
'driver' => 'elasticsearch',
//......
//......
//......
'error_log_index' => env('ES_ERROR_INDEX', false),
],- White space code clean-up
New Contributors
- @use-the-fork made their first contribution in #30
Full Changelog: v4.0.2...v4.0.3
Contributors
UseTheFork
Assets 2
v4.0.2
New Features
New numeric type mappings for IndexBlueprint
double($field)- A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.byte($field)- A signed 8-bit integer with a minimum value of -128 and a maximum value of 127.halfFloat($field)- A half-precision 16-bit IEEE 754 floating point number, restricted to finite values.scaledFloat($field, $scalingFactor = 100)- A floating point number that is backed by a long, scaled by a fixed double scaling factor.unsignedLong($field)- An unsigned 64-bit integer with a minimum value of 0 and a maximum value of 264-1.
Example:
Schema::create('my_index', function (IndexBlueprint $index) {
$index->double('some_field_a');
$index->byte('some_field_b');
$index->halfFloat('some_field_c');
$index->scaledFloat('some_field_d', 100);
$index->unsignedLong('some_field_e');
});Upgrades
- Upgraded Connection class to parse the config's connection name. This allows for multiple connections or if you define your connection in the database file something other than
elasticsearch
Example with multiple connections (database.php):
'elasticsearch' => [
'driver' => 'elasticsearch',
'auth_type' => env('ES_AUTH_TYPE', 'http'), //http, cloud or api
'hosts' => explode(',', env('ES_HOSTS', 'http://localhost:9200')),
'username' => env('ES_USERNAME', ''),
'password' => env('ES_PASSWORD', ''),
'cloud_id' => env('ES_CLOUD_ID', ''),
'api_id' => env('ES_API_ID', ''),
'api_key' => env('ES_API_KEY', ''),
'ssl_cert' => env('ES_SSL_CA', ''),
'ssl' => [
'cert' => env('ES_SSL_CERT', ''),
'cert_password' => env('ES_SSL_CERT_PASSWORD', ''),
'key' => env('ES_SSL_KEY', ''),
'key_password' => env('ES_SSL_KEY_PASSWORD', ''),
],
'index_prefix' => env('ES_INDEX_PREFIX', false),
'options' => [
'allow_id_sort' => env('ES_OPT_ID_SORTABLE', false),
'ssl_verification' => env('ES_OPT_VERIFY_SSL', true),
'retires' => env('ES_OPT_RETRIES', null),
'meta_header' => env('ES_OPT_META_HEADERS', true),
],
'query_log' => [
'index' => false,
'error_only' => true,
],
],
'elasticsearch-cloud' => [
'driver' => 'elasticsearch',
'auth_type' => env('ES_CLOUD_AUTH_TYPE', 'http'), //http or cloud
'hosts' => explode(',', env('ES_CLOUD_HOSTS', 'http://localhost:9200')),
'username' => env('ES_CLOUD_USERNAME', ''),
'password' => env('ES_CLOUD_PASSWORD', ''),
'cloud_id' => env('ES_CLOUD_CLOUD_ID', ''),
'api_id' => env('ES_CLOUD_API_ID', ''),
'api_key' => env('ES_CLOUD_API_KEY', ''),
'ssl_cert' => env('ES_CLOUD_SSL_CA', ''),
'ssl' => [
'cert' => env('ES_CLOUD_SSL_CERT', ''),
'cert_password' => env('ES_CLOUD_SSL_CERT_PASSWORD', ''),
'key' => env('ES_CLOUD_SSL_KEY', ''),
'key_password' => env('ES_CLOUD_SSL_KEY_PASSWORD', ''),
],
'index_prefix' => env('ES_CLOUD_INDEX_PREFIX', false),
'options' => [
'allow_id_sort' => env('ES_CLOUD_OPT_ID_SORTABLE', false),
'ssl_verification' => env('ES_CLOUD_OPT_VERIFY_SSL', true),
'retires' => env('ES_CLOUD_OPT_RETRIES', null),
'meta_header' => env('ES_CLOUD_OPT_META_HEADERS', true),
],
'query_log' => [
'index' => false,
'error_only' => true,
],
],Examples of selecting connection:
Schema::on('elasticsearch-cloud')->create('my_index', ...... );
Product::on('elasticsearch-cloud')->get() //If $connection in Product model is not 'elasticsearch-cloud';New Contributors
Full Changelog: v4.0.1...v4.0.2
Contributors
danneker
Assets 2
v3.9.2
New Features
New numeric type mappings for IndexBlueprint
double($field)- A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.byte($field)- A signed 8-bit integer with a minimum value of -128 and a maximum value of 127.halfFloat($field)- A half-precision 16-bit IEEE 754 floating point number, restricted to finite values.scaledFloat($field, $scalingFactor = 100)- A floating point number that is backed by a long, scaled by a fixed double scaling factor.unsignedLong($field)- An unsigned 64-bit integer with a minimum value of 0 and a maximum value of 264-1.
Example:
Schema::create('my_index', function (IndexBlueprint $index) {
$index->double('some_field_a');
$index->byte('some_field_b');
$index->halfFloat('some_field_c');
$index->scaledFloat('some_field_d', 100);
$index->unsignedLong('some_field_e');
});Upgrades
- Upgraded Connection class to parse the config's connection name. This allows for multiple connections or if you define your connection in the database file something other than
elasticsearch
Example with multiple connections (database.php):
'elasticsearch' => [
'driver' => 'elasticsearch',
'auth_type' => env('ES_AUTH_TYPE', 'http'), //http, cloud or api
'hosts' => explode(',', env('ES_HOSTS', 'http://localhost:9200')),
'username' => env('ES_USERNAME', ''),
'password' => env('ES_PASSWORD', ''),
'cloud_id' => env('ES_CLOUD_ID', ''),
'api_id' => env('ES_API_ID', ''),
'api_key' => env('ES_API_KEY', ''),
'ssl_cert' => env('ES_SSL_CA', ''),
'ssl' => [
'cert' => env('ES_SSL_CERT', ''),
'cert_password' => env('ES_SSL_CERT_PASSWORD', ''),
'key' => env('ES_SSL_KEY', ''),
'key_password' => env('ES_SSL_KEY_PASSWORD', ''),
],
'index_prefix' => env('ES_INDEX_PREFIX', false),
'options' => [
'allow_id_sort' => env('ES_OPT_ID_SORTABLE', false),
'ssl_verification' => env('ES_OPT_VERIFY_SSL', true),
'retires' => env('ES_OPT_RETRIES', null),
'meta_header' => env('ES_OPT_META_HEADERS', true),
],
'query_log' => [
'index' => false,
'error_only' => true,
],
],
'elasticsearch-cloud' => [
'driver' => 'elasticsearch',
'auth_type' => env('ES_CLOUD_AUTH_TYPE', 'http'), //http or cloud
'hosts' => explode(',', env('ES_CLOUD_HOSTS', 'http://localhost:9200')),
'username' => env('ES_CLOUD_USERNAME', ''),
'password' => env('ES_CLOUD_PASSWORD', ''),
'cloud_id' => env('ES_CLOUD_CLOUD_ID', ''),
'api_id' => env('ES_CLOUD_API_ID', ''),
'api_key' => env('ES_CLOUD_API_KEY', ''),
'ssl_cert' => env('ES_CLOUD_SSL_CA', ''),
'ssl' => [
'cert' => env('ES_CLOUD_SSL_CERT', ''),
'cert_password' => env('ES_CLOUD_SSL_CERT_PASSWORD', ''),
'key' => env('ES_CLOUD_SSL_KEY', ''),
'key_password' => env('ES_CLOUD_SSL_KEY_PASSWORD', ''),
],
'index_prefix' => env('ES_CLOUD_INDEX_PREFIX', false),
'options' => [
'allow_id_sort' => env('ES_CLOUD_OPT_ID_SORTABLE', false),
'ssl_verification' => env('ES_CLOUD_OPT_VERIFY_SSL', true),
'retires' => env('ES_CLOUD_OPT_RETRIES', null),
'meta_header' => env('ES_CLOUD_OPT_META_HEADERS', true),
],
'query_log' => [
'index' => false,
'error_only' => true,
],
],Examples of selecting connection:
Schema::on('elasticsearch-cloud')->create('my_index', ...... );
Product::on('elasticsearch-cloud')->get() //If $connection in Product model is not 'elasticsearch-cloud';v3.8.2
New Features
New numeric type mappings for IndexBlueprint
double($field)- A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.byte($field)- A signed 8-bit integer with a minimum value of -128 and a maximum value of 127.halfFloat($field)- A half-precision 16-bit IEEE 754 floating point number, restricted to finite values.scaledFloat($field, $scalingFactor = 100)- A floating point number that is backed by a long, scaled by a fixed double scaling factor.unsignedLong($field)- An unsigned 64-bit integer with a minimum value of 0 and a maximum value of 264-1.
Example:
Schema::create('my_index', function (IndexBlueprint $index) {
$index->double('some_field_a');
$index->byte('some_field_b');
$index->halfFloat('some_field_c');
$index->scaledFloat('some_field_d', 100);
$index->unsignedLong('some_field_e');
});Upgrades
- Upgraded Connection class to parse the config's connection name. This allows for multiple connections or if you define your connection in the database file something other than
elasticsearch
Example with multiple connections (database.php):
'elasticsearch' => [
'driver' => 'elasticsearch',
'auth_type' => env('ES_AUTH_TYPE', 'http'), //http, cloud or api
'hosts' => explode(',', env('ES_HOSTS', 'http://localhost:9200')),
'username' => env('ES_USERNAME', ''),
'password' => env('ES_PASSWORD', ''),
'cloud_id' => env('ES_CLOUD_ID', ''),
'api_id' => env('ES_API_ID', ''),
'api_key' => env('ES_API_KEY', ''),
'ssl_cert' => env('ES_SSL_CA', ''),
'ssl' => [
'cert' => env('ES_SSL_CERT', ''),
'cert_password' => env('ES_SSL_CERT_PASSWORD', ''),
'key' => env('ES_SSL_KEY', ''),
'key_password' => env('ES_SSL_KEY_PASSWORD', ''),
],
'index_prefix' => env('ES_INDEX_PREFIX', false),
'options' => [
'allow_id_sort' => env('ES_OPT_ID_SORTABLE', false),
'ssl_verification' => env('ES_OPT_VERIFY_SSL', true),
'retires' => env('ES_OPT_RETRIES', null),
'meta_header' => env('ES_OPT_META_HEADERS', true),
],
'query_log' => [
'index' => false,
'error_only' => true,
],
],
'elasticsearch-cloud' => [
'driver' => 'elasticsearch',
'auth_type' => env('ES_CLOUD_AUTH_TYPE', 'http'), //http or cloud
'hosts' => explode(',', env('ES_CLOUD_HOSTS', 'http://localhost:9200')),
'username' => env('ES_CLOUD_USERNAME', ''),
'password' => env('ES_CLOUD_PASSWORD', ''),
'cloud_id' => env('ES_CLOUD_CLOUD_ID', ''),
'api_id' => env('ES_CLOUD_API_ID', ''),
'api_key' => env('ES_CLOUD_API_KEY', ''),
'ssl_cert' => env('ES_CLOUD_SSL_CA', ''),
'ssl' => [
'cert' => env('ES_CLOUD_SSL_CERT', ''),
'cert_password' => env('ES_CLOUD_SSL_CERT_PASSWORD', ''),
'key' => env('ES_CLOUD_SSL_KEY', ''),
'key_password' => env('ES_CLOUD_SSL_KEY_PASSWORD', ''),
],
'index_prefix' => env('ES_CLOUD_INDEX_PREFIX', false),
'options' => [
'allow_id_sort' => env('ES_CLOUD_OPT_ID_SORTABLE', false),
'ssl_verification' => env('ES_CLOUD_OPT_VERIFY_SSL', true),
'retires' => env('ES_CLOUD_OPT_RETRIES', null),
'meta_header' => env('ES_CLOUD_OPT_META_HEADERS', true),
],
'query_log' => [
'index' => false,
'error_only' => true,
],
],Examples of selecting connection:
Schema::on('elasticsearch-cloud')->create('my_index', ...... );
Product::on('elasticsearch-cloud')->get() //If $connection in Product model is not 'elasticsearch-cloud';v4.0.1
Laravel 10 & 11
This Release is for both Laravel 10 and 11 users, require:
"pdphilip/elasticsearch": "^4.0"
New Features
highlight()- This package now dials into Elaticsearch's highlight feature - docswhereTimestamp()- convenience clause to help sanitize timestamp values - docs - issue #22rawAggregation()- similar torawSearch(), passing in aggregation DSL queries will be processed and formatted- docs - issue #24
Upgrades
- Improved error handling with readable messages and method for full data docs
- Chunking rebuilt around Elasticseach PIT (Point in time) API docs - issue #23
- Models have a built-in method for returning a query's metadata - docs
- Connection upgrades to allow more options
- Set Verify SSL
- Set Retries
- Set ES Meta headers override
- Sorting by
_iddisabled by default. The package will now remove any clauses that include_idsorting.
Update your databse.php to fit the new config features:
'elasticsearch' => [
'driver' => 'elasticsearch',
'auth_type' => env('ES_AUTH_TYPE', 'http'), //http or cloud
'hosts' => explode(',', env('ES_HOSTS', 'http://localhost:9200')),
'username' => env('ES_USERNAME', ''),
'password' => env('ES_PASSWORD', ''),
'cloud_id' => env('ES_CLOUD_ID', ''),
'api_id' => env('ES_API_ID', ''),
'api_key' => env('ES_API_KEY', ''),
'ssl_cert' => env('ES_SSL_CA', ''),
'ssl' => [
'cert' => env('ES_SSL_CERT', ''),
'cert_password' => env('ES_SSL_CERT_PASSWORD', ''),
'key' => env('ES_SSL_KEY', ''),
'key_password' => env('ES_SSL_KEY_PASSWORD', ''),
],
'index_prefix' => env('ES_INDEX_PREFIX', false),
'options' => [
'allow_id_sort' => env('ES_OPT_ID_SORTABLE', false),
'ssl_verification' => env('ES_OPT_VERIFY_SSL', true),
'retires' => env('ES_OPT_RETRIES', null),
'meta_header' => env('ES_OPT_META_HEADERS', true),
],
'query_log' => [
'index' => false, //Or provide a name for the logging index ex: 'laravel_query_logs'
'error_only' => true, //If false, then all queries are logged if the query_log index is set
],
],Bug fixes
- Failed calls trigger a connection rebuild to counter cached failed connections via job queues - issue #27
- Return type error for index_prefixes to allow for null
- Allow for API key in local connection config
Full Changelog: v3.11.0...v4.0.1
v3.9.1
Laravel 9 Users
New Features
highlight()- This package now dials into Elaticsearch's highlight feature - docswhereTimestamp()- convenience clause to help sanitize timestamp values - docsrawAggregation()- similar torawSearch(), passing in aggregation DSL queries will be processed and formatted- docs
Upgrades
- Improved error handling with readable messages and method for full data docs
- Chunking rebuilt around Elasticseach PIT (Point in time) API docs
- Models have a built-in method for returning a query's metadata - docs
- Connection upgrades to allow more options
- Set Verify SSL
- Set Retries
- Set ES Meta headers override
- Sorting by
_iddisabled by default. The package will now remove any clauses that include_idsorting.
Update your databse.php to fit the new config features:
'elasticsearch' => [
'driver' => 'elasticsearch',
'auth_type' => env('ES_AUTH_TYPE', 'http'), //http or cloud
'hosts' => explode(',', env('ES_HOSTS', 'http://localhost:9200')),
'username' => env('ES_USERNAME', ''),
'password' => env('ES_PASSWORD', ''),
'cloud_id' => env('ES_CLOUD_ID', ''),
'api_id' => env('ES_API_ID', ''),
'api_key' => env('ES_API_KEY', ''),
'ssl_cert' => env('ES_SSL_CA', ''),
'ssl' => [
'cert' => env('ES_SSL_CERT', ''),
'cert_password' => env('ES_SSL_CERT_PASSWORD', ''),
'key' => env('ES_SSL_KEY', ''),
'key_password' => env('ES_SSL_KEY_PASSWORD', ''),
],
'index_prefix' => env('ES_INDEX_PREFIX', false),
'options' => [
'allow_id_sort' => env('ES_OPT_ID_SORTABLE', false),
'ssl_verification' => env('ES_OPT_VERIFY_SSL', true),
'retires' => env('ES_OPT_RETRIES', null),
'meta_header' => env('ES_OPT_META_HEADERS', true),
],
'query_log' => [
'index' => false, //Or provide a name for the logging index ex: 'laravel_query_logs'
'error_only' => true, //If false, then all queries are logged if the query_log index is set
],
],Full Changelog: v3.9.0...v3.9.1
v3.8.1
Laravel 8 Users
New Features
highlight()- This package now dials into Elaticsearch's highlight feature - docswhereTimestamp()- convenience clause to help sanitize timestamp values - docsrawAggregation()- similar torawSearch(), passing in aggregation DSL queries will be processed and formatted- docs
Upgrades
- Improved error handling with readable messages and method for full data docs
- Chunking rebuilt around Elasticseach PIT (Point in time) API docs
- Models have a built-in method for returning a query's metadata - docs
- Connection upgrades to allow more options
- Set Verify SSL
- Set Retries
- Set ES Meta headers override
- Sorting by
_iddisabled by default. The package will now remove any clauses that include_idsorting.
Update your databse.php to fit the new config features:
'elasticsearch' => [
'driver' => 'elasticsearch',
'auth_type' => env('ES_AUTH_TYPE', 'http'), //http or cloud
'hosts' => explode(',', env('ES_HOSTS', 'http://localhost:9200')),
'username' => env('ES_USERNAME', ''),
'password' => env('ES_PASSWORD', ''),
'cloud_id' => env('ES_CLOUD_ID', ''),
'api_id' => env('ES_API_ID', ''),
'api_key' => env('ES_API_KEY', ''),
'ssl_cert' => env('ES_SSL_CA', ''),
'ssl' => [
'cert' => env('ES_SSL_CERT', ''),
'cert_password' => env('ES_SSL_CERT_PASSWORD', ''),
'key' => env('ES_SSL_KEY', ''),
'key_password' => env('ES_SSL_KEY_PASSWORD', ''),
],
'index_prefix' => env('ES_INDEX_PREFIX', false),
'options' => [
'allow_id_sort' => env('ES_OPT_ID_SORTABLE', false),
'ssl_verification' => env('ES_OPT_VERIFY_SSL', true),
'retires' => env('ES_OPT_RETRIES', null),
'meta_header' => env('ES_OPT_META_HEADERS', true),
],
'query_log' => [
'index' => false, //Or provide a name for the logging index ex: 'laravel_query_logs'
'error_only' => true, //If false, then all queries are logged if the query_log index is set
],
],Full Changelog: v3.8.0...v3.8.1
v3.11.0
Version 3
This major version brings a host of powerful enhancements and a significant architectural overhaul to the core query engine, transforming the way Elasticsearch queries are integrated and executed within Laravel applications.
Highlights:
Documentation
Given the expansion of this package, the documentation has moved to a dedicated site.
Core Engine Overhaul:
The centerpiece of this update, the query engine, has been completely rebuilt. This transformation shifts away from reliance on query strings to a direct integration with Elasticsearch's DSL (Domain Specific Language), unlocking a broader range of querying capabilities and a more profound integration with Elasticsearch's advanced features.
Nested Queries and Sorting:
- Nested Object Queries: Deep dive into your nested data structures with comprehensive querying support.
- Order By Nested: Enhanced sorting capabilities allow you to order search results based on fields within nested objects.
- Filter Nested Values: Apply query filters to nested data elements returning the desired matches for the data in a nested field.
New where type clauses:
- Phrase Matching: Boost your search precision with enhanced phrase matching, enabling the targeting of exact sequences within text fields.
- Exact Matching: Strengthen your search with improved exact matching capabilities, ensuring only documents that exactly match specified criteria are retrieved.
Sorting Enhancements:
- Advanced Sorting Features: Leverage Elasticsearch's native sorting features, including various sorting modes and handling of missing values.
- Geo-Distance Sorting: Sort data with geographical considerations, enabling spatially-aware application features.
Saving Enhancements:
- First Or Create: Streamline data existence checks and creation in one go, optimizing data management workflows.
- First Or Create without Refresh: Enhance performance for non-critical operations by skipping the immediate refresh. #19
Grouped Queries: Build complex queries more intuitively with the new grouped query functionality, allowing for nested conditionals within a single, organized query block.
Future-Ready Architecture
Version 3 not only enhances current functionalities but also lays a solid foundation for future expansion, especially in adopting more Elasticsearch-specific features. As Elasticsearch continues to evolve, this package is designed to adapt and incorporate new capabilities, ensuring that Laravel developers have access to the forefront of search technology.