Added support for dynamic indices

Author: pdphilip

README.md

@@ -1213,6 +1213,53 @@ Queues
 _[Coming]_
 
 
+Dynamic Indies
+========
+In some cases you will need to split a model into different indices. There are limits to this to keep within reasonable Laravel ORM bounds, but if you keep the index prefix consistent then the plugin can manage the rest. 
+
+For example, let's imagine we're tracking page hits, the `PageHit.php` model could be
+
+```php
+<?php
+
+namespace App\Models;
+
+use PDPhilip\Elasticsearch\Eloquent\Model as Eloquent;
+
+class PageHit extends Eloquent
+{
+    protected $connection = 'elasticsearch';
+    protected $index = 'page_hits_*'; //Dynamic index
+
+}
+```
+
+If you set a dynamic index you can read/search across all the indices that match the prefix `page_hits_`
+
+```php 
+$pageHits = PageHit::where('page_id',1)->get();
+```
+
+You will need to set the record's actual index when creating a new record, with `setIndex('value')` 
+
+Create example:
+```php
+$pageHit = new PageHit
+$pageHit->page_id = 4;
+$pageHit->ip = $someIp;
+$pageHit->setIndex('page_hits_'.date('Y-m-d'));
+$pageHit->save(); 
+
+```
+
+Each eloquent model will have the current record's index embedded into it, to retrieve it simply call `getRecordIndex()`
+```php
+$pageHit->getRecordIndex();  //returns page_hits_2021-01-01
+```
+
+
+```
+
 RAW DSL
 ========
 

src/DSL/Bridge.php

@@ -194,6 +194,9 @@ public function processSave($data, $refresh): Results
             $id = $data['_id'];
             unset($data['_id']);
         }
+        if (isset($data['_index'])) {
+            unset($data['_index']);
+        }
 //        $data = $this->cleanData($data);
         $params = [
             'index' => $this->index,
@@ -209,7 +212,6 @@ public function processSave($data, $refresh): Results
 
         try {
             $response = $this->client->index($params);
-
             $savedData = ['_id' => $response['_id']] + $data;
 
             return $this->_return($savedData, $response, $params, $this->_queryTag(__FUNCTION__));
@@ -613,10 +615,12 @@ private function _sanitizeSearchResponse($response, $params, $queryTag)
         $meta['timed_out'] = $response['timed_out'];
         $meta['total'] = $response['hits']['total']['value'] ?? 0;
         $meta['max_score'] = $response['hits']['max_score'] ?? 0;
+
         $data = [];
         if (!empty($response['hits']['hits'])) {
             foreach ($response['hits']['hits'] as $hit) {
                 $datum = [];
+                $datum['_index'] = $hit['_index'];
                 $datum['_id'] = $hit['_id'];
                 if (!empty($hit['_source'])) {
                     foreach ($hit['_source'] as $key => $value) {
@@ -632,7 +636,6 @@ private function _sanitizeSearchResponse($response, $params, $queryTag)
 
     private function _return($data, $meta, $params, $queryTag): Results
     {
-
         unset($meta['_source']);
 
         $results = new Results($data, $meta, $params, $queryTag);

src/DSL/QueryBuilder.php

@@ -173,7 +173,7 @@ private static function _ninQueryString($key, $values): string
     private static function _parseParams($key, $value): string
     {
 
-        if ($key == 'and' || $key == 'or') {
+        if ($key === 'and' || $key === 'or') {
             return self::{'_'.$key.'QueryString'}($value);
         }
         if (is_array($value)) {

src/Eloquent/Builder.php

@@ -3,6 +3,8 @@
 namespace PDPhilip\Elasticsearch\Eloquent;
 
 use Illuminate\Database\Eloquent\Builder as BaseEloquentBuilder;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\DB;
 use PDPhilip\Elasticsearch\Helpers\QueriesRelationships;
 
 class Builder extends BaseEloquentBuilder
@@ -77,7 +79,6 @@ public function getModels($columns = ['*'])
 
         $data = $this->query->get($columns);
         $results = $this->model->hydrate($data->all())->all();
-
         return ['results' => $results];
 
     }
@@ -343,4 +344,31 @@ public function fields(array $fields)
         return $this;
     }
 
+
+    public function hydrate(array $items)
+    {
+        $instance = $this->newModelInstance();
+        return $instance->newCollection(array_map(function ($item) use ($items, $instance) {
+            $recordIndex = null;
+            if (is_array($item)){
+                $recordIndex = !empty($item['_index']) ? $item['_index'] : null;
+                if ($recordIndex){
+                    unset($item['_index']);
+                }
+            }
+
+            $model = $instance->newFromBuilder($item);
+            if ($recordIndex){
+                $model->setRecordIndex($recordIndex);
+                $model->setIndex($recordIndex);
+
+            }
+            if (count($items) > 1) {
+                $model->preventsLazyLoading = Model::preventsLazyLoading();
+            }
+
+            return $model;
+        }, $items));
+    }
+
 }

src/Eloquent/Model.php

@@ -22,6 +22,8 @@ abstract class Model extends BaseModel
 
     protected $index;
 
+    protected $recordIndex;
+
     protected $primaryKey = '_id';
 
     protected $keyType = 'string';
@@ -33,12 +35,16 @@ public function __construct(array $attributes = [])
     {
         parent::__construct($attributes);
         $this->setIndex();
+        $this->setRecordIndex();
         $this->forcePrimaryKey();
     }
 
 
-    public function setIndex()
+    public function setIndex($index = null)
     {
+        if ($index){
+            return $this->index = $index;
+        }
         $this->index = $this->index ?? $this->getTable();
         unset($this->table);
     }
@@ -51,6 +57,20 @@ public function setTable($index)
         return $this;
     }
 
+    public function setRecordIndex($recordIndex = null)
+    {
+        if ($recordIndex){
+            return $this->recordIndex = $recordIndex;
+        }
+        return  $this->recordIndex = $this->index;
+    }
+
+    public function getRecordIndex()
+    {
+        return  $this->recordIndex;
+    }
+
+
 
     public function forcePrimaryKey()
     {
@@ -119,6 +139,11 @@ public function freshTimestamp()
      * @inheritdoc
      */
     public function getTable()
+    {
+        return $this->getIndex();
+    }
+
+    public function getIndex()
     {
         return $this->index ? : parent::getTable();
     }