Merge branch 'main' into 5.x

Author: pdphilip

CHANGELOG.md

@@ -2,6 +2,77 @@
 
 All notable changes to this `laravel-elasticsearch` package will be documented in this file.
 
+## v5.1.0 - 2025-08-20
+
+This release is compatible with Laravel 10, 11 & 12
+
+#### 1. New feature, `withTrackTotalHits(bool|int|null $val = true)`
+
+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
+
+```php
+$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`:
+
+```php
+'elasticsearch' => [
+    'driver' => 'elasticsearch',
+    .....
+    'options' => [
+        'track_total_hits' => env('ES_TRACK_TOTAL_HITS', null),
+        ....
+    ],
+],
+
+```
+#### 2. New feature, `createOrFail(array $attributes)`
+
+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
+
+```php
+Product::createOrFail([
+    'id' => 'some-existing-id',
+    'name' => 'Blender',
+    'price' => 30,
+]);
+
+```
+#### 3. New feature `withRefresh(bool|string $refresh)`
+
+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_for`
+  Wait 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.
+- `false`
+  Take no refresh-related actions. The changes made by this request will be made visible at some point after the request returns.
+
+```php
+Product::withRefresh('wait_for')->create([
+    'name' => 'Blender',
+    'price' => 30,
+]);
+
+```
+### PRS
+
+* Add withTrackTotalHits method to Builder class to add track_total_hits by @caufab in https://github.com/pdphilip/laravel-elasticsearch/pull/76
+* feat(query): add op_type=create support and dedupe helpers by @abkrim in https://github.com/pdphilip/laravel-elasticsearch/pull/79
+
+### Bugfix
+
+* Laravel ^12.23 Compatibility - close [#81](https://github.com/pdphilip/laravel-elasticsearch/issues/81)
+
+### New Contributors
+
+* @caufab made their first contribution in https://github.com/pdphilip/laravel-elasticsearch/pull/76
+
+**Full Changelog**: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.0.7...v5.1.0
+
 ## v5.0.7 - 2025-07-13
 
 This release is compatible with Laravel 10, 11 & 12
@@ -93,6 +164,7 @@ People::bulkInsert([
 
 
 
+
 ```
 Returns:
 
@@ -117,6 +189,7 @@ Returns:
 
 
 
+
 ```
 #### 2. Bug fix: `distinct()` aggregation now appends `searchAfter` key in meta
 
@@ -156,6 +229,7 @@ with Laravel’s Eloquent. It lays a solid, future-proof foundation for everythi
 
 
 
+
 ```
 ### Breaking Changes
 
@@ -187,6 +261,7 @@ with Laravel’s Eloquent. It lays a solid, future-proof foundation for everythi
 
 
 
+  
   ```
 
 #### 3. Queries
@@ -205,6 +280,7 @@ with Laravel’s Eloquent. It lays a solid, future-proof foundation for everythi
 
 
 
+  
   ```
 - `orderByRandom()` Removed
 
@@ -224,6 +300,7 @@ with Laravel’s Eloquent. It lays a solid, future-proof foundation for everythi
 
 
 
+  
   ```
 - Legacy Search Methods Removed
   All `{xx}->search()` methods been removed. Use `{multi_match}->get()` instead.
@@ -248,6 +325,7 @@ with Laravel’s Eloquent. It lays a solid, future-proof foundation for everythi
 
 
 
+  
   ```
 - `Schema::hasIndex` has been removed. Use `Schema::hasTable` or `Schema::indexExists` instead.
 
@@ -316,6 +394,7 @@ Connection::on('elasticsearch')->elastic()->{clientMethod}();
 
 
 
+
 ```
 ### What's Changed