Elasticsearch

https://elasticsearch.pdphilip.com
Admin
Elasticsearch is a Laravel package that seamlessly integrates Elasticsearch functionalities into...
Tokens:135,987
Snippets:1,306
Trust Score:5.4
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example Index Summary Data

Source: https://elasticsearch.pdphilip.com/schema/migrations

This is an example of the data structure returned when retrieving index summaries.

```json
...
{
    "name": "user_logs",
    "status": "open",
    "health": "yellow",
    "uuid": "UfLaQLcWSHSP_rVaWZuibA",
    "docs_count": "12554",
    "docs_deleted": "0",
    "store_size": "2.3mb"
},
...
```

--------------------------------

### Install Elasticsearch Package for Laravel 7.x

Source: https://elasticsearch.pdphilip.com/getting-started

Install the package version compatible with Laravel 7.x.

```bash
composer require pdphilip/elasticsearch:~2.7
```

--------------------------------

### Example Usage of Relationships

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Demonstrates how to retrieve and create relationships for User and Role models in an Elasticsearch context.

```php
// Returing relationships
$user = User::first();
$roles = $user->roles->toArray(); //Shows all roles (belongs to many)
$role = Role::first();
$users = $role->users->toArray(); //Shows all users (belongs to many)

// Creating relationships
$user = User::first();
$user->roles()->attach([$roleId1,$roleId2]); //Attach roles to a user
$user->roles()->create(['name' => 'Can sing']); //Create a role and attach to user
```

--------------------------------

### Example Usage: Retrieving Data Across Databases

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Illustrates retrieving data from both Elasticsearch and MySQL using Eloquent relationships. This example shows how to access related models and their properties.

```php
// Retrieve User and related Elasticsearch models
$user = User::first();
$userCompanyName = $user->company->name; //Company name for the user
$userTwitter = $user->userProfile->twitter;
$userAvatar = $user->avatar->url; //Link to Avatar
$userPhotos = $user->photos->toArray(); //Array of photos

// Retrieve UserLog and related MySQL User
$userLog = UserLog::first();
$userName = $userLog->user->name;

// Retrieve Company and related MySQL Users
$company = Company::first();
$companyUsers = $company->users->toArray(); //Array of users

```

--------------------------------

### Basic Search Query String

Source: https://elasticsearch.pdphilip.com/eloquent/query-string-queries

Perform a basic search using the `searchQueryString` method. This example searches for 'Eric' or a combination of 'Lean' and 'Startup'.

```php
Book::searchQueryString('Eric OR (Lean AND Startup)')->get();
```

```json
{
    "index": "books",
    "body": {
        "query": {
            "query_string": {
                "query": "Eric OR (Lean AND Startup)"
            }
        },
        "size": 1000
    }
}
```

--------------------------------

### Configure Elasticsearch Connection for Cloud

Source: https://elasticsearch.pdphilip.com/getting-started

Example .env configuration for connecting to Elasticsearch Cloud.

```dotenv
ES_AUTH_TYPE=cloud
ES_HOSTS="https://xxxxx-xxxxxx.es.europe-west1.gcp.cloud.es.io:9243"
ES_USERNAME=elastic
ES_PASSWORD=XXXXXXXXXXXXXXXXXXXX
ES_CLOUD_ID=XXXXX:ZXVyb3BlLXdl.........SQwYzM1YzU5ODI5MTE0NjQ3YmEyNDZlYWUzOGNkN2Q1Yg==
ES_API_ID=
ES_API_KEY=
ES_SSL_CA=
ES_INDEX_PREFIX=my_app_
ES_ERROR_INDEX=
```

--------------------------------

### Replace legacy search methods with get()

Source: https://elasticsearch.pdphilip.com/llms-full.txt

All legacy `{xx}->search()` methods have been removed. Use the `get()` method for executing search queries.

```php
-   Book::term('Eric')->orTerm('Lean')->andTerm('Startup')->search();
Book::searchTerm('Eric')->orSearchTerm('Lean')->searchTerm('Startup')->get();
```

```php
-   Book::phrase('United States')->orPhrase('United Kingdom')->search();
Book::searchPhrase('United States')->orSearchPhrase('United Kingdom')->get();
```

```php
-   $results = Book::term('Eric')->fields(['title', 'author', 'description'])->search();
Book::searchTerm('Eric',['title', 'author', 'description'])->get();
```

```php
-   $results = Book::fuzzyTerm('quikc')->orFuzzyTerm('brwn')->andFuzzyTerm('foks')->search();
Book::searchTerm('quikc',['fuzziness' => 'AUTO'])
    ->orSearchTerm('brwn',['fuzziness' => 'AUTO'])
    ->searchTerm('foks',['fuzziness' => 'AUTO'])
    ->get();
```

--------------------------------

### Example Bulk Distinct Results

Source: https://elasticsearch.pdphilip.com/llms-full.txt

This JSON displays example results from a bulk distinct query, showing unique values and their counts for 'country', 'device', and 'browser_name'.

```json
[
    {
        "country": "US",
        "country_count": 737
    },
    {
        "country": "ZA",
        "country_count": 148
    },
    {
        "country": "GB",
        "country_count": 105
    },
    {
        "device": "desktop",
        "device_count": 2287
    },
    {
        "device": "mobile",
        "device_count": 1574
    },
    {
        "device": "tablet",
        "device_count": 1139
    },
    {
        "browser_name": "Chrome",
        "browser_name_count": 1569
    },
    {
        "browser_name": "Safari",
        "browser_name_count": 1496
    },
    {
        "browser_name": "Firefox",
        "browser_name_count": 1139
    }
]
```

