Added support for dynamic indices , close #2

Author: pdphilip

README.md

@@ -15,22 +15,10 @@ Elasticsearch in laravel as if it were native to Laravel, meaning:
     - [Migrations](#migrations)
     - ES features like [Geo Filtering](#geo) & [Regular Expressions](#regex-in-where)
 
-- No need to write your own DSL queries ([unless you want to](#raw-dsl)!)
+- [Dynamic Indices](#dynamic-indies)
+- No need to write your own DSL queries ([unless you want to](#raw-dsl))
 - [Eloquent style searching](#elasticsearching)
 
-> # Alpha release notice
-> This package is being released prematurely to an interested community of testers. It is not ready for production just yet only due to a lack of testing mileage. Once deemed stable, the plugin will move to V1. Elasticsearch is a deep topic on its own and there are many native features that have not yet been included.
->
-> #### Versioning Schema: {plugin_version}.{laravel_version}.{iteration}
->
-> ex: 0.8.1
->
-> Version 0 will be alpha & beta    
-> Version 1 will be RC & stable     
-> Version 2+ will be next gen feature set
-
-____
-
 Installation
 ===============
 
@@ -632,7 +620,7 @@ Book::term('Eric')->search();
 
 - To search across all the fields in the **books** index for: **eric OR (lean AND startup)**
 - ***Note**: You can't start a search query chain with and/or and you can't have subsequent chained terms without and/or
-  - **ordering matters***
+    - **ordering matters***
 
 ```php
 Book::term('Eric')->orTerm('Lean')->andTerm('Startup')->search();
@@ -1274,6 +1262,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

@@ -119,18 +119,20 @@ public function processFind($wheres, $options, $columns): Results
 //            }
 //        }
         $params = $this->buildParams($this->index, $wheres, $options, $columns);
-        return $this->_returnSearch($params,__FUNCTION__);
+
+        return $this->_returnSearch($params, __FUNCTION__);
 
     }
 
-    public function processSearch($searchParams,$searchOptions,$wheres,$opts,$fields,$cols)
+    public function processSearch($searchParams, $searchOptions, $wheres, $opts, $fields, $cols)
     {
-        $params = $this->buildSearchParams($this->index, $searchParams, $searchOptions,$wheres,$opts,$fields,$cols);
-        return $this->_returnSearch($params,__FUNCTION__);
+        $params = $this->buildSearchParams($this->index, $searchParams, $searchOptions, $wheres, $opts, $fields, $cols);
+
+        return $this->_returnSearch($params, __FUNCTION__);
 
     }
 
-    protected function _returnSearch($params,$source)
+    protected function _returnSearch($params, $source)
     {
         if (empty($params['size'])) {
             $params['size'] = $this->maxSize;
@@ -151,7 +153,7 @@ public function processDistinct($column, $wheres): Results
         if (is_array($column)) {
             $col = $column[0];
         }
-        $params = $this->buildParams($this->index,$wheres);
+        $params = $this->buildParams($this->index, $wheres);
         $params['body']['aggs']['distinct_'.$col]['terms'] = [
             'field' => $col,
             'size'  => $this->maxSize,
@@ -177,7 +179,7 @@ public function processDistinct($column, $wheres): Results
 
     public function processShowQuery($wheres, $options, $columns)
     {
-        $params = $this->buildParams($this->index,$wheres, $options, $columns);
+        $params = $this->buildParams($this->index, $wheres, $options, $columns);
 
         return $params['body']['query']['query_string']['query'] ?? null;
     }
@@ -194,7 +196,9 @@ public function processSave($data, $refresh): Results
             $id = $data['_id'];
             unset($data['_id']);
         }
-//        $data = $this->cleanData($data);
+        if (isset($data['_index'])) {
+            unset($data['_index']);
+        }
         $params = [
             'index' => $this->index,
             'body'  => $data,
@@ -551,7 +555,7 @@ private function _minAggregate($wheres, $options, $columns): Results
 
     private function _sumAggregate($wheres, $options, $columns): Results
     {
-        $params = $this->buildParams($this->index,$wheres, $options);
+        $params = $this->buildParams($this->index, $wheres, $options);
         try {
             $agg = new SumAggregation('sum_value', $columns[0]);
             $params['body']['aggs']['sum_value'] = $agg->toArray();
@@ -583,7 +587,7 @@ private function _avgAggregate($wheres, $options, $columns): Results
 
     private function _matrixAggregate($wheres, $options, $columns): Results
     {
-        $params = $this->buildParams($this->index,$wheres, $options);
+        $params = $this->buildParams($this->index, $wheres, $options);
         try {
             $agg = new MatrixAggregation('sum_value', $columns);
             $params['body']['aggs']['statistics'] = $agg->toArray();
@@ -617,6 +621,7 @@ private function _sanitizeSearchResponse($response, $params, $queryTag)
         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) {

src/DSL/QueryBuilder.php

@@ -18,42 +18,42 @@ trait QueryBuilder
 
     protected static $equivalenceOperators = ['in', 'nin'];
 
-    protected static $clauseOperators = ['ne', 'gt', 'gte', 'lt', 'lte', 'between', 'not_between', 'like', 'not_like', 'exists','regex'];
+    protected static $clauseOperators = ['ne', 'gt', 'gte', 'lt', 'lte', 'between', 'not_between', 'like', 'not_like', 'exists', 'regex'];
 
 
     //======================================================================
     // Parameter builders
     //======================================================================
 
-    public static function buildSearchParams($index, $searchQuery, $searchOptions,$wheres = [],$options = [],$fields = [],$columns = [])
+    public static function buildSearchParams($index, $searchQuery, $searchOptions, $wheres = [], $options = [], $fields = [], $columns = [])
     {
         $params = [];
-        if ($index){
+        if ($index) {
             $params['index'] = $index;
         }
         $params['body'] = [];
 
 
         $queryString['query'] = $searchQuery;
-        if($wheres){
+        if ($wheres) {
             $wheres = self::_buildQuery($wheres);
             $whereQueryString = $wheres['query']['query_string']['query'] ?? null;
-            if ($whereQueryString){
+            if ($whereQueryString) {
                 $queryString['query'] = '('.$searchQuery.') AND '.$whereQueryString;
             }
         }
 
-        if ($fields){
+        if ($fields) {
             $queryString['fields'] = [];
-            foreach ($fields as $field => $boostLevel){
-                if($boostLevel > 1){
+            foreach ($fields as $field => $boostLevel) {
+                if ($boostLevel > 1) {
                     $field = $field.'^'.$boostLevel;
                 }
                 $queryString['fields'][] = $field;
             }
         }
-        if ($searchOptions){
-            foreach ($searchOptions as $searchOption => $searchOptionValue){
+        if ($searchOptions) {
+            foreach ($searchOptions as $searchOption => $searchOptionValue) {
                 $queryString[$searchOption] = $searchOptionValue;
             }
         }
@@ -63,7 +63,7 @@ public static function buildSearchParams($index, $searchQuery, $searchOptions,$w
         if ($columns && $columns != '*') {
             $params['body']['_source'] = $columns;
         }
-        if ($options){
+        if ($options) {
             $opts = self::_buildOptions($options);
             if ($opts) {
                 foreach ($opts as $key => $value) {
@@ -75,17 +75,18 @@ public static function buildSearchParams($index, $searchQuery, $searchOptions,$w
                 }
             }
         }
-        if (self::$filter){
+        if (self::$filter) {
             $params = self::_parseFilterParameter($params, self::$filter);
         }
+
         return $params;
     }
 
     public static function buildParams($index, $wheres, $options = [], $columns = [], $_id = null)
     {
-        if ($index){
+        if ($index) {
             $params = [
-                'index' => $index
+                'index' => $index,
             ];
         }
 
@@ -108,7 +109,7 @@ public static function buildParams($index, $wheres, $options = [], $columns = []
                 }
             }
         }
-        if (self::$filter){
+        if (self::$filter) {
             $params = self::_parseFilterParameter($params, self::$filter);
         }
 
@@ -173,7 +174,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)) {
@@ -301,8 +302,8 @@ private static function _buildOptions($options): array
                         $return['body']['min_score'] = $value;
                         break;
                     case 'filters':
-                        foreach ($value as $filterType => $filerValues){
-                            self::_parseFilter($filterType,$filerValues);
+                        foreach ($value as $filterType => $filerValues) {
+                            self::_parseFilter($filterType, $filerValues);
                         }
                         break;
                     case 'multiple':
@@ -318,22 +319,22 @@ private static function _buildOptions($options): array
         return $return;
     }
 
-    public static function _parseFilter($filterType,$filterPayload)
+    public static function _parseFilter($filterType, $filterPayload)
     {
-        switch ($filterType){
+        switch ($filterType) {
             case 'filterGeoBox':
                 self::$filter['filter']['geo_bounding_box'][$filterPayload['field']] = [
-                    'top_left' => $filterPayload['topLeft'],
+                    'top_left'     => $filterPayload['topLeft'],
                     'bottom_right' => $filterPayload['bottomRight'],
                 ];
                 break;
             case 'filterGeoPoint':
                 self::$filter['filter']['geo_distance'] = [
-                    'distance' => $filterPayload['distance'],
+                    'distance'              => $filterPayload['distance'],
                     $filterPayload['field'] => [
                         'lat' => $filterPayload['geoPoint'][0],
                         'lon' => $filterPayload['geoPoint'][1],
-                    ]
+                    ],
 
                 ];
                 break;
@@ -354,35 +355,36 @@ private static function _parseSortOrder($value): array
         return $sort->toArray();
     }
 
-    public static function _parseFilterParameter($params,$filer)
+    public static function _parseFilterParameter($params, $filer)
     {
         $body = $params['body'];
-        if (!empty($body['query']['match_all'])){
+        if (!empty($body['query']['match_all'])) {
             $filteredBody = [
                 'query' => [
                     'bool' => [
-                        'must' => [
+                        'must'   => [
                             'match_all' => $body['query']['match_all'],
                         ],
-                        'filter' => $filer['filter']
-                    ]
-                ]
+                        'filter' => $filer['filter'],
+                    ],
+                ],
             ];
             $params['body'] = $filteredBody;
         }
-        if (!empty($body['query']['query_string'])){
+        if (!empty($body['query']['query_string'])) {
             $filteredBody = [
                 'query' => [
                     'bool' => [
-                        'must' => [
+                        'must'   => [
                             'query_string' => $body['query']['query_string'],
                         ],
-                        'filter' => $filer['filter']
-                    ]
-                ]
+                        'filter' => $filer['filter'],
+                    ],
+                ],
             ];
             $params['body'] = $filteredBody;
         }
+
         return $params;
     }
 }