Explorer

https://github.com/jeroen-g/explorer
Admin
Explorer is a next-gen Elasticsearch driver for Laravel Scout that enhances its capabilities with...
Tokens:7,715
Snippets:103
Trust Score:9.1
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example Search Controller

Source: https://github.com/jeroen-g/explorer/blob/master/docs/debugging.md

This is an example of a controller that performs a search using the Cartographer::search method.

```php
class SearchController
{
    public function __invoke(SearchFormRequest $request)
    {
        $people = Cartographer::search($request->get('keywords'))->get();

        return view('search', [
            'people' => $people,
        ]);
    }
}
```

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

### Implement Custom Term Query Syntax

Source: https://github.com/jeroen-g/explorer/blob/master/docs/advanced-queries.md

Create a custom query class by implementing the SyntaxInterface. This example shows how to build a 'term' query.

```php
namespace App\Explorer\MyQueries;

use JeroenG\Explorer\Domain\Syntax\SyntaxInterface;

class Term implements SyntaxInterface
{
    private string $field;
    
    private mixed $value;

    public function __construct(string $field, $value = null)
    {
        $this->field = $field;
        $this->value = $value;
    }

    public function build(): array
    {
        return ['term' => [
            $this->field => [
                'value' => $this->value,
            ],
        ]];
    }
}
```

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

### Complex Data Preparation with Pipelines

Source: https://github.com/jeroen-g/explorer/blob/master/docs/preparing-data.md

For more complex data transformations, leverage Laravel's pipelines within the `prepare` method. This example shows how to chain multiple formatting steps like Markdown conversion, tag stripping, and emoji encoding.

```php
public function prepare(array $searchable): array
{
    $searchable['content'] = (new Illuminate\Pipeline\Pipeline())
                ->send($searchable['content'])
                ->through([
                    App\Formatters\ConvertMarkdown::class,
                    App\Formatters\StripTags::class,
                    App\Formatters\EncodeEmoji::class,
                ])
                ->thenReturn();

    return $searchable;
}
```

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

### Docker Compose for Elasticsearch and Kibana

Source: https://github.com/jeroen-g/explorer/blob/master/docs/quickstart.md

Use this docker-compose.yml configuration to spin up Elasticsearch and Kibana instances. Ensure Docker is installed and running before executing 'docker-compose up -d'.

```yaml
version: '2.2'
services:
  es01:
    image: docker.elastic.co/elasticsearch/elasticsearch:7.9.3
    container_name: es01
    environment:
      - node.name=es01
      - cluster.name=es-docker-cluster
      - discovery.type=single-node
      - bootstrap.memory_lock=true
      - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
    ulimits:
      memlock:
        soft: -1
        hard: -1
    volumes:
      - data01:/usr/share/elasticsearch/data
    ports:
      - 9200:9200
    networks:
      - elastic

  kib01:
    image: docker.elastic.co/kibana/kibana:7.9.3
    container_name: kib01
    ports:
      - 5601:5601
    environment:
      ELASTICSEARCH_URL: http://es01:9200
      ELASTICSEARCH_HOSTS: http://es01:9200
    networks:
      - elastic

volumes:
  data01:
    driver: local

networks:
  elastic:
    driver: bridge

```

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

### Install Explorer via Composer

Source: https://github.com/jeroen-g/explorer/blob/master/docs/index.md

Use Composer to add the Explorer package to your Laravel project. This is the initial step for integrating Elasticsearch with Laravel Scout.

```bash
composer require jeroen-g/explorer
```

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

### Advanced Elasticsearch Query with Explorer

Source: https://github.com/jeroen-g/explorer/blob/master/readme.md

Construct complex search queries using Explorer's query builder. This example demonstrates filtering, term matching, and boosting scores.

```php
$posts = Post::search('lorem')
    ->must(new Matching('title', 'ipsum'))
    ->should(new Terms('tags', ['featured'], 2))
    ->filter(new Term('published', true))
    ->get();
```

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

### Define Elasticsearch Index Mapping

Source: https://github.com/jeroen-g/explorer/blob/master/docs/quickstart.md

Configure the index name and properties for your Elasticsearch index within the config/explorer.php file. This example defines mappings for a 'posts_index'.

```php
'indexes' => [
    'posts_index' => [
        'properties' => [
            'id' => 'keyword',
            'title' => 'text',
        ],
    ]
]
```

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