--------------------------------

### Install Elasticsearch Package for Laravel 10/11/12

Source: https://elasticsearch.pdphilip.com/getting-started

Install the package version compatible with Laravel 10/11/12.

```bash
composer require pdphilip/elasticsearch:~5.5
```

--------------------------------

### Get Models Matching Criteria

Source: https://elasticsearch.pdphilip.com/eloquent/querying-models

Use `get()` to retrieve all models that match the specified query criteria. This method returns a model collection.

```php
$product = Product::where('status',1)->get();
```

```json
{
   "index":"products",
   "body":{
      "query":{
         "match":{
            "status":1
         }
      },
      "_source":[
         "*"
      ]
   }
}
```

--------------------------------

### Install Elasticsearch Package for Laravel 8

Source: https://elasticsearch.pdphilip.com/getting-started

Install the package version compatible with Laravel 8.

```bash
composer require pdphilip/elasticsearch:~3.8
```

--------------------------------

### Elasticsearch Highlight Query with Basic Tags

Source: https://elasticsearch.pdphilip.com/eloquent/search-queries

An example Elasticsearch query body demonstrating highlighting with basic pre and post tags.

```json
{
    "index": "products",
    "body": {
        "query": {
            "multi_match": {
                "query": "and",
                "type": "best_fields"
            }
        },
        "highlight": {
            "pre_tags": "<em>",
            "post_tags": "</em>"
        },
        "size": 1000
    }
}

```

--------------------------------

### Example Usage of Many-to-Many Relationships

Source: https://elasticsearch.pdphilip.com/relationships/es-es

Demonstrates how to retrieve and create many-to-many relationships. Use `toArray()` to fetch relationship data and `attach()` or `create()` to manage associations.

```php
// Returing relationships
$user = User::first();
$roles = $user->roles->toArray(); //Shows all roles (belongs to many)
$role = Role::first();
$users = $role->users->toArray(); //Shows all users (belongs to many)


// Creating relationships
$user = User::first();
$user->roles()->attach([$roleId1,$roleId2]); //Attach roles to a user
$user->roles()->create(['name' => 'Can sing']); //Create a role and attach to user
```

--------------------------------

### Matrix Stats Aggregation Result Example

Source: https://elasticsearch.pdphilip.com/eloquent/aggregation

An example of the JSON output structure for a matrix aggregation on 'price' and 'orders' fields.

```json
{
    "matrix_stats_price": {
        "name": "price",
        "count": 80,
        "mean": 971.7610051512718,
        "variance": 319573.9412606584,
        "skewness": 0.09455383230430257,
        "kurtosis": 1.8069082807157395,
        "covariance": {
            "price": 319573.9412606584,
            "orders": 6096.144923266881
        },
        "correlation": {
            "price": 1,
            "orders": 0.14887562780257566
        }
    },
    "matrix_stats_orders": {
        "name": "orders",
        "count": 80,
        "mean": 120.7,
        "variance": 5246.769620253164,
        "skewness": -0.06873472971174674,
        "kurtosis": 1.8427347935190153,
        "covariance": {
            "price": 6096.144923266881,
            "orders": 5246.769620253164
        },
        "correlation": {
            "price": 0.14887562780257566,
            "orders": 1
        }
    }
}
```

--------------------------------

### Install Elasticsearch Package for Laravel 11/12/13

Source: https://elasticsearch.pdphilip.com/getting-started

Install the package version compatible with Laravel 11/12/13.

```bash
composer require pdphilip/elasticsearch:~5.6
```

--------------------------------

### Install Elasticsearch Package for Laravel 9

Source: https://elasticsearch.pdphilip.com/getting-started

Install the package version compatible with Laravel 9.

```bash
composer require pdphilip/elasticsearch:~3.9
```

--------------------------------

### Example Raw Bucket Values from Aggregation

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Sample JSON output showing raw bucket data, including document counts and aggregated values for min, max, and average price.

```json
// return $buckets;
[
    {
        "key": "low-stock",
        "to": 5,
        "doc_count": 2,
        "min_price": {
            "value": 8
        },
        "avg_price": {
            "value": 754
        },
        "max_price": {
            "value": 1500
        }
    },
    {
        "key": "medium-stock",
        "from": 5,
        "to": 15,
        "doc_count": 6,
        "min_price": {
            "value": 6
        },
        "avg_price": {
            "value": 173.83333333333334
        },
        "max_price": {
            "value": 900
        }
    },
    {
        "key": "high-stock",
        "from": 15,
        "doc_count": 2,
        "min_price": {
            "value": 3
        },
        "avg_price": {
            "value": 176.5
        },
        "max_price": {
            "value": 350
        }
    }
]
```

--------------------------------

### Retrieve All Records

Source: https://elasticsearch.pdphilip.com/eloquent/querying-models

Use `all()` or `get()` to retrieve all records for a model. `all()` is equivalent to `get()` without any clauses.

```php
$products = Product::all();
```

```php
$products = Product::get();
```

--------------------------------

### Install Elasticsearch Package for Laravel 6.x (5.8)

