Function updated and bug fixes

- functionScore() working
- Matrix agg against multiple fields
- mappings default to flat,
- Direct Client indices()
- model docs

Author: pdphilip

src/Connection.php

@@ -7,6 +7,7 @@
 use Closure;
 use Elastic\Elasticsearch\Client;
 use Elastic\Elasticsearch\ClientBuilder;
+use Elastic\Elasticsearch\Endpoints\Indices;
 use Elastic\Elasticsearch\Exception\AuthenticationException;
 use Elastic\Elasticsearch\Exception\ClientResponseException;
 use Elastic\Elasticsearch\Exception\MissingParameterException;
@@ -413,6 +414,11 @@ public function getMappings($index): array
         return $this->connection->getMappings($index);
     }
 
+    public function indices(): Indices
+    {
+        return $this->connection->indices();
+    }
+
     // ----------------------------------------------------------------------
     // Query Execution
     // ----------------------------------------------------------------------

src/ElasticClient.php

@@ -3,6 +3,7 @@
 namespace PDPhilip\Elasticsearch;
 
 use Elastic\Elasticsearch\Client;
+use Elastic\Elasticsearch\Endpoints\Indices;
 use Elastic\Elasticsearch\Exception\ClientResponseException;
 use Elastic\Elasticsearch\Exception\MissingParameterException;
 use Elastic\Elasticsearch\Exception\ServerResponseException;
@@ -95,6 +96,11 @@ public function clearScroll(array $params = []): Elasticsearch|Promise
     // Indices
     // ----------------------------------------------------------------------
 
