Query.php 19.2 KB
Newer Older
1 2
<?php
/**
3 4 5
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
6 7 8 9
 */

namespace yii\elasticsearch;

10
use Yii;
11
use yii\base\Component;
12
use yii\base\NotSupportedException;
13 14
use yii\db\QueryInterface;
use yii\db\QueryTrait;
15

16
/**
Carsten Brandt committed
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
 * Query represents a query to the search API of elasticsearch.
 *
 * Query provides a set of methods to facilitate the specification of different parameters of the query.
 * These methods can be chained together.
 *
 * By calling [[createCommand()]], we can get a [[Command]] instance which can be further
 * used to perform/execute the DB query against a database.
 *
 * For example,
 *
 * ~~~
 * $query = new Query;
 * $query->fields('id, name')
 *     ->from('myindex', 'users')
 *     ->limit(10);
 * // build and execute the query
 * $command = $query->createCommand();
 * $rows = $command->search(); // this way you get the raw output of elasticsearch.
 * ~~~
 *
 * You would normally call `$query->search()` instead of creating a command as this method
 * adds the `indexBy()` feature and also removes some inconsistencies from the response.
 *
 * Query also provides some methods to easier get some parts of the result only:
 *
 * - [[one()]]: returns a single record populated with the first row of data.
 * - [[all()]]: returns all records based on the query results.
 * - [[count()]]: returns the number of records.
 * - [[scalar()]]: returns the value of the first column in the first row of the query result.
 * - [[column()]]: returns the value of the first column in the query result.
 * - [[exists()]]: returns a value indicating whether the query result has data or not.
48 49 50 51 52
 *
 * @author Carsten Brandt <mail@cebe.cc>
 * @since 2.0
 */