Source: https://elasticsearch.pdphilip.com/getting-started

Install the package version compatible with Laravel 6.x (PHP 5.8).

```bash
composer require pdphilip/elasticsearch:~2.6
```

--------------------------------

### Install Elasticsearch Package for Laravel 10/11 (v4)

Source: https://elasticsearch.pdphilip.com/getting-started

Install version 4 of the package, compatible with Laravel 10/11.

```bash
composer require pdphilip/elasticsearch:~4
```

--------------------------------

### Install Elasticsearch Package for Laravel 7.x (Elasticsearch 7.x)

Source: https://elasticsearch.pdphilip.com/getting-started

Install the package version compatible with Laravel 7.x for Elasticsearch 7.x.

```bash
composer require pdphilip/elasticsearch:~1.7
```

--------------------------------

### Install Elasticsearch Package for Laravel 9.x (Elasticsearch 7.x)

Source: https://elasticsearch.pdphilip.com/getting-started

Install the package version compatible with Laravel 9.x for Elasticsearch 7.x.

```bash
composer require pdphilip/elasticsearch:~1.9
```

--------------------------------

### Get Search Highlights for Products

Source: https://elasticsearch.pdphilip.com/eloquent/search-queries

Retrieve products containing 'espresso' and store their highlights. Highlights are stored in the model's metadata.

```php
$highlights = [];
$products = Product::searchTerm('espresso')->highlight()->get();
foreach ($products as $product) {
    $highlights[$product->id] = $product->searchHighlights;
}

```

--------------------------------

### Get Index Settings

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Retrieves the settings for a specified index.

```php
Schema::getSettings('my_index');
```

--------------------------------

### Save Product with Empty String Color (Bad Example)

Source: https://elasticsearch.pdphilip.com/eloquent/eloquent-queries

Illustrates an incorrect way to handle missing data by saving an empty string. Elasticsearch will treat this as a value, complicating future queries.

```php
$product = new Product();
$product->name = 'Glass bowl';
$product->color = '';
$product->save();
```

--------------------------------

### Example Usage of Elasticsearch Relationships

Source: https://elasticsearch.pdphilip.com/relationships/es-es

Demonstrates how to access related data for a Company model, including hasMany, hasOne, morphOne, and morphMany relationships in Elasticsearch.

```php
$company = Company::first();
$companyLogs = $company->companyLogs->toArray(); //Shows all company logs (has many)
$companyProfile = $company->companyProfile->toArray(); //Shows the company profile (has one)
$companyAvatar = $company->avatar->toArray(); //Shows the company avatar (morph one)
$companyPhotos = $company->photos->toArray(); //Shows the company photos (morph many)
```

--------------------------------

### Paginate Products in Elasticsearch

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Implement pagination for Elasticsearch results in Laravel. This example finds all active products and paginates them with 50 items per page.

```php
$products = Product::where('is_active',true)
$products = $products->paginate(50)
```

```php
{{ $products->appends(request()->query())->links() }}
```

--------------------------------

### Get All Matching Records

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Retrieve all model instances that match the query criteria. Returns an empty collection if no matching records are found.

```php
$product = Product::where('status',1)->get();
```

--------------------------------

### Example aggregation results for stock ranges

Source: https://elasticsearch.pdphilip.com/eloquent/distinct

This JSON shows the expected output format for the stock range aggregation, including counts and price statistics for each defined stock range.

```json
[
    {
        "count_stock_range_low-stock": 2,
        "min_price_stock_range_low-stock": 8,
        "max_price_stock_range_low-stock": 1500,
        "avg_price_stock_range_low-stock": 754
    },
    {
        "count_stock_range_medium-stock": 6,
        "min_price_stock_range_medium-stock": 6,
        "max_price_stock_range_medium-stock": 900,
        "avg_price_stock_range_medium-stock": 173.83333333333334
    },
    {
        "count_stock_range_high-stock": 2,
        "min_price_stock_range_high-stock": 3,
        "max_price_stock_range_high-stock": 350,
        "avg_price_stock_range_high-stock": 176.5
    }
]
```

--------------------------------

### Fuzzy Search with Multiple Conditions

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Use `searchFuzzy` and `orSearchFuzzy` for fuzzy matching. This example searches for books containing 'Erc' or a combination of 'Leen' and 'Startop'.

```php
Book::searchFuzzy('Erc')->orSearchFuzzy('Leen')->orSearchFuzzy('Startop')->get();
```

```json
{
    "index": "books",
    "body": {
        "query": {
            "bool": {
                "should": [
                    {
                        "bool": {
                            "must": [
                                {
                                    "multi_match": {
                                        "query": "Erc",
                                        "type": "best_fields",
                                        "fuzziness": "AUTO"
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "bool": {
                            "must": [
                                {
                                    "multi_match": {
                                        "query": "Leen",
                                        "type": "best_fields",
                                        "fuzziness": "AUTO"
                                    }
                                },
                                {
                                    "multi_match": {
                                        "query": "Startop",
                                        "type": "best_fields",
                                        "fuzziness": "AUTO"
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        },
        "size": 1000
    }
}
```

--------------------------------

### Configure Highlighting Options and Search

Source: https://elasticsearch.pdphilip.com/eloquent/search-queries

Set global options for highlighting, such as the number of fragments and fragment size. Then, perform a search for 'espresso' and retrieve highlighted results.