+    public function indices(): Indices
+    {
+        return $this->client->indices();
+    }
+
     /**
      * @throws ServerResponseException
      * @throws ClientResponseException

src/Eloquent/Builder.php

@@ -560,19 +560,19 @@ public function deleteIndexIfExists(): void
         Schema::connection($this->query->connection->getName())->dropIfExists($this->from);
     }
 
-    public function getIndexMappings(bool $flatten = true): array
+    public function getIndexMappings(bool $raw = false): array
     {
-        return Schema::on($this->query->connection->getName())->getMappings($this->from, $flatten);
+        return Schema::on($this->query->connection->getName())->getMappings($this->from, $raw);
     }
 
-    public function getFieldMappings(bool $flatten = true): array
+    public function getFieldMappings(bool $raw = false): array
     {
-        return Schema::connection($this->query->connection->getName())->getFieldMapping($this->from, '*', $flatten);
+        return Schema::connection($this->query->connection->getName())->getFieldMapping($this->from, '*', $raw);
     }
 
-    public function getFieldMapping(string|array $field = '*', bool $flatten = true): array
+    public function getFieldMapping(string|array $field = '*', bool $raw = false): array
     {
-        return Schema::connection($this->query->connection->getName())->getFieldMapping($this->from, $field, $flatten);
+        return Schema::connection($this->query->connection->getName())->getFieldMapping($this->from, $field, $raw);
     }
 
     public function getIndexSettings(): array

src/Eloquent/Docs/ModelDocs.php

@@ -8,16 +8,15 @@
 use Illuminate\Contracts\Database\Query\Expression;
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 use Illuminate\Pagination\Cursor;
-use PDPhilip\Elasticsearch\Collection\ElasticCollection;
-use PDPhilip\Elasticsearch\Connection;
+use PDPhilip\Elasticsearch\Eloquent\Builder;
+use PDPhilip\Elasticsearch\Eloquent\ElasticCollection;
 use PDPhilip\Elasticsearch\Eloquent\Model;
 use PDPhilip\Elasticsearch\Pagination\SearchAfterPaginator;
-use PDPhilip\Elasticsearch\Query\Builder;
 
 /**
  * Query Builder Methods ---------------------------------
  *
- * @method static $this query()
+ * @method static Builder query()
  * @method static $this where(array|Closure|Expression|string $column, $operator = null, $value = null, $boolean = 'and')
  * @method static $this whereIn(string $column, array $values)
  * @method static $this whereExact(string $column, string $value, $boolean = 'and')
@@ -86,15 +85,14 @@
  * @method static ElasticCollection insert($values, $returnData = null):
  * @method static ElasticCollection insertWithoutRefresh($values, $returnData = null)
  * @method static array toDsl(array $columns = ['*'])
+ * @method static array toSql(array $columns = ['*'])
  * @method static mixed rawDsl(array $bodyParams)
  * @method static ElasticCollection rawSearch(array $bodyParams)
  * @method static array rawAggregation(array $bodyParams)
  * @method static bool chunk(mixed $count, callable $callback, string $keepAlive = '5m')
  * @method static bool chunkById(mixed $count, callable $callback, $column = '_id', $alias = null, $keepAlive = '5m')
  *
  * Index Methods ---------------------------------
- * @method static string getQualifiedKeyName()
- * @method static Connection getConnection()
  * @method static void truncate()
  * @method static bool indexExists()
  * @method static bool deleteIndexIfExists()
@@ -104,27 +102,6 @@
  * @method static array getFieldMapping(string|array $field = '*', $raw = false)
  * @method static array getIndexOptions()
  *
- * Search Methods - Due for sunsetting, keep for now
- * @method static $this term(string $term, $boostFactor = null)
- * @method static $this andTerm(string $term, $boostFactor = null)
- * @method static $this orTerm(string $term, $boostFactor = null)
- * @method static $this fuzzyTerm(string $term, $boostFactor = null)
- * @method static $this andFuzzyTerm(string $term, $boostFactor = null)
- * @method static $this orFuzzyTerm(string $term, $boostFactor = null)
- * @method static $this regEx(string $term, $boostFactor = null)
- * @method static $this andRegEx(string $term, $boostFactor = null)
- * @method static $this orRegEx(string $term, $boostFactor = null)
- * @method static $this phrase(string $term, $boostFactor = null)
- * @method static $this andPhrase(string $term, $boostFactor = null)
- * @method static $this orPhrase(string $term, $boostFactor = null)
- * @method static $this minShouldMatch(int $value)
- * @method static $this highlight(array $fields = [], string|array $preTag = '<em>', string|array $postTag = '</em>', $globalOptions = [])
- * @method static $this minScore(float $value)
- * @method static $this field(string $field, int $boostFactor = null)
- * @method static $this fields(array $fields)
- * @method static array searchModels(array $columns = ['*'])
- * @method static ElasticCollection search(array $columns = ['*'])
- *
  * @property object $search_highlights
  * @property object $with_highlights
  * @property array $search_highlights_as_array

src/Eloquent/ElasticsearchModel.php

@@ -12,6 +12,7 @@
 use Illuminate\Support\Str;
 use PDPhilip\Elasticsearch\Connection;
 use PDPhilip\Elasticsearch\Data\ModelMeta;
+use PDPhilip\Elasticsearch\Eloquent\Docs\ModelDocs;
 use PDPhilip\Elasticsearch\Exceptions\RuntimeException;
 use PDPhilip\Elasticsearch\Traits\HasOptions;
 
@@ -21,10 +22,11 @@
  * @property object $withHighlights
  *
  * @mixin \PDPhilip\Elasticsearch\Query\Builder
+ * @mixin \PDPhilip\Elasticsearch\Eloquent\Builder
  */
 trait ElasticsearchModel
 {
-    use HasOptions, HybridRelations;
+    use HasOptions, HybridRelations, ModelDocs;
 
     protected ?ModelMeta $meta;
 

src/Query/Builder.php

@@ -1750,12 +1750,15 @@ public function stringStats($columns, $options = [])
      */
     protected function aggregateMetric($function, $columns = ['*'], $options = [])
     {
+        if ($function == 'matrix_stats' && is_array($columns)) {
+            $args = $columns;
+        }
         // Each column we want aggregated
         $columns = Arr::wrap($columns);
         foreach ($columns as $column) {
             $this->metricsAggregations[] = [
                 'key' => $column,
-                'args' => $column,
+                'args' => ! empty($args) ? $args : $column,
                 'type' => $function,
                 'options' => $options,
             ];
@@ -2034,15 +2037,15 @@ public function dynamicFilter(string $method, array $args): self
     /**
      * Adds a function score of any type
      *
-     * @param  string  $boolean
-     * @param  array  $options  see elastic search docs for options
+     * @param  string  $functionType
+     * @param  array  $functionOptions  see elastic search docs for options
      */
-    public function functionScore($functionType, callable $query, $boolean = 'and', $options = []): self
+    public function functionScore($functionType, array $functionOptions, callable $query, string $boolean = 'and'): self
     {
-
         $type = 'FunctionScore';
+        $options = $functionOptions;
 
-        call_user_func($query, $query = $this->newQuery());
+        call_user_func($query, $query = $this->newQuery($this->from));
 
         $this->wheres[] = compact('functionType', 'query', 'type', 'boolean', 'options');
 
@@ -2101,7 +2104,7 @@ public function getMapping()
     {
         if (empty($this->mapping)) {
             $index = $this->getFrom();
-            $this->mapping = Schema::connection($this->connection->getName())->getFieldsMapping($index, true);
+            $this->mapping = Schema::connection($this->connection->getName())->getFieldsMapping($index);
         }
 
         return $this->mapping;

src/Query/DSL/DslFactory.php

@@ -255,12 +255,12 @@ public static function prefix(string $field, string $value, array $options = [])
         ];
     }
 
-    public static function functionScore(array $query, string $functionType, array $options = []): array
+    public static function functionScore(array $query, string $functionType, array $functionOptions = []): array
     {
         return [
             'function_score' => array_merge(
-                [$functionType => ['query' => $query]],
-                $options
+                ['query' => $query],
+                [$functionType => $functionOptions],
             ),
         ];
     }
@@ -355,11 +355,11 @@ public static function composite(array $sources, ?int $size = null, ?array $afte
         ];
     }
 
-    public static function matrixStats(string $field, array $options = []): array
+    public static function matrixStats(mixed $fields, array $options = []): array
     {
         return [
             'matrix_stats' => array_merge(
-                ['fields' => $field],
+                ['fields' => $fields],
                 $options
             ),
         ];

src/Query/Grammar.php

@@ -444,7 +444,6 @@ protected function compileWhereBetween(Builder $builder, array $where): array
     protected function compileWhereFunctionScore(Builder $builder, array $where): array
     {
         $compiled = $this->compileWheres($where['query']);
-
         foreach ($compiled as $queryPart => $clauses) {
             $compiled[$queryPart] = array_map(function ($clause) use ($where) {
                 if ($clause) {
@@ -457,9 +456,9 @@ protected function compileWhereFunctionScore(Builder $builder, array $where): ar
 
         $compiled = array_filter($compiled);
         $functionType = $where['functionType'];
-        $options = $where['options'] ?? [];
+        $functionOptions = $where['options'];
 
-        return DslFactory::functionScore($compiled['query'], $functionType, $options);
+        return DslFactory::functionScore($compiled['query'], $functionType, $functionOptions);
     }
 
     /**
@@ -960,7 +959,6 @@ protected function compileMetricAggregations(Builder $builder): array
 
         foreach ($builder->metricsAggregations as $aggregation) {
             $result = $this->compileAggregation($builder, $aggregation);
-
             $aggregations = array_merge_recursive($aggregations, $result);
         }
 
@@ -1138,10 +1136,11 @@ protected function compileBoxplotAggregation(Builder $builder, array $aggregatio
      */
     protected function compileMatrixStatsAggregation(Builder $builder, array $aggregation): array
     {
+
         $options = $aggregation['options'] ?? [];
-        $field = is_array($aggregation['args']) ? $aggregation['args']['field'] : $aggregation['args'];
+        $fields = $aggregation['args'];
 
-        return DslFactory::matrixStats($field, $options);
+        return DslFactory::matrixStats($fields, $options);
     }
 
     /**