### Multiple Connections with Round Robin Selector

Source: https://github.com/jeroen-g/explorer/blob/master/docs/connection.md

Configure multiple ElasticSearch connections and use a Round Robin selector to distribute requests. This example includes a primary connection and two additional connections.

```php
use Elastic\Transport\NodePool\Selector\RoundRobin;

return [
    'connection' => [
        'host' => 'localhost',
        'port' => '9200',
        'scheme' => 'http',
        'ssl' => [
            'verify' => false,
        ],
        'selector' => RoundRobin::class
    ],
    'additionalConnections' => [
        [
            'host' => 'localhost',
            'port' => '9201',
            'scheme' => 'http',
        ],
        [
            'host' => 'localhost',
            'port' => '9202',
            'scheme' => 'http',
        ]
    ],
];
```

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

### Filter Query Example

Source: https://github.com/jeroen-g/explorer/blob/master/docs/advanced-queries.md

Use the filter method to apply a query that must match but does not contribute to the score. This is useful for structured data like dates or flags.

```php
use App\Models\Post;
use JeroenG\Explorer\Domain\Syntax\Term;

$results = Post::search('Self-steering')
    ->filter(new Term('organisation_sector', 'IT'))
    ->get();
```

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

### Search Documents using Laravel Scout

Source: https://github.com/jeroen-g/explorer/blob/master/docs/quickstart.md

Perform full-text searches on your indexed documents using the 'search' method provided by Laravel Scout. This example searches for posts containing 'Lorem'.

```php
$ipsum = App\Models\Post::search('Lorem')->get();
```

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

### Create Synonym Analyzer in PHP

Source: https://github.com/jeroen-g/explorer/blob/master/docs/text-analysis.md

Defines a custom text analyzer named 'frameworks' that includes a lowercase filter and a synonym filter. This setup allows searching for 'Vue' to also return results for 'React'. Be mindful of the performance impact of custom analyzers in Elasticsearch.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use JeroenG\Explorer\Application\Explored;
use JeroenG\Explorer\Application\IndexSettings;
use JeroenG\Explorer\Domain\Analysis\Analysis;
use JeroenG\Explorer\Domain\Analysis\Analyzer\StandardAnalyzer;
use JeroenG\Explorer\Domain\Analysis\Filter\SynonymFilter;
use Laravel\Scout\Searchable;

class Post extends Model implements Explored, IndexSettings
{
    use HasFactory;
    use Searchable;

    protected $fillable = ['title', 'published'];

    public function mappableAs(): array
    {
        return [
            'id' => 'keyword',
            'title' => [
                'type' => 'text',
                'analyzer' => 'frameworks',
            ],
            'published' => 'boolean',
            'created_at' => 'date',
        ];
    }
    
    public function indexSettings(): array
    {
        $synonymFilter = new SynonymFilter();
        $synonymFilter->setSynonyms(['vue => react']);

        $synonymAnalyzer = new StandardAnalyzer('frameworks');
        $synonymAnalyzer->setFilters(['lowercase', $synonymFilter]);

        return (new Analysis())
            ->addAnalyzer($synonymAnalyzer)
            ->addFilter($synonymFilter)
            ->build();
    }
}
```

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

### Add Terms Aggregation to Search

Source: https://github.com/jeroen-g/explorer/blob/master/docs/aggregations.md

Use this to get metrics on how many times every place is present in the Elasticsearch index. Ensure the Cartographer facade and TermsAggregation class are available.

```php
$search = Cartographer::search();
$search->aggregation('places', new TermsAggregation('place'));

$results = $search->raw();
$aggregations = $results->aggregations();
```

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

### Sort Search Results by Date Descending

Source: https://github.com/jeroen-g/explorer/blob/master/docs/sorting.md

Use the `orderBy()` function to sort search results by a specific field in descending order. This example sorts posts by their 'published_at' date.

```php
use App\Models\Post;

$results = Post::search('Self-steering')
    ->orderBy('published_at', 'desc')
    ->get();
```

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

### Query Nested Fields

Source: https://github.com/jeroen-g/explorer/blob/master/docs/mapping.md

Query for data within nested fields using dot notation. This example demonstrates searching for posts where the author's name matches 'Jeroen' within a nested 'author' object.

```php
$posts = Post::search('my post')
    ->must(new Nested('author', new Matching('author.name', 'Jeroen')))
    ->get();
