Class yii\elasticsearch\Query
| Inheritance | yii\ |
|---|---|
| Implements | yii\ |
| Uses Traits | yii\ |
| Subclasses | yii\ |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-elasticsearch/blob/master/Query.php |
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\
For example,
$query = new Query;
$query->storedFields('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
| Property | Type | Description | Defined By |
|---|---|---|---|
| $aggregations | array | List of aggregations to add to this query. | yii\ |
| $behaviors | array<yii\ |
List of behaviors attached to this component. | yii\ |
| $collapse | array | List of collapse to add to this query. | yii\ |
| $emulateExecution | boolean | Whether to emulate the actual query execution, returning empty or false results. | yii\ |
| $explain | boolean | Enables explanation for each hit on how its score was computed. | yii\ |
| $fields | array | Use the fields parameter to retrieve the values of runtime fields. | yii\ |
| $filter | array|string | The filter part of this search query. | yii\ |
| $highlight | array | The highlight part of this search query. | yii\ |
| $index | string|array | The index to retrieve data from. | yii\ |
| $indexBy | string|callable|null | The name of the column by which the query results should be indexed by. | yii\ |
| $limit | integer|yii\ |
Maximum number of records to be returned. | yii\ |
| $minScore | float | Exclude documents which have a _score less than the minimum specified in min_score | yii\ |
| $offset | integer|yii\ |
Zero-based offset from where the records are to be returned. | yii\ |
| $options | array | List of options that will passed to commands created by this query. | yii\ |
| $orderBy | array|null | How to sort the query results. | yii\ |
| $postFilter | string|array | The post_filter part of the search query for differentially filter search results and aggregations. |
yii\ |
| $query | array|string | The query part of this search query. | yii\ |
| $runtimeMappings | array | An array of runtime fields evaluated at query time Example: `php $query->$runtimeMappings = [ 'value_times_two' => [ 'type' => 'double', 'script' => "emit(doc['my_field_name'].value * 2)", ], 'value_times_factor' => [ 'type' => 'double', 'script' => "emit(doc['my_field_name'].value * factor)", 'params' => [ 'factor' => 2.0 ], ], ] ` |
yii\ |
| $scriptFields | array | The scripted fields being retrieved from the documents. | yii\ |
| $search_after | array | Allows pagination of large datasets. | yii\ |
| $source | array | This option controls how the _source field is returned from the documents. |
yii\ |
| $stats | array | The 'stats' part of the query. | yii\ |
| $storedFields | array | The fields being retrieved from the documents. | yii\ |
| $suggest | array | List of suggesters to add to this query. | yii\ |
| $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\ |
| $type | string|array | The type to retrieve data from. | yii\ |
| $where | string|array|yii\ |
Query condition. | yii\ |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\ |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\ |
| __construct() | Constructor. | yii\ |
| __get() | Returns the value of a component property. | yii\ |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\ |
| __set() | Sets the value of a component property. | yii\ |
| __unset() | Sets a component property to be null. | yii\ |
| addAgg() | yii\ |
|
| addAggregate() | Adds an aggregation to this query. Supports nested aggregations. | yii\ |
| addAggregation() | yii\ |
|
| addCollapse() | Adds a collapse to this query. | yii\ |
| addOptions() | Adds more options, overwriting existing options. | yii\ |
| addOrderBy() | Adds additional ORDER BY columns to the query. | yii\ |
| addSuggester() | Adds a suggester to this query. | yii\ |
| all() | Executes the query and returns all results as an array. | yii\ |
| andFilterWhere() | Adds an additional WHERE condition to the existing one but ignores empty operands. | yii\ |
| andWhere() | Adds an additional WHERE condition to the existing one. | yii\ |
| attachBehavior() | Attaches a behavior to this component. | yii\ |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\ |
| batch() | Starts a batch query. | yii\ |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\ |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\ |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\ |
| className() | Returns the fully qualified name of this class. | yii\ |
| column() | Executes the query and returns the first column of the result. | yii\ |
| count() | Returns the number of records. | yii\ |
| createCommand() | Creates a DB command that can be used to execute this query. | yii\ |
| delete() | Executes the query and deletes all matching documents. | yii\ |
| detachBehavior() | Detaches a behavior from the component. | yii\ |
| detachBehaviors() | Detaches all behaviors from the component. | yii\ |
| each() | Starts a batch query and retrieves data row by row. | yii\ |
| emulateExecution() | Sets whether to emulate query execution, preventing any interaction with data storage. | yii\ |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\ |
| exists() | Returns a value indicating whether the query result contains any row of data. | yii\ |
| explain() | Explain for how the score of each document was computer | yii\ |
| fields() | Sets the runtime fields to retrieve from the documents. | yii\ |
| filterWhere() | Sets the WHERE part of the query but ignores empty operands. | yii\ |
| from() | Sets the index and type to retrieve documents from. | yii\ |
| getBehavior() | Returns the named behavior object. | yii\ |
| getBehaviors() | Returns all behaviors attached to this component. | yii\ |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\ |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\ |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\ |
| highlight() | Sets a highlight parameters to retrieve from the documents. | yii\ |
| indexBy() | Sets the indexBy() property. | yii\ |
| init() | Initializes the object. | yii\ |
| limit() | Sets the LIMIT part of the query. | yii\ |
| minScore() | yii\ |
|
| off() | Detaches an existing event handler from this component. | yii\ |
| offset() | Sets the OFFSET part of the query. | yii\ |
| on() | Attaches an event handler to an event. | yii\ |
| one() | Executes the query and returns a single row of result. | yii\ |
| options() | Sets the options to be passed to the command created by this query. | yii\ |
| orFilterWhere() | Adds an additional WHERE condition to the existing one but ignores empty operands. | yii\ |
| orWhere() | Adds an additional WHERE condition to the existing one. | yii\ |
| orderBy() | Sets the ORDER BY part of the query. | yii\ |
| populate() | Converts the raw query results into the format as specified by this query. This method is internally used to convert the data fetched from database into the format as required by this query. | yii\ |
| postFilter() | Set the post_filter part of the search query. |
yii\ |
| query() | Sets the query part of this search query. | yii\ |
| runtimeMappings() | Sets the runtime mappings for this query | yii\ |
| scalar() | Returns the query result as a scalar value. The value returned will be the specified field in the first document of the query results. | yii\ |
| scriptFields() | Sets the script fields to retrieve from the documents. | yii\ |
| search() | Executes the query and returns the complete search result including e.g. | yii\ |
| source() | Sets the source filtering, specifying how the _source field of the
document should be returned. |
yii\ |
| stats() | Adds a 'stats' part to the query. | yii\ |
| storedFields() | Sets the fields to retrieve from the documents. | yii\ |
| timeout() | Sets the search timeout. | yii\ |
| trigger() | Triggers an event. | yii\ |
| where() | Sets the WHERE part of the query. | yii\ |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| filterCondition() | Removes empty operands from the given query condition. | yii\ |
| isEmpty() | Returns a value indicating whether the give value is "empty". | yii\ |
| normalizeOrderBy() | Normalizes format of ORDER BY data. | yii\ |
Property Details
List of aggregations to add to this query.
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html.
List of collapse to add to this query.
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html.
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.
Use the fields parameter to retrieve the values of runtime fields.
Runtime fields won’t display in _source, but the fields API works for all fields, even those that were not sent as part of the original _source.
See also:
The filter part of this search query.
This is an array or json string that follows the format of the elasticsearch Query DSL.
The highlight part of this search query.
This is an array that allows to highlight search results on one or more fields.
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-highlighting.html.
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().
Exclude documents which have a _score less than the minimum specified in min_score
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-min-score.html.
List of options that will passed to commands created by this query.
See also yii\
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.
The query part of this search query.
This is an array or json string that follows the format of the elasticsearch Query DSL.
An array of runtime fields evaluated at query time Example: `php $query->$runtimeMappings = [ 'value_times_two' => [ 'type' => 'double', 'script' => "emit(doc['my_field_name'].value * 2)", ], 'value_times_factor' => [ 'type' => 'double', 'script' => "emit(doc['my_field_name'].value * factor)", 'params' => [ 'factor' => 2.0 ], ], ] `
See also:
The scripted fields being retrieved from the documents.
Example:
`php
$query->scriptFields = [
'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:
Allows pagination of large datasets.
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:
The 'stats' part of the query.
An array of groups to maintain a statistics aggregation for.
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search.html#stats-groups.
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.
> Note: Field values are always returned as arrays even if they only
> have one value.
See also:
List of suggesters to add to this query.
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html.
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:
Method Details
Defined in:
yii\
Calls the named method which is not a class method.
This method will check if any attached behavior has the named method and will execute it if available.
Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.
| public __call( string $name, array $params ): mixed | ||
| $name | string |
The method name |
| $params | array |
Method parameters |
| return | mixed |
The method return value |
|---|---|---|
| throws | yii\ |
when calling unknown method |
public function __call($name, $params)
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $object) {
if ($object->hasMethod($name)) {
return call_user_func_array([$object, $name], $params);
}
}
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
Defined in:
yii\
This method is called after the object is created by cloning an existing one.
It removes all behaviors because they are attached to the old object.
| public __clone( ): mixed |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
Defined in:
yii\
Constructor.
The default implementation does two things:
- Initializes the object with the given configuration
$config. - Call init().
If this method is overridden in a child class, it is recommended that
- the last parameter of the constructor is a configuration array, like
$confighere. - call the parent implementation at the end of the constructor.
| public __construct( array<string, mixed> $config = [] ): mixed | ||
| $config | array<string, mixed> |
Name-value pairs that will be used to initialize the object properties |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
Defined in:
yii\
Returns the value of a component property.
This method will check in the following order and act accordingly:
- a property defined by a getter: return the getter result
- a property of a behavior: return the behavior property value
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $value = $component->property;.
See also __set().
| public __get( string $name ): mixed | ||
| $name | string |
The property name |
| return | mixed |
The property value or the value of a behavior's property |
|---|---|---|
| throws | yii\ |
if the property is not defined |
| throws | yii\ |
if the property is write-only. |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
// read property, e.g. getName()
return $this->$getter();
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name;
}
}
if (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in:
yii\
Checks if a property is set, i.e. defined and not null.
This method will check in the following order and act accordingly:
- a property defined by a setter: return whether the property is set
- a property of a behavior: return whether the property is set
- return
falsefor non existing properties
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing isset($component->property).
| public __isset( string $name ): boolean | ||
| $name | string |
The property name or the event name |
| return | boolean |
Whether the named property is set |
|---|---|---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name !== null;
}
}
return false;
}
Defined in:
yii\
Sets the value of a component property.
This method will check in the following order and act accordingly:
- a property defined by a setter: set the property value
- an event in the format of "on xyz": attach the handler to the event "xyz"
- a behavior in the format of "as xyz": attach the behavior named as "xyz"
- a property of a behavior: set the behavior property value
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $component->property = $value;.
See also __get().
| public __set( string $name, mixed $value ): mixed | ||
| $name | string |
The property name or the event name |
| $value | mixed |
The property value |
| throws | yii\ |
if the property is not defined |
|---|---|---|
| throws | yii\ |
if the property is read-only. |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
// set property
$this->$setter($value);
return;
} elseif (strncmp($name, 'on ', 3) === 0) {
// on event: attach event handler
$this->on(trim(substr($name, 3)), $value);
return;
} elseif (strncmp($name, 'as ', 3) === 0) {
// as behavior: attach behavior
$name = trim(substr($name, 3));
if ($value instanceof Behavior) {
$this->attachBehavior($name, $value);
} elseif ($value instanceof \Closure) {
$this->attachBehavior($name, call_user_func($value));
} elseif (isset($value['__class']) && is_subclass_of($value['__class'], Behavior::class)) {
$this->attachBehavior($name, Yii::createObject($value));
} elseif (!isset($value['__class']) && isset($value['class']) && is_subclass_of($value['class'], Behavior::class)) {
$this->attachBehavior($name, Yii::createObject($value));
} elseif (is_string($value) && is_subclass_of($value, Behavior::class, true)) {
$this->attachBehavior($name, Yii::createObject($value));
} else {
throw new InvalidConfigException('Class is not of type ' . Behavior::class . ' or its subclasses');
}
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = $value;
return;
}
}
if (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in:
yii\
Sets a component property to be null.
This method will check in the following order and act accordingly:
- a property defined by a setter: set the property value to be null
- a property of a behavior: set the property value to be null
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing unset($component->property).
| public __unset( string $name ): mixed | ||
| $name | string |
The property name |
| throws | yii\ |
if the property is read only. |
|---|---|---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = null;
return;
}
}
throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}
| public addAgg( string $name, string $type, string|array $options ): $this | ||
| $name | string |
The name of the aggregation |
| $type | string |
The aggregation type. e.g. |
| $options | string|array |
The configuration options for this aggregation. Can be an array or a json string. |
| return | $this |
The query object itself |
|---|---|---|
public function addAgg($name, $type, $options)
{
return $this->addAggregate($name, [$type => $options]);
}
Adds an aggregation to this query. Supports nested aggregations.
See also https://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-aggregations.html.
| public addAggregate( string $name, string|array $options ): $this | ||
| $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 |
|---|---|---|
public function addAggregate($name, $options)
{
$this->aggregations[$name] = $options;
return $this;
}
| public addAggregation( string $name, string $type, string|array $options ): $this | ||
| $name | string |
The name of the aggregation |
| $type | string |
The aggregation type. e.g. |
| $options | string|array |
The configuration options for this aggregation. Can be an array or a json string. |
| return | $this |
The query object itself |
|---|---|---|
public function addAggregation($name, $type, $options)
{
return $this->addAggregate($name, [$type => $options]);
}
Adds a collapse to this query.
| public addCollapse( array $collapse ): $this | ||
| $collapse | array |
The configuration options for collapse. |
| return | $this |
The query object itself |
|---|---|---|
public function addCollapse($collapse)
{
$this->collapse = $collapse;
return $this;
}
Adds more options, overwriting existing options.
See also options().
| public addOptions( array $options ): $this | ||
| $options | array |
The options to be added. |
| return | $this |
The query object itself |
|---|---|---|
| throws | yii\ |
if $options is not an array |
public function addOptions($options)
{
if (!is_array($options)) {
throw new InvalidArgumentException('Array parameter expected, ' . gettype($options) . ' received.');
}
$this->options = array_merge($this->options, $options);
return $this;
}
Defined in:
yii\
Adds additional ORDER BY columns to the query.
See also orderBy().
| public addOrderBy( string|array|yii\ | ||
| $columns | string|array|yii\ |
The columns (and the directions) to be ordered by.
Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array
(e.g. The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression). Note that if your order-by is an expression containing commas, you should always use an array to represent the order-by information. Otherwise, the method will not be able to correctly determine the order-by columns. Since version 2.0.7, an yii\ |
| return | $this |
The query object itself |
|---|---|---|
public function addOrderBy($columns)
{
$columns = $this->normalizeOrderBy($columns);
if ($this->orderBy === null) {
$this->orderBy = $columns;
} else {
$this->orderBy = array_merge($this->orderBy, $columns);
}
return $this;
}
Adds a suggester to this query.
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html.
| public addSuggester( string $name, string|array $definition ): $this | ||
| $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 |
|---|---|---|
public function addSuggester($name, $definition)
{
$this->suggest[$name] = $definition;
return $this;
}
Executes the query and returns all results as an array.
| public all( yii\ | ||
| $db | yii\ |
The database connection used to execute the query.
If this parameter is not given, the |
| return | array |
The query results. If the query results in nothing, an empty array will be returned. |
|---|---|---|
public function all($db = null)
{
if ($this->emulateExecution) {
return [];
}
$result = $this->createCommand($db)->search();
if ($result === false) {
throw new Exception('Elasticsearch search query failed.');
}
if (empty($result['hits']['hits'])) {
return [];
}
$rows = $result['hits']['hits'];
return $this->populate($rows);
}
Defined in:
yii\
Adds an additional WHERE condition to the existing one but ignores empty operands.
The new condition and the existing one will be joined using the 'AND' operator.
This method is similar to andWhere(). The main difference is that this method will remove empty query operands. As a result, this method is best suited for building query conditions based on filter values entered by users.
See also:
| public andFilterWhere( array $condition ): $this | ||
| $condition | array |
The new WHERE condition. Please refer to where() on how to specify this parameter. |
| return | $this |
The query object itself |
|---|---|---|
public function andFilterWhere(array $condition)
{
$condition = $this->filterCondition($condition);
if ($condition !== []) {
$this->andWhere($condition);
}
return $this;
}
Adds an additional WHERE condition to the existing one.
The new condition and the existing one will be joined using the 'AND' operator.
| public andWhere( mixed $condition ): $this | ||
| $condition | mixed |
The new WHERE condition. Please refer to where() on how to specify this parameter. |
| return | $this |
The query object itself |
|---|---|---|
public function andWhere($condition)
{
if ($this->where === null) {
$this->where = $condition;
} elseif (isset($this->where[0]) && $this->where[0] === 'and') {
$this->where[] = $condition;
} else {
$this->where = ['and', $this->where, $condition];
}
return $this;
}
Defined in:
yii\
Attaches a behavior to this component.
This method will create the behavior object based on the given
configuration. After that, the behavior object will be attached to
this component by calling the yii\
See also detachBehavior().
| public attachBehavior( string $name, string|array|yii\ | ||
| $name | string |
The name of the behavior. |
| $behavior | string|array|yii\ |
The behavior configuration. This can be one of the following:
|
| return | yii\ |
The behavior object |
|---|---|---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
Defined in:
yii\
Attaches a list of behaviors to the component.
Each behavior is indexed by its name and should be a yii\
See also attachBehavior().
| public attachBehaviors( array $behaviors ): mixed | ||
| $behaviors | array |
List of behaviors to be attached to the component |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
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\
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 batch( string $scrollWindow = '1m', yii\ | ||
| $scrollWindow | string |
How long Elasticsearch should keep the search context alive, in time units |
| $db | yii\ |
The database connection. If not set, the
|
| return | yii\ |
The batch query result. It implements the Iterator interface and can be traversed to retrieve the data in batches. |
|---|---|---|
public function batch($scrollWindow = '1m', $db = null)
{
return Yii::createObject([
'class' => BatchQueryResult::class,
'query' => $this,
'scrollWindow' => $scrollWindow,
'db' => $db,
'each' => false,
]);
}
Defined in:
yii\
Returns a list of behaviors that this component should behave as.
Child classes may override this method to specify the behaviors they want to behave as.
The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
Note that a behavior class must extend from yii\
Behaviors declared in this method will be attached to the component automatically (on demand).
| public behaviors( ): array<array-key, class-string|array{class: class-string}|yii\ | ||
| return | array<array-key, class-string|array{class: class-string}|yii\ |
The behavior configurations. |
|---|---|---|
public function behaviors()
{
return [];
}
Defined in:
yii\
Returns a value indicating whether a property can be read.
A property can be read if:
- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true); - an attached behavior has a readable property of the given name (when
$checkBehaviorsis true).
See also canSetProperty().
| public canGetProperty( string $name, boolean $checkVars = true, boolean $checkBehaviors = true ): boolean | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| $checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
| return | boolean |
Whether the property can be read |
|---|---|---|
public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
Defined in:
yii\
Returns a value indicating whether a property can be set.
A property can be written if:
- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true); - an attached behavior has a writable property of the given name (when
$checkBehaviorsis true).
See also canGetProperty().
| public canSetProperty( string $name, boolean $checkVars = true, boolean $checkBehaviors = true ): boolean | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| $checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
| return | boolean |
Whether the property can be written |
|---|---|---|
public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
::class instead.
Defined in:
yii\
Returns the fully qualified name of this class.
| public static className( ): string | ||
| return | string |
The fully qualified name of this class. |
|---|---|---|
public static function className()
{
return get_called_class();
}
Executes the query and returns the first column of the result.
| public column( string $field, yii\ | ||
| $field | string |
The field to query over |
| $db | yii\ |
The database connection used to execute the query.
If this parameter is not given, the |
| return | array |
The first column of the query result. An empty array is returned if the query results in nothing. |
|---|---|---|
public function column($field, $db = null)
{
if ($this->emulateExecution) {
return [];
}
$command = $this->createCommand($db);
$command->queryParts['_source'] = [$field];
$result = $command->search();
if ($result === false) {
throw new Exception('Elasticsearch search query failed.');
}
if (empty($result['hits']['hits'])) {
return [];
}
$column = [];
foreach ($result['hits']['hits'] as $row) {
if (isset($row['fields'][$field])) {
$column[] = $row['fields'][$field];
} elseif (isset($row['_source'][$field])) {
$column[] = $row['_source'][$field];
} else {
$column[] = null;
}
}
return $column;
}
Returns the number of records.
| public count( string $q = '*', yii\ | ||
| $q | string |
The COUNT expression. This parameter is ignored by this implementation. |
| $db | yii\ |
The database connection used to execute the query.
If this parameter is not given, the |
| return | integer |
Number of records |
|---|---|---|
public function count($q = '*', $db = null)
{
if ($this->emulateExecution) {
return 0;
}
$command = $this->createCommand($db);
// performing a query with return size of 0, is equal to getting result stats such as count
// https://www.elastic.co/guide/en/elasticsearch/reference/5.6/breaking_50_search_changes.html#_literal_search_type_literal
$searchOptions = ['size' => 0];
// Set track_total_hits to 'true' for ElasticSearch version 6 and up
// https://www.elastic.co/guide/en/elasticsearch/reference/master/search-your-data.html#track-total-hits
if ($command->db->dslVersion >= 6) {
$searchOptions['track_total_hits'] = 'true';
}
$result = $command->search($searchOptions);
// since ES7 totals are returned as array (with count and precision values)
if (isset($result['hits']['total'])) {
return is_array($result['hits']['total']) ? (int)$result['hits']['total']['value'] : (int)$result['hits']['total'];
}
return 0;
}
Creates a DB command that can be used to execute this query.
| public createCommand( yii\ | ||
| $db | yii\ |
The database connection used to execute the query.
If this parameter is not given, the |
| return | yii\ |
The created DB command instance. |
|---|---|---|
public function createCommand($db = null)
{
if ($db === null) {
$db = Yii::$app->get('elasticsearch');
}
$commandConfig = $db->getQueryBuilder()->build($this);
return $db->createCommand($commandConfig);
}
Executes the query and deletes all matching documents.
Everything except query and filter will be ignored.
| public delete( yii\ | ||
| $db | yii\ |
The database connection used to execute the query.
If this parameter is not given, the |
| $options | array |
The options given with this query. |
| return | array |
The query results. |
|---|---|---|
public function delete($db = null, $options = [])
{
if ($this->emulateExecution) {
return [];
}
return $this->createCommand($db)->deleteByQuery($options);
}
Defined in:
yii\
Detaches a behavior from the component.
The behavior's yii\
| public detachBehavior( string $name ): yii\ | ||
| $name | string |
The behavior's name. |
| return | yii\ |
The detached behavior. Null if the behavior does not exist. |
|---|---|---|
public function detachBehavior($name)
{
$this->ensureBehaviors();
if (isset($this->_behaviors[$name])) {
$behavior = $this->_behaviors[$name];
unset($this->_behaviors[$name]);
$behavior->detach();
return $behavior;
}
return null;
}
Defined in:
yii\
Detaches all behaviors from the component.
| public detachBehaviors( ): mixed |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
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 each( string $scrollWindow = '1m', yii\ | ||
| $scrollWindow | string |
How long Elasticsearch should keep the search context alive, in time units |
| $db | yii\ |
The database connection. If not set, the
|
| return | yii\ |
The batch query result. It implements the Iterator interface and can be traversed to retrieve the data in batches. |
|---|---|---|
public function each($scrollWindow = '1m', $db = null)
{
return Yii::createObject([
'class' => BatchQueryResult::class,
'query' => $this,
'scrollWindow' => $scrollWindow,
'db' => $db,
'each' => true,
]);
}
Defined in:
yii\
Sets whether to emulate query execution, preventing any interaction with data storage.
After this mode is enabled, methods, returning query results like yii\0=1.
| public emulateExecution( boolean $value = true ): $this | ||
| $value | boolean |
Whether to prevent query execution. |
| return | $this |
The query object itself. |
|---|---|---|
public function emulateExecution($value = true)
{
$this->emulateExecution = $value;
return $this;
}
Defined in:
yii\
Makes sure that the behaviors declared in behaviors() are attached to this component.
| public ensureBehaviors( ): mixed |
public function ensureBehaviors()
{
if ($this->_behaviors === null) {
$this->_behaviors = [];
foreach ($this->behaviors() as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
}
Returns a value indicating whether the query result contains any row of data.
| public exists( yii\ | ||
| $db | yii\ |
The database connection used to execute the query.
If this parameter is not given, the |
| return | boolean |
Whether the query result contains any row of data. |
|---|---|---|
public function exists($db = null)
{
return self::one($db) !== false;
}
Explain for how the score of each document was computer
| public explain( mixed $explain ): $this | ||
| $explain | mixed | |
public function explain($explain)
{
$this->explain = $explain;
return $this;
}
Sets the runtime fields to retrieve from the documents.
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-retrieving-fields.html.
| public fields( array $fields ): $this | ||
| $fields | array |
The fields to be selected. |
| return | $this |
The query object itself |
|---|---|---|
public function fields($fields)
{
if (is_array($fields) || $fields === null) {
$this->fields = $fields;
} else {
$this->fields = func_get_args();
}
return $this;
}
Defined in:
yii\
Removes empty operands from the given query condition.
| protected filterCondition( array $condition ): array | ||
| $condition | array |
The original condition |
| return | array |
The condition with empty operands removed. |
|---|---|---|
| throws | yii\ |
if the condition operator is not supported |
protected function filterCondition($condition)
{
if (!is_array($condition)) {
return $condition;
}
if (!isset($condition[0])) {
// hash format: 'column1' => 'value1', 'column2' => 'value2', ...
foreach ($condition as $name => $value) {
if ($this->isEmpty($value)) {
unset($condition[$name]);
}
}
return $condition;
}
// operator format: operator, operand 1, operand 2, ...
$operator = array_shift($condition);
switch (strtoupper($operator)) {
case 'NOT':
case 'AND':
case 'OR':
foreach ($condition as $i => $operand) {
$subCondition = $this->filterCondition($operand);
if ($this->isEmpty($subCondition)) {
unset($condition[$i]);
} else {
$condition[$i] = $subCondition;
}
}
if (empty($condition)) {
return [];
}
break;
case 'BETWEEN':
case 'NOT BETWEEN':
if (array_key_exists(1, $condition) && array_key_exists(2, $condition)) {
if ($this->isEmpty($condition[1]) || $this->isEmpty($condition[2])) {
return [];
}
}
break;
default:
if (array_key_exists(1, $condition) && $this->isEmpty($condition[1])) {
return [];
}
}
array_unshift($condition, $operator);
return $condition;
}
Defined in:
yii\
Sets the WHERE part of the query but ignores empty operands.
This method is similar to where(). The main difference is that this method will remove empty query operands. As a result, this method is best suited for building query conditions based on filter values entered by users.
The following code shows the difference between this method and where():
// WHERE `age`=:age
$query->filterWhere(['name' => null, 'age' => 20]);
// WHERE `age`=:age
$query->where(['age' => 20]);
// WHERE `name` IS NULL AND `age`=:age
$query->where(['name' => null, 'age' => 20]);
Note that unlike where(), you cannot pass binding parameters to this method.
See also:
| public filterWhere( array $condition ): $this | ||
| $condition | array |
The conditions that should be put in the WHERE part. See where() on how to specify this parameter. |
| return | $this |
The query object itself |
|---|---|---|
public function filterWhere(array $condition)
{
$condition = $this->filterCondition($condition);
if ($condition !== []) {
$this->where($condition);
}
return $this;
}
Sets the index and type to retrieve documents from.
| public from( string|array $index, string|array $type = null ): $this | ||
| $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 |
| $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 |
| return | $this |
The query object itself |
|---|---|---|
public function from($index, $type = null)
{
$this->index = $index;
$this->type = $type;
return $this;
}
Defined in:
yii\
Returns the named behavior object.
| public getBehavior( string $name ): yii\ | ||
| $name | string |
The behavior name |
| return | yii\ |
The behavior object, or null if the behavior does not exist |
|---|---|---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
Defined in:
yii\
Returns all behaviors attached to this component.
| public getBehaviors( ): array<yii\ | ||
| return | array<yii\ |
List of behaviors attached to this component |
|---|---|---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
Defined in:
yii\
Returns a value indicating whether there is any handler attached to the named event.
| public hasEventHandlers( string $name ): boolean | ||
| $name | string |
The event name |
| return | boolean |
Whether there is any handler attached to the event. |
|---|---|---|
public function hasEventHandlers($name)
{
$this->ensureBehaviors();
if (!empty($this->_events[$name])) {
return true;
}
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
return true;
}
}
return Event::hasHandlers($this, $name);
}
Defined in:
yii\
Returns a value indicating whether a method is defined.
A method is defined if:
- the class has a method with the specified name
- an attached behavior has a method with the given name (when
$checkBehaviorsis true).
| public hasMethod( string $name, boolean $checkBehaviors = true ): boolean | ||
| $name | string |
The property name |
| $checkBehaviors | boolean |
Whether to treat behaviors' methods as methods of this component |
| return | boolean |
Whether the method is defined |
|---|---|---|
public function hasMethod($name, $checkBehaviors = true)
{
if (method_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->hasMethod($name)) {
return true;
}
}
}
return false;
}
Defined in:
yii\
Returns a value indicating whether a property is defined for this component.
A property is defined if:
- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true); - an attached behavior has a property of the given name (when
$checkBehaviorsis true).
See also:
| public hasProperty( string $name, boolean $checkVars = true, boolean $checkBehaviors = true ): boolean | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| $checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
| return | boolean |
Whether the property is defined |
|---|---|---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
Sets a highlight parameters to retrieve from the documents.
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-highlighting.html.
| public highlight( array $highlight ): $this | ||
| $highlight | array |
Array of parameters to highlight results. |
| return | $this |
The query object itself |
|---|---|---|
public function highlight($highlight)
{
$this->highlight = $highlight;
return $this;
}
Defined in:
yii\
Sets the indexBy() property.
| public indexBy( string|callable $column ): $this | ||
| $column | string|callable |
The name of the column by which the query results should be indexed by. This can also be a callable (e.g. anonymous function) that returns the index value based on the given row data. The signature of the callable should be:
|
| return | $this |
The query object itself |
|---|---|---|
public function indexBy($column)
{
$this->indexBy = $column;
return $this;
}
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
| public init( ): mixed |
public function init()
{
parent::init();
// setting the default limit according to Elasticsearch defaults
// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#_parameters_5
if ($this->limit === null) {
$this->limit = 10;
}
}
Defined in:
yii\
Returns a value indicating whether the give value is "empty".
The value is considered "empty", if one of the following conditions is satisfied:
- it is
null, - an empty string (
''), - a string containing only whitespace characters,
- or an empty array.
| protected isEmpty( mixed $value ): boolean | ||
| $value | mixed | |
| return | boolean |
If the value is empty |
|---|---|---|
protected function isEmpty($value)
{
return $value === '' || $value === [] || $value === null || is_string($value) && trim($value) === '';
}
Defined in:
yii\
Sets the LIMIT part of the query.
| public limit( integer|yii\ | ||
| $limit | integer|yii\ |
The limit. Use null or negative value to disable limit. |
| return | $this |
The query object itself |
|---|---|---|
public function limit($limit)
{
$this->limit = $limit;
return $this;
}
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-min-score.html.
| public minScore( float $minScore ): $this | ||
| $minScore | float |
Exclude documents which have a |
| return | $this |
The query object itself |
|---|---|---|
public function minScore($minScore)
{
$this->minScore = $minScore;
return $this;
}
Defined in:
yii\
Normalizes format of ORDER BY data.
| protected normalizeOrderBy( array|string|yii\ | ||
| $columns | array|string|yii\ |
The columns value to normalize. See orderBy() and addOrderBy(). |
protected function normalizeOrderBy($columns)
{
if (empty($columns)) {
return [];
} elseif ($columns instanceof ExpressionInterface) {
return [$columns];
} elseif (is_array($columns)) {
return $columns;
}
$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
$result = [];
foreach ($columns as $column) {
if (preg_match('/^(.*?)\s+(asc|desc)$/i', $column, $matches)) {
$result[$matches[1]] = strcasecmp($matches[2], 'desc') ? SORT_ASC : SORT_DESC;
} else {
$result[$column] = SORT_ASC;
}
}
return $result;
}
Defined in:
yii\
Detaches an existing event handler from this component.
This method is the opposite of on().
Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.
See also on().
| public off( string $name, callable|null $handler = null ): boolean | ||
| $name | string |
Event name |
| $handler | callable|null |
The event handler to be removed. If it is null, all handlers attached to the named event will be removed. |
| return | boolean |
If a handler is found and detached |
|---|---|---|
public function off($name, $handler = null)
{
$this->ensureBehaviors();
if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
return false;
}
if ($handler === null) {
unset($this->_events[$name], $this->_eventWildcards[$name]);
return true;
}
$removed = false;
// plain event names
if (isset($this->_events[$name])) {
foreach ($this->_events[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_events[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_events[$name] = array_values($this->_events[$name]);
return true;
}
}
// wildcard event names
if (isset($this->_eventWildcards[$name])) {
foreach ($this->_eventWildcards[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_eventWildcards[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
// remove empty wildcards to save future redundant regex checks:
if (empty($this->_eventWildcards[$name])) {
unset($this->_eventWildcards[$name]);
}
}
}
return $removed;
}
Defined in:
yii\
Sets the OFFSET part of the query.
| public offset( integer|yii\ | ||
| $offset | integer|yii\ |
The offset. Use null or negative value to disable offset. |
| return | $this |
The query object itself |
|---|---|---|
public function offset($offset)
{
$this->offset = $offset;
return $this;
}
Defined in:
yii\
Attaches an event handler to an event.
The event handler must be a valid PHP callback. The following are some examples:
function ($event) { ... } // anonymous function
[$object, 'handleClick'] // $object->handleClick()
['Page', 'handleClick'] // Page::handleClick()
'handleClick' // global function handleClick()
The event handler must be defined with the following signature,
function ($event)
where $event is an yii\
Since 2.0.14 you can specify event name as a wildcard pattern:
$component->on('event.group.*', function ($event) {
Yii::trace($event->name . ' is triggered.');
});
See also off().
| public on( string $name, callable $handler, mixed $data = null, boolean $append = true ): mixed | ||
| $name | string |
The event name |
| $handler | callable |
The event handler |
| $data | mixed |
The data to be passed to the event handler when the event is triggered.
When the event handler is invoked, this data can be accessed via yii\ |
| $append | boolean |
Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list. |
public function on($name, $handler, $data = null, $append = true)
{
$this->ensureBehaviors();
if (strpos($name, '*') !== false) {
if ($append || empty($this->_eventWildcards[$name])) {
$this->_eventWildcards[$name][] = [$handler, $data];
} else {
array_unshift($this->_eventWildcards[$name], [$handler, $data]);
}
return;
}
if ($append || empty($this->_events[$name])) {
$this->_events[$name][] = [$handler, $data];
} else {
array_unshift($this->_events[$name], [$handler, $data]);
}
}
Executes the query and returns a single row of result.
| public one( yii\ | ||
| $db | yii\ |
The database connection used to execute the query.
If this parameter is not given, the |
| 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)
{
if ($this->emulateExecution) {
return false;
}
$result = $this->createCommand($db)->search(['size' => 1]);
if ($result === false) {
throw new Exception('Elasticsearch search query failed.');
}
if (empty($result['hits']['hits'])) {
return false;
}
$record = reset($result['hits']['hits']);
return $record;
}
Sets the options to be passed to the command created by this query.
See also yii\
| public options( array $options ): $this | ||
| $options | array |
The options to be set. |
| return | $this |
The query object itself |
|---|---|---|
| throws | yii\ |
if $options is not an array |
public function options($options)
{
if (!is_array($options)) {
throw new InvalidArgumentException('Array parameter expected, ' . gettype($options) . ' received.');
}
$this->options = $options;
return $this;
}
Defined in:
yii\
Adds an additional WHERE condition to the existing one but ignores empty operands.
The new condition and the existing one will be joined using the 'OR' operator.
This method is similar to orWhere(). The main difference is that this method will remove empty query operands. As a result, this method is best suited for building query conditions based on filter values entered by users.
See also:
| public orFilterWhere( array $condition ): $this | ||
| $condition | array |
The new WHERE condition. Please refer to where() on how to specify this parameter. |
| return | $this |
The query object itself |
|---|---|---|
public function orFilterWhere(array $condition)
{
$condition = $this->filterCondition($condition);
if ($condition !== []) {
$this->orWhere($condition);
}
return $this;
}
Adds an additional WHERE condition to the existing one.
The new condition and the existing one will be joined using the 'OR' operator.
| public orWhere( mixed $condition ): $this | ||
| $condition | mixed |
The new WHERE condition. Please refer to where() on how to specify this parameter. |
| return | $this |
The query object itself |
|---|---|---|
public function orWhere($condition)
{
if ($this->where === null) {
$this->where = $condition;
} elseif (isset($this->where[0]) && $this->where[0] === 'or') {
$this->where[] = $condition;
} else {
$this->where = ['or', $this->where, $condition];
}
return $this;
}
Defined in:
yii\
Sets the ORDER BY part of the query.
See also addOrderBy().
| public orderBy( string|array|yii\ | ||
| $columns | string|array|yii\ |
The columns (and the directions) to be ordered by.
Columns can be specified in either a string (e.g. The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression). Note that if your order-by is an expression containing commas, you should always use an array to represent the order-by information. Otherwise, the method will not be able to correctly determine the order-by columns. Since version 2.0.7, an yii\ |
| return | $this |
The query object itself |
|---|---|---|
public function orderBy($columns)
{
$this->orderBy = $this->normalizeOrderBy($columns);
return $this;
}
Converts the raw query results into the format as specified by this query. This method is internally used to convert the data fetched from database into the format as required by this query.
| public populate( array $rows ): array | ||
| $rows | array |
The raw query result from database |
| return | array |
The converted query result |
|---|---|---|
public function populate($rows)
{
if ($this->indexBy === null) {
return $rows;
}
$models = [];
foreach ($rows as $key => $row) {
if ($this->indexBy !== null) {
if (is_string($this->indexBy)) {
$key = isset($row['fields'][$this->indexBy]) ?
reset($row['fields'][$this->indexBy]) : $row['_source'][$this->indexBy];
} else {
$key = call_user_func($this->indexBy, $row);
}
}
$models[$key] = $row;
}
return $models;
}
Set the post_filter part of the search query.
| public postFilter( string|array $filter ): $this | ||
| $filter | string|array | |
| return | $this |
The query object itself |
|---|---|---|
public function postFilter($filter)
{
$this->postFilter = $filter;
return $this;
}
Sets the query part of this search query.
| public query( string|array $query ): $this | ||
| $query | string|array | |
| return | $this |
The query object itself |
|---|---|---|
public function query($query)
{
$this->query = $query;
return $this;
}
Sets the runtime mappings for this query
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime.html.
| public runtimeMappings( mixed $mappings ): $this | ||
| $mappings | mixed | |
| return | $this |
The query object itself |
|---|---|---|
public function runtimeMappings($mappings)
{
if (is_array($mappings) || $mappings === null) {
$this->runtimeMappings = $mappings;
} else {
$this->runtimeMappings = func_get_args();
}
return $this;
}
Returns the query result as a scalar value. The value returned will be the specified field in the first document of the query results.
| public scalar( string $field, yii\ | ||
| $field | string |
Name of the attribute to select |
| $db | yii\ |
The database connection used to execute the query.
If this parameter is not given, the |
| 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 function scalar($field, $db = null)
{
if ($this->emulateExecution) {
return null;
}
$record = self::one($db);
if ($record !== false) {
if ($field === '_id') {
return $record['_id'];
} elseif (isset($record['_source'][$field])) {
return $record['_source'][$field];
} elseif (isset($record['fields'][$field])) {
return count($record['fields'][$field]) == 1 ? reset($record['fields'][$field]) : $record['fields'][$field];
}
}
return null;
}
Sets the script fields to retrieve from the documents.
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-script-fields.html.
| public scriptFields( array $fields ): $this | ||
| $fields | array |
The fields to be selected. |
| return | $this |
The query object itself |
|---|---|---|
public function scriptFields($fields)
{
if (is_array($fields) || $fields === null) {
$this->scriptFields = $fields;
} else {
$this->scriptFields = func_get_args();
}
return $this;
}
Executes the query and returns the complete search result including e.g.
hits, aggregations, suggesters, totalCount.
| public search( yii\ | ||
| $db | yii\ |
The database connection used to execute the query.
If this parameter is not given, the |
| $options | array |
The options given with this query. Possible options are: |
| return | array |
The query results. |
|---|---|---|
public function search($db = null, $options = [])
{
if ($this->emulateExecution) {
return [
'hits' => [
'total' => 0,
'hits' => [],
],
];
}
$result = $this->createCommand($db)->search($options);
if ($result === false) {
throw new Exception('Elasticsearch search query failed.');
}
if (!empty($result['hits']['hits']) && $this->indexBy !== null) {
$rows = [];
foreach ($result['hits']['hits'] as $key => $row) {
if (is_string($this->indexBy)) {
$key = isset($row['fields'][$this->indexBy]) ?
$row['fields'][$this->indexBy] : $row['_source'][$this->indexBy];
} else {
$key = call_user_func($this->indexBy, $row);
}
$rows[$key] = $row;
}
$result['hits']['hits'] = $rows;
}
return $result;
}
Sets the source filtering, specifying how the _source field of the
document should be returned.
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-source-filtering.html.
| public source( array|string|null|false $source ): $this | ||
| $source | array|string|null|false |
The source patterns to be selected. |
| return | $this |
The query object itself |
|---|---|---|
public function source($source)
{
if (is_array($source) || $source === null || $source === false) {
$this->source = $source;
} else {
$this->source = func_get_args();
}
return $this;
}
Adds a 'stats' part to the query.
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search.html#stats-groups.
| public stats( array $groups ): $this | ||
| $groups | array |
An array of groups to maintain a statistics aggregation for. |
| return | $this |
The query object itself |
|---|---|---|
public function stats($groups)
{
$this->stats = $groups;
return $this;
}
Sets the fields to retrieve from the documents.
Quote from the Elasticsearch doc: > The stored_fields parameter is about fields that are explicitly marked > as stored in the mapping, which is off by default and generally not > recommended. Use source filtering instead to select subsets of the > original source document to be returned.
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-stored-fields.html.
| public storedFields( array $fields ): $this | ||
| $fields | array |
The fields to be selected. |
| return | $this |
The query object itself |
|---|---|---|
public function storedFields($fields)
{
if (is_array($fields) || $fields === null) {
$this->storedFields = $fields;
} else {
$this->storedFields = func_get_args();
}
return $this;
}
Sets the search timeout.
| public timeout( integer $timeout ): $this | ||
| $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 |
|---|---|---|
public function timeout($timeout)
{
$this->timeout = $timeout;
return $this;
}
Defined in:
yii\
Triggers an event.
This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.
| public trigger( string $name, yii\ | ||
| $name | string |
The event name |
| $event | yii\ |
The event instance. If not set, a default yii\ |
public function trigger($name, ?Event $event = null)
{
$this->ensureBehaviors();
$eventHandlers = [];
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (StringHelper::matchWildcard($wildcard, $name)) {
$eventHandlers[] = $handlers;
}
}
if (!empty($this->_events[$name])) {
$eventHandlers[] = $this->_events[$name];
}
if (!empty($eventHandlers)) {
$eventHandlers = call_user_func_array('array_merge', $eventHandlers);
if ($event === null) {
$event = new Event();
}
if ($event->sender === null) {
$event->sender = $this;
}
$event->handled = false;
$event->name = $name;
foreach ($eventHandlers as $handler) {
$event->data = $handler[1];
call_user_func($handler[0], $event);
// stop further handling if the event is handled
if ($event->handled) {
return;
}
}
}
// invoke class-level attached handlers
Event::trigger($this, $name, $event);
}
Defined in:
yii\
Sets the WHERE part of the query.
See yii\
See also:
| public where( string|array|yii\ | ||
| $condition | string|array|yii\ |
The conditions that should be put in the WHERE part. |
| return | $this |
The query object itself |
|---|---|---|
public function where($condition)
{
$this->where = $condition;
return $this;
}