All notable changes to this laravel-elasticsearch package will be documented in this file.
This release is compatible with Laravel 11, 12 & 13, and with Elasticsearch 8 & 9
- Elasticsearch 9 support - the full suite runs green against ES 8.18 and 9.5, and CI now tests
both on every push. No code changes were needed: the
^8.17client talks to both server lines. ElasticCollection::hasQueryMeta()- whether a collection carries the meta of the query that built it. False for the collections Eloquent builds on its own:newCollection(),hydrate(), and anything derived throughmap(),filter()orvalues().
cursor()returns aLazyCollection- matching Laravel's own builders, socursor()->chunk(),->map()and->filter()work instead of fataling withCall to undefined method Generator::chunk(). Found and fixed by @BobbyBorisov in laravel-opensearch#28cursor()crashed on a fresh connection -Processor::getRawResponse()dereferenced null when a cursor was the first query on its connection (Call to a member function asArray() on null)paginate()lost its query meta when nothing matched - Laravel skips the query entirely once the count comes back as zero, so an empty page arrived as a bare collection andgetQueryMeta()on it threwMethod Illuminate\Database\Eloquent\Collection::getQueryMeta does not exist. The count query's meta is now carried onto the empty page:getTotalHits()reports0, and it still honourswithTrackTotalHits()for indices past the 10k window- Meta getters fataled on collections Eloquent built itself -
ElasticCollection::$metawas a typed property that nothing initialised, sogetQueryMeta(),getTook(),getDsl()and the rest threwTyped property ElasticCollection::$meta must not be accessed before initializationon any collection that did not come from a query. They now fall back to an emptyQueryMeta, which reports its unknowns as-1. Note that nullsafe could not guard this: the error came from the property access, so$collection?->getQueryMeta()fataled too Query\Builder::get()could hand a nullMetaDTOtosetQueryMeta()- it read the$metaTransferproperty directly instead of the accessor that initialises it
cursor()returnsLazyCollectioninstead ofGenerator.foreachis unaffected; anything type-hintingGeneratororIteratorneeds updating- A cursor is re-iterable - a second pass opens a fresh scroll instead of throwing
Cannot rewind a generator Query\Builder::getMetaTransfer()(internal) returnsMetaDTOinstead of?MetaDTO- it initialises on demand and never actually returned null
Laravel 11 notice: three advisories now cover the whole 11.x branch with no 11.x release that clears them, and Composer 2.9+ blocks advisory-affected versions while resolving. On Laravel 11,
composer requireandcomposer updatewill refuse to install anything, this package included.composer installfrom a lock file still works.composer config policy.advisories.block falselifts it; upgrading to 12 or 13 is the real fix.
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.7.0...v5.7.1
This release is compatible with Laravel 11, 12 & 13
whereNestedFieldExists($path)(docs) - explicit, zero-overhead check for "this nested path has at least one document." Emits the idiomaticnested + existsform directly, no closure required. Variants:whereNotNestedFieldExists,orWhereNestedFieldExists,orWhereNotNestedFieldExists.whereFieldExists($field)(docs) - properly named alias for the Elasticsearchexistsquery. Variants:whereNotFieldExists,orWhereFieldExists,orWhereNotFieldExists.nestedQuery($column)(docs) - returns a pre-configured Builder you can build up across conditionals and functions, then pass straight towhereNestedObject(). The closure form still works for simple cases; this is the escape hatch for programmatic composition.whereNestedObject()now accepts a pre-built Builder (fromnestedQuery()) in addition to a Closure or raw DSL string. Invalid input now throwsBuilderExceptioninstead of silently being stored.
- Exists queries on nested-mapped fields auto-wrap in
nested(docs) -whereFieldExists('comments.country'),whereNotNull('comments.country'), andwhereNull('comments.country')now emit the idiomaticnested { path: comments, query: { exists: ... } }form when the target field lives under a nested path. Detection only fires for dotted field names - bare-field calls (whereNotNull('title')) pay no overhead. - IDE/PHPDoc improvements -
find,first,firstOrCreatenow returnstatic(not the abstract baseModel), so subclass property hints resolve correctly. Collection-returning methods (get,rawSearch,distinct,bulkDistinct) annotated asarray<int, static>soforeachtyping works in PhpStorm.ElasticCollectiontemplate hygiene tightened (FQN parent in@extends, dropped name-collidinguse Model as TModelalias).
whereTermExistsfamily - replaced bywhereFieldExists. TheTermprefix was historical (the underlying ES query isn't term-related) and the old name avoided collision with Laravel's basewhereExists(Closure). Old methods still work; will be removed in v6:whereTermExists→whereFieldExistswhereNotTermExists→whereNotFieldExistsorWhereTermExists→orWhereFieldExistsorWhereNotTermsExists→orWhereNotFieldExists(also fixes the typo'd plural "Terms")
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.6.1...v5.7.0
Future-proofing note: After GitHub incorrectly shadow-banned my account (since reinstated with no explanation beyond "it shouldn't happen again"), all packages are now mirrored to GitLab. GitHub remains the home for issues, PRs, and community collaboration, but Packagist downloads exclusively from GitLab to ensure uninterrupted access to releases regardless of GitHub's actions.
This release is compatible with Laravel 11, 12 & 13
- Laravel 13.3 compatibility -
newCollection()override on base Model to preventHasCollectiontrait from attempting to instantiate the abstract parent class (Cannot instantiate abstract classerror introduced in Laravel 13.3's newresolveCollectionFromAttributegrandchild resolution) - QueryException crash on
Undefined array key "error"when Elasticsearch returns responses without the expectederror.typestructure (e.g. malformed or non-standard error payloads)
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.6.0...v5.6.1
This release is compatible with Laravel 11, 12 & 13
- Laravel 13 support
- Symfony 8 support (via Laravel 13)
- Composer test scripts for per-version testing:
composer test:l11,composer test:l12,composer test:l13,composer test:all
- Dropped Laravel 10 support (EOL)
pdphilip/omnitermbumped to^3.0Connection::select()signature updated with$fetchUsingparameter (Laravel 13 compatibility)- CI matrix updated: PHP 8.3/8.4, Laravel 11/12/13
- Collapsed Laravel version compatibility layer from 12 files (4 dispatchers + 4 v11 traits + 4 v12 traits) into 4 self-contained traits. Version checks now happen inside each method with spread operators for different constructor
signatures - no more file-level conditional trait loading. Removed phpstan bootstrap
class_aliashacks that were needed for the old pattern.
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.5.3...v5.6.0
distinct(),bulkDistinct(), andgroupBy()now work on nested fields (e.g.,distinct('tags.key', true)). Previously these returned empty results because the compiled DSL lacked the requirednestedaggregation wrapper. The package now auto-detects nested mappings and wraps aggregations accordingly - no changes needed in userland code.- When
whereNestedObject()is combined withdistinct()on the same nested path, the nested filter is injected inside the aggregation context so that only matching sub-documents are aggregated.
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.5.2...v5.5.3
elastic:re-indexmapping analysis now includes settings for analyzers, tokenizers, char filters, filters, and normalizers.
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.5.1...v5.5.2
Schema::compileMapping()- compile a Blueprint callback into its resulting ES mapping structure without creating the index. Useful for debugging and previewing whatmappingDefinition()will produce.Grammar::compileMapping()- public access to the Blueprint-to-properties compilation pipeline.
elastic:re-indexnow correctly detects nested field mappings (e.g.,nested('tags')->properties(...)) including their sub-fields and keyword sub-field changes.
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.5.0...v5.5.1
This release is compatible with Laravel 10, 11 & 12
New elastic:re-index command that automates the entire re-indexing process when your field mappings change. Pass a model name and the command handles the rest - creating a temp index, copying data, verifying counts, swapping, and cleaning
up across 9 interactive phases with confirmation prompts between each step. - Docs
php artisan elastic:re-index UserLog
php artisan elastic:re-index "App\Models\ES\UserLog"Features include:
- Smart mapping analysis that detects type mismatches and sub-field changes (e.g., adding
hasKeyword: true) - Resume capability - interrupted runs pick up where they left off
- Configurable tolerance and retry settings
--forceflag to skip all confirmation prompts
New elastic:make command to scaffold Elasticsearch models with the correct base class, connection, and a starter mappingDefinition(). - Docs
php artisan elastic:make UserLog
php artisan elastic:make ES/UserLogDefine your index field mappings directly on the model by overriding mappingDefinition(). Uses the same Blueprint syntax as migrations. Powers the elastic:re-index command's mapping
analysis. - Docs
public static function mappingDefinition(Blueprint $index): void
{
$index->keyword('status');
$index->text('title', hasKeyword: true);
$index->geoPoint('location');
}All five Artisan commands (elastic:status, elastic:indices, elastic:show, elastic:make, elastic:re-index) are now documented on a dedicated page. - Docs
whereNestedObject()andfilterNested()no longer leakparentFieldinto the parent query builder. The nested path was being set on$thisinstead of the sub-query, causing it to persist across subsequent queries on the same builder.
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.4.1...v5.5.0
_idno longer leaks into serialized output (toArray(),toJson()). The internal_idmetadata field was being exposed alongsideid, resulting in duplicate ID fields in model serialization.
This release is compatible with Laravel 10, 11 & 12
When a model queries an index that doesn't exist yet, the index is created automatically instead of throwing index_not_found_exception. Matches Elasticsearch's own auto-create behavior for writes, extended to reads.
// No migration needed - index is created on first query
$products = Product::where('status', 'active')->get(); // returns empty collectionControlled via options.auto_create_index config (default: true). - Docs
Why: New models shouldn't crash before the first write. Elasticsearch already auto-creates on insert; this extends the same behavior to reads.
First-class CLI tools for managing your Elasticsearch connection and indices:
php artisan elastic:status- Connection health check with cluster info and license detailsphp artisan elastic:indices- List all indices with health, doc count, and store sizephp artisan elastic:show {index}- Inspect an index: overview, mappings, settings, and analysis config
php artisan elastic:status
php artisan elastic:indices --all
php artisan elastic:show productsAll commands support --connection= for non-default connections.
Why: Until now, inspecting your Elasticsearch setup meant leaving Laravel for curl or Kibana. These commands bring that visibility into Artisan where it belongs.
New upsert() method matching Laravel's native signature. Insert or update records by unique key in a single bulk operation. - Docs
Product::upsert(
[
['sku' => 'ABC', 'name' => 'Widget', 'price' => 10],
['sku' => 'DEF', 'name' => 'Gadget', 'price' => 20],
],
['sku'], // unique key
['name', 'price'] // columns to update if exists
);Supports single documents, batch operations, and composite unique keys.
Why: Elasticsearch has no native upsert-by-field. This queries for existing documents first, then issues a single bulk request mixing index and update actions.
New GeneratesTimeOrderedIds trait for sortable, chronologically-ordered IDs. 20 characters, URL-safe, lexicographic sort matches creation order across
processes. - Docs
use PDPhilip\Elasticsearch\Eloquent\GeneratesTimeOrderedIds;
class TrackingEvent extends Model
{
use GeneratesTimeOrderedIds;
}
$event->id; // "0B3kF5XRABCDE_fghijk"
$event->getRecordTimestamp(); // 1771160093773 (ms)
$event->getRecordDate(); // Carbon instanceSafe for mixed datasets; returns null for pre-existing IDs not generated by this trait.
Why: When you need IDs that sort chronologically across multiple processes/workers, ideal for high-volume event tracking and time-sequenced analytics.
- Refactored Query Builder into focused concerns:
BuildsAggregations,BuildsSearchQueries,BuildsFieldQueries,BuildsGeoQueries,BuildsNestedQueries,HandlesScripts,ManagesPit - Refactored Grammar into concerns:
CompilesAggregations,CompilesOrders,CompilesWheres,FieldUtilities - Decomposed
ElasticsearchModeltrait into focused traits for clarity - Consolidated ES PHP client usage into
ElasticClientwrapper - Consolidated metadata handling into single
MetaDTO - Simplified
ManagesOptionsparameter inference - Extracted
addFieldQuery()dispatcher inBuildsFieldQueriesto deduplicate field query methods - Refactored Relations for readability: early returns, named variables, simplified loops
- Schema Builder: added
getIndexes(),getForeignKeys(),getViews()for Laravel compatibility - CI updated to Elasticsearch 8.18.0
- Test suite expanded from 379 to 422 tests (2,548 assertions), all passing
idis now always present in serialized model output (toArray(),toJson())_idis no longer exposed in serialized output (internal metadata stays internal)- Removed dead debug code from Connection.php
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.3.0...v5.4.0
This release is compatible with Laravel 10, 11 & 12
distinct() queries now return ElasticCollections;
If a model relation exists and the aggregation is done on the foreign key, you can load the related model
UserLog::where('created_at', '>=', Carbon::now()->subDays(30))
->with('user')
->orderByDesc('_count')
->select('user_id')
->distinct(true);
Why: You can now treat distinct aggregations like real Eloquent results, including relationships.
New query method bulkDistinct(array $fields, $includeDocCount = false) - Docs
Run multiple distinct aggregations in parallel within a single Elasticsearch query.
$top3 = UserSession::where('created_at', '>=', Carbon::now()->subDays(30))
->limit(3)
->bulkDistinct(['country', 'device', 'browser_name'], true);Why: Massive performance gains vs running sequential distinct queries.
groupByRanges() performs a range aggregation on the specified
field. - Docs
groupByRanges()->get() - return bucketed results - Docs
groupByRanges()->agg() - apply metric aggregations per bucket -Docs
groupByDateRanges() performs a date range aggregation on the specified
field. - Docs
groupByDateRanges()->get() - bucketed date ranges
groupByDateRanges()->agg() - metrics per date bucket
New model method getMetaValue($key) - Docs
Convenience method to get a specific meta value from the model instance.
$product = Product::where('color', 'green')->first();
$score = $product->getMetaValue('score');When a bucketed query is executed, the raw bucket data is now stored in model meta. -Docs
$products = Product::distinct('price');
$buckets = $products->map(function ($product) {
return $product->getMetaValue('bucket');
});Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.2.0...v5.3.0
This release is compatible with Laravel 10, 11 & 12
This release introduces Query String Queries, bringing full Elasticsearch query_string syntax support directly into your Eloquent-style queries.
- Method:
searchQueryString(query, $fields = null, $options = [])and related methods (orSearchQueryString,searchNotQueryString, etc.) - Supports all
query_stringfeatures - logical operators, wildcards, fuzziness, ranges, regex, boosting, field scoping, and more - Includes a dedicated
QueryStringOptionsclass for fluent option configuration or array-based parameters - See Tests
- Full documentation
Example:
Product::searchQueryString('status:(active OR pending) name:(full text search)^2')->get();
Product::searchQueryString('price:[5 TO 19}')->get();
// vanilla optional, +pizza required, -ice forbidden
Product::searchQueryString('vanilla +pizza -ice', function (QueryStringOptions $options) {
$options->type('cross_fields')->fuzziness(2);
})->get();
//etc
- You can now add an
unmapped_typeflag to your ordering query #88
Product::query()->orderBy('name', 'desc', ['unmapped_type' => 'keyword'])->get();
- Fixed issue where limit values were being reset on bucket aggregations #84
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.1.0...v5.2.0
This release is compatible with Laravel 10, 11 & 12
Appends the track_total_hits parameter to the DSL query, setting value to true will count all the hits embedded in the query meta not capping to Elasticsearch default of 10k hits
$products = Product::limit(5)->withTrackTotalHits(true)->get();
$totalHits = $products->getQueryMeta()->getTotalHits();
This can be set by default for all queries by updating the connection config in database.php:
'elasticsearch' => [
'driver' => 'elasticsearch',
.....
'options' => [
'track_total_hits' => env('ES_TRACK_TOTAL_HITS', null),
....
],
],
By default, when using create($attributes) where $attributes has an id that exists, the operation will upsert. createOrFail will throw a BulkInsertQueryException with status code 409 if the id exists
Product::createOrFail([
'id' => 'some-existing-id',
'name' => 'Blender',
'price' => 30,
]);
By default, inserting documents will wait for the shards to refresh, ie: withRefresh(true), you can set the refresh flag with the following (as per ES docs):
true(default) Refresh the relevant primary and replica shards (not the whole index) immediately after the operation occurs, so that the updated document appears in search results immediately.wait_forWait for the changes made by the request to be made visible by a refresh before replying. This doesn’t force an immediate refresh, rather, it waits for a refresh to happen.falseTake no refresh-related actions. The changes made by this request will be made visible at some point after the request returns.
Product::withRefresh('wait_for')->create([
'name' => 'Blender',
'price' => 30,
]);
- Add withTrackTotalHits method to Builder class to add track_total_hits by @caufab in #76
- feat(query): add op_type=create support and dedupe helpers by @abkrim in #79
- Laravel ^12.23 Compatibility - close #81
- @caufab made their first contribution in #76
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.0.7...v5.1.0
This release is compatible with Laravel 10, 11 & 12
- Connection bug fix by @pdphilip in #75 - close #70
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.0.6...v5.0.7
This release is compatible with Laravel 10, 11 & 12
- Bug fix: Chunking
$countvalue fixed for setting query limit correctly, via #68
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.0.5...v5.0.6
This release is compatible with Laravel 10, 11 & 12
- Merging in bug fixes by @use-the-fork in #65
- Updated outstanding tests
- Fixed bug in relations
has()method
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.0.4...v5.0.5
This release is compatible with Laravel 10, 11 & 12
- Connection
disconnect()resets connection - removing connection is unnecessary in the context of Elasticsearch. Issue #64 - Added
getTotalHits()helper method from query meta - Bug fix:
searchFuzzy()parses options as a closure - Minor code reorganising
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.0.3...v5.0.4
This release is compatible with Laravel 10, 11 & 12
- Bug fix: Internal model attribute
metarenamed to_metato avoid the issue where a model could have a field calledmeta - Bug fix:
highlight()passed without fields did not highlight all hits - Bug fix: Hybrid
BelongsToin some SQL cases used ES connection - Bug fix:
orderBy('_score')was not parsing correctly - Bug fix: Edge case where a string value was being seen as callable
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.0.2...v5.0.3
This release is compatible with Laravel 10, 11 & 12
bulkInsert() is identical to insert() but will continue on errors and return an array of the results.
People::bulkInsert([
[
'id' => '_edo3ZUBnJmuNNwymfhJ', // Will update (if id exists)
'name' => 'Jane Doe',
'status' => 1,
],
[
'name' => 'John Doe', // Will Create
'status' => 2,
],
[
'name' => 'John Dope',
'status' => 3,
'created_at' => 'xxxxxx', // Will fail
],
]);
Returns:
{
"hasErrors": true,
"total": 3,
"took": 0,
"success": 2,
"created": 1,
"modified": 1,
"failed": 1,
"errors": [
{
"id": "Y-dp3ZUBnJmuNNwy7vkF",
"type": "document_parsing_exception",
"reason": "[1:45] failed to parse field [created_at] of type [date] in document with id 'Y-dp3ZUBnJmuNNwy7vkF'. Preview of field's value: 'xxxxxx'"
}
]
}
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.0.1...v5.0.2
This release is compatible with Laravel 10, 11 & 12
- Updated model docs for comprehensive IDE support when building queries
- Added
orderByNestedDesc() - Removed & replaced compatibility-loader that depended on
class_aliasto set the correct traits for the given Laravel version
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.0.0...v5.0.1
We’re excited to announce v5 of the laravel-elasticsearch package - compatible with Laravel 10, 11, and 12.
V5 is the brainchild of @use-the-fork and is a near-complete rewrite of the package; packed with powerful new features, deep integration with Elasticsearch’s full capabilities, and a much tighter alignment with Laravel’s Eloquent. It lays a solid, future-proof foundation for everything that comes next.
-
Please take a look at the upgrade guide carefully, as there are several significant breaking changes.
"pdphilip/elasticsearch": "^5",
- Index Prefix Handling
The
ES_INDEX_PREFIXno longer auto-appends an underscore (_). Old behavior:ES_INDEX_PREFIX=my_prefix→my_prefix_New: set explicitly if needed →ES_INDEX_PREFIX=my_prefix_
-
Model ID Field
$model->_idis deprecated. Use$model->idinstead. If your model had a separateidfield, you must rename it. -
Default Limit Constant
MAX_SIZEconstant is removed. Use$defaultLimitproperty:use PDPhilip\Elasticsearch\Eloquent\Model; class Product extends Model { protected $defaultLimit = 10000; protected $connection = 'elasticsearch'; }
-
where()Behavior ChangedNow uses term query instead of match.
// Old: Product::where('name', 'John')->get(); // match query // New: Product::whereMatch('name', 'John')->get(); // match query Product::where('name', 'John')->get(); // term query
-
orderByRandom()RemovedReplace with
functionScore()Docs -
Full-text Search Options Updated Methods like
asFuzzy(),setMinShouldMatch(),setBoost()removed. Use callback-based SearchOptions instead:Product::searchTerm('espresso time', function (SearchOptions $options) { $options->searchFuzzy(); $options->boost(2); $options->minimumShouldMatch(2); })->get();
-
Legacy Search Methods Removed All
{xx}->search()methods been removed. Use{multi_match}->get()instead.
-
distinct()andgroupBy()behavior updated. DocsReview queries using them and refactor accordingly.
-
IndexBlueprintandAnalyzerBlueprinthas been removed and replaced with a singleBlueprintclass- use PDPhilip\Elasticsearch\Schema\IndexBlueprint; - use PDPhilip\Elasticsearch\Schema\AnalyzerBlueprint; use PDPhilip\Elasticsearch\Schema\Blueprint;
-
Schema::hasIndexhas been removed. UseSchema::hasTableorSchema::indexExistsinstead. -
geo($field)field property has been replaced withgeoPoint($field) -
{field}->index($bool)field property has been replaced with{field}->indexField($bool); -
alias()field type has been removed. UsealiasField()instead. -
settings()method has been replaced withwithSetting() -
map()method has been replaced withwithMapping() -
analyzer()method has been replaced withaddAnalyzer() -
tokenizer()method has been replaced withaddTokenizer() -
charFilter()method has been replaced withaddCharFilter() -
filter()method has been replaced withaddFilter()
- Dynamic indices are now managed by the
DynamicIndextrait. upgrade guide
- You can now generate Elasticsearch ids in Laravel Docs
- All clauses in the query builder now accept an optional callback of Elasticsearch options to be applied to the clause. Docs
- Belongs to many relationships are now supported. Docs
- Boxplot Aggregations Docs
- Stats Aggregations Docs
- Extended Stats Aggregations - Docs
- Cardinality Aggregations - Docs
- Median Absolute Deviation Aggregations - Docs
- Percentiles Aggregations - Docs
- String Stats Aggregations - Docs
- Normalizers can now be defined in migrations. Docs
Connection::on('elasticsearch')->elastic()->{clientMethod}();
Full Changelog: https://github.com/pdphilip/laravel-elasticsearch/compare/v4.5.3...v5.0.0