# Class yii\elasticsearch\BulkCommand

Inheritance | yii\elasticsearch\BulkCommand » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable
Available since version | 2.0.5
Source Code | https://github.com/yiisoft/yii2-elasticsearch/blob/master/BulkCommand.php

The yii\elasticsearch\BulkCommand class implements the API for accessing the Elasticsearch bulk REST API.

Further details on bulk API is available in Elasticsearch guide.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$actions | array|string | Actions to be executed in this bulk command, given as either an array of arrays or as one newline-delimited string. | yii\elasticsearch\BulkCommand
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component
$db | yii\elasticsearch\Connection |  | yii\elasticsearch\BulkCommand
$index | string | Default index to execute the queries on. | yii\elasticsearch\BulkCommand
$options | array | Options to be appended to the query URL. | yii\elasticsearch\BulkCommand
$type | string | Default type to execute the queries on. | yii\elasticsearch\BulkCommand

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\Component
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component
__construct() | Constructor. | yii\base\BaseObject
__get() | Returns the value of a component property. | yii\base\Component
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component
__set() | Sets the value of a component property. | yii\base\Component
__unset() | Sets a component property to be null. | yii\base\Component
addAction() | Adds an action to the command. Will overwrite existing actions if they are specified as a string. | yii\elasticsearch\BulkCommand
addDeleteAction() | Adds a delete action to the command. | yii\elasticsearch\BulkCommand
attachBehavior() | Attaches a behavior to this component. | yii\base\Component
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
detachBehavior() | Detaches a behavior from the component. | yii\base\Component
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component
execute() | Executes the bulk command. | yii\elasticsearch\BulkCommand
getBehavior() | Returns the named behavior object. | yii\base\Component
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component
init() | Initializes the object. | yii\base\BaseObject
off() | Detaches an existing event handler from this component. | yii\base\Component
on() | Attaches an event handler to an event. | yii\base\Component
trigger() | Triggers an event. | yii\base\Component

## Property Details

$actions public property

Actions to be executed in this bulk command, given as either an array of arrays or as one newline-delimited string. All actions except delete span two lines.

public array|string $actions = null
$db public property
public yii\elasticsearch\Connection $db = null
$index public property

Default index to execute the queries on. Defaults to null meaning that index needs to be specified in every action.

public string $index = null
$options public property

Options to be appended to the query URL.

public array $options = []
$type public property

Default type to execute the queries on. Defaults to null meaning that type needs to be specified in every action.

public string $type = null

## Method Details

addAction() public method

Adds an action to the command. Will overwrite existing actions if they are specified as a string.

public void addAction ( $line1, $line2 = null )
$line1 |  |
$line2 |  |

addDeleteAction() public method

Adds a delete action to the command.

public void addDeleteAction ( $id, $index = null, $type = null )
$id | string | Document ID
$index | string | Index that the document belogs to. Can be set to null if the command has a default index (yii\elasticsearch\BulkCommand::$index) assigned.
$type | string | Type that the document belogs to. Can be set to null if the command has a default type (yii\elasticsearch\BulkCommand::$type) assigned.

execute() public method

Executes the bulk command.

public mixed execute ( )
throws | \yii\elasticsearch\yii\base\InvalidCallException |