Класс yii\elasticsearch\BulkCommand
| Наследование | yii\elasticsearch\BulkCommand » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0.5 |
| Исходный код | https://github.com/yiisoft/yii2-elasticsearch/blob/master/BulkCommand.php |
Класс yii\elasticsearch\BulkCommand реализует API для доступа к REST API elasticsearch для пакетных операций.
Дополнительные сведения о пакетном API доступны в руководстве elasticsearch.
Открытые свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $actions | массив|строка | Действия, которые необходимо выполнить в рамках этого пакетного запроса, заданные либо как массив массивов, либо как одна строка, разделенная символом новой строки. | yii\elasticsearch\BulkCommand |
| $behaviors | yii\base\Behavior[] | Список присоединённых к этому компоненту поведений | yii\base\Component |
| $db | yii\elasticsearch\Connection | yii\elasticsearch\BulkCommand | |
| $index | строка | Базовый индекс, на котором будут выполняться запросы. | yii\elasticsearch\BulkCommand |
| $options | массив | Параметры, которые будут добавлены к URL запроса. | yii\elasticsearch\BulkCommand |
| $type | строка | Базовый тип, на котором будут выполняться запросы. | yii\elasticsearch\BulkCommand |
Открытые методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Component |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства компонента. | yii\base\Component |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Component |
| __set() | Устанавливает значение свойства компонента. | yii\base\Component |
| __unset() | Устанавливает свойство компонента в значение null. | yii\base\Component |
| addAction() | Добавляет действие в команду. Перезапишет существующие действия, если они указаны как строка. | yii\elasticsearch\BulkCommand |
| addDeleteAction() | Добавляет действие удаления в команду. | yii\elasticsearch\BulkCommand |
| attachBehavior() | Присоединяет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, по которым должен действовать этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Component |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Component |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| execute() | Выполняет пакетную команду. | yii\elasticsearch\BulkCommand |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все поведения, присоединённые к этому компоненту. | yii\base\Component |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, присоединённый к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Component |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для этого компонента. | yii\base\Component |
| init() | Инициализирует объект. | yii\base\Object |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| trigger() | Вызывает событие. | yii\base\Component |
Подробное описание свойств
$actions открытое свойство
Действия, которые необходимо выполнить в рамках этого пакетного запроса, заданные либо как массив массивов, либо как одна строка, разделенная символом новой строки. Все действия, кроме удаления, занимают две строки.
public array|string $actions = null
$db открытое свойство
public yii\elasticsearch\Connection $db = null
$index открытое свойство
Базовый индекс, на котором будут выполняться запросы. По умолчанию равно null, что означает, что индекс необходимо указать в каждом действии.
public string $index = null
$options открытое свойство
Параметры, которые будут добавлены к URL запроса.
public array $options = []
$type открытое свойство
Базовый тип, на котором будут выполняться запросы. По умолчанию равно null, что означает, что тип необходимо указать в каждом действии.
public string $type = null
Подробное описание методов
addAction() public method
Добавляет действие в команду. Заменит существующие действия, если они заданы как строка.
| public void addAction ( $line1, $line2 = null ) | ||
|---|---|---|
| $line1 | ||
| $line2 | ||
addDeleteAction() public method
Добавляет действие удаления в команду.
| public void addDeleteAction ( $id, $index = null, $type = null ) | ||
|---|---|---|
| $id | string |
Идентификатор документа |
| $index | string |
Индекс, к которому принадлежит документ. Может быть задан как null, если у команды есть заданный по умолчанию индекс (yii\elasticsearch\BulkCommand::$index). |
| $type | string |
Тип, к которому принадлежит документ. Может быть задан как null, если у команды есть заданный по умолчанию тип (yii\elasticsearch\BulkCommand::$type). |
execute() public method
Выполняет команду bulk.
| public mixed execute ( ) | ||
|---|---|---|
| throws | \yii\elasticsearch\yii\base\InvalidCallException | |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-elasticsearch-bulkcommand.html