```

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

### Define Nested Mapping

Source: https://github.com/jeroen-g/explorer/blob/master/docs/mapping.md

Define nested mappings for complex data structures like objects or models within your documents. This example shows how to map an 'author' field with a 'name' sub-field.

```php
[
    'id' => 'keyword',
    'title' => 'text',
    'published' => 'boolean',
    'created_at' => 'date',
    'author' => [
        'name' => 'text',
    ],
]
```

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

### Simple Data Preparation

Source: https://github.com/jeroen-g/explorer/blob/master/docs/preparing-data.md

Use this method to make simple modifications to the searchable data, such as capitalizing a string. Ensure your model implements the `JeroenG\Explorer\Application\BePrepared` interface.

```php
public function prepare(array $searchable): array
{
    $searchable['name'] = ucfirst($searchable['name']);

    return $searchable;
}
```

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

### Perform a Basic Search

Source: https://github.com/jeroen-g/explorer/blob/master/docs/commands.md

This command allows for rudimentary testing of basic search queries. Specify the model, search term, and optional fields.

```bash
php artisan elastic:search <model> <term> --fields=<fields>
```

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

### HTTP Connection with Basic Authorization

Source: https://github.com/jeroen-g/explorer/blob/master/docs/connection.md

Configure an HTTP connection with basic username and password authentication. Use the 'auth' key to provide credentials.

```php
return [
    'connection' => [
        'host' => 'localhost',
        'port' => '9200',
        'scheme' => 'http',
        'auth' => [
            'username' => 'myName',
            'password' => 'myPassword'
        ],
    ],
];
```

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

### Import Models for Indexing

Source: https://github.com/jeroen-g/explorer/blob/master/docs/commands.md

Use this command to create and update indices for your models. Specify the model class name as an argument.

```bash
php artisan scout:import <model>
```

```bash
php artisan scout:import "App\Models\Post"
```

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

### Configure Index Settings via Configuration Array

Source: https://github.com/jeroen-g/explorer/blob/master/docs/index-settings.md

Define index settings, including analyzers and properties, within the `config/explorer.php` file using the configuration array notation. This method allows for centralized configuration of index settings.

```php
return [
    'indexes' => [
        'posts' => [
            'settings' => [
                'analysis' => [
                    'analyzer' => [
                        'standard_lowercase' => [
                            'type' => 'custom',
                            'tokenizer' => 'standard',
                            'filter' => ['lowercase'],
                        ],
                    ],
                ],
            ],
            'properties' => [
                'id' => 'keyword',
                'title' => 'text',
                'created_at' => 'date',
                'published' => 'boolean',
                'author' => 'nested',
            ],
        ],
    ],
];
```

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

### Publish Explorer Configuration

Source: https://github.com/jeroen-g/explorer/blob/master/docs/index.md

Publish the configuration file for Explorer using the Artisan command. This allows you to define your Elasticsearch indexes.

```bash
php artisan vendor:publish --tag=explorer.config
```

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

### Register Model Index in Configuration

Source: https://github.com/jeroen-g/explorer/blob/master/docs/mapping.md

Tell Explorer which models should be indexed by adding them to the configuration file. This ensures that your models are recognized and processed by the indexing system.

```php
return [
    'indexes' => [
        \App\Models\Post::class
    ],
];
```

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

### Combine Configuration and Model Mapping

Source: https://github.com/jeroen-g/explorer/blob/master/docs/mapping.md

You can combine both configuration-based and model-based mapping methods. This allows for flexibility in defining mappings for different indexes or models within the same configuration.

```php
return [
    'indexes' => [
        \App\Models\Post::class,
        'subscribers' => [
            'properties' => [
                'id' => 'keyword',
                'firstname' => 'text',
                'email' => 'text',
                'subscribed_at' => 'date',
            ],
        ],
    ],
];
```

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

### TLS Connection with Public Certificate and Private Key

Source: https://github.com/jeroen-g/explorer/blob/master/docs/connection.md

Establish a TLS connection using a public certificate and private key. Specify the paths to your certificate and key files, along with their passphrases if applicable.

```php
return [
    'connection' => [
        'host' => 'localhost',
        'port' => '9200',
        'scheme' => 'https',
        'ssl' => [
            'cert' => ['path/to/cert.pem', 'passphrase'],
            'key' => ['path/to/key.pem', 'passphrase'],
        ],
    ],
];
```

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

### Search Index via Artisan Command

Source: https://github.com/jeroen-g/explorer/blob/master/readme.md

Execute searches directly from the command line using the `elastic:search` Artisan command. Ensure your indexes are configured first.

```bash
php artisan elastic:search "App\Models\Post" lorem
```

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

### HTTP Connection with API Key

Source: https://github.com/jeroen-g/explorer/blob/master/docs/connection.md

Connect using an API key for authentication. Provide your API key ID and secret using the 'api' key.

```php
return [
    'connection' => [
        'host' => 'localhost',
        'port' => '9200',
        'scheme' => 'http',
        'api' => [
            'id' => 'myId',
            'key' => 'myKey'
        ],
    ],
];
```

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

### Set Default Index Settings

Source: https://github.com/jeroen-g/explorer/blob/master/docs/index-settings.md

Configure default index settings that apply to all indices by adding the `default_index_settings` key to your configuration file. This is useful for applying common settings like `max_result_window` or default analyzers across your application.

```php
return [
    'default_index_settings' => [
        'index' => [
            'max_result_window' => 100000,
        ],
        'analysis' => [
            'analyzer' => [
                'standard_lowercase' => [
                    'type' => 'custom',
                    'tokenizer' => 'standard',
                    'filter' => ['lowercase'],
                ],
            ],
        ],
    ],
];
```

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

### Define Index Mappings in Configuration

Source: https://github.com/jeroen-g/explorer/blob/master/docs/mapping.md

Configure index mappings by defining properties and their types within the explorer.php configuration file. Elasticsearch will infer types for fields not explicitly defined.

```php
return [
    'indexes' => [
        'posts' => [
            'properties' => [
                'id' => 'keyword',
                'title' => 'text',
                'created_at' => 'date',
                'published' => 'boolean',
                'author' => 'nested',
            ],
        ],
        'subscribers' => [
            'properties' => [
                'id' => 'keyword',
                'firstname' => 'text',
                'email' => 'text',
                'subscribed_at' => 'date',
            ],
        ],
    ],
];
```

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

### Configure Index Mapping in Config File

Source: https://github.com/jeroen-g/explorer/blob/master/readme.md

Define index mappings directly within the configuration file. This approach is suitable for static index structures.

```php
return [
    'indexes' => [
        'posts_index' => [
            'properties' => [
                'id' => 'keyword',
                'title' => 'text',
            ],
        ]
    ]
];
```

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

### Basic HTTP Connection

Source: https://github.com/jeroen-g/explorer/blob/master/docs/connection.md

Configure a basic HTTP connection to ElasticSearch without any authorization. This is suitable for local development environments.

```php
return [
    'connection' => [
        'host' => 'localhost',
        'port' => '9200',
        'scheme' => 'http',
    ],
];
```

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

### Import Data into Elasticsearch Index

Source: https://github.com/jeroen-g/explorer/blob/master/docs/quickstart.md

Use the 'scout:import' Artisan command to populate your Elasticsearch index with data from your specified Eloquent model. Ensure the model has the required attributes.

```bash
php artisan scout:import "App\Models\Post"
```

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

### TLS Connection with Verification Disabled

Source: https://github.com/jeroen-g/explorer/blob/master/docs/connection.md

Configure a TLS connection with CA verification disabled. Set 'ssl.verify' to false. This is not recommended for production environments.

```php
return [
    'connection' => [
        'host' => 'localhost',
        'port' => '9200',
        'scheme' => 'http',
        'ssl' => [
            'verify' => false,
        ],
    ],
];
```

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

### TLS Connection with CA Verification

Source: https://github.com/jeroen-g/explorer/blob/master/docs/connection.md

Configure a TLS connection and verify the Certificate Authority (CA). Set 'ssl.verify' to the CA certificate path. Disabling verification is not recommended for production.

```php
return [
    'connection' => [
        'host' => 'localhost',
        'port' => '9200',
        'scheme' => 'http',
        'ssl' => [
            'verify' => true,
            'key' => './path/to/ca.crt',
        ],
    ],
];
```

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

### Configure Index Aliases in Explorer

Source: https://github.com/jeroen-g/explorer/blob/master/docs/index-aliases.md

Configure index aliases within the `config/explorer.php` file. Set `aliased` to `true` for the specific index you want to manage with aliases.

```php
return [
    'indexes' => [
        'posts' => [
            'aliased' => true,
            'properties' => [
                'id' => 'keyword',
                'title' => 'text',
                'created_at' => 'date',
                'published' => 'boolean',
                'author' => 'nested',
            ],
        ],
    ],
];
```

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

### Update Aliased Indexes

Source: https://github.com/jeroen-g/explorer/blob/master/docs/commands.md

Use this command for updating aliased indexes instead of `scout:import`. You can specify a single index or omit it to update all.

```bash
php artisan elastic:update <index?>
```

```bash
php artisan elastic:update posts
```

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

### Implement Aliased Interface for Model

Source: https://github.com/jeroen-g/explorer/blob/master/docs/index-aliases.md

To enable index aliases for a model, it must implement the `Aliased` interface. This ensures that Scout updates are managed through aliases.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use JeroenG\Explorer\Application\Explored;
use JeroenG\Explorer\Application\Aliased;
use Laravel\Scout\Searchable;

class Post extends Model implements Explored, Aliased
{
    use HasFactory;
    use Searchable;

    //...
}
```

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

