Merge pull request #66 from ensi-platform/v7-search-type

V7 add search type and boost

Author: MsNatali

src/Concerns/InteractsWithIndex.php

@@ -29,17 +29,17 @@ protected function settings(): array
     /**
      * @see SearchIndex::search()
      */
-    public function search(array $dsl): array
+    public function search(array $dsl, ?string $searchType = null): array
     {
-        return $this->resolveClient()->search($this->indexName(), $dsl);
+        return $this->resolveClient()->search($this->indexName(), $dsl, $searchType);
     }
 
     /**
      * @see SearchIndex::search()
      */
-    public function searchAsync(array $dsl): FutureArray
+    public function searchAsync(array $dsl, ?string $searchType = null): FutureArray
     {
-        return $this->resolveClient()->searchAsync($this->indexName(), $dsl);
+        return $this->resolveClient()->searchAsync($this->indexName(), $dsl, $searchType);
     }
 
     /**

src/Contracts/MultiMatchOptions.php

@@ -14,7 +14,8 @@ public static function make(
         ?string $type = null,
         ?string $operator = null,
         ?string $fuzziness = null,
-        ?string $minimumShouldMatch = null
+        ?string $minimumShouldMatch = null,
+        ?float $boost = null,
     ): static {
         Assert::nullOrOneOf($type, MatchType::cases());
         Assert::nullOrOneOf($operator, ['or', 'and']);
@@ -24,6 +25,7 @@ public static function make(
             'operator' => $operator,
             'fuzziness' => $fuzziness,
             'minimum_should_match' => $minimumShouldMatch,
+            'boost' => $boost,
         ]));
     }
 

src/Contracts/SearchIndex.php

@@ -15,9 +15,10 @@ public function tiebreaker(): string;
      * Perform search query.
      *
      * @param array $dsl
+     * @param string|null $searchType
      * @return array
      */
-    public function search(array $dsl): array;
+    public function search(array $dsl, ?string $searchType = null): array;
 
     /**
      * Perform delete by query.

src/ElasticClient.php

@@ -22,24 +22,31 @@ public function getClient(): Client
         return $this->client;
     }
 
-    public function search(string $indexName, array $dsl): array
+    public function search(string $indexName, array $dsl, ?string $searchType = null): array
     {
         $this->queryLog?->log($indexName, $dsl);
 
-        return $this->client->search([
-            'index' => $indexName,
-            'body' => $dsl,
-        ]);
+        return $this->client
+            ->search(
+                array_filter([
+                    'index' => $indexName,
+                    'body' => $dsl,
+                    'search_type' => $searchType,
+                ])
+            );
     }
 
-    public function searchAsync(string $indexName, array $dsl): FutureArray
+    public function searchAsync(string $indexName, array $dsl, ?string $searchType = null): FutureArray
     {
         $this->queryLog?->log($indexName, $dsl);
 
-        return $this->client->search($this->paramsAsync([
-            'index' => $indexName,
-            'body' => $dsl,
-        ]));
+        return $this->client->search($this->paramsAsync(
+            array_filter([
+                'index' => $indexName,
+                'body' => $dsl,
+                'search_type' => $searchType,
+            ]),
+        ));
     }
 
     public function deleteByQuery(string $indexName, array $dsl): array

src/Search/Enums/SearchType.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Search\Enums;
+
+class SearchType
+{
+    public const QUERY_THEN_FETCH = 'query_then_fetch';
+    public const DFS_QUERY_THEN_FETCH = 'dfs_query_then_fetch';
+
+    public static function cases(): array
+    {
+        return [
+            self::QUERY_THEN_FETCH,
+            self::DFS_QUERY_THEN_FETCH,
+        ];
+    }
+}

src/Search/SearchQuery.php

@@ -36,6 +36,7 @@ class SearchQuery implements SortableQuery, CollapsibleQuery
     protected array $fields = [];
     protected array $include = [];
     protected array $exclude = [];
+    protected ?string $searchType = null;
 
     public function __construct(protected SearchIndex $index)
     {
@@ -169,7 +170,7 @@ protected function execute(
 
         $dsl = array_filter($dsl);
 
-        return $async ? $this->index->searchAsync($dsl) : $this->index->search($dsl);
+        return $async ? $this->index->searchAsync($dsl, $this->searchType) : $this->index->search($dsl, $this->searchType);
     }
 
     protected function sourceToDSL(bool $source): array | bool
@@ -264,6 +265,15 @@ public function skip(int $count): static
         return $this;
     }
 
+    public function searchType(string $searchType): static
+    {
+        Assert::stringNotEmpty($searchType);
+
+        $this->searchType = $searchType;
+
+        return $this;
+    }
+
     //endregion
 
     protected function boolQuery(): BoolQueryBuilder