Class yii\elasticsearch\Query

All Classes | Properties | Methods

Inheritance	yii\elasticsearch\Query » yii\base\Component
Implements	yii\db\QueryInterface
Uses Traits	yii\db\QueryTrait
Subclasses	yii\elasticsearch\ActiveQuery
Available since version	2.0

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 yii\elasticsearch\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.

NOTE: elasticsearch limits the number of records returned to 10 records by default. If you expect to get more records you should specify limit explicitly.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$aggregations	array	List of aggregations to add to this query.	yii\elasticsearch\Query
$explain	boolean	Enables explanation for each hit on how its score was computed.	yii\elasticsearch\Query
$fields	array	The fields being retrieved from the documents.	yii\elasticsearch\Query
$filter	array\|string	The filter part of this search query.	yii\elasticsearch\Query
$highlight	array	The highlight part of this search query.	yii\elasticsearch\Query
$index	string\|array	The index to retrieve data from.	yii\elasticsearch\Query
$minScore	float	Exclude documents which have a _score less than the minimum specified in min_score	yii\elasticsearch\Query
$options	array	List of options that will passed to commands created by this query.	yii\elasticsearch\Query
$postFilter	string\|array	The `post_filter` part of the search query for differentially filter search results and aggregations.	yii\elasticsearch\Query
$query	array\|string	The query part of this search query.	yii\elasticsearch\Query
$source	array	This option controls how the `_source` field is returned from the documents.	yii\elasticsearch\Query
$stats	array	The 'stats' part of the query.	yii\elasticsearch\Query
$suggest	array	List of suggesters to add to this query.	yii\elasticsearch\Query
$timeout	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.	yii\elasticsearch\Query
$type	string\|array	The type to retrieve data from.	yii\elasticsearch\Query

Public Methods

Hide inherited methods

Method	Description	Defined By
addAgg()		yii\elasticsearch\Query
addAggregate()	Adds an aggregation to this query. Supports nested aggregations.	yii\elasticsearch\Query
addAggregation()		yii\elasticsearch\Query
addOptions()	Adds more options, overwriting existing options.	yii\elasticsearch\Query
addSuggester()	Adds a suggester to this query.	yii\elasticsearch\Query
all()	Executes the query and returns all results as an array.	yii\elasticsearch\Query
batch()	Starts a batch query.	yii\elasticsearch\Query
column()	Executes the query and returns the first column of the result.	yii\elasticsearch\Query
count()	Returns the number of records.	yii\elasticsearch\Query
createCommand()	Creates a DB command that can be used to execute this query.	yii\elasticsearch\Query
delete()	Executes the query and deletes all matching documents.	yii\elasticsearch\Query
each()	Starts a batch query and retrieves data row by row.	yii\elasticsearch\Query
exists()	Returns a value indicating whether the query result contains any row of data.	yii\elasticsearch\Query
explain()	Explain for how the score of each document was computer	yii\elasticsearch\Query
fields()	Sets the fields to retrieve from the documents.	yii\elasticsearch\Query
filter()	Sets the filter part of this search query.	yii\elasticsearch\Query
from()	Sets the index and type to retrieve documents from.	yii\elasticsearch\Query
highlight()	Sets a highlight parameters to retrieve from the documents.	yii\elasticsearch\Query
init()		yii\elasticsearch\Query
minScore()		yii\elasticsearch\Query
one()	Executes the query and returns a single row of result.	yii\elasticsearch\Query
options()	Sets the options to be passed to the command created by this query.	yii\elasticsearch\Query
populate()	Converts the raw query results into the format as specified by this query.	yii\elasticsearch\Query
postFilter()	Set the `post_filter` part of the search query.	yii\elasticsearch\Query
query()	Sets the query part of this search query.	yii\elasticsearch\Query
scalar()	Returns the query result as a scalar value.	yii\elasticsearch\Query
search()	Executes the query and returns the complete search result including e.g. hits, facets, totalCount.	yii\elasticsearch\Query
source()	Sets the source filtering, specifying how the `_source` field of the document should be returned.	yii\elasticsearch\Query
stats()	Adds a 'stats' part to the query.	yii\elasticsearch\Query
timeout()	Sets the search timeout.	yii\elasticsearch\Query