### Basic Scout Search

Source: https://github.com/jeroen-g/explorer/blob/master/readme.md

Perform a basic search using Laravel Scout. This is suitable for simple term searches.

```php
$posts = Post::search('lorem ipsum')->get();
```

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

### Log to a Laravel Channel by Name

Source: https://github.com/jeroen-g/explorer/blob/master/docs/logging.md

If you pass a string value as the logger, it will be interpreted as the name of a log channel in Laravel.

```php
'logger' => 'daily',
```

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

### Define Index Settings in a Model

Source: https://github.com/jeroen-g/explorer/blob/master/docs/index-settings.md

Implement the `IndexSettings` interface in your Eloquent model to define custom index settings, such as analyzers. Remember that any changes to index settings necessitate index recreation.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use JeroenG\Explorer\Application\Explored;
use JeroenG\Explorer\Application\IndexSettings;
use Laravel\Scout\Searchable;

class Post extends Model implements Explored, IndexSettings
{
    use HasFactory;
    use Searchable;

    protected $fillable = ['title', 'published'];

    public function mappableAs(): array
    {
        return [
            'id' => 'keyword',
            'title' => 'text',
            'published' => 'boolean',
            'created_at' => 'date',
        ];
    }
    
    public function indexSettings(): array
    {
        return [
            'analysis' => [
                'analyzer' => [
                    'standard_lowercase' => [
                        'type' => 'custom',
                        'tokenizer' => 'standard',
                        'filter' => ['lowercase'],
                    ],
                ],
            ],
        ];
    }
}
```

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

### Model-Based Mapping with Explored Interface

Source: https://github.com/jeroen-g/explorer/blob/master/docs/mapping.md

Implement the Explored interface in your Eloquent model and define the `mappableAs()` method to specify field mappings. This method allows for partial mappings, with other types being inferred.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use JeroenG\Explorer\Application\Explored;
use Laravel\Scout\Searchable;

class Post extends Model implements Explored
{
    use HasFactory;
    use Searchable;

    protected $fillable = ['title', 'published'];

    public function mappableAs(): array
    {
        return [
            'id' => 'keyword',
            'title' => 'text',
            'published' => 'boolean',
            'created_at' => 'date',
        ];
    }
}
```

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