```php
$options = [
    'number_of_fragments' => 3,
    'fragment_size' => 150,
];
$highlights = [];
$products = Product::searchTerm('espresso')->highlight([],'<em>','</em>',$options)->get();
foreach ($products as $product) {
    $highlights[$product->_id] = $product->searchHighlights;
}
```

--------------------------------

### Example Elasticsearch Query for Specific Dynamic Index

Source: https://elasticsearch.pdphilip.com/llms-full.txt

This JSON illustrates an Elasticsearch query targeting a specific index within a dynamic index setup. It shows how `withSuffix()` translates to a precise index name in the query.

```json
{
    "index": "page_hits_2023-01-01",
    "body": {
        "query": {
            "term": {
                "page_id": {
                    "value": 3
                }
            }
        },
        "size": 10000
    }
}
```

--------------------------------

### Example Elasticsearch ID Format

Source: https://elasticsearch.pdphilip.com/llms-full.txt

This is an example of the ID format generated by the GeneratesElasticIds trait.

```json
{
    "id": "GXUGv5UBt-dmV3b48pjF"
}
```

--------------------------------

### Create Site Log Record (Initial)

Source: https://elasticsearch.pdphilip.com/schema/re-indexing

Creates a record for the site log index before the 'location' field is correctly mapped.

```php
SiteLog::create([
    'url' => 'https://example.com/contact-us',
    'user_ip' => '0.0.0.0',
    'location' => ['lat' => -7.3, 'lon' => 3.1] // This field is not correctly mapped yet
]);
```

--------------------------------

### Use SearchOptions for fuzzy, minShouldMatch, and boost

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Replaced `asFuzzy()`, `setMinShouldMatch()`, and `setBoost()` with a `SearchOptions` object passed to `searchTerm()`. Configure fuzzy matching, minimum should match, and boost values within this object.

```php
-   Product::searchTerm('espreso tme')
-        ->asFuzzy()->setMinShouldMatch(2)->setBoost(2)
-        ->get();
Product::searchTerm('espreso tme', function (SearchOptions $options) {
    $options->searchFuzzy();
    $options->boost(2);
    $options->minimumShouldMatch(2);
})->get();
```

--------------------------------

### Install Elasticsearch Package for Laravel

Source: https://elasticsearch.pdphilip.com/getting-started

Use Composer to install the package for Laravel 11/12/13 with Elasticsearch 8.x.

```bash
composer require pdphilip/elasticsearch
```

--------------------------------

### Match Query with Options

Source: https://elasticsearch.pdphilip.com/eloquent/es-queries

Customize match queries with options like operator, analyzer, and fuzziness. Use the MatchOptions facade for configuration.

```php
use PDPhilip\Elasticsearch\Query\Options\MatchOptions;


Person::whereMatch('description', 'Jhn Smth', function (MatchOptions $options) {
    $options->operator('or');
    $options->analyzer('my_custom_analyzer');
    $options->asFuzzy();
})->get();
```

```json
{
    "index": "products",
    "body": {
        "query": {
            "match": {
                "description": {
                    "query": "Jhn Smth",
                    "operator": "or",
                    "analyzer": "my_custom_analyzer",
                    "fuzziness": "AUTO"
                }
            }
        },
        "size": 1000
    }
}
```

--------------------------------

### Search Query String with Specific Fields and Boost

Source: https://elasticsearch.pdphilip.com/eloquent/query-string-queries

Specify fields to search within and optionally boost certain fields to influence relevance scoring. This example searches for 'John' in 'name', 'description', and 'friends.name', boosting 'name' and 'description'.

```php
People::searchQueryString('John',['name^3','description^2','friends.name'])->get();
```

```json
{
    "index": "people",
    "body": {
        "query": {
            "query_string": {
                "query": "John",
                "fields": [
                    "name^3",
                    "description^2",
                    "friends.name"
                ]
            }
        },
        "size": 1000
    }
}
```

--------------------------------

### Get Index Mappings

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Retrieves the mappings for a specified index. Pass `true` as the second argument to get raw mappings.

```php
Schema::getMappings('my_index');
```

```php
Schema::getMappings('my_index',true);
```

--------------------------------

### All Query Options Helper Import

Source: https://elasticsearch.pdphilip.com/eloquent/eloquent-queries

Imports the ClauseOptions helper for accessing all query options within a single helper.

```php
use PDPhilip\Elasticsearch\Query\Options\ClauseOptions;
```

--------------------------------

### Query for Exact Case-Sensitive Prefixes

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Use `wherePrefix` or its alias `whereStartsWith` to find values that begin with a specific string. Ensure the target field is mapped as `keyword` or uses a `.keyword` subfield for accurate results.

```php
Person::wherePrefix('name', 'John Sm')->get();
//Or
Person::whereStartsWith('name', 'John Sm')->get(); //Alias
```

--------------------------------

### Basic Highlighting with Default Tags

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Enables highlighting for all matched terms using default `<em>` tags. The highlights are stored in `$product->searchHighlights`.

```php
$highlights = [];
$products = Product::searchTerm('espresso')->highlight()->get();
foreach ($products as $product) {
    $highlights[$product->id] = $product->searchHighlights;
}
```

--------------------------------

### Install Elasticsearch Package for Laravel 8.x (Elasticsearch 7.x)