Property Details

$aggregations public property

List of aggregations to add to this query.

public array $aggregations = []

$explain public property (available since version 2.0.5)

Enables explanation for each hit on how its score was computed.

public boolean $explain = null

$fields public property

The fields being retrieved from the documents. For example, ['id', 'name']. If not set, this option will not be applied to the query and no fields will be returned. In this case the _source field will be returned by default which can be configured using source(). Setting this to an empty array will result in no fields being retrieved, which means that only the primaryKey of a record will be available in the result.

For each field you may also add an array representing a script field. Example:

$query->fields = [
    'id',
    'name',
    'value_times_two' => [
        'script' => "doc['my_field_name'].value * 2",
    ],
    'value_times_factor' => [
        'script' => "doc['my_field_name'].value * factor",
        'params' => [
            'factor' => 2.0
        ],
    ],
]

Note: Field values are always returned as arrays even if they only have one value.

Method Details

addAgg() public method

Deprecated since 2.0.5 use addAggragate() instead Adds an aggregation to this query. This is an alias for addAggregation().

public $this addAgg ( $name, $type, $options )
$name	string	The name of the aggregation
$type	string	The aggregation type. e.g. `terms`, `range`, `histogram`...
$options	string\|array	The configuration options for this aggregation. Can be an array or a json string.
return	$this	The query object itself

addAggregate() public method

Adds an aggregation to this query. Supports nested aggregations.

public $this addAggregate ( $name, $options )
$name	string	The name of the aggregation
$options	string\|array	The configuration options for this aggregation. Can be an array or a json string.
return	$this	The query object itself

addAggregation() public method

Deprecated since 2.0.5 use addAggragate() instead Adds an aggregation to this query.

public $this addAggregation ( $name, $type, $options )
$name	string	The name of the aggregation
$type	string	The aggregation type. e.g. `terms`, `range`, `histogram`...
$options	string\|array	The configuration options for this aggregation. Can be an array or a json string.
return	$this	The query object itself

addOptions() public method (available since version 2.0.4)

Adds more options, overwriting existing options.

See also options().

public $this addOptions ( $options )
$options	array	The options to be added.
return	$this	The query object itself
throws	\yii\base\InvalidParamException	if $options is not an array

addSuggester() public method

Adds a suggester to this query.

public $this addSuggester ( $name, $definition )
$name	string	The name of the suggester
$definition	string\|array	The configuration options for this suggester. Can be an array or a json string.
return	$this	The query object itself

all() public method

Executes the query and returns all results as an array.

public array all ( $db = null )
$db	yii\elasticsearch\Connection	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.

batch() public method (available since version 2.0.4)

Starts a batch query.

A batch query supports fetching data in batches, which can keep the memory usage under a limit. This method will return a yii\elasticsearch\BatchQueryResult object which implements the Iterator interface and can be traversed to retrieve the data in batches.

For example,

$query = (new Query)->from('user');
foreach ($query->batch() as $rows) {
    // $rows is an array of 10 or fewer rows from user table
}

Batch size is determined by the limit setting (note that in scan mode batch limit is per shard).

public yii\elasticsearch\BatchQueryResult batch ( $scrollWindow = '1m', $db = null )
$scrollWindow	string	How long Elasticsearch should keep the search context alive, in time units
$db	yii\elasticsearch\Connection	The database connection. If not set, the `elasticsearch` application component will be used.
return	yii\elasticsearch\BatchQueryResult	The batch query result. It implements the Iterator interface and can be traversed to retrieve the data in batches.

column() public method

Executes the query and returns the first column of the result.

public array column ( $field, $db = null )
$field	string	The field to query over
$db	yii\elasticsearch\Connection	The database connection used to execute the query. If this parameter is not given, the `elasticsearch` application component will be used.
return	array	The first column of the query result. An empty array is returned if the query results in nothing.

