Класс yii\elasticsearch\Query

Query представляет запрос к API поиска elasticsearch.

Query предоставляет набор методов для удобного задания различных параметров запроса. Эти методы можно использовать по цепочке.

Вызывая createCommand(), мы можем получить экземпляр yii\elasticsearch\Command, который можно использовать для выполнения запроса к базе данных.

Например,

$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.

Обычно вызывается $query->search() вместо создания команды, так как этот метод добавляет indexBy() функциональность и также устраняет некоторые несоответствия в ответе.

Query также предоставляет некоторые методы для более легкого получения только определенных частей результата:

• one(): возвращает единственную запись, заполненную первой строкой данных.
• all(): возвращает все записи на основе результатов запроса.
• count(): возвращает количество записей.
• scalar(): возвращает значение первого столбца в первой строке результата запроса.
• column(): возвращает значение первого столбца в результате запроса.
• exists(): возвращает значение, указывающее, содержит ли результат запроса данные или нет.

ПРИМЕЧАНИЕ: elasticsearch по умолчанию ограничивает количество возвращаемых записей 10. Если ожидается получить больше записей, необходимо явно указать лимит.

Публичные свойства

Публичные методы

Защищенные методы

Подробное описание свойств

$aggregations общедоступное свойство

Список агрегаций для добавления в этот запрос.

См. также http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-aggregations.html.

public array $aggregations = []

$explain общедоступное свойство (доступно начиная с версии 2.0.5)

Включает объяснение для каждого результата, как был вычислен его рейтинг.

См. также https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-explain.html.

public boolean $explain = null

$fields общедоступное свойство

Поля, извлекаемые из документов. Например, ['id', 'name']. Если не задано, этот параметр не будет применен к запросу, и поля не будут возвращены. В этом случае поле _source будет возвращено по умолчанию, что можно настроить с помощью source(). Установка этого параметра в пустой массив приведет к тому, что поля не будут извлечены, что означает, что только первичный ключ записи будет доступен в результате.

Для каждого поля вы также можете добавить массив, представляющий поле сценария. Пример:

$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
        ],
    ],
]

Примечание: Значения полей всегда возвращаются в виде массивов, даже если у них есть только одно значение.

См. также:

• 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 общедоступное свойство

Часть фильтра этого поискового запроса. Это массив или json-строка, которые соответствуют формату Query DSL elasticsearch.

public array|string $filter = null

$highlight общедоступное свойство

Часть выделения этого поискового запроса. Это массив, который позволяет выделять результаты поиска по одному или нескольким полям.

См. также http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-request-highlighting.html.

public array $highlight = null

$index общедоступное свойство

Индекс для извлечения данных. Это может быть строка, представляющая один индекс, или массив, представляющий несколько индексов. Если это не задано, индексы будут запрошены.

См. также from().

public string|array $index = null

$minScore общедоступное свойство (доступно начиная с версии 2.0.4)

Исключить документы, у которых _score меньше, чем минимальное значение, указанное в min_score

См. также http://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-min-score.html.

public float $minScore = null

$options общедоступное свойство (доступно начиная с версии 2.0.4)

Список параметров, которые будут переданы командам, созданным этим запросом.

См. также yii\elasticsearch\Command::$options.

public array $options = []

$postFilter общедоступное свойство (доступно начиная с версии 2.0.5)

Часть post_filter поискового запроса для дифференциальной фильтрации результатов поиска и агрегаций.

См. также https://www.elastic.co/guide/en/elasticsearch/guide/current/_post_filter.html.

public string|array $postFilter = null

$query общедоступное свойство

Часть запроса этого поискового запроса. Это массив или json-строка, которые соответствуют формату Query DSL elasticsearch.

public array|string $query = null

$source общедоступное свойство

Этот параметр контролирует, как возвращается поле _source из документов. Например, ['id', 'name'] означает, что должны быть возвращены только поля id и name из _source. Если не задано, это означает извлечение всего поля _source, если не указаны fields(). Установка этого параметра в false отключит возвращение поля _source, что означает, что только первичный ключ записи будет доступен в результате.

См. также:

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

public array $source = null

$stats общедоступное свойство

Часть 'stats' запроса. Массив групп для поддержания агрегации статистики.

См. также http://www.elastic.co/guide/en/elasticsearch/reference/current/search.html#stats-groups.

public array $stats = []

$suggest общедоступное свойство

Список суффиксов для добавления в этот запрос.

См. также http://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html.

public array $suggest = []

$timeout общедоступное свойство

Таймаут поиска, ограничивающий запрос поиска временем выполнения и прекращающий его с накопленными результатами по истечении времени. По умолчанию таймаут отсутствует.

См. также:

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

public integer $timeout = null

$type общедоступное свойство

Тип для получения данных. Это может быть строка, представляющая один тип, или массив, представляющий несколько типов. Если это не установлено, все типы запрашиваются.

См. также from().

public string|array $type = null

Подробное описание методов

$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) {
}