Source: https://elasticsearch.pdphilip.com/getting-started

Install the package version compatible with Laravel 8.x for Elasticsearch 7.x.

```bash
composer require pdphilip/elasticsearch:~1.8
```

--------------------------------

### Query for Products with Empty String Color (Package Specific)

Source: https://elasticsearch.pdphilip.com/eloquent/eloquent-queries

Utilize the package's `whereExact` method for a more precise query to find products where the 'color' field is exactly an empty string.

```php
Product::whereExact('color', '')->get();
```

--------------------------------

### Configure Elasticsearch Connection in .env

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Set up your .env file with Elasticsearch connection details, including host, authentication, and index prefix.

```ini
ES_AUTH_TYPE=http
ES_HOSTS="http://localhost:9200"
ES_USERNAME=
ES_PASSWORD=
ES_CLOUD_ID=
ES_API_ID=
ES_API_KEY=
ES_SSL_CA=
ES_INDEX_PREFIX=my_app_
ES_SSL_CERT=
ES_SSL_CERT_PASSWORD=
ES_SSL_KEY=
ES_SSL_KEY_PASSWORD=
ES_OPT_ID_SORTABLE=false
ES_OPT_VERIFY_SSL=true
ES_OPT_RETRIES=
ES_OPT_META_HEADERS=true
ES_ERROR_INDEX=
ES_OPT_BYPASS_MAP_VALIDATION=false
ES_OPT_DEFAULT_LIMIT=1000
```

```ini
ES_HOSTS="http://es01:9200,http://es02:9200,http://es03:9200"
```

```ini
ES_AUTH_TYPE=cloud
ES_HOSTS="https://xxxxx-xxxxxx.es.europe-west1.gcp.cloud.es.io:9243"
ES_USERNAME=elastic
ES_PASSWORD=XXXXXXXXXXXXXXXXXXXX
ES_CLOUD_ID=XXXXX:ZXVyb3BlLXdl.........SQwYzM1YzU5ODI5MTE0NjQ3YmEyNDZlYWUzOGNkN2Q1Yg==
ES_API_ID=
ES_API_KEY=
ES_SSL_CA=
ES_INDEX_PREFIX=my_app_
ES_ERROR_INDEX=
```

--------------------------------

### withMapping()

Source: https://elasticsearch.pdphilip.com/schema/index-blueprint

Adjust core index settings such as the number of shards.

```APIDOC
## withMapping()

### Description
Adjust core index settings such as the number of shards.

### Method
Not applicable (Schema DSL)

### Endpoint
Not applicable (Schema DSL)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```php
Schema::create('contacts', function (Blueprint $index) {
    $index->withMapping('dynamic', false);
});
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Install Elasticsearch Package for Laravel 6.x (5.8) (Elasticsearch 7.x)

Source: https://elasticsearch.pdphilip.com/getting-started

Install the package version compatible with Laravel 6.x (PHP 5.8) for Elasticsearch 7.x.

```bash
composer require pdphilip/elasticsearch:~1.6
```

--------------------------------

### Elasticsearch Grouped Query Example

Source: https://elasticsearch.pdphilip.com/eloquent/eloquent-queries

This example demonstrates a grouped query in Elasticsearch using aggregations to group by 'status' and then by 'category'. It also includes sorting and size parameters.

```json
{
    "query": {
        "bool": {
            "must": [
                {
                    "match_all": {}
                }
            ]
        }
    },
    "aggs": {
        "group_by_status": {
            "terms": {
                "field": "status.keyword"
            },
            "aggs": {
                "group_by_category": {
                    "terms": {
                        "field": "category.keyword"
                    }
                }
            }
        }
    },
    "sort": [
        {
            "status": {
                "order": "asc"
            }
        }
    ],
    "size": 1000
}
```

--------------------------------

### Match Query with Options

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Execute a 'match' query with custom options, including operator, analyzer, and fuzziness for more flexible text searching.

```php
use PDPhilip\Elasticsearch\Query\Options\MatchOptions;

Person::whereMatch('description', 'Jhn Smth', function (MatchOptions $options) {
    $options->operator('or');
    $options->analyzer('my_custom_analyzer');
    $options->asFuzzy();
})->get();
```

```json
{
    "index": "products",
    "body": {
        "query": {
            "match": {
                "description": {
                    "query": "Jhn Smth",
                    "operator": "or",
                    "analyzer": "my_custom_analyzer",
                    "fuzziness": "AUTO"
                }
            }
        },
        "size": 1000
    }
}
```

--------------------------------

### Example Distinct Results with User Relation

Source: https://elasticsearch.pdphilip.com/llms-full.txt

This JSON shows an example of distinct results, including the user ID, its count, and the related user object, as returned from an Elasticsearch query.

```json
{
    "user_id": "1",
    "user_id_count": 24,
    "user": {
        "id": "1",
        "name": "John Doe",
        ...
    }
},
{
    "user_id": "2",
    "user_id_count": 18,
    "user": {
        "id": "2",
        "name": "Jane Smith",
        ...
    }
},
{
    "user_id": "3",
    "user_id_count": 8,
    "user": {
        "id": "3",
        "name": "Alice Johnson",
        ...
    }
},
```

--------------------------------

### Schema::getSettings

Source: https://elasticsearch.pdphilip.com/schema/migrations

Retrieves the settings for a specified index.

