Class yii\elasticsearch\Query

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

Public Methods

Protected Methods

Property Details

$aggregations public property

List of aggregations to add to this query.

See also http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-aggregations.html.

public array $aggregations = []

$explain public property (available since version 2.0.5)

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

See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-explain.html.

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.

See also:

• http://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-fields.html#search-request-fields
• http://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-script-fields.html
• fields()
• source()

public array $fields = null

$filter public property

The filter part of this search query. This is an array or json string that follows the format of the elasticsearch Query DSL.

public array|string $filter = null

$highlight public property

The highlight part of this search query. This is an array that allows to highlight search results on one or more fields.

See also http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-request-highlighting.html.

public array $highlight = null

$index public property

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 also from().

public string|array $index = null

$minScore public property (available since version 2.0.4)

Exclude documents which have a _score less than the minimum specified in min_score

See also http://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-min-score.html.

public float $minScore = null

$options public property (available since version 2.0.4)

List of options that will passed to commands created by this query.

See also yii\elasticsearch\Command::$options.

public array $options = []

$postFilter public property (available since version 2.0.5)

The post_filter part of the search query for differentially filter search results and aggregations.

See also https://www.elastic.co/guide/en/elasticsearch/guide/current/_post_filter.html.

public string|array $postFilter = null

$query public property

The query part of this search query. This is an array or json string that follows the format of the elasticsearch Query DSL.

public array|string $query = null

$source public property

This option controls how the _source field is returned from the documents. For example, ['id', 'name'] means that only the id and name field should be returned from _source. If not set, it means retrieving the full _source field unless fields() are specified. Setting this option to false will disable return of the _source field, this means that only the primaryKey of a record will be available in the result.

See also:

• http://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-source-filtering.html
• source()
• fields()

public array $source = null

$stats public property

The 'stats' part of the query. An array of groups to maintain a statistics aggregation for.

See also http://www.elastic.co/guide/en/elasticsearch/reference/current/search.html#stats-groups.

public array $stats = []

$suggest public property

List of suggesters to add to this query.

See also http://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html.

public array $suggest = []

$timeout public property

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 also:

• timeout()
• http://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#_parameters_5

public integer $timeout = null

$type public property

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 also from().

public string|array $type = null

Method Details

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

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