ActiveRecord.php 16.5 KB
Newer Older
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
4
 * @copyright Copyright (c) 2008 Yii Software LLC
5 6 7 8 9 10 11
 * @license http://www.yiiframework.com/license/
 */

namespace yii\elasticsearch;

use yii\base\InvalidCallException;
use yii\base\InvalidConfigException;
12
use yii\db\BaseActiveRecord;
13 14
use yii\helpers\Inflector;
use yii\helpers\Json;
15
use yii\helpers\StringHelper;
16 17 18 19

/**
 * ActiveRecord is the base class for classes representing relational data in terms of objects.
 *
Carsten Brandt committed
20 21 22 23 24 25
 * This class implements the ActiveRecord pattern for the fulltext search and data storage
 * [elasticsearch](http://www.elasticsearch.org/).
 *
 * For defining a record a subclass should at least implement the [[attributes()]] method to define
 * attributes.
 * The primary key (the `_id` field in elasticsearch terms) is represented by `getId()` and `setId()`.
26
 * The primary key is not part of the attributes.
Carsten Brandt committed
27 28 29 30 31 32 33 34 35 36 37 38
 *
 * The following is an example model called `Customer`:
 *
 * ```php
 * class Customer extends \yii\elasticsearch\ActiveRecord
 * {
 *     public function attributes()
 *     {
 *         return ['id', 'name', 'address', 'registration_date'];
 *     }
 * }
 * ```
39
 *
Carsten Brandt committed
40
 * You may override [[index()]] and [[type()]] to define the index and type this record represents.
41 42 43 44
 *
 * @author Carsten Brandt <mail@cebe.cc>
 * @since 2.0
 */
