Merge remote-tracking branch 'origin/dev-l9' into dev-l8

Author: pdphilip

README.md

@@ -1,10 +1,19 @@
 <img align="left" width="70" height="70" src="https://cdn.snipform.io/pdphilip/elasticsearch/laravel-x-es.png">
 
-# Laravel x Elasticsearch
+# Laravel-Elasticsearch
 
-This package extends Laravel's Eloquent model and query builder with seamless integration of Elasticsearch functionalities. Designed to feel native to Laravel, this plugin enables you to work with Eloquent models while leveraging the
+[![Latest Stable Version](http://img.shields.io/github/release/pdphilip/laravel-elasticsearch.svg)](https://packagist.org/packages/pdphilip/elasticsearch)
+[![Total Downloads](http://img.shields.io/packagist/dm/pdphilip/elasticsearch.svg)](https://packagist.org/packages/pdphilip/elasticsearch)
+
+### An Elasticsearch implementation of Laravel's Eloquent ORM
+
+This package extends Laravel's Eloquent model and query builder with seamless integration of Elasticsearch functionalities. Designed to feel native to Laravel, this package enables you to work with Eloquent models while leveraging the
 powerful search and analytics capabilities of Elasticsearch.
 
+```php
+$logs = UserLog::where('type', UserLogType::LOGIN)->where('created_at','>=',Carbon::now()->subDays(30))->get();
+```
+
 ### Read the [Documentation](https://elasticsearch.pdphilip.com/)
 
 ---
@@ -44,7 +53,115 @@ composer require pdphilip/elasticsearch
 | Laravel 7.x       | `composer require pdphilip/elasticsearch:~1.7` | ❌         |
 | Laravel 6.x (5.8) | `composer require pdphilip/elasticsearch:~1.6` | ❌         |
 
-Next, [Configuration](https://elasticsearch.pdphilip.com/#configuration)
+## Configuration
+
+1. Set up your `.env` with the following Elasticsearch settings:
+
+```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
+# prefix will be added to all indexes created by the package with an underscore
+# ex: my_app_user_logs for UserLog.php model
+ES_SSL_CERT=
+ES_SSL_CERT_PASSWORD=
+ES_SSL_KEY=
+ES_SSL_KEY_PASSWORD=
+# Options
+ES_OPT_ID_SORTABLE=false
+ES_OPT_VERIFY_SSL=true
+ES_OPT_RETRIES=
+ES_OPT_META_HEADERS=true
+```
+
+For multiple nodes, pass in as comma-separated:
+
+```ini
+ES_HOSTS="http://es01:9200,http://es02:9200,http://es03:9200"
+```
+
+<details>
+<summary>Example cloud config .env: (Click to expand)</summary>
+
+```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
+```
+
+</details>
+
+2. In `config/database.php`, add the elasticsearch connection:
+
+```php
+'elasticsearch' => [
+    'driver'       => 'elasticsearch',
+    'auth_type'    => env('ES_AUTH_TYPE', 'http'), //http or cloud
+    'hosts'        => explode(',', env('ES_HOSTS', 'http://localhost:9200')),
+    'username'     => env('ES_USERNAME', ''),
+    'password'     => env('ES_PASSWORD', ''),
+    'cloud_id'     => env('ES_CLOUD_ID', ''),
+    'api_id'       => env('ES_API_ID', ''),
+    'api_key'      => env('ES_API_KEY', ''),
+    'ssl_cert'     => env('ES_SSL_CA', ''),
+    'ssl'          => [
+        'cert'          => env('ES_SSL_CERT', ''),
+        'cert_password' => env('ES_SSL_CERT_PASSWORD', ''),
+        'key'           => env('ES_SSL_KEY', ''),
+        'key_password'  => env('ES_SSL_KEY_PASSWORD', ''),
+    ],
+    'index_prefix' => env('ES_INDEX_PREFIX', false),
+    'options'      => [
+        'allow_id_sort'    => env('ES_OPT_ID_SORTABLE', false),
+        'ssl_verification' => env('ES_OPT_VERIFY_SSL', true),
+        'retires'          => env('ES_OPT_RETRIES', null),
+        'meta_header'      => env('ES_OPT_META_HEADERS', true),
+    ],
+    'query_log'    => [
+        'index'      => false, //Or provide a name for the logging index ex: 'laravel_query_logs'
+        'error_only' => true, //If false, then all queries are logged if the query_log index is set
+    ],
+],
+```
+
+### 3. If packages are not autoloaded, add the service provider:
+
+For **Laravel 10 and below**:
+
+```php
+//config/app.php
+'providers' => [
+    ...
+    ...
+    PDPhilip\Elasticsearch\ElasticServiceProvider::class,
+    ...
+
+```
+
+For **Laravel 11**:
+
+```php
+//bootstrap/providers.php
+<?php
+return [
+    App\Providers\AppServiceProvider::class,
+    PDPhilip\Elasticsearch\ElasticServiceProvider::class,
+];
+```
+
+Now, you're all set to use Elasticsearch with Laravel as if it were native to the framework.
 
 ---
 
@@ -63,8 +180,9 @@ Next, [Configuration](https://elasticsearch.pdphilip.com/#configuration)
 -   [Deleting Models](https://elasticsearch.pdphilip.com/deleting-models)
 -   [Ordering and Pagination](https://elasticsearch.pdphilip.com/ordering-and-pagination)
 -   [Distinct and GroupBy](https://elasticsearch.pdphilip.com/distinct)
--   [Aggregations](https://elasticsearch.pdphilip.com/aggregations)
+-   [Aggregations](https://elasticsearch.pdphilip.com/aggregation)
 -   [Chunking](https://elasticsearch.pdphilip.com/chunking)
+-   [Nested Queries](https://elasticsearch.pdphilip.com/nested-queries) **New in Version 3**
 -   [Elasticsearch Specific Queries](https://elasticsearch.pdphilip.com/es-specific)
 -   [Full-Text Search](https://elasticsearch.pdphilip.com/full-text-search)
 -   [Dynamic Indices](https://elasticsearch.pdphilip.com/dynamic-indices)

src/Connection.php

@@ -17,15 +17,17 @@ class Connection extends BaseConnection
     protected $index;
     protected $maxSize;
     protected $indexPrefix;
-    
+    protected $retires = null; //null will use default
+    protected $sslVerification = true;
+    protected $elasticMetaHeader = true;
+    protected $rebuild = false;
+    protected $allowIdSort = false;
 
     public function __construct(array $config)
     {
         $this->config = $config;
 
-        if (!empty($config['index_prefix'])) {
-            $this->indexPrefix = $config['index_prefix'];
-        }
+        $this->setOptions($config);
 
         $this->client = $this->buildConnection();
 
@@ -37,7 +39,26 @@ public function __construct(array $config)
 
     }
 
-    public function getIndexPrefix(): string
+    public function setOptions($config)
+    {
+        if (!empty($config['index_prefix'])) {
+            $this->indexPrefix = $config['index_prefix'];
+        }
+        if (!empty($config['options']['allow_id_sort'])) {
+            $this->allowIdSort = $config['options']['allow_id_sort'];
+        }
+        if (!empty($config['options']['ssl_verification'])) {
+            $this->sslVerification = $config['options']['ssl_verification'];
+        }
+        if (!empty($config['options']['retires'])) {
+            $this->retires = $config['options']['retires'];
+        }
+        if (!empty($config['options']['meta_header'])) {
+            $this->elasticMetaHeader = $config['options']['meta_header'];
+        }
+    }
+    
+    public function getIndexPrefix(): string|null
     {
         return $this->indexPrefix;
     }
@@ -48,7 +69,7 @@ public function setIndexPrefix($newPrefix): void
     }
 
 
-    public function getTablePrefix(): string
+    public function getTablePrefix(): string|null
     {
         return $this->getIndexPrefix();
     }
@@ -57,7 +78,7 @@ public function setIndex($index): string
     {
         $this->index = $index;
         if ($this->indexPrefix) {
-            if (!(strpos($this->index, $this->indexPrefix.'_') !== false)) {
+            if (!(str_contains($this->index, $this->indexPrefix.'_'))) {
                 $this->index = $this->indexPrefix.'_'.$index;
             }
         }
@@ -138,6 +159,26 @@ protected function getDefaultSchemaGrammar()
         return new Schema\Grammar();
     }
 
+    public function rebuildConnection()
+    {
+        $this->rebuild = true;
+    }
+    
+    public function getClient()
+    {
+        return $this->client;
+    }
+    
+    public function getMaxSize()
+    {
+        return $this->maxSize;
+    }
+    
+    public function getAllowIdSort()
+    {
+        return $this->allowIdSort;
+    }
+    
 
     //----------------------------------------------------------------------
     // Connection Builder
@@ -160,13 +201,15 @@ protected function _httpConnection(): Client
         $hosts = config('database.connections.elasticsearch.hosts') ?? null;
         $username = config('database.connections.elasticsearch.username') ?? null;
         $pass = config('database.connections.elasticsearch.password') ?? null;
-        $certPath = config('database.connections.elasticsearch.ssl_cert') ?? null;
+        $apiId = config('database.connections.elasticsearch.api_id') ?? null;
+        $apiKey = config('database.connections.elasticsearch.api_key') ?? null;
         $cb = ClientBuilder::create()->setHosts($hosts);
+        $cb = $this->_builderOptions($cb);
         if ($username && $pass) {
-            $cb->setBasicAuthentication($username, $pass)->build();
+            $cb->setBasicAuthentication($username, $pass);
         }
-        if ($certPath) {
-            $cb->setCABundle($certPath);
+        if ($apiKey) {
+            $cb->setApiKey($apiKey, $apiId);
         }
 
         return $cb->build();
@@ -179,20 +222,45 @@ protected function _cloudConnection(): Client
         $pass = config('database.connections.elasticsearch.password') ?? null;
         $apiId = config('database.connections.elasticsearch.api_id') ?? null;
         $apiKey = config('database.connections.elasticsearch.api_key') ?? null;
-        $certPath = config('database.connections.elasticsearch.ssl_cert') ?? null;
+        
         $cb = ClientBuilder::create()->setElasticCloudId($cloudId);
-        if ($apiId && $apiKey) {
-            $cb->setApiKey($apiKey, $apiId)->build();
-        } elseif ($username && $pass) {
-            $cb->setBasicAuthentication($username, $pass)->build();
+        $cb = $this->_builderOptions($cb);
+        if ($username && $pass) {
+            $cb->setBasicAuthentication($username, $pass);
         }
-        if ($certPath) {
-            $cb->setSSLVerification($certPath);
+        if ($apiKey) {
+            $cb->setApiKey($apiKey, $apiId);
         }
 
+        
         return $cb->build();
     }
 
+    protected function _builderOptions($cb)
+    {
+        $cb->setSSLVerification($this->sslVerification);
+        $cb->setElasticMetaHeader($this->elasticMetaHeader);
+        if ($this->retires) {
+            $cb->setRetries($this->retires);
+        }
+        $caBundle = config('database.connections.elasticsearch.ssl_cert') ?? null;
+        if ($caBundle) {
+            $cb->setCABundle($caBundle);
+        }
+        $sslCert = config('database.connections.elasticsearch.ssl.cert') ?? null;
+        $sslCertPassword = config('database.connections.elasticsearch.ssl.cert_password') ?? null;
+        $sslKey = config('database.connections.elasticsearch.ssl.key') ?? null;
+        $sslKeyPassword = config('database.connections.elasticsearch.ssl.key_password') ?? null;
+        if ($sslCert) {
+            $cb->setSSLCert($sslCert, $sslCertPassword);
+        }
+        if ($sslKey) {
+            $cb->setSSLKey($sslKey, $sslKeyPassword);
+        }
+        
+        return $cb;
+    }
+    
 
     //----------------------------------------------------------------------
     // Dynamic call routing to DSL bridge
@@ -203,8 +271,11 @@ public function __call($method, $parameters)
         if (!$this->index) {
             $this->index = $this->indexPrefix.'*';
         }
-        
-        $bridge = new Bridge($this->client, $this->index, $this->maxSize, $this->indexPrefix);
+        if ($this->rebuild) {
+            $this->client = $this->buildConnection();
+            $this->rebuild = false;
+        }
+        $bridge = new Bridge($this);
 
         return $bridge->{'process'.Str::studly($method)}(...$parameters);
     }