Merge pull request #71 from beowulfenator/master

options in query

Author: beowulfenator

CHANGELOG.md

@@ -15,6 +15,7 @@ Yii Framework 2 elasticsearch extension Change Log
 - Enh #33: Implemented `Command::updateSettings()` and `Command::updateAnalyzers()` (githubjeka)
 - Enh #50: Implemented HTTP auth (silverfire)
 - Enh #62: Added support for scroll API in `batch()` and `each()` (beowulfenator, 13leaf)
+- Enh #70: `Query` and `ActiveQuery` now have `$options` attribute that is passed to commands generated by queries (beowulfenator)
 - Enh: Unified model creation from result set in `Query` and `ActiveQuery` with `populate()` (beowulfenator)
 
 

Command.php

@@ -39,6 +39,9 @@ class Command extends Component
      * @var array list of arrays or json strings that become parts of a query
      */
     public $queryParts;
+    /**
+     * @var array options to be appended to the query URL, such as "search_type" for search or "timeout" for delete
+     */
     public $options = [];
 
 

Query.php

@@ -9,6 +9,7 @@
 
 use Yii;
 use yii\base\Component;
+use yii\base\InvalidParamException;
 use yii\db\QueryInterface;
 use yii\db\QueryTrait;
 
@@ -157,6 +158,12 @@ class Query extends Component implements QueryInterface
      * @see http://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-min-score.html
      */
     public $minScore;
+    /**
+     * @var array list of options that will passed to commands created by this query.
+     * @see Command::$options
+     * @since  2.0.4
+     */
+    public $options = [];
 
     /**
      * @inheritdoc
@@ -607,4 +614,41 @@ public function minScore($minScore)
         $this->minScore = $minScore;
         return $this;
     }
+
+    /**
+     * Sets the options to be passed to the command created by this query.
+     * @param array $options the options to be set.
+     * @return $this the query object itself
+     * @throws InvalidParamException if $options is not an array
+     * @see Command::$options
+     * @since  2.0.4
+     */
+    public function options($options)
+    {
+        if (!is_array($options)) {
+            throw new InvalidParamException('Array parameter expected, ' . gettype($options) . ' received.');
+        }
+
+        $this->options = $options;
+        return $this;
+    }
+
+    /**
+     * Adds more options, overwriting existing options.
+     * @param array $options the options to be added.
+     * @return $this the query object itself
+     * @throws InvalidParamException if $options is not an array
+     * @see options()
+     * @since  2.0.4
+     */
+    public function addOptions($options)
+    {
+        if (!is_array($options)) {
+            throw new InvalidParamException('Array parameter expected, ' . gettype($options) . ' received.');
+        }
+
+        $this->options = array_merge($this->options, $options);
+        return $this;
+    }
+
 }

QueryBuilder.php

@@ -119,7 +119,7 @@ public function build($query)
             $parts['sort'] = $sort;
         }
 
-        $options = [];
+        $options = $query->options;
         if ($query->timeout !== null) {
             $options['timeout'] = $query->timeout;
         }

tests/QueryBuilderTest.php

@@ -34,10 +34,10 @@ public function setUp()
     private function prepareDbData()
     {
         $command = $this->getConnection()->createCommand();
-        $command->insert('yiitest', 'article', ['title' => 'I love yii!'], 1);
-        $command->insert('yiitest', 'article', ['title' => 'Symfony2 is another framework'], 2);
-        $command->insert('yiitest', 'article', ['title' => 'Yii2 out now!'], 3);
-        $command->insert('yiitest', 'article', ['title' => 'yii test'], 4);
+        $command->insert('yiitest', 'article', ['title' => 'I love yii!', 'weight' => 1], 1);
+        $command->insert('yiitest', 'article', ['title' => 'Symfony2 is another framework', 'weight' => 2], 2);
+        $command->insert('yiitest', 'article', ['title' => 'Yii2 out now!', 'weight' => 3], 3);
+        $command->insert('yiitest', 'article', ['title' => 'yii test', 'weight' => 4], 4);
 
         $command->flushIndex('yiitest');
     }
@@ -67,20 +67,34 @@ public function testYiiCanBeFoundByQuery()
 
     public function testMinScore()
     {
-        if (version_compare($this->version, '1.6', '<')) {
-            $this->markTestSkipped('Score calculation in ES < 1.6 is untestable');
-        }
-        $queryParts = ['term' => ['title' => 'yii']];
+        $queryParts = [
+            'function_score' => [
+                'boost_mode' => 'replace',
+                'query' => ['term' => ['title' => 'yii']],
+                'functions' => [
+                    ['script_score' => [
+                        'script' => "doc['weight'].getValue()",
+                    ]],
+                ],
+            ],
+        ];
+        //without min_score should get 2 documents with weights 1 and 4
+
         $query = new Query();
         $query->from('yiitest', 'article');
-        $query->query = $queryParts;
-        $query->minScore(0.9);
+        $query->query($queryParts);
+
+        $query->minScore(0.5);
         $result = $query->search($this->getConnection());
-        $this->assertEquals(0, $result['hits']['total']);
+        $this->assertEquals(2, $result['hits']['total']);
 
-        $query->minScore(0.6);
+        $query->minScore(2);
         $result = $query->search($this->getConnection());
         $this->assertEquals(1, $result['hits']['total']);
+
+        $query->minScore(5);
+        $result = $query->search($this->getConnection());
+        $this->assertEquals(0, $result['hits']['total']);
     }
 
     public function testMltSearch()

tests/QueryTest.php

@@ -302,7 +302,8 @@ public function testBatch()
 
         //test each
         $query = new Query;
-        $query->from('yiitest', 'user')->limit(3)->orderBy(['name' => SORT_ASC])->indexBy('name');
+        $query->from('yiitest', 'user')->limit(3)->orderBy(['name' => SORT_ASC])->indexBy('name')->options(['preference' => '_local']);
+        //NOTE: preference -> _local has no influence on query result, everything's fine as long as query doesn't fail
 
         $result_keys = [];
         $result_values = [];
@@ -319,7 +320,8 @@ public function testBatch()
 
         //test batch
         $query = new Query;
-        $query->from('yiitest', 'user')->limit(3)->orderBy(['name' => SORT_ASC])->indexBy('name');
+        $query->from('yiitest', 'user')->limit(3)->orderBy(['name' => SORT_ASC])->indexBy('name')->options(['preference' => '_local']);
+        //NOTE: preference -> _local has no influence on query result, everything's fine as long as query doesn't fail
 
         $results = [];
         foreach ($query->batch('1m', $this->getConnection()) as $batchId => $batch) {