• Главная
• yii
• elasticsearch
• Query

PHP Класс yii\elasticsearch\Query

Query provides a set of methods to facilitate the specification of different parameters of the query. These methods can be chained together. By calling Query::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: - Query::one: returns a single record populated with the first row of data. - Query::all: returns all records based on the query results. - Query::count: returns the number of records. - Query::scalar: returns the value of the first column in the first row of the query result. - Query::column: returns the value of the first column in the query result. - Query::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. Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$aggregations		List of aggregations to add to this query.
$fields		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: php $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. [always returned as arrays]: http://www.elastic.co/guide/en/elasticsearch/reference/1.x/_return_values.html#_return_values [script field]: http://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-script-fields.html
$filter		The filter part of this search query. This is an array or json string that follows the format of the elasticsearch Query DSL.
$highlight		The highlight part of this search query. This is an array that allows to highlight search results on one or more fields.
$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 not set, indexes are being queried.
$minScore		Exclude documents which have a _score less than the minimum specified in min_score
$options		list of options that will passed to commands created by this query.
$postFilter		The post_filter part of the search query for differentially filter search results and aggregations.
$query		The query part of this search query. This is an array or json string that follows the format of the elasticsearch Query DSL.
$source		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.
$stats		the 'stats' part of the query. An array of groups to maintain a statistics aggregation for.
$suggest		list of suggesters to add to this query.
$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.
$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 not set, all types are being queried.

Открытые методы

Метод	Описание
addAgg ( string $name, string $type, string | array $options )
addAggregate ( string $name, string | array $options )	Adds an aggregation to this query. Supports nested aggregations.
addAggregation ( string $name, string $type, string | array $options )
addOptions ( array $options )	Adds more options, overwriting existing options.
addSuggester ( string $name, string | array $definition )	Adds a suggester to this query.
all ( Connection $db = null ) : array	Executes the query and returns all results as an array.
batch ( string $scrollWindow = '1m', Connection $db = null ) : BatchQueryResult	Starts a batch query.
column ( string $field, Connection $db = null ) : array	Executes the query and returns the first column of the result.
count ( string $q = '*', Connection $db = null ) : integer	Returns the number of records.
createCommand ( Connection $db = null ) : Command	Creates a DB command that can be used to execute this query.
delete ( Connection $db = null, array $options = [] ) : array	Executes the query and deletes all matching documents.
each ( string $scrollWindow = '1m', Connection $db = null ) : BatchQueryResult	Starts a batch query and retrieves data row by row.
exists ( Connection $db = null ) : boolean	Returns a value indicating whether the query result contains any row of data.
fields ( array $fields )	Sets the fields to retrieve from the documents.
filter ( string $filter )	Sets the filter part of this search query.
from ( string | array $index, string | array $type = null )	Sets the index and type to retrieve documents from.
highlight ( array $highlight )	Sets a highlight parameters to retrieve from the documents.
init ( )
minScore ( float $minScore ) : static
one ( Connection $db = null ) : array | boolean	Executes the query and returns a single row of result.
options ( array $options )	Sets the options to be passed to the command created by this query.
populate ( array $rows ) : array	Converts the raw query results into the format as specified by this query.
postFilter ( string | array $filter )	Set the post_filter part of the search query.
query ( string $query )	Sets the querypart of this search query.
scalar ( string $field, Connection $db = null ) : string	Returns the query result as a scalar value.
search ( Connection $db = null, array $options = [] ) : array	Executes the query and returns the complete search result including e.g. hits, facets, totalCount.
source ( array $source )	Sets the source filtering, specifying how the _source field of the document should be returned.
stats ( array $groups )	Adds a 'stats' part to the query.
timeout ( integer $timeout )	Sets the search timeout.

Описание методов

Описание свойств