# Class yii\elasticsearch\ActiveRecord

Inheritance | yii\elasticsearch\ActiveRecord » yii\db\BaseActiveRecord » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements | ArrayAccess, IteratorAggregate, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface, yii\db\ActiveRecordInterface
Uses Traits | yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveRecord.php

ActiveRecord is the base class for classes representing relational data in terms of objects.

This class implements the ActiveRecord pattern for the fulltext search and data storage Elasticsearch.

For defining a record a subclass should at least implement the attributes() method to define attributes. IMPORTANT: The primary key (the `_id` attribute) MUST NOT be included in attributes().

The following is an example model called `Customer`:

    class Customer extends \yii\elasticsearch\ActiveRecord
    {
        public function attributes()
        {
            return ['name', 'address', 'registration_date'];
        }
    }

You may override index() and type() to define the index and type this record represents. Types are being deprecated, and it is recommended to have a single type per index. For more information read about removal of mapping types. For Elasticsearch 7 and later (as configured in yii\elasticsearch\Connection, type() is ignored.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$_id | mixed | The primary key of the record. Can only be written to for new records, otherwise read-only. | yii\elasticsearch\ActiveRecord
$activeValidators | yii\validators\Validator[] | The validators applicable to the current $scenario. This property is read-only. | yii\base\Model
$attributes | array | Attribute values (name => value). | yii\base\Model
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component
$dirtyAttributes | array | The changed attribute values (name-value pairs). This property is read-only. | yii\db\BaseActiveRecord
$errors | array | An array of errors for all attributes. Empty array is returned if no error. The result is a two-dimensional array. See getErrors() for detailed description. This property is read-only. | yii\base\Model
$explanation | array|null | An explanation for each hit on how its score was computed. This property is read-only. | yii\elasticsearch\ActiveRecord
$firstErrors | array | The first errors. The array keys are the attribute names, and the array values are the corresponding error messages. An empty array will be returned if there is no error. This property is read-only. | yii\base\Model
$highlight | array|null | A list of arrays with highlighted excerpts indexed by field names. This property is read-only. | yii\elasticsearch\ActiveRecord
$isNewRecord | boolean | Whether the record is new and should be inserted when calling save(). | yii\db\BaseActiveRecord
$iterator | ArrayIterator | An iterator for traversing the items in the list. This property is read-only. | yii\base\Model
$oldAttributes | array | The old attribute values (name-value pairs). Note that the type of this property differs in getter and setter. See getOldAttributes() and setOldAttributes() for details. | yii\db\BaseActiveRecord
$oldPrimaryKey | mixed | The old primary key value. An array (column name => column value) is returned if the primary key is composite. A string is returned otherwise (null will be returned if the key value is null). This property is read-only. | yii\db\BaseActiveRecord
$primaryKey | mixed | The primary key value. An array (column name => column value) is returned if the primary key is composite. A string is returned otherwise (null will be returned if the key value is null). This property is read-only. | yii\db\BaseActiveRecord
$relatedRecords | array | An array of related records indexed by relation names. This property is read-only. | yii\db\BaseActiveRecord
$scenario | string | The scenario that this model is in. Defaults to SCENARIO_DEFAULT. | yii\base\Model
$score | float | Returns the score of this record when it was retrieved via a find() query. This property is read-only. | yii\elasticsearch\ActiveRecord
$validators | ArrayObject|yii\validators\Validator[] | All the validators declared in the model. This property is read-only. | yii\base\Model

## 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() | PHP getter magic method. | yii\db\BaseActiveRecord
__isset() | Checks if a property value is null. | yii\db\BaseActiveRecord
__set() | PHP setter magic method. | yii\db\BaseActiveRecord
__unset() | Sets a component property to be null. | yii\db\BaseActiveRecord
activeAttributes() | Returns the attribute names that are subject to validation in the current scenario. | yii\base\Model
addError() | Adds a new error to the specified attribute. | yii\base\Model
addErrors() | Adds a list of errors. | yii\base\Model
afterDelete() | This method is invoked after deleting a record. | yii\db\BaseActiveRecord
afterFind() | This method is called when the AR object is created and populated with the query result. | yii\db\BaseActiveRecord
afterRefresh() | This method is called when the AR object is refreshed. | yii\db\BaseActiveRecord
afterSave() | This method is called at the end of inserting or updating a record. | yii\db\BaseActiveRecord
afterValidate() | This method is invoked after validation ends. | yii\base\Model
arrayAttributes() | A list of attributes that should be treated as array valued when retrieved through ActiveQuery::fields. | yii\elasticsearch\ActiveRecord
attachBehavior() | Attaches a behavior to this component. | yii\base\Component
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component
attributeHints() | Returns the attribute hints. | yii\base\Model
attributeLabels() | Returns the attribute labels. | yii\base\Model
attributes() | Returns the list of all attribute names of the model. | yii\elasticsearch\ActiveRecord
beforeDelete() | This method is invoked before deleting a record. | yii\db\BaseActiveRecord
beforeSave() | This method is called at the beginning of inserting or updating a record. | yii\db\BaseActiveRecord
beforeValidate() | This method is invoked before validation starts. | yii\base\Model
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\db\BaseActiveRecord
canSetProperty() | Returns a value indicating whether a property can be set. | yii\db\BaseActiveRecord
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
clearErrors() | Removes errors for all attributes or a single attribute. | yii\base\Model
createValidators() | Creates validator objects based on the validation rules specified in rules(). | yii\base\Model
delete() | Deletes the table row corresponding to this active record. | yii\elasticsearch\ActiveRecord
deleteAll() | Deletes rows in the table using the provided conditions. | yii\elasticsearch\ActiveRecord
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
equals() | Returns a value indicating whether the given active record is the same as the current one. | yii\db\BaseActiveRecord
extraFields() | Returns the list of fields that can be expanded further and returned by toArray(). | yii\base\ArrayableTrait
fields() | Returns the list of fields that should be returned by default by toArray() when no specific fields are specified. | yii\base\ArrayableTrait
find() | Creates an yii\db\ActiveQueryInterface instance for query purpose. | yii\elasticsearch\ActiveRecord
findAll() | Returns a list of active record models that match the specified primary key value(s) or a set of column values. | yii\elasticsearch\ActiveRecord
findOne() | Returns a single active record model instance by a primary key or an array of column values. | yii\elasticsearch\ActiveRecord
formName() | Returns the form name that this model class should use. | yii\base\Model
generateAttributeLabel() | Generates a user friendly attribute label based on the give attribute name. | yii\base\Model
get() | Gets a record by its primary key. | yii\elasticsearch\ActiveRecord
getActiveValidators() | Returns the validators applicable to the current $scenario. | yii\base\Model
getAttribute() | Returns the named attribute value. | yii\db\BaseActiveRecord
getAttributeHint() | Returns the text hint for the specified attribute. | yii\db\BaseActiveRecord
getAttributeLabel() | Returns the text label for the specified attribute. | yii\db\BaseActiveRecord
getAttributes() | Returns attribute values. | yii\base\Model
getBehavior() | Returns the named behavior object. | yii\base\Component
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component
getDb() | Returns the database connection used by this AR class. | yii\elasticsearch\ActiveRecord
getDirtyAttributes() | Returns the attribute values that have been modified since they are loaded or saved most recently. | yii\db\BaseActiveRecord
getErrorSummary() | Returns the errors for all attributes as a one-dimensional array. | yii\base\Model
getErrors() | Returns the errors for all attributes or a single attribute. | yii\base\Model
getExplanation() |  | yii\elasticsearch\ActiveRecord
getFirstError() | Returns the first error of the specified attribute. | yii\base\Model
getFirstErrors() | Returns the first error of every attribute in the model. | yii\base\Model
getHighlight() |  | yii\elasticsearch\ActiveRecord
getIsNewRecord() | Returns a value indicating whether the current record is new. | yii\db\BaseActiveRecord
getIterator() | Returns an iterator for traversing the attributes in the model. | yii\base\Model
getOldAttribute() | Returns the old value of the named attribute. | yii\db\BaseActiveRecord
getOldAttributes() | Returns the old attribute values. | yii\db\BaseActiveRecord
getOldPrimaryKey() | Returns the old primary key value(s). | yii\elasticsearch\ActiveRecord
getPrimaryKey() | Alias to get_id(). Returns the primary key value. | yii\elasticsearch\ActiveRecord
getRelatedRecords() | Returns all populated related records. | yii\db\BaseActiveRecord
getRelation() | Returns the relation object with the specified name. | yii\db\BaseActiveRecord
getScenario() | Returns the scenario that this model is used in. | yii\base\Model
getScore() |  | yii\elasticsearch\ActiveRecord
getValidators() | Returns all the validators declared in rules(). | yii\base\Model
get_id() | Returns the `_id` attribute that holds the primary key (for compatibility with relations) | yii\elasticsearch\ActiveRecord
hasAttribute() | Returns a value indicating whether the model has an attribute with the specified name. | yii\db\BaseActiveRecord
hasErrors() | Returns a value indicating whether there is any validation error. | yii\base\Model
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component
hasMany() | Declares a `has-many` relation. | yii\db\BaseActiveRecord
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component
hasOne() | Declares a `has-one` relation. | yii\db\BaseActiveRecord
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component
index() |  | yii\elasticsearch\ActiveRecord
init() | Initializes the object. | yii\db\BaseActiveRecord
insert() | Inserts a document into the associated index using the attribute values of this record. | yii\elasticsearch\ActiveRecord
instance() | Returns static class instance, which can be used to obtain meta information. | yii\base\StaticInstanceTrait
instantiate() | Creates an active record instance. | yii\elasticsearch\ActiveRecord
isAttributeActive() | Returns a value indicating whether the attribute is active in the current scenario. | yii\base\Model
isAttributeChanged() | Returns a value indicating whether the named attribute has been changed. | yii\db\BaseActiveRecord
isAttributeRequired() | Returns a value indicating whether the attribute is required. | yii\base\Model
isAttributeSafe() | Returns a value indicating whether the attribute is safe for massive assignments. | yii\base\Model
isPrimaryKey() | Returns a value indicating whether the given set of attributes represents the primary key for this model. | yii\db\BaseActiveRecord
isRelationPopulated() | Check whether the named relation has been populated with records. | yii\db\BaseActiveRecord
link() |  | yii\elasticsearch\ActiveRecord
load() | Populates the model with input data. | yii\base\Model
loadMultiple() | Populates a set of models with the data from end user. | yii\base\Model
markAttributeDirty() | Marks an attribute dirty. | yii\db\BaseActiveRecord
mget() | Gets a list of records by its primary keys. | yii\elasticsearch\ActiveRecord
off() | Detaches an existing event handler from this component. | yii\base\Component
offsetExists() | Returns whether there is an element at the specified offset. | yii\db\BaseActiveRecord
offsetGet() | Returns the element at the specified offset. | yii\base\Model
offsetSet() | Sets the element at the specified offset. | yii\base\Model
offsetUnset() | Sets the element value at the specified offset to null. | yii\db\BaseActiveRecord
on() | Attaches an event handler to an event. | yii\base\Component
onUnsafeAttribute() | This method is invoked when an unsafe attribute is being massively assigned. | yii\base\Model
optimisticLock() | This method has no effect in Elasticsearch ActiveRecord. | yii\elasticsearch\ActiveRecord
populateRecord() | Populates an active record object using a row of data from the database/storage. | yii\elasticsearch\ActiveRecord
populateRelation() | Populates the named relation with the related records. | yii\db\BaseActiveRecord
primaryKey() | This method defines the attribute that uniquely identifies a record. | yii\elasticsearch\ActiveRecord
refresh() | Repopulates this active record with the latest data. | yii\db\BaseActiveRecord
rules() | Returns the validation rules for attributes. | yii\base\Model
safeAttributes() | Returns the attribute names that are safe to be massively assigned in the current scenario. | yii\base\Model
save() | Saves the current record. | yii\db\BaseActiveRecord
scenarios() | Returns a list of scenarios and the corresponding active attributes. | yii\base\Model
setAttribute() | Sets the named attribute value. | yii\db\BaseActiveRecord
setAttributes() | Sets the attribute values in a massive way. | yii\base\Model
setIsNewRecord() | Sets the value indicating whether the record is new. | yii\db\BaseActiveRecord
setOldAttribute() | Sets the old value of the named attribute. | yii\db\BaseActiveRecord
setOldAttributes() | Sets the old attribute values. | yii\db\BaseActiveRecord
setPrimaryKey() | Alias to set_id(). Sets the primary key value. | yii\elasticsearch\ActiveRecord
setScenario() | Sets the scenario for the model. | yii\base\Model
set_id() | Sets the `_id` attribute that holds the primary key (for compatibility with relations) | yii\elasticsearch\ActiveRecord
toArray() | Converts the model into an array. | yii\base\ArrayableTrait
trigger() | Triggers an event. | yii\base\Component
type() | Returns the name of the type of this record. | yii\elasticsearch\ActiveRecord
unlink() | Destroys the relationship between two models. | yii\db\BaseActiveRecord
unlinkAll() | Destroys the relationship in current model. | yii\elasticsearch\ActiveRecord
update() | Saves the changes to this active record into the associated database table. | yii\elasticsearch\ActiveRecord
updateAll() | Updates all records that match a certain condition. | yii\elasticsearch\ActiveRecord
updateAllCounters() | Updates all matching records using the provided counter changes and conditions. | yii\elasticsearch\ActiveRecord
updateAttributes() | Updates the specified attributes. | yii\db\BaseActiveRecord
updateCounters() | Updates one or several counter columns for the current AR object. | yii\db\BaseActiveRecord
validate() | Performs the data validation. | yii\base\Model
validateMultiple() | Validates multiple models. | yii\base\Model

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
createRelationQuery() | Creates a query instance for `has-one` or `has-many` relation. | yii\db\BaseActiveRecord
extractFieldsFor() | Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id". | yii\base\ArrayableTrait
extractRootFields() | Extracts the root field names from nested fields. | yii\base\ArrayableTrait
findByCondition() | Finds ActiveRecord instance(s) by the given condition. | yii\db\BaseActiveRecord
primaryKeysByCondition() | Performs a quick and highly efficient scroll/scan query to get the list of primary keys that satisfy the given condition. If condition is a list of primary keys (e.g.: `['_id' => ['1', '2', '3']]`), the query is not performed for performance considerations. | yii\elasticsearch\ActiveRecord
refreshInternal() | Repopulates this active record with the latest data from a newly fetched instance. | yii\db\BaseActiveRecord
resolveFields() | Determines which fields can be returned by toArray(). | yii\base\ArrayableTrait
updateInternal() |  | yii\elasticsearch\ActiveRecord
validateViaRelationLink() | Validates model so that it does not contain array as its keys while linking. | yii\elasticsearch\ActiveRecord

## Events

Hide inherited events

Event | Type | Description | Defined By
--- | --- | --- | ---
EVENT_AFTER_DELETE | \yii\db\Event | An event that is triggered after a record is deleted. | yii\db\BaseActiveRecord
EVENT_AFTER_FIND | \yii\db\Event | An event that is triggered after the record is created and populated with query result. | yii\db\BaseActiveRecord
EVENT_AFTER_INSERT | yii\db\AfterSaveEvent | An event that is triggered after a record is inserted. | yii\db\BaseActiveRecord
EVENT_AFTER_REFRESH | \yii\db\Event | An event that is triggered after a record is refreshed. (available since version 2.0.8) | yii\db\BaseActiveRecord
EVENT_AFTER_UPDATE | yii\db\AfterSaveEvent | An event that is triggered after a record is updated. | yii\db\BaseActiveRecord
EVENT_AFTER_VALIDATE | yii\base\Event | An event raised at the end of validate() | yii\base\Model
EVENT_BEFORE_DELETE | yii\base\ModelEvent | An event that is triggered before deleting a record. | yii\db\BaseActiveRecord
EVENT_BEFORE_INSERT | yii\base\ModelEvent | An event that is triggered before inserting a record. | yii\db\BaseActiveRecord
EVENT_BEFORE_UPDATE | yii\base\ModelEvent | An event that is triggered before updating a record. | yii\db\BaseActiveRecord
EVENT_BEFORE_VALIDATE | yii\base\ModelEvent | An event raised at the beginning of validate(). | yii\base\Model
EVENT_INIT | \yii\db\Event | An event that is triggered when the record is initialized via init(). | yii\db\BaseActiveRecord

## Constants

Hide inherited constants

Constant | Value | Description | Defined By
--- | --- | --- | ---
SCENARIO_DEFAULT | 'default' | The name of the default scenario. | yii\base\Model

## Property Details

$_id public property

The primary key of the record. Can only be written to for new records, otherwise read-only.

public mixed $_id = null
$explanation public property

An explanation for each hit on how its score was computed. This property is read-only.

public array|null $explanation = null
$highlight public property

A list of arrays with highlighted excerpts indexed by field names. This property is read-only.

public array|null $highlight = null
$score public property

Returns the score of this record when it was retrieved via a find() query. This property is read-only.

public float $score = null

## Method Details

arrayAttributes() public method

A list of attributes that should be treated as array valued when retrieved through ActiveQuery::fields.

If not listed by this method, attributes retrieved through ActiveQuery::fields will converted to a scalar value when the result array contains only one value.

public string[] arrayAttributes ( )
return | string[] | List of attribute names. Must be a subset of attributes().

attributes() public method

Returns the list of all attribute names of the model.

This method must be overridden by child classes to define available attributes. IMPORTANT: The primary key (the `_id` attribute) MUST NOT be included in attributes().

Attributes are names of fields of the corresponding Elasticsearch document.

public string[] attributes ( )
return | string[] | List of attribute names.
throws | yii\base\InvalidConfigException | if not overridden in a child class.

delete() public method

Deletes the table row corresponding to this active record.

This method performs the following steps in order:

1. call beforeDelete(). If the method returns `false`, it will skip the rest of the steps;
2. delete the record from the database;
3. call afterDelete().

In the above step 1 and 3, events named EVENT_BEFORE_DELETE and EVENT_AFTER_DELETE will be raised by the corresponding methods.

public integer|boolean delete ( $options = [] )

$options

array

Options given in this parameter are passed to Elasticsearch as request URI parameters. These are among others:

- `routing` define shard placement of this record.
- `parent` by giving the primaryKey of another record this defines a parent-child relation
- `timeout` timeout waiting for a shard to become available.
- `replication` the replication type for the delete/index operation (sync or async).
- `consistency` the write consistency of the index/delete operation.
- `refresh` refresh the relevant primary and replica shards (not the whole index) immediately after the operation occurs, so that the updated document appears in search results immediately.

Please refer to the Elasticsearch documentation for more details on these options.

The following parameters are Yii specific:

- `optimistic_locking` set this to `true` to enable optimistic locking, avoid updating when the record has changed since it has been loaded from the database. Yii will set the `version` parameter to the value stored in version. See the Elasticsearch documentation for details.

  Make sure the record has been fetched with a version before. This is only the case for records fetched via get() and mget() by default. For normal queries, the `_version` field has to be fetched explicitly.

return | integer|boolean | The number of rows deleted, or false if the deletion is unsuccessful for some reason. Note that it is possible the number of rows deleted is 0, even though the deletion execution is successful.
throws | yii\db\StaleObjectException | if optimistic locking is enabled and the data being deleted is outdated.
throws | yii\elasticsearch\Exception | in case delete failed.

deleteAll() public static method

Deletes rows in the table using the provided conditions.

WARNING: If you do not specify any condition, this method will delete ALL rows in the table.

For example, to delete all customers whose status is 3:

    Customer::deleteAll(['status' => 3]);

See also [[yii\elasticsearch\ActiveRecord::primaryKeysByCondition()]].

public static integer deleteAll ( $condition = [] )
$condition | array | The conditions that will be passed to the `where()` method when building the query. Please refer to yii\elasticsearch\ActiveQuery::where() on how to specify this parameter.
return | integer | The number of rows deleted
throws | yii\elasticsearch\Exception | on error.

find() public static method

Creates an yii\db\ActiveQueryInterface instance for query purpose.

The returned yii\db\ActiveQueryInterface instance can be further customized by calling methods defined in yii\db\ActiveQueryInterface before `one()` or `all()` is called to return populated ActiveRecord instances. For example,

    // find the customer whose ID is 1
    $customer = Customer::find()->where(['id' => 1])->one();

    // find all active customers and order them by their age:
    $customers = Customer::find()
        ->where(['status' => 1])
        ->orderBy('age')
        ->all();

This method is also called by yii\db\BaseActiveRecord::hasOne() and yii\db\BaseActiveRecord::hasMany() to create a relational query.

You may override this method to return a customized query. For example,

    class Customer extends ActiveRecord
    {
        public static function find()
        {
            // use CustomerQuery instead of the default ActiveQuery
            return new CustomerQuery(get_called_class());
        }
    }

The following code shows how to apply a default condition for all queries:

    class Customer extends ActiveRecord
    {
        public static function find()
        {
            return parent::find()->where(['deleted' => false]);
        }
    }

    // Use andWhere()/orWhere() to apply the default condition
    // SELECT FROM customer WHERE `deleted`=:deleted AND age>30
    $customers = Customer::find()->andWhere('age>30')->all();

    // Use where() to ignore the default condition
    // SELECT FROM customer WHERE age>30
    $customers = Customer::find()->where('age>30')->all();

public static yii\elasticsearch\ActiveQuery find ( )
return | yii\elasticsearch\ActiveQuery | The newly created yii\elasticsearch\ActiveQuery instance.

findAll() public static method

Returns a list of active record models that match the specified primary key value(s) or a set of column values.

The method accepts:

- a scalar value (integer or string): query by a single primary key value and return an array containing the corresponding record (or an empty array if not found).
- a non-associative array: query by a list of primary key values and return the corresponding records (or an empty array if none was found). Note that an empty condition will result in an empty result as it will be interpreted as a search for primary keys and not an empty `WHERE` condition.
- an associative array of name-value pairs: query by a set of attribute values and return an array of records matching all of them (or an empty array if none was found). Note that `['id' => 1, 2]` is treated as a non-associative array. Column names are limited to current records table columns for SQL DBMS, or filtered otherwise to be limted to simple filter conditions.
- a yii\db\Expression: The expression will be used directly. (@since 2.0.37)

This method will automatically call the `all()` method and return an array of ActiveRecord instances.

> Note: As this is a short-hand method only, using more complex conditions, like ['!=', 'id', 1] will not work. If you need to specify more complex conditions, use find() in combination with where() instead.

See the following code for usage examples:

    // find the customers whose primary key value is 10
    $customers = Customer::findAll(10);

    // the above code is equivalent to:
    $customers = Customer::find()->where(['id' => 10])->all();

    // find the customers whose primary key value is 10, 11 or 12.
    $customers = Customer::findAll([10, 11, 12]);

    // the above code is equivalent to:
    $customers = Customer::find()->where(['id' => [10, 11, 12]])->all();

    // find customers whose age is 30 and whose status is 1
    $customers = Customer::findAll(['age' => 30, 'status' => 1]);

    // the above code is equivalent to:
    $customers = Customer::find()->where(['age' => 30, 'status' => 1])->all();

If you need to pass user input to this method, make sure the input value is scalar or in case of array condition, make sure the array structure can not be changed from the outside:

    // yii\web\Controller ensures that $id is scalar
    public function actionView($id)
    {
        $model = Post::findOne($id);
        // ...
    }

    // explicitly specifying the colum to search, passing a scalar or array here will always result in finding a single record
    $model = Post::findOne(['id' => Yii::$app->request->get('id')]);

    // do NOT use the following code! it is possible to inject an array condition to filter by arbitrary column values!
    $model = Post::findOne(Yii::$app->request->get('id'));

public static static[] findAll ( $condition )
$condition | mixed | Primary key value or a set of column values
return | static[] | An array of ActiveRecord instances, or an empty array if nothing matches.

findOne() public static method

Returns a single active record model instance by a primary key or an array of column values.

The method accepts:

- a scalar value (integer or string): query by a single primary key value and return the corresponding record (or `null` if not found).
- a non-associative array: query by a list of primary key values and return the first record (or `null` if not found).
- an associative array of name-value pairs: query by a set of attribute values and return a single record matching all of them (or `null` if not found). Note that `['id' => 1, 2]` is treated as a non-associative array. Column names are limited to current records table columns for SQL DBMS, or filtered otherwise to be limited to simple filter conditions.
- a yii\db\Expression: The expression will be used directly. (@since 2.0.37)

That this method will automatically call the `one()` method and return an ActiveRecord instance.

> Note: As this is a short-hand method only, using more complex conditions, like ['!=', 'id', 1] will not work. If you need to specify more complex conditions, use find() in combination with where() instead.

See the following code for usage examples:

    // find a single customer whose primary key value is 10
    $customer = Customer::findOne(10);

    // the above code is equivalent to:
    $customer = Customer::find()->where(['id' => 10])->one();

    // find the customers whose primary key value is 10, 11 or 12.
    $customers = Customer::findOne([10, 11, 12]);

    // the above code is equivalent to:
    $customers = Customer::find()->where(['id' => [10, 11, 12]])->one();

    // find the first customer whose age is 30 and whose status is 1
    $customer = Customer::findOne(['age' => 30, 'status' => 1]);

    // the above code is equivalent to:
    $customer = Customer::find()->where(['age' => 30, 'status' => 1])->one();

If you need to pass user input to this method, make sure the input value is scalar or in case of array condition, make sure the array structure can not be changed from the outside:

    // yii\web\Controller ensures that $id is scalar
    public function actionView($id)
    {
        $model = Post::findOne($id);
        // ...
    }

    // explicitly specifying the colum to search, passing a scalar or array here will always result in finding a single record
    $model = Post::findOne(['id' => Yii::$app->request->get('id')]);

    // do NOT use the following code! it is possible to inject an array condition to filter by arbitrary column values!
    $model = Post::findOne(Yii::$app->request->get('id'));

public static static|null findOne ( $condition )
$condition | mixed | Primary key value or a set of column values
return | static|null | ActiveRecord instance matching the condition, or `null` if nothing matches.

get() public static method

Gets a record by its primary key.

public static static|null get ( $primaryKey, $options = [] )
$primaryKey | mixed | The primaryKey value
$options | array | Options given in this parameter are passed to Elasticsearch as request URI parameters. Please refer to the Elasticsearch documentation for more details on these options.
return | static|null | The record instance or null if it was not found.

getDb() public static method

Returns the database connection used by this AR class.

By default, the "elasticsearch" application component is used as the database connection. You may override this method if you want to use a different database connection.

public static yii\elasticsearch\Connection getDb ( )
return | yii\elasticsearch\Connection | The database connection used by this AR class.

getExplanation() public method (available since version 2.0.5)

public array|null getExplanation ( )
return | array|null | An explanation for each hit on how its score was computed.

getHighlight() public method

public array|null getHighlight ( )
return | array|null | A list of arrays with highlighted excerpts indexed by field names.

getOldPrimaryKey() public method

Returns the old primary key value(s).

This refers to the primary key value that is populated into the record after executing a find method (e.g. find(), findOne()). The value remains unchanged even if the primary key attribute is manually assigned with a different value.

public mixed getOldPrimaryKey ( $asArray = false )
$asArray | boolean | Whether to return the primary key value as an array. If `true`, the return value will be an array with column name as key and column value as value. If this is `false` (default), a scalar value will be returned for non-composite primary key.
return | mixed | The old primary key value. An array (column name => column value) is returned if the primary key is composite or `$asArray` is `true`. A string is returned otherwise (null will be returned if the key value is null).
throws | yii\db\Exception | if the AR model does not have a primary key

getPrimaryKey() public method
Deprecated since 2.1.0

Alias to get_id(). Returns the primary key value.

public mixed getPrimaryKey ( $asArray = false )
$asArray | boolean |

getScore() public method

public float getScore ( )
return | float | Returns the score of this record when it was retrieved via a find() query.

get_id() public method

Returns the `_id` attribute that holds the primary key (for compatibility with relations)

public mixed get_id ( )

index() public static method

public static string index ( )
return | string | The name of the index this record is stored in.

insert() public method

Inserts a document into the associated index using the attribute values of this record.

This method performs the following steps in order:

1. call beforeValidate() when `$runValidation` is true. If validation fails, it will skip the rest of the steps;
2. call afterValidate() when `$runValidation` is true.
3. call beforeSave(). If the method returns false, it will skip the rest of the steps;
4. insert the record into database. If this fails, it will skip the rest of the steps;
5. call afterSave();

In the above step 1, 2, 3 and 5, events EVENT_BEFORE_VALIDATE, EVENT_BEFORE_INSERT, EVENT_AFTER_INSERT and EVENT_AFTER_VALIDATE will be raised by the corresponding methods.

Only the changed attribute values will be inserted into database.

If the primary key is not set (null) during insertion, it will be populated with a randomly generated value after insertion.

For example, to insert a customer record:

    $customer = new Customer;
    $customer->name = $name;
    $customer->email = $email;
    $customer->insert();

public boolean insert ( $runValidation = true, $attributes = null, $options = [] )
$runValidation | boolean | Whether to perform validation before saving the record. If the validation fails, the record will not be inserted into the database.
$attributes | array | List of attributes that need to be saved. Defaults to null, meaning all attributes will be saved.

$options

array

Options given in this parameter are passed to Elasticsearch as request URI parameters. These are among others:

- `routing` define shard placement of this record.
- `parent` by giving the primaryKey of another record this defines a parent-child relation

Please refer to the Elasticsearch documentation for more details on these options.

By default the `op_type` is set to `create` if model primary key is present.

return | boolean | Whether the attributes are valid and the record is inserted successfully.

instantiate() public static method

Creates an active record instance.

This method is called together with populateRecord() by yii\elasticsearch\ActiveQuery. It is not meant to be used for creating new records directly.

You may override this method if the instance being created depends on the row data to be populated into the record. For example, by creating a record based on the value of a column, you may implement the so-called single-table inheritance mapping.

public static static instantiate ( $row )

$row

array

Row data to be populated into the record. This array consists of the following keys:

- `_source`: refers to the attributes of the record.
- `_type`: the type this record is stored in.
- `_index`: the index this record is stored in.

return | static | The newly created active record

link() public method

public void link ( $name, $model, $extraColumns = [] )
$name |  |
$model |  |
$extraColumns |  |

mget() public static method

Gets a list of records by its primary keys.

public static array mget ( array $primaryKeys, $options = [] )
$primaryKeys | array | An array of primaryKey values
$options | array | Options given in this parameter are passed to Elasticsearch as request URI parameters. Please refer to the Elasticsearch documentation for more details on these options.
return | array | The record instances, or empty array if nothing was found

optimisticLock() public method

This method has no effect in Elasticsearch ActiveRecord.

Elasticsearch ActiveRecord uses native Optimistic locking. See update() for more details.

public void optimisticLock ( )

populateRecord() public static method

Populates an active record object using a row of data from the database/storage.

This is an internal method meant to be called to create active record objects after fetching data from the database. It is mainly used by yii\elasticsearch\ActiveQuery to populate the query results into active records.

When calling this method manually you should call afterFind() on the created record to trigger the afterFind Event.

public static void populateRecord ( $record, $row )
$record | yii\elasticsearch\ActiveRecord | The record to be populated. In most cases this will be an instance created by instantiate() beforehand.
$row | array | Attribute values (name => value)

primaryKey() public static method

This method defines the attribute that uniquely identifies a record.

The name of the primary key attribute is `_id`, and can not be changed.

Elasticsearch does not support composite primary keys in the traditional sense. However to match the signature of the ActiveRecordInterface this methods returns an array instead of a single string.

public static string[] primaryKey ( )
return | string[] | Array of primary key attributes. Only the first element of the array will be used.

primaryKeysByCondition() protected static method (available since version 2.0.4)

Performs a quick and highly efficient scroll/scan query to get the list of primary keys that satisfy the given condition. If condition is a list of primary keys (e.g.: `['_id' => ['1', '2', '3']]`), the query is not performed for performance considerations.

See also:

- updateAll()
- updateAllCounters()
- deleteAll()

protected static array primaryKeysByCondition ( $condition )
$condition | array | Please refer to yii\elasticsearch\ActiveQuery::where() on how to specify this parameter
return | array | Primary keys that correspond to given conditions

setPrimaryKey() public method
Deprecated since 2.1.0

Alias to set_id(). Sets the primary key value.

public void setPrimaryKey ( $value )
$value | mixed |
throws | yii\base\InvalidCallException | when record is not new

set_id() public method

Sets the `_id` attribute that holds the primary key (for compatibility with relations)

public void set_id ( $value )
$value | mixed |
throws | yii\base\InvalidCallException | when record is not new

type() public static method

Returns the name of the type of this record.

IMPORTANT: For Elasticsearch 7 and later, type() is ignored.

public static string type ( )
return | string | The name of the type of this record.

unlinkAll() public method

Destroys the relationship in current model.

This method is not supported by Elasticsearch.

public void unlinkAll ( $name, $delete = false )
$name |  |
$delete |  |

update() public method

Saves the changes to this active record into the associated database table.

This method performs the following steps in order:

1. call beforeValidate() when `$runValidation` is `true`. If beforeValidate() returns `false`, the rest of the steps will be skipped;
2. call afterValidate() when `$runValidation` is `true`. If validation failed, the rest of the steps will be skipped;
3. call beforeSave(). If beforeSave() returns `false`, the rest of the steps will be skipped;
4. save the record into database. If this fails, it will skip the rest of the steps;
5. call afterSave();

In the above step 1, 2, 3 and 5, events EVENT_BEFORE_VALIDATE, EVENT_AFTER_VALIDATE, EVENT_BEFORE_UPDATE, and EVENT_AFTER_UPDATE will be raised by the corresponding methods.

Only the changed attribute values will be saved into database.

For example, to update a customer record:

    $customer = Customer::findOne($id);
    $customer->name = $name;
    $customer->email = $email;
    $customer->update();

Note that it is possible the update does not affect any row in the table. In this case, this method will return 0. For this reason, you should use the following code to check if update() is successful or not:

    if ($customer->update() !== false) {
        // update successful
    } else {
        // update failed
    }

public integer|boolean update ( $runValidation = true, $attributeNames = null, $options = [] )
$runValidation | boolean | Whether to perform validation before saving the record. If the validation fails, the record will not be inserted into the database.
$attributeNames | array | List of attribute names that need to be saved. Defaults to null, meaning all attributes that are loaded from DB will be saved.

$options

array

Options given in this parameter are passed to Elasticsearch as request URI parameters. These are among others:

- `routing` define shard placement of this record.
- `parent` by giving the primaryKey of another record this defines a parent-child relation
- `timeout` timeout waiting for a shard to become available.
- `replication` the replication type for the delete/index operation (sync or async).
- `consistency` the write consistency of the index/delete operation.
- `refresh` refresh the relevant primary and replica shards (not the whole index) immediately after the operation occurs, so that the updated document appears in search results immediately.
- `detect_noop` this parameter will become part of the request body and will prevent the index from getting updated when nothing has changed.

Please refer to the Elasticsearch documentation for more details on these options.

The following parameters are Yii specific:

- `optimistic_locking` set this to `true` to enable optimistic locking, avoid updating when the record has changed since it has been loaded from the database. Yii will set the `version` parameter to the value stored in version. See the Elasticsearch documentation for details.

  Make sure the record has been fetched with a version before. This is only the case for records fetched via get() and mget() by default. For normal queries, the `_version` field has to be fetched explicitly.

return | integer|boolean | The number of rows affected, or false if validation fails or beforeSave() stops the updating process.
throws | yii\db\StaleObjectException | if optimistic locking is enabled and the data being updated is outdated.
throws | \yii\elasticsearch\InvalidParamException | if no version is available and optimistic locking is enabled.
throws | yii\elasticsearch\Exception | in case update failed.

updateAll() public static method

Updates all records that match a certain condition.

For example, to change the status to be 1 for all customers whose status is 2:

    Customer::updateAll(['status' => 1], ['status' => 2]);

See also [[yii\elasticsearch\ActiveRecord::primaryKeysByCondition()]].

public static integer updateAll ( $attributes, $condition = [] )
$attributes | array | Attribute values (name-value pairs) to be saved into the table
$condition | array | The conditions that will be passed to the `where()` method when building the query. Please refer to yii\elasticsearch\ActiveQuery::where() on how to specify this parameter.
return | integer | The number of rows updated
throws | yii\elasticsearch\Exception | on error.

updateAllCounters() public static method

Updates all matching records using the provided counter changes and conditions.

For example, to add 1 to age of all customers whose status is 2,

    Customer::updateAllCounters(['age' => 1], ['status' => 2]);

See also [[yii\elasticsearch\ActiveRecord::primaryKeysByCondition()]].

public static integer updateAllCounters ( $counters, $condition = [] )
$counters | array | The counters to be updated (attribute name => increment value). Use negative values if you want to decrement the counters.
$condition | array | The conditions that will be passed to the `where()` method when building the query. Please refer to yii\elasticsearch\ActiveQuery::where() on how to specify this parameter.
return | integer | The number of rows updated
throws | yii\elasticsearch\Exception | on error.

updateInternal() protected method

See also update().

protected integer|false updateInternal ( $attributes = null, $options = [] )
$attributes | array | Attributes to update
$options | array | Options given in this parameter are passed to Elasticsearch as request URI parameters. See update() for details.
return | integer|false | The number of rows affected, or false if beforeSave() stops the updating process.
throws | yii\db\StaleObjectException | if optimistic locking is enabled and the data being updated is outdated.
throws | \yii\elasticsearch\InvalidParamException | if no version is available and optimistic locking is enabled.
throws | yii\elasticsearch\Exception | in case update failed.

validateViaRelationLink() protected method

Validates model so that it does not contain array as its keys while linking.

protected void validateViaRelationLink ( $model, $relation )
$model | yii\db\ActiveRecordInterface | The model to be linked with the current one.
$relation |  |