### Enable Debugging for Scout Engine

Source: https://github.com/jeroen-g/explorer/blob/master/docs/debugging.md

Call the static `debug` method on the Elastic Engine for Laravel Scout to enable query inspection. This method returns a debug instance that can provide the last executed query.

```php
use JeroenG\Explorer\Infrastructure\Scout\ElasticEngine;

$debug = ElasticEngine::debug();
```

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

### Log to a Specific Laravel Channel

Source: https://github.com/jeroen-g/explorer/blob/master/docs/logging.md

Configure the logger to use a specific log channel provided by Laravel.

```php
'logger' => \Illuminate\\Support\\Facades\\Log::channel('daily'),
```

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

### Disable Logging with NullLogger

Source: https://github.com/jeroen-g/explorer/blob/master/docs/logging.md

Use a NullLogger to explicitly disable logging when the logger is enabled.

```php
'logger' => new \Psr\Log\NullLogger(),
```

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

### Configure Laravel Scout Driver

Source: https://github.com/jeroen-g/explorer/blob/master/docs/quickstart.md

Set the 'driver' to 'elastic' in your Laravel application's scout configuration file (config/scout.php) to enable Elasticsearch integration.

```php
'driver' => 'elastic',
```

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

### Laravel Feature Test with Fake Elasticsearch Response