```APIDOC
## Schema::getSettings

### Description
Retrieves the settings for a specified index.

### Method Signature
Schema::getSettings(index_name: string)

### Parameters
- **index_name** (string) - The name of the index to retrieve settings for.

### Request Example
```php
Schema::getSettings('my_index');
```

### Response Example
```json
{
    "my_index": {
        "settings": {
            "index": {
                "routing": {
                    "allocation": {
                        "include": {
                            "_tier_preference": "data_content"
                        }
                    }
                },
                "number_of_shards": "1",
                "provided_name": "my_index",
                "creation_date": "1742830787691",
                "number_of_replicas": "1",
                "uuid": "g1Jzm6_ORA6dGftm59asKQ",
                "version": {
                    "created": "8521000"
                }
            }
        }
    }
}
```
```

--------------------------------

### Query Options Helper Imports

Source: https://elasticsearch.pdphilip.com/eloquent/eloquent-queries

Imports for various query options helpers available in the package.

```php
use PDPhilip\Elasticsearch\Query\Options\TermOptions; // for where() and whereTerm()
use PDPhilip\Elasticsearch\Query\Options\TermsOptions; //for whereIn()
use PDPhilip\Elasticsearch\Query\Options\MatchOptions; // for whereMatch()
use PDPhilip\Elasticsearch\Query\Options\NestedOptions; // for whereNestedObject()
use PDPhilip\Elasticsearch\Query\Options\PhraseOptions; // for wherePhrase()
use PDPhilip\Elasticsearch\Query\Options\PhrasePrefixOptions; // for wherePhrasePrefix()
use PDPhilip\Elasticsearch\Query\Options\PrefixOptions; // for wherePrefix()
use PDPhilip\Elasticsearch\Query\Options\RegexOptions; // for whereRegex()
use PDPhilip\Elasticsearch\Query\Options\FuzzyOptions; // for whereTermFuzzy()
use PDPhilip\Elasticsearch\Query\Options\SearchOptions; //All multi_match queries
use PDPhilip\Elasticsearch\Query\Options\DateOptions; // for whereDate()
```

--------------------------------

### Example Elasticsearch response with comments > 5 likes

Source: https://elasticsearch.pdphilip.com/eloquent/nested-queries

This is an example response from Elasticsearch after filtering for blog posts with status 5 and comments having more than 5 likes. It displays the blog post and its relevant comments.

```json
{
    "_id": "1IiLKG38BCOXW3U9a4zcn",
    "title": "My first post",
    "status": 5,
    "comments": [
        {
            "name": "Damaris Ondricka",
            "comment": "Quia quis facere cupiditate unde natus dolorem. Quia voluptatem in nam occaecati. Veritatis libero neque vitae.",
            "country": "Peru",
            "likes": 6
        },
        {
            "name": "April Von",
            "comment": "Repudiandae rem aspernatur neque molestiae voluptatibus ut aut. Animi dolor id voluptas. Blanditiis a est nobis voluptatem sed sed illum esse.",
            "country": "Switzerland",
            "likes": 10
        },
        {
            "name": "Mabelle Schinner",
            "comment": "Aliquid molestiae quas vitae ipsam neque nam sed. Facere blanditiis repellendus sequi autem. Explicabo cupiditate porro quia animi ut minus tempora ut.",
            "country": "Switzerland",
            "likes": 7
        }
    ]
}
```

--------------------------------

### Example Elasticsearch Response with Nested Comments

Source: https://elasticsearch.pdphilip.com/eloquent/nested-queries

This is an example of an Elasticsearch response document that matches the nested query criteria. It includes a blog post with status 5 and two nested comments, each having more than 5 likes.

```json
{
    "_id": "1IiLKG38BCOXW3U9a4zcn",
    "title": "My first post",
    "status": 5,
    "comments": [
        {
            "name": "Damaris Ondricka",
            "comment": "Quia quis facere cupiditate unde natus dolorem. Quia voluptatem in nam occaecati. Veritatis libero neque vitae.",
            "country": "Peru",
            "likes": 6
        },
        {
            "name": "April Von",
            "comment": "Repudiandae rem aspernatur neque molestiae voluptatibus ut aut. Animi dolor id voluptas. Blanditiis a est nobis voluptatem sed sed illum esse.",
            "country": "Switzerland",
            "likes": 10
        }
    ]
}
```

--------------------------------

### Replace settings() with withSetting() in IndexBlueprint

Source: https://elasticsearch.pdphilip.com/upgrade-guide

The `settings()` method in `IndexBlueprint` has been replaced with `withSetting()` for configuring index settings.

```php
$index->settings('number_of_shards', 3);
$index->withSetting('number_of_shards', 3);
```

--------------------------------

### Example Elasticsearch response with filtered comments

Source: https://elasticsearch.pdphilip.com/eloquent/nested-queries

This is an example of the Elasticsearch response when filtering for blog posts with status 5 and comments from Switzerland, ordered by likes. It includes the blog post details and the matching comments.