class Query extends Component implements QueryInterface
53
{
54
	use QueryTrait;
55

56
	/**
Carsten Brandt committed
57 58 59 60 61 62 63 64 65 66 67
	 * @var array the fields being retrieved from the documents. For example, `['id', 'name']`.
	 * If not set, it means retrieving all fields. An empty array will result in no fields being
	 * retrieved. This means that only the primaryKey of a record will be available in the result.
	 * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-fields.html#search-request-fields
	 * @see fields()
	 */
	public $fields;
	/**
	 * @var string|array The index to retrieve data from. This can be a string representing a single index
	 * or a an array of multiple indexes. If this is not set, indexes are being queried.
	 * @see from()
68
	 */
69
	public $index;
Carsten Brandt committed
70 71 72 73 74
	/**
	 * @var string|array The type to retrieve data from. This can be a string representing a single type
	 * or a an array of multiple types. If this is not set, all types are being queried.
	 * @see from()
	 */
75
	public $type;
Carsten Brandt committed
76 77 78 79 80 81 82
	/**
	 * @var integer A search timeout, bounding the search request to be executed within the specified time value
	 * and bail with the hits accumulated up to that point when expired. Defaults to no timeout.
	 * @see timeout()
	 * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-body.html#_parameters_3
	 */
	public $timeout;
83 84 85 86
	/**
	 * @var array|string The query part of this search query. This is an array or json string that follows the format of
	 * the elasticsearch [Query DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html).
	 */
87
	public $query;
88 89 90 91
	/**
	 * @var array|string The filter part of this search query. This is an array or json string that follows the format of
	 * the elasticsearch [Query DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html).
	 */
92 93 94 95
	public $filter;

	public $facets = [];

96 97 98 99 100 101 102 103 104
	public function init()
	{
		parent::init();
		// setting the default limit according to elasticsearch defaults
		// http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-body.html#_parameters_3
		if ($this->limit === null) {
			$this->limit = 10;
		}
	}
105

106 107
	/**
	 * Creates a DB command that can be used to execute this query.
Carsten Brandt committed
108
	 * @param Connection $db the database connection used to execute the query.
109
	 * If this parameter is not given, the `elasticsearch` application component will be used.
110 111 112 113 114
	 * @return Command the created DB command instance.
	 */
	public function createCommand($db = null)
	{
		if ($db === null) {
115
			$db = Yii::$app->getComponent('elasticsearch');
116 117
		}

118 119
		$commandConfig = $db->getQueryBuilder()->build($this);
		return $db->createCommand($commandConfig);
120 121 122 123
	}

	/**
	 * Executes the query and returns all results as an array.
Carsten Brandt committed
124 125
	 * @param Connection $db the database connection used to execute the query.
	 * If this parameter is not given, the `elasticsearch` application component will be used.
126 127 128 129
	 * @return array the query results. If the query results in nothing, an empty array will be returned.
	 */
	public function all($db = null)
	{
130
		$result = $this->createCommand($db)->search();
131 132 133 134
		if (empty($result['hits']['hits'])) {
			return [];
		}
		$rows = $result['hits']['hits'];
Carsten Brandt committed
135
		if ($this->indexBy === null && $this->fields === null) {
136 137
			return $rows;
		}
138
		$models = [];
Carsten Brandt committed
139 140 141 142 143 144 145 146 147 148 149
		foreach ($rows as $key => $row) {
			if ($this->fields !== null) {
				$row['_source'] = isset($row['fields']) ? $row['fields'] : [];
				unset($row['fields']);
			}
			if ($this->indexBy !== null) {
				if (is_string($this->indexBy)) {
					$key = $row['_source'][$this->indexBy];
				} else {
					$key = call_user_func($this->indexBy, $row);
				}
150
			}
151
			$models[$key] = $row;
152
		}
153
		return $models;
154 155 156 157
	}

	/**
	 * Executes the query and returns a single row of result.
Carsten Brandt committed
158 159
	 * @param Connection $db the database connection used to execute the query.
	 * If this parameter is not given, the `elasticsearch` application component will be used.
160 161 162 163 164
	 * @return array|boolean the first row (in terms of an array) of the query result. False is returned if the query
	 * results in nothing.
	 */
	public function one($db = null)
	{
Carsten Brandt committed
165
		$options['size'] = 1;
166
		$result = $this->createCommand($db)->search($options);
167
		if (empty($result['hits']['hits'])) {
Carsten Brandt committed
168 169
			return false;
		}
170
		$record = reset($result['hits']['hits']);
Carsten Brandt committed
171 172 173 174 175
		if ($this->fields !== null) {
			$record['_source'] = isset($record['fields']) ? $record['fields'] : [];
			unset($record['fields']);
		}
		return $record;
176 177
	}

178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
	/**
	 * Executes the query and returns the complete search result including e.g. hits, facets, totalCount.
	 * @param Connection $db the database connection used to execute the query.
	 * If this parameter is not given, the `elasticsearch` application component will be used.
	 * @param array $options The options given with this query. Possible options are:
	 * - [routing](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search.html#search-routing)
	 * - [search_type](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-search-type.html)
	 * @return array the query results.
	 */
	public function search($db = null, $options = [])
	{
		$result = $this->createCommand($db)->search($options);
		if (!empty($result['hits']['hits']) && ($this->indexBy === null || $this->fields === null)) {
			$rows = [];
			foreach ($result['hits']['hits'] as $key => $row) {
				if ($this->fields !== null) {
					$row['_source'] = isset($row['fields']) ? $row['fields'] : [];
					unset($row['fields']);
				}
				if ($this->indexBy !== null) {
					if (is_string($this->indexBy)) {
						$key = $row['_source'][$this->indexBy];
					} else {
						$key = call_user_func($this->indexBy, $row);
					}
				}
				$rows[$key] = $row;
			}
			$result['hits']['hits'] = $rows;
		}
		return $result;
	}

	// TODO add query stats http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search.html#stats-groups

	// TODO add scroll/scan http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-search-type.html#scan

215 216 217 218 219 220 221 222 223 224 225
	/**
	 * Executes the query and deletes all matching documents.
	 *
	 * This will not run facet queries.
	 *
	 * @param Connection $db the database connection used to execute the query.
	 * If this parameter is not given, the `elasticsearch` application component will be used.
	 * @return array the query results. If the query results in nothing, an empty array will be returned.
	 */
	public function delete($db = null)
	{
226 227
		// TODO implement http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete-by-query.html
		throw new NotSupportedException('Delete by query is not implemented yet.');
228 229
	}

230 231
	/**
	 * Returns the query result as a scalar value.
Carsten Brandt committed
232 233
	 * The value returned will be the specified field in the first document of the query results.
	 * @param string $field name of the attribute to select
234
	 * @param Connection $db the database connection used to execute the query.
Carsten Brandt committed
235
	 * If this parameter is not given, the `elasticsearch` application component will be used.
236
	 * @return string the value of the specified attribute in the first record of the query result.
Carsten Brandt committed
237
	 * Null is returned if the query result is empty or the field does not exist.
238
	 */
Carsten Brandt committed
239
	public function scalar($field, $db = null)
240
	{
241
		$record = self::one($db); // TODO limit fields to the one required
Carsten Brandt committed
242 243
		if ($record !== false && isset($record['_source'][$field])) {
			return $record['_source'][$field];
244
		} else {
245
			return null;
246
		}
247 248 249
	}

	/**
250
	 * Executes the query and returns the first column of the result.
Carsten Brandt committed
251 252 253
	 * @param string $field the field to query over
	 * @param Connection $db the database connection used to execute the query.
	 * If this parameter is not given, the `elasticsearch` application component will be used.
254
	 * @return array the first column of the query result. An empty array is returned if the query results in nothing.
255
	 */
Carsten Brandt committed
256
	public function column($field, $db = null)
257
	{
258 259
		$command = $this->createCommand($db);
		$command->queryParts['fields'] = [$field];
260 261 262
		$result = $command->search();
		if (empty($result['hits']['hits'])) {
			return [];
Carsten Brandt committed
263
		}
264 265 266 267 268
		$column = [];
		foreach ($result['hits']['hits'] as $row) {
			$column[] = isset($row['fields'][$field]) ? $row['fields'][$field] : null;
		}
		return $column;
269 270 271
	}

	/**
272
	 * Returns the number of records.
273
	 * @param string $q the COUNT expression. This parameter is ignored by this implementation.
Carsten Brandt committed
274 275
	 * @param Connection $db the database connection used to execute the query.
	 * If this parameter is not given, the `elasticsearch` application component will be used.
276
	 * @return integer number of records
277
	 */
278
	public function count($q = '*', $db = null)
279
	{
280 281 282 283
		// TODO consider sending to _count api instead of _search for performance
		// only when no facety are registerted.
		// http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-count.html

284 285
		$options = [];
		$options['search_type'] = 'count';
286
		return $this->createCommand($db)->search($options)['hits']['total'];
287 288 289
	}

	/**
290
	 * Returns a value indicating whether the query result contains any row of data.
Carsten Brandt committed
291 292
	 * @param Connection $db the database connection used to execute the query.
	 * If this parameter is not given, the `elasticsearch` application component will be used.
293
	 * @return boolean whether the query result contains any row of data.
294
	 */
295
	public function exists($db = null)
296
	{
297
		return self::one($db) !== false;
298 299 300
	}

	/**
301 302 303 304
	 * Adds a facet search to this query.
	 * @param string $name the name of this facet
	 * @param string $type the facet type. e.g. `terms`, `range`, `histogram`...
	 * @param string|array $options the configuration options for this facet. Can be an array or a json string.
305
	 * @return static the query object itself
306
	 * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-facets-query-facet.html
307
	 */
308
	public function addFacet($name, $type, $options)
309
	{
310 311
		$this->facets[$name] = [$type => $options];
		return $this;
312 313 314
	}

	/**
315 316 317
	 * The `terms facet` allow to specify field facets that return the N most frequent terms.
	 * @param string $name the name of this facet
	 * @param array $options additional option. Please refer to the elasticsearch documentation for details.
318
	 * @return static the query object itself
319
	 * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-facets-terms-facet.html
320
	 */
321
	public function addTermFacet($name, $options)
322
	{
323
		return $this->addFacet($name, 'terms', $options);
324 325 326
	}

	/**
327 328 329 330
	 * Range facet allows to specify a set of ranges and get both the number of docs (count) that fall
	 * within each range, and aggregated data either based on the field, or using another field.
	 * @param string $name the name of this facet
	 * @param array $options additional option. Please refer to the elasticsearch documentation for details.
331
	 * @return static the query object itself
332
	 * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-facets-range-facet.html
333
	 */
334
	public function addRangeFacet($name, $options)
335
	{
336
		return $this->addFacet($name, 'range', $options);
337 338 339
	}

	/**
340 341 342 343 344
	 * The histogram facet works with numeric data by building a histogram across intervals of the field values.
	 * Each value is "rounded" into an interval (or placed in a bucket), and statistics are provided per
	 * interval/bucket (count and total).
	 * @param string $name the name of this facet
	 * @param array $options additional option. Please refer to the elasticsearch documentation for details.
345
	 * @return static the query object itself
346
	 * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-facets-histogram-facet.html
347
	 */
348
	public function addHistogramFacet($name, $options)
349
	{
350
		return $this->addFacet($name, 'histogram', $options);
351 352 353
	}

	/**
354 355 356
	 * A specific histogram facet that can work with date field types enhancing it over the regular histogram facet.
	 * @param string $name the name of this facet
	 * @param array $options additional option. Please refer to the elasticsearch documentation for details.
357
	 * @return static the query object itself
358
	 * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-facets-date-histogram-facet.html
359
	 */
360
	public function addDateHistogramFacet($name, $options)
361
	{
362 363 364 365 366 367 368 369
		return $this->addFacet($name, 'date_histogram', $options);
	}

	/**
	 * A filter facet (not to be confused with a facet filter) allows you to return a count of the hits matching the filter.
	 * The filter itself can be expressed using the Query DSL.
	 * @param string $name the name of this facet
	 * @param string $filter the query in Query DSL
370
	 * @return static the query object itself
371 372 373 374 375 376 377 378 379 380 381 382
	 * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-facets-filter-facet.html
	 */
	public function addFilterFacet($name, $filter)
	{
		return $this->addFacet($name, 'filter', $filter);
	}

	/**
	 * A facet query allows to return a count of the hits matching the facet query.
	 * The query itself can be expressed using the Query DSL.
	 * @param string $name the name of this facet
	 * @param string $query the query in Query DSL
383
	 * @return static the query object itself
384 385 386 387 388 389 390 391 392 393 394 395
	 * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-facets-query-facet.html
	 */
	public function addQueryFacet($name, $query)
	{
		return $this->addFacet($name, 'query', $query);
	}

	/**
	 * Statistical facet allows to compute statistical data on a numeric fields. The statistical data include count,
	 * total, sum of squares, mean (average), minimum, maximum, variance, and standard deviation.
	 * @param string $name the name of this facet
	 * @param array $options additional option. Please refer to the elasticsearch documentation for details.
396
	 * @return static the query object itself
397 398 399 400 401 402 403 404 405 406 407 408
	 * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-facets-statistical-facet.html
	 */
	public function addStatisticalFacet($name, $options)
	{
		return $this->addFacet($name, 'statistical', $options);
	}

	/**
	 * The `terms_stats` facet combines both the terms and statistical allowing to compute stats computed on a field,
	 * per term value driven by another field.
	 * @param string $name the name of this facet
	 * @param array $options additional option. Please refer to the elasticsearch documentation for details.
409
	 * @return static the query object itself
410 411 412 413 414 415 416 417 418 419 420 421
	 * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-facets-terms-stats-facet.html
	 */
	public function addTermsStatsFacet($name, $options)
	{
		return $this->addFacet($name, 'terms_stats', $options);
	}

	/**
	 * The `geo_distance` facet is a facet providing information for ranges of distances from a provided `geo_point`
	 * including count of the number of hits that fall within each range, and aggregation information (like `total`).
	 * @param string $name the name of this facet
	 * @param array $options additional option. Please refer to the elasticsearch documentation for details.
422
	 * @return static the query object itself
423 424 425 426 427 428 429 430 431 432 433 434 435
	 * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-facets-geo-distance-facet.html
	 */
	public function addGeoDistanceFacet($name, $options)
	{
		return $this->addFacet($name, 'geo_distance', $options);
	}

	// TODO add suggesters http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-suggesters.html

	// TODO add validate query http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-validate.html

	// TODO support multi query via static method http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-multi-search.html

436 437 438
	/**
	 * Sets the querypart of this search query.
	 * @param string $query
439
	 * @return static the query object itself
440 441
	 */
	public function query($query)
442
	{
443 444 445
		$this->query = $query;
		return $this;
	}
446

447 448 449
	/**
	 * Sets the filter part of this search query.
	 * @param string $filter
450
	 * @return static the query object itself
451 452 453 454 455
	 */
	public function filter($filter)
	{
		$this->filter = $filter;
		return $this;
456 457
	}

Carsten Brandt committed
458 459 460 461 462 463
	/**
	 * Sets the index and type to retrieve documents from.
	 * @param string|array $index The index to retrieve data from. This can be a string representing a single index
	 * or a an array of multiple indexes. If this is `null` it means that all indexes are being queried.
	 * @param string|array $type The type to retrieve data from. This can be a string representing a single type
	 * or a an array of multiple types. If this is `null` it means that all types are being queried.
464
	 * @return static the query object itself
Carsten Brandt committed
465 466
	 * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html#search-multi-index-type
	 */
467
	public function from($index, $type = null)
468
	{
469 470
		$this->index = $index;
		$this->type = $type;
471
		return $this;
472
	}
Carsten Brandt committed
473 474 475 476 477 478 479 480 481

	/**
	 * Sets the fields to retrieve from the documents.
	 * @param array $fields the fields to be selected.
	 * @return static the query object itself
	 * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-fields.html
	 */
	public function fields($fields)
	{
482
		if (is_array($fields) || $fields === null) {
483 484 485 486
			$this->fields = $fields;
		} else {
			$this->fields = func_get_args();
		}
Carsten Brandt committed
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
		return $this;
	}

	/**
	 * Sets the search timeout.
	 * @param integer $timeout A search timeout, bounding the search request to be executed within the specified time value
	 * and bail with the hits accumulated up to that point when expired. Defaults to no timeout.
	 * @return static the query object itself
	 * @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-body.html#_parameters_3
	 */
	public function timeout($timeout)
	{
		$this->timeout = $timeout;
		return $this;
	}
502
}