Source: https://github.com/jeroen-g/explorer/blob/master/docs/testing.md

This snippet demonstrates how to set up a Laravel feature test to mock Elasticsearch responses using the Explorer package's fake capabilities. It's useful for testing API endpoints that interact with Elasticsearch without requiring a live instance.

```php
<?php

declare(strict_types=1);

namespace Tests\Feature\Api;

use JeroenG\Explorer\Infrastructure\Elastic\FakeResponse;
use Tests\TestCase;

class SearchControllerTest extends TestCase
{
    public function test_it_returns_results(): void
    {
        $fakeResponseFile = fopen(base_path("tests/Support/Elastic/Responses/example.json"), 'rb');
        
        $fakeResponse = new FakeResponse($statusCode, $fakeResponseFile);
        
        // see https://laravel.com/docs/mocking for more information
        $this->instance(ElasticClientFactory::class, ElasticClientFactory::fake($fakeResponse));

        $response = $this->post('api/search');

        $response->assertStatus(200);
    }
}
```

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

### Elastic Cloud ID Connection

Source: https://github.com/jeroen-g/explorer/blob/master/docs/connection.md

Connect to ElasticSearch using an Elastic Cloud ID. This is a convenient way to connect to managed ElasticSearch instances.

```php
return [
    'connection' => [
        'elasticCloudId' => 'staging:dXMtZWFzdC0xLmF3cy5mb3VuZC5pbyRjZWM2ZjI2MWE3NGJmMjRjZTMzYmI4ODExYjg0Mjk0ZiRjNmMyY2E2ZDA0MjI0OWFmMGNjN2Q3YTllOTYyNTc0Mw',
    ],
];
```

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

### Set Custom Search Result Size

Source: https://github.com/jeroen-g/explorer/blob/master/docs/pagination.md

Use the `take()` method on a Scout search query to specify the maximum number of results to retrieve from Elasticsearch. This is useful for controlling the size of paginated results.

```php
use App\Models\Post;

$results = Post::search('Spartans')->take(300)->get();
```

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

### Retrieve Selected Fields

Source: https://github.com/jeroen-g/explorer/blob/master/docs/advanced-queries.md

Use the field() method to specify which fields to retrieve from the search results. Note that this does not necessarily improve performance as the entire document is still processed by Elasticsearch.

```php
use App\Models\Post;

$results = Post::search('Self-steering')
    ->field('id')
    ->field('published_at')
    ->get();
```

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

### Track Total Hits Query Property

Source: https://github.com/jeroen-g/explorer/blob/master/docs/advanced-queries.md

Add the 'track_total_hits' query property using the TrackTotalHits class. You can set it to true, false, or a specific count.

```php
use App\Models\Post;
use JeroenG\Explorer\Domain\Query\QueryProperties\TrackTotalHits;

$results = Post::search('Self-steering')
    ->field('id')
    ->property(TrackTotalHits::all())
    ->get();
```

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

### Source Filter Query Property

Source: https://github.com/jeroen-g/explorer/blob/master/docs/advanced-queries.md

Apply source field filtering using the SourceFilter class. This allows you to include or exclude specific fields from the document source in the results.

```php
use App\Models\Post;
use JeroenG\Explorer\Domain\Query\QueryProperties\SourceFilter;

$results = Post::search('Self-steering')
    ->field('id')
    ->property(SourceFilter::empty()->include('*.description')->exclude('*_secret'))
    ->get();
```

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

### Retrieve Last Query as Array or JSON

Source: https://github.com/jeroen-g/explorer/blob/master/docs/debugging.md

Access the last executed query as a PHP array or a JSON string using the `array()` or `json()` methods on the debug instance. The JSON output can be directly used as an Elasticsearch query.

```php
$lastQueryAsArray = ElasticEngine::debug()->array();
$lastQueryAsJson = ElasticEngine::debug()->json();
```

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

### Delete Index for a Model

Source: https://github.com/jeroen-g/explorer/blob/master/docs/commands.md

Use the `scout:delete-index` command to remove the index associated with a specific model.

```bash
php artisan scout:delete-index <model>
```
Tokens:
Raw