```json
{
    "_id": "1IiLKG38BCOXW3U9a4zcn",
    "title": "My first post",
    "status": 5,
    "comments": [
        {
            "name": "Mabelle Schinner",
            "comment": "Aliquid molestiae quas vitae ipsam neque nam sed. Facere blanditiis repellendus sequi autem. Explicabo cupiditate porro quia animi ut minus tempora ut.",
            "country": "Switzerland",
            "likes": 7
        },
        {
            "name": "April Von",
            "comment": "Repudiandae rem aspernatur neque molestiae voluptatibus ut aut. Animi dolor id voluptas. Blanditiis a est nobis voluptatem sed sed illum esse.",
            "country": "Switzerland",
            "likes": 10
        }
    ]
}
```

--------------------------------

### Create Index If Not Exists

Source: https://elasticsearch.pdphilip.com/schema/migrations

Use this to create a new index only if it doesn't already exist. Define fields, settings, and mappings within the closure.

```php
Schema::createIfNotExists('my_index', function (Blueprint $index) {
    // Define fields, settings, and mappings
});
```

--------------------------------

### wherePrefix

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Finds documents where a field's value starts with a specified prefix.

```APIDOC
## wherePrefix($field, $value, $options)

### Description
Finds people whose name starts with 'John Sm'. An alias `whereStartsWith` is also available.

### Method
Not specified, but implies a query builder method.

### Endpoint
Not specified.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```php
Person::wherePrefix('name', 'John Sm')->get();
//Or
Person::whereStartsWith('name', 'John Sm')->get(); //Alias
```

### Response
#### Success Response (200)
```json
{
    "index": "people",
    "body": {
        "query": {
            "prefix": {
                "name.keyword": {
                    "value": "John Sm"
                }
            }
        },
        "size": 1000
    }
}
```
```

--------------------------------

### Find First Matching Model

Source: https://elasticsearch.pdphilip.com/eloquent/querying-models

Use `first()` to retrieve the first model matching the query. `firstOrFail()` retrieves the first model or throws a `ModelNotFoundException`, potentially resulting in a 404 HTTP response.

```php
$product = Product::where('status',1)->first();
```

```php
$product = Product::where('status',1)->firstOrFail();
```

--------------------------------

### Replace Fuzzy and Boost Methods with SearchOptions

Source: https://elasticsearch.pdphilip.com/upgrade-guide

Methods like `asFuzzy()`, `setMinShouldMatch()`, and `setBoost()` are replaced by the `$options` array in `searchTerm()`.

```php
Product::searchTerm('espreso tme')
        ->asFuzzy()->setMinShouldMatch(2)->setBoost(2)
        ->get();
Product::searchTerm('espreso tme', function (SearchOptions $options) {
    $options->searchFuzzy();
    $options->boost(2);
    $options->minimumShouldMatch(2);
})->get();
```

--------------------------------

### Get Indices Summary

Source: https://elasticsearch.pdphilip.com/schema/migrations

Retrieves a summary of all indices on the Elasticsearch cluster. This is an alternative to `Schema::getTables()`.

```php
Schema::getIndicesSummary();
```

--------------------------------

### Find First Matching Record or Throw Exception

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Retrieve the first model instance that matches the query criteria. Throws a `ModelNotFoundException` if no matching record is found. If uncaught, this results in a 404 HTTP response.

```php
$product = Product::where('status',1)->firstOrFail();
```

--------------------------------

### wherePhrasePrefix

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Performs a 'match_phrase_prefix' query to find documents where the specified field starts with the given prefix.

```APIDOC
## wherePhrasePrefix($field, $value, $options)

### Description
Performs a 'match_phrase_prefix' query to find documents where the specified field starts with the given prefix.

### Method
```php
Person::wherePhrasePrefix('description', 'loves es')->get();
```

### Request Example
```json
{
    "index": "people",
    "body": {
        "query": {
            "match_phrase_prefix": {
                "description": {
                    "query": "loves es"
                }
            }
        },
        "size": 1000
    }
}
```
```

--------------------------------

### Order Products by Creation Date Descending

Source: https://elasticsearch.pdphilip.com/eloquent/ordering-and-pagination

Find all products and order them by creation date in descending order. This uses the `orderBy` method with a 'desc' direction.

```php
Product::orderBy('created_at', 'desc')->get();
```

```json
{
    "index": "products",
    "body": {
        "sort": [
            {
                "created_at": {
                    "order": "desc"
                }
            }
        ],
        "size": 1000
    }
}
```

--------------------------------

### Bool Prefix Search

Source: https://elasticsearch.pdphilip.com/notes/elasticsearch-to-eloquent-map

Searches for documents where a phrase exists and the next word starts with a given prefix.

```APIDOC
## searchBoolPrefix($phrase, $options)

### Description
Searches for people who have the phrase ‘loves espressos and’ with a prefix of ‘ru’ in the next word in any field. Ex: ‘loves espressos and tea’.

### Method
```php
Person::searchBoolPrefix('loves espressos and te')->get();
```

### Request Body Example
```json
{
    "index": "products",
    "body": {
        "query": {
            "multi_match": {
                "query": "loves espressos and te",
                "type": "bool_prefix"
            }
        },
        "size": 1000
    }
}
```
```

--------------------------------

### Configure Query String Options with an Array

Source: https://elasticsearch.pdphilip.com/eloquent/query-string-queries

Pass query string options as an associative array for simpler configurations. This is an alternative to using a closure with QueryStringOptions.