45
class ActiveRecord extends BaseActiveRecord
46
{
47
	private $_id;
48
	private $_score;
49 50
	private $_version;

51 52 53 54 55 56 57 58
	/**
	 * 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.
	 * @return Connection the database connection used by this AR class.
	 */
	public static function getDb()
	{
59
		return \Yii::$app->getComponent('elasticsearch');
60 61 62
	}

	/**
Qiang Xue committed
63
	 * @inheritdoc
64 65 66 67 68
	 */
	public static function find($q = null)
	{
		$query = static::createQuery();
		if (is_array($q)) {
69
			return $query->andWhere($q)->one();
70 71 72 73 74 75
		} elseif ($q !== null) {
			return static::get($q);
		}
		return $query;
	}

76 77 78 79 80 81 82 83 84 85
	/**
	 * Gets a record by its primary key.
	 *
	 * @param mixed $primaryKey the primaryKey value
	 * @param array $options options given in this parameter are passed to elasticsearch
	 * as request URI parameters.
	 * Please refer to the [elasticsearch documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html)
	 * for more details on these options.
	 * @return static|null The record instance or null if it was not found.
	 */
86 87
	public static function get($primaryKey, $options = [])
	{
88 89 90
		if ($primaryKey === null) {
			return null;
		}
91 92 93 94 95 96 97 98
		$command = static::getDb()->createCommand();
		$result = $command->get(static::index(), static::type(), $primaryKey, $options);
		if ($result['exists']) {
			return static::create($result);
		}
		return null;
	}

99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
	/**
	 * Gets a list of records by its primary keys.
	 *
	 * @param array $primaryKeys an array of primaryKey values
	 * @param array $options options given in this parameter are passed to elasticsearch
	 * as request URI parameters.
	 *
	 * Please refer to the [elasticsearch documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html)
	 * for more details on these options.
	 * @return static|null The record instance or null if it was not found.
	 */

	public static function mget($primaryKeys, $options = [])
	{
		if (empty($primaryKeys)) {
			return [];
		}
		$command = static::getDb()->createCommand();
		$result = $command->mget(static::index(), static::type(), $primaryKeys, $options);
		$models = [];
		foreach($result['docs'] as $doc) {
			if ($doc['exists']) {
				$models[] = static::create($doc);
			}
		}
		return $models;
	}

127 128 129 130
	// TODO add more like this feature http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-more-like-this.html

	// TODO add percolate functionality http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html

131
	/**
Qiang Xue committed
132
	 * @inheritdoc
133
	 */
134
	public static function createQuery()
135
	{
136
		return new ActiveQuery(['modelClass' => get_called_class()]);
137 138
	}

139
	/**
Qiang Xue committed
140
	 * @inheritdoc
141 142 143 144 145 146 147
	 */
	public static function createActiveRelation($config = [])
	{
		return new ActiveRelation($config);
	}

	// TODO implement copy and move as pk change is not possible
148

149 150 151 152
	/**
	 * @return float returns the score of this record when it was retrieved via a [[find()]] query.
	 */
	public function getScore()
153
	{
154
		return $this->_score;
155 156
	}

157
	/**
158 159 160 161
	 * Sets the primary key
	 * @param mixed $value
	 * @throws \yii\base\InvalidCallException when record is not new
	 */
162
	public function setPrimaryKey($value)
163
	{
164
		$pk = static::primaryKey()[0];
165 166
		if ($this->getIsNewRecord() || $pk != '_id') {
			$this->$pk = $value;
167 168 169 170 171 172
		} else {
			throw new InvalidCallException('Changing the primaryKey of an already saved record is not allowed.');
		}
	}

	/**
Qiang Xue committed
173
	 * @inheritdoc
174 175 176
	 */
	public function getPrimaryKey($asArray = false)
	{
177
		$pk = static::primaryKey()[0];
178
		if ($asArray) {
179
			return [$pk => $this->$pk];
180
		} else {
181
			return $this->$pk;
182 183 184 185
		}
	}

	/**
Qiang Xue committed
186
	 * @inheritdoc
187 188 189
	 */
	public function getOldPrimaryKey($asArray = false)
	{
190
		$pk = static::primaryKey()[0];
191 192 193 194 195 196 197
		if ($this->getIsNewRecord()) {
			$id = null;
		} elseif ($pk == '_id') {
			$id = $this->_id;
		} else {
			$id = $this->getOldAttribute($pk);
		}
198
		if ($asArray) {
199
			return [$pk => $id];
200
		} else {
201
			return $id;
202
		}
203 204 205
	}

	/**
206
	 * This method defines the attribute that uniquely identifies a record.
207
	 *
208 209
	 * The primaryKey for elasticsearch documents is the `_id` field by default. This field is not part of the
	 * ActiveRecord attributes so you should never add `_id` to the list of [[attributes()|attributes]].
210
	 *
211 212 213 214 215 216 217 218 219
	 * You may overide this method to define the primary key name when you have defined
	 * [path mapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping-id-field.html)
	 * for the `_id` field so that it is part of the `_source` and thus part of the [[attributes()|attributes]].
	 *
	 * Note that elasticsearch only supports _one_ attribute to be the primary key. However to match the signature
	 * of the [[\yii\db\ActiveRecordInterface|ActiveRecordInterface]] this methods returns an array instead of a
	 * single string.
	 *
	 * @return string[] array of primary key attributes. Only the first element of the array will be used.
220 221 222
	 */
	public static function primaryKey()
	{
223
		return ['_id'];
224 225 226 227
	}

	/**
	 * Returns the list of all attribute names of the model.
228
	 *
229
	 * This method must be overridden by child classes to define available attributes.
230 231 232 233 234 235 236
	 *
	 * Attributes are names of fields of the corresponding elasticsearch document.
	 * The primaryKey for elasticsearch documents is the `_id` field by default which is not part of the attributes.
	 * You may define [path mapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping-id-field.html)
	 * for the `_id` field so that it is part of the `_source` fields and thus becomes part of the attributes.
	 *
	 * @return string[] list of attribute names.
237
	 */
238
	public function attributes()
239 240 241 242
	{
		throw new InvalidConfigException('The attributes() method of elasticsearch ActiveRecord has to be implemented by child classes.');
	}

243 244 245
	/**
	 * @return string the name of the index this record is stored in.
	 */
246 247
	public static function index()
	{
248
		return Inflector::pluralize(Inflector::camel2id(StringHelper::basename(get_called_class()), '-'));
249 250
	}

251 252 253
	/**
	 * @return string the name of the type of this record.
	 */
254 255
	public static function type()
	{
256
		return Inflector::camel2id(StringHelper::basename(get_called_class()), '-');
257 258 259 260 261 262 263 264 265 266 267 268
	}

	/**
	 * Creates an active record object using a row of data.
	 * This method is called by [[ActiveQuery]] to populate the query results
	 * into Active Records. It is not meant to be used to create new records.
	 * @param array $row attribute values (name => value)
	 * @return ActiveRecord the newly created active record.
	 */
	public static function create($row)
	{
		$record = parent::create($row['_source']);
269
		$pk = static::primaryKey()[0];
270 271 272
		$record->$pk = $row['_id'];
		$record->_score = isset($row['_score']) ? $row['_score'] : null;
		$record->_version = isset($row['_version']) ? $row['_version'] : null; // TODO version should always be available...
273 274 275 276
		return $record;
	}

	/**
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
	 * 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 [[dirtyAttributes|changed attribute values]] will be inserted into database.
	 *
	 * If the [[primaryKey|primary key]] is not set (null) during insertion,
	 * it will be populated with a
	 * [randomly generated value](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-index_.html#_automatic_id_generation)
	 * after insertion.
	 *
	 * For example, to insert a customer record:
	 *
	 * ~~~
	 * $customer = new Customer;
	 * $customer->name = $name;
	 * $customer->email = $email;
	 * $customer->insert();
	 * ~~~
	 *
	 * @param boolean $runValidation whether to perform validation before saving the record.
	 * If the validation fails, the record will not be inserted into the database.
	 * @param array $attributes list of attributes that need to be saved. Defaults to null,
	 * meaning all attributes will be saved.
	 * @param array $options 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
	 * - `timestamp` specifies the timestamp to store along with the document. Default is indexing time.
	 *
	 * Please refer to the [elasticsearch documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-index_.html)
	 * for more details on these options.
	 *
	 * By default the `op_type` is set to `create`.
	 * @return boolean whether the attributes are valid and the record is inserted successfully.
325
	 */
326
	public function insert($runValidation = true, $attributes = null, $options = ['op_type' => 'create'])
327 328 329 330 331 332 333 334 335 336 337
	{
		if ($runValidation && !$this->validate($attributes)) {
			return false;
		}
		if ($this->beforeSave(true)) {
			$values = $this->getDirtyAttributes($attributes);

			$response = static::getDb()->createCommand()->insert(
				static::index(),
				static::type(),
				$values,
338 339
				$this->getPrimaryKey(),
				$options
340 341
			);

342
			if (!isset($response['ok'])) {
343 344
				return false;
			}
345 346 347 348 349
			$pk = static::primaryKey()[0];
			$this->$pk = $response['_id'];
			if ($pk != '_id') {
				$values[$pk] = $response['_id'];
			}
350
			$this->_version = $response['_version'];
351
			$this->_score = null;
352 353 354 355 356 357 358 359 360
			$this->setOldAttributes($values);
			$this->afterSave(true);
			return true;
		}
		return false;
	}

	/**
	 * Updates all records whos primary keys are given.
361 362 363
	 * For example, to change the status to be 1 for all customers whose status is 2:
	 *
	 * ~~~
364
	 * Customer::updateAll(array('status' => 1), array(2, 3, 4));
365 366 367 368 369 370 371
	 * ~~~
	 *
	 * @param array $attributes attribute values (name-value pairs) to be saved into the table
	 * @param array $condition the conditions that will be put in the WHERE part of the UPDATE SQL.
	 * Please refer to [[ActiveQuery::where()]] on how to specify this parameter.
	 * @return integer the number of rows updated
	 */
372
	public static function updateAll($attributes, $condition = [])
373
	{
374
		$pkName = static::primaryKey()[0];
375
		if (count($condition) == 1 && isset($condition[$pkName])) {
376
			$primaryKeys = is_array($condition[$pkName]) ? $condition[$pkName] : [$condition[$pkName]];
377
		} else {
378
			$primaryKeys = static::find()->where($condition)->column($pkName); // TODO check whether this works with default pk _id
379 380
		}
		if (empty($primaryKeys)) {
381 382
			return 0;
		}
383
		$bulk = '';
384
		foreach($primaryKeys as $pk) {
385 386
			$action = Json::encode([
				"update" => [
387
					"_id" => $pk,
388 389 390 391
					"_type" => static::type(),
					"_index" => static::index(),
				],
			]);
392
			$data = Json::encode([
393
				"doc" => $attributes
394
			]);
395
			$bulk .= $action . "\n" . $data . "\n";
396
		}
397 398

		// TODO do this via command
399 400
		$url = [static::index(), static::type(), '_bulk'];
		$response = static::getDb()->post($url, [], $bulk);
401
		$n=0;
402
		$errors = [];
403
		foreach($response['items'] as $item) {
404 405 406
			if (isset($item['update']['error'])) {
				$errors[] = $item['update'];
			} elseif ($item['update']['ok']) {
407
				$n++;
408 409
			}
		}
410 411 412
		if (!empty($errors)) {
			throw new Exception(__METHOD__ . ' failed updating records.', $errors);
		}
413 414 415
		return $n;
	}

416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
	/**
	 * Updates all matching records using the provided counter changes and conditions.
	 * For example, to increment all customers' age by 1,
	 *
	 * ~~~
	 * Customer::updateAllCounters(['age' => 1]);
	 * ~~~
	 *
	 * @param array $counters the counters to be updated (attribute name => increment value).
	 * Use negative values if you want to decrement the counters.
	 * @param string|array $condition the conditions that will be put in the WHERE part of the UPDATE SQL.
	 * Please refer to [[Query::where()]] on how to specify this parameter.
	 * @return integer the number of rows updated
	 */
	public static function updateAllCounters($counters, $condition = [])
	{
432
		$pkName = static::primaryKey()[0];
433
		if (count($condition) == 1 && isset($condition[$pkName])) {
434
			$primaryKeys = is_array($condition[$pkName]) ? $condition[$pkName] : [$condition[$pkName]];
435
		} else {
436
			$primaryKeys = static::find()->where($condition)->column($pkName); // TODO check whether this works with default pk _id
437 438 439 440 441
		}
		if (empty($primaryKeys) || empty($counters)) {
			return 0;
		}
		$bulk = '';
442
		foreach($primaryKeys as $pk) {
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
			$action = Json::encode([
				"update" => [
					"_id" => $pk,
					"_type" => static::type(),
					"_index" => static::index(),
				],
			]);
			$script = '';
			foreach($counters as $counter => $value) {
				$script .= "ctx._source.$counter += $counter;\n";
			}
			$data = Json::encode([
				"script" => $script,
                "params" => $counters
			]);
			$bulk .= $action . "\n" . $data . "\n";
		}

		// TODO do this via command
		$url = [static::index(), static::type(), '_bulk'];
		$response = static::getDb()->post($url, [], $bulk);
		$n=0;
465
		$errors = [];
466
		foreach($response['items'] as $item) {
467 468 469
			if (isset($item['update']['error'])) {
				$errors[] = $item['update'];
			} elseif ($item['update']['ok']) {
470 471 472
				$n++;
			}
		}
473 474 475
		if (!empty($errors)) {
			throw new Exception(__METHOD__ . ' failed updating records counters.', $errors);
		}
476 477
		return $n;
	}
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492

	/**
	 * 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');
	 * ~~~
	 *
	 * @param array $condition the conditions that will be put in the WHERE part of the DELETE SQL.
	 * Please refer to [[ActiveQuery::where()]] on how to specify this parameter.
	 * @return integer the number of rows deleted
	 */
493
	public static function deleteAll($condition = [])
494
	{
495
		$pkName = static::primaryKey()[0];
496
		if (count($condition) == 1 && isset($condition[$pkName])) {
497
			$primaryKeys = is_array($condition[$pkName]) ? $condition[$pkName] : [$condition[$pkName]];
498
		} else {
499
			$primaryKeys = static::find()->where($condition)->column($pkName); // TODO check whether this works with default pk _id
500 501
		}
		if (empty($primaryKeys)) {
502 503
			return 0;
		}
504
		$bulk = '';
505
		foreach($primaryKeys as $pk) {
506
			$bulk .= Json::encode([
507
				"delete" => [
508
					"_id" => $pk,
509 510 511 512
					"_type" => static::type(),
					"_index" => static::index(),
				],
			]) . "\n";
513
		}
514 515

		// TODO do this via command
516 517
		$url = [static::index(), static::type(), '_bulk'];
		$response = static::getDb()->post($url, [], $bulk);
518
		$n=0;
519
		$errors = [];
520
		foreach($response['items'] as $item) {
521 522 523
			if (isset($item['delete']['error'])) {
				$errors[] = $item['delete'];
			} elseif ($item['delete']['found'] && $item['delete']['ok']) {
524 525
				$n++;
			}
526
		}
527 528 529
		if (!empty($errors)) {
			throw new Exception(__METHOD__ . ' failed deleting records.', $errors);
		}
530
		return $n;
531 532
	}
}