count() public method

Returns the number of records.

public integer count ( $q = '*', $db = null )
$q	string	The COUNT expression. This parameter is ignored by this implementation.
$db	yii\elasticsearch\Connection	The database connection used to execute the query. If this parameter is not given, the `elasticsearch` application component will be used.
return	integer	Number of records

createCommand() public method

Creates a DB command that can be used to execute this query.

public yii\elasticsearch\Command createCommand ( $db = null )
$db	yii\elasticsearch\Connection	The database connection used to execute the query. If this parameter is not given, the `elasticsearch` application component will be used.
return	yii\elasticsearch\Command	The created DB command instance.

delete() public method

Executes the query and deletes all matching documents.

Everything except query and filter will be ignored.

public array delete ( $db = null, $options = [] )
$db	yii\elasticsearch\Connection	The database connection used to execute the query. If this parameter is not given, the `elasticsearch` application component will be used.
$options	array	The options given with this query.
return	array	The query results.

each() public method (available since version 2.0.4)

Starts a batch query and retrieves data row by row.

This method is similar to batch() except that in each iteration of the result, only one row of data is returned. For example,

$query = (new Query)->from('user');
foreach ($query->each() as $row) {
}

public yii\elasticsearch\BatchQueryResult each ( $scrollWindow = '1m', $db = null )
$scrollWindow	string	How long Elasticsearch should keep the search context alive, in time units
$db	yii\elasticsearch\Connection	The database connection. If not set, the `elasticsearch` application component will be used.
return	yii\elasticsearch\BatchQueryResult	The batch query result. It implements the Iterator interface and can be traversed to retrieve the data in batches.

exists() public method

Returns a value indicating whether the query result contains any row of data.

public boolean exists ( $db = null )
$db	yii\elasticsearch\Connection	The database connection used to execute the query. If this parameter is not given, the `elasticsearch` application component will be used.
return	boolean	Whether the query result contains any row of data.

explain() public method (available since version 2.0.5)

Explain for how the score of each document was computer

public $this fields ( $fields )
$fields	array	The fields to be selected.
return	$this	The query object itself

public $this filter ( $filter )
$filter	string
return	$this	The query object itself

public $this from ( $index, $type = null )
$index	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 `null` it means that all indexes are being queried.
$type	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 `null` it means that all types are being queried.
return	$this	The query object itself

public $this highlight ( $highlight )
$highlight	array	Array of parameters to highlight results.
return	$this	The query object itself

public static minScore ( $minScore )
$minScore	float	Exclude documents which have a `_score` less than the minimum specified minScore
return	static	The query object itself

public array\|boolean one ( $db = null )
$db	yii\elasticsearch\Connection	The database connection used to execute the query. If this parameter is not given, the `elasticsearch` application component will be used.
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 $this options ( $options )
$options	array	The options to be set.
return	$this	The query object itself
throws	\yii\base\InvalidParamException	if $options is not an array

public array populate ( $rows )
$rows	array	The raw query result from database
return	array	The converted query result

public $this postFilter ( $filter )
$filter	string\|array
return	$this	The query object itself

public $this query ( $query )
$query	string\|array
return	$this	The query object itself

public string scalar ( $field, $db = null )
$field	string	Name of the attribute to select
$db	yii\elasticsearch\Connection	The database connection used to execute the query. If this parameter is not given, the `elasticsearch` application component will be used.
return	string	The value of the specified attribute in the first record of the query result. Null is returned if the query result is empty or the field does not exist.

public array search ( $db = null, $options = [] )
$db	yii\elasticsearch\Connection	The database connection used to execute the query. If this parameter is not given, the `elasticsearch` application component will be used.
$options	array	The options given with this query. Possible options are: routing search_type
return	array	The query results.

public $this source ( $source )
$source	array	The source patterns to be selected.
return	$this	The query object itself

public $this stats ( $groups )
$groups	array	An array of groups to maintain a statistics aggregation for.
return	$this	The query object itself

public $this timeout ( $timeout )
$timeout	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.
return	$this	The query object itself