```php
Product::searchQueryString('espreso tme', [
    'type' => 'most_fields',
    'fuzziness' => 2,
    'fuzzy_prefix_length' => 1,
    'fuzzy_transpositions' => true,
    'boost' => 2.0,
    'default_operator' => 'OR',
    'minimum_should_match' => '2',
    'auto_generate_synonyms_phrase_query' => true,
    'analyzer' => 'my_custom_analyzer',
    'lenient' => true,
    'phrase_slop' => 2,
])->get();
```

--------------------------------

### Matrix Stats Aggregations

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Perform matrix statistics aggregations on specified fields to get comprehensive statistical summaries.

```APIDOC
## Matrix Stats Aggregations

##### `matrix(string|array $fields,$options = [])`

Performs matrix statistics aggregations on one or more fields.

### Parameters

*   **fields** (string|array) - Required - The field(s) to perform matrix stats on.
*   **options** (array) - Optional - Additional options for the aggregation.

### Request Example

```php
// Matrix stats for 'price' field, excluding 'red' and 'green' colored products
Product::whereNotIn('color', ['red', 'green'])->matrix('price');

// Matrix stats for both 'price' and 'orders' fields
Product::whereNotIn('color', ['red', 'green'])->matrix(['price', 'orders']);
```

### Response Example

```json
{
    "matrix_stats_price": {
        "name": "price",
        "count": 80,
        "mean": 971.7610051512718,
        "variance": 319573.9412606584,
        "skewness": 0.09455383230430257,
        "kurtosis": 1.8069082807157395,
        "covariance": {
            "price": 319573.9412606584,
            "orders": 6096.144923266881
        },
        "correlation": {
            "price": 1,
            "orders": 0.14887562780257566
        }
    },
    "matrix_stats_orders": {
        "name": "orders",
        "count": 80,
        "mean": 120.7,
        "variance": 5246.769620253164,
        "skewness": -0.06873472971174674,
        "kurtosis": 1.8427347935190153,
        "covariance": {
            "price": 6096.144923266881,
            "orders": 5246.769620253164
        },
        "correlation": {
            "price": 0.14887562780257566,
            "orders": 1
        }
    }
}
```

### Matrix Results Explained

The result of a matrix aggregation is a detailed statistical summary of the selected fields. Here's a breakdown of what each statistic represents:

*   **doc_count**: The total number of documents that matched the aggregation query.
*   **fields**: An array containing the statistical data for each field included in the matrix aggregation.
    *   **name**: The name of the field.
    *   **count**: The number of values analyzed for this field.
    *   **mean**: The average value.
    *   **variance**: The variance indicating the data's spread.
    *   **skewness**: A measure of the asymmetry of the data distribution.
    *   **kurtosis**: A measure of the 'tailedness' of the data distribution.
    *   **covariance**: The covariance between the current field and other fields in the matrix, indicating how the fields vary together.
    *   **correlation**: The correlation between the current field and other fields, showing the strength and direction of a linear relationship.
```

--------------------------------

### Where Phrase Prefix Options with Analyzer, Max Expansions, and Slop

Source: https://elasticsearch.pdphilip.com/eloquent/es-queries

Configure `wherePhrasePrefix` with options such as analyzer, max_expansions, and slop using a callback. This allows for more granular control over prefix phrase matching.

```php
use PDPhilip\Elasticsearch\Query\Options\PhrasePrefixOptions;


Person::wherePhrasePrefix('description', 'loves es',function (PhrasePrefixOptions $options) {
    $options->analyzer('my_custom_analyzer');
    $options->maxExpansions(75);
    $options->slop(1);
})->get();
```

```json
{
    "index": "people",
    "body": {
        "query": {
            "match_phrase_prefix": {
                "description": {
                    "query": "loves es",
                    "analyzer": "my_custom_analyzer",
                    "max_expansions": 75,
                    "slop": 1
                }
            }
        },
        "size": 1000
    }
}
```

--------------------------------

### Get All Indices

Source: https://elasticsearch.pdphilip.com/schema/migrations

Retrieves full information about all indices present on the Elasticsearch cluster. This is equivalent to calling `Schema::getIndex('*')`.

```php
Schema::getIndices();
```

--------------------------------

### Field Boosting with searchQueryString

Source: https://elasticsearch.pdphilip.com/llms-full.txt

Demonstrates how to specify specific fields to search within and apply relevance boosting to certain fields using the `searchQueryString` method.

```APIDOC
## Parameter: $fields in searchQueryString

### Description
Allows specifying which fields to search and optionally boosting certain fields to influence their relevance in the search results. Boosting is done using a caret (`^`) followed by a numeric multiplier.

### Method Signature
`searchQueryString(string $query, array $fields, array $options = [])`

### Parameters
- **$query** (string) - The search query.
- **$fields** (array) - An array of fields to search. Fields can have a boost value (e.g., 'name^3').
- **$options** (array, optional) - Additional options for the query.

### Request Example
```php
People::searchQueryString('John', ['name^3', 'description^2', 'friends.name'])->get();
```

### Explanation
This example searches for 'John' primarily in the 'name' field (boosted by 3), secondarily in the 'description' field (boosted by 2), and also includes the 'friends.name' field in the search. The boosting affects the relevance score, influencing the order of results.

### Response Example
```json
{
    "index": "people",
    "body": {
        "query": {
            "query_string": {
                "query": "John",
                "fields": [
                    "name^3",
                    "description^2",
                    "friends.name"
                ]
            }
        },
        "size": 1000
    }
}
```
```
Tokens:
Raw