db-active-record.md 38.7 KB
Newer Older
Alexander Makarov committed
1 2 3
Active Record
=============

4
> Note: This section is under development.
Qiang Xue committed
5

Qiang Xue committed
6 7 8 9 10
[Active Record](http://en.wikipedia.org/wiki/Active_record_pattern) provides an object-oriented interface
for accessing data stored in a database. An Active Record class is associated with a database table,
an Active Record instance corresponds to a row of that table, and an attribute of an Active Record
instance represents the value of a column in that row. Instead of writing raw SQL statements,
you can work with Active Record in an object-oriented fashion to manipulate the data in database tables.
Larry Ullman committed
11

12 13 14
For example, assume `Customer` is an Active Record class is associated with the `customer` table
and `name` is a column of `customer` table. You can write the following code to insert a new
row into `customer` table:
Alexander Makarov committed
15 16 17 18

```php
$customer = new Customer();
$customer->name = 'Qiang';
Qiang Xue committed
19 20 21 22
$customer->save();
```

The above code is equivalent to using the following raw SQL statement, which is less
23
intuitive, more error prone, and may have compatibility problems for different DBMS:
Qiang Xue committed
24 25

```php
26
$db->createCommand('INSERT INTO customer (name) VALUES (:name)', [
Qiang Xue committed
27 28
    ':name' => 'Qiang',
])->execute();
Alexander Makarov committed
29 30
```

Qiang Xue committed
31 32 33 34 35 36 37
Below is the list of databases that are currently supported by Yii Active Record:

* MySQL 4.1 or later: via [[yii\db\ActiveRecord]]
* PostgreSQL 7.3 or later: via [[yii\db\ActiveRecord]]
* SQLite 2 and 3: via [[yii\db\ActiveRecord]]
* Microsoft SQL Server 2010 or later: via [[yii\db\ActiveRecord]]
* Oracle: via [[yii\db\ActiveRecord]]
38 39
* CUBRID 9.3 or later: via [[yii\db\ActiveRecord]] (Note that due to a [bug](http://jira.cubrid.org/browse/APIS-658) in
  the cubrid PDO extension, quoting of values will not work, so you need CUBRID 9.3 as the client as well as the server)
Qiang Xue committed
40 41 42 43 44 45 46 47 48
* Sphnix: via [[yii\sphinx\ActiveRecord]], requires `yii2-sphinx` extension
* ElasticSearch: via [[yii\elasticsearch\ActiveRecord]], requires `yii2-elasticsearch` extension
* Redis 2.6.12 or later: via [[yii\redis\ActiveRecord]], requires `yii2-redis` extension
* MongoDB 1.3.0 or later: via [[yii\mongodb\ActiveRecord]], requires `yii2-mongodb` extension

As you can see, Yii provides Active Record support for relational databases as well as NoSQL databases.
In this tutorial, we will mainly describe the usage of Active Record for relational databases.
However, most content described here are also applicable to Active Record for NoSQL databases.

Alexander Makarov committed
49

Qiang Xue committed
50
Declaring Active Record Classes
Alexander Makarov committed
51 52
------------------------------

Qiang Xue committed
53 54
To declare an Active Record class you need to extend [[yii\db\ActiveRecord]] and implement
the `tableName` method that returns the name of the database table associated with the class:
Alexander Makarov committed
55 56

```php
Qiang Xue committed
57 58
namespace app\models;

Qiang Xue committed
59 60 61
use yii\db\ActiveRecord;

class Customer extends ActiveRecord
Alexander Makarov committed
62
{
63 64 65 66 67
    /**
     * @return string the name of the table associated with this ActiveRecord class.
     */
    public static function tableName()
    {
68
        return 'customer';
69
    }
Alexander Makarov committed
70 71 72
}
```

Larry Ullman committed
73

Qiang Xue committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
Accessing Column Data
---------------------

Active Record maps each column of the corresponding database table row to an attribute in the Active Record
object. An attribute behaves like a regular object public property. The name of an attribute is the same
as the corresponding column name and is case-sensitive.

To read the value of a column, you can use the following syntax:

```php
// "id" and "email" are the names of columns in the table associated with $customer ActiveRecord object
$id = $customer->id;
$email = $customer->email;
```

To change the value of a column, assign a new value to the associated property and save the object:
Larry Ullman committed
90

Qiang Xue committed
91 92 93 94
```php
$customer->email = 'jane@example.com';
$customer->save();
```
Larry Ullman committed
95

Qiang Xue committed
96 97

Connecting to Database
Alexander Makarov committed
98 99
----------------------

Qiang Xue committed
100
Active Record uses a [[yii\db\Connection|DB connection]] to exchange data with database. By default,
101
it uses the `db` [application component](structure-application-components.md) as the connection. As explained in [Database basics](db-dao.md),
Qiang Xue committed
102
you may configure the `db` component in the application configuration file like follows,
Alexander Makarov committed
103 104

```php
Alexander Makarov committed
105
return [
106 107 108 109 110 111 112 113
    'components' => [
        'db' => [
            'class' => 'yii\db\Connection',
            'dsn' => 'mysql:host=localhost;dbname=testdb',
            'username' => 'demo',
            'password' => 'demo',
        ],
    ],
Alexander Makarov committed
114
];
Alexander Makarov committed
115 116
```

Qiang Xue committed
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
If you are using multiple databases in your application and you want to use a different DB connection
for your Active Record class, you may override the [[yii\db\ActiveRecord::getDb()|getDb()]] method:

```php
class Customer extends ActiveRecord
{
    // ...

    public static function getDb()
    {
        return \Yii::$app->db2;  // use "db2" application component
    }
}
```

Alexander Makarov committed
132

Qiang Xue committed
133
Querying Data from Database
Qiang Xue committed
134
---------------------------
Alexander Makarov committed
135

Qiang Xue committed
136
Active Record provides two entry methods for building DB queries and populating data into Active Record instances:
Alexander Makarov committed
137

138 139
 - [[yii\db\ActiveRecord::find()]]
 - [[yii\db\ActiveRecord::findBySql()]]
Alexander Makarov committed
140

Alexander Makarov committed
141
Both methods return an [[yii\db\ActiveQuery]] instance, which extends [[yii\db\Query]], and thus supports the same set
Qiang Xue committed
142 143
of flexible and powerful DB query building methods, such as `where()`, `join()`, `orderBy()`, etc. The following examples
demonstrate some of the possibilities.
Alexander Makarov committed
144 145 146 147

```php
// to retrieve all *active* customers and order them by their ID:
$customers = Customer::find()
148 149 150
    ->where(['status' => Customer::STATUS_ACTIVE])
    ->orderBy('id')
    ->all();
Alexander Makarov committed
151 152 153

// to return a single customer whose ID is 1:
$customer = Customer::find()
154 155
    ->where(['id' => 1])
    ->one();
Alexander Makarov committed
156 157 158

// to return the number of *active* customers:
$count = Customer::find()
159 160
    ->where(['status' => Customer::STATUS_ACTIVE])
    ->count();
Alexander Makarov committed
161

Qiang Xue committed
162 163 164 165 166
// to index the result by customer IDs:
$customers = Customer::find()->indexBy('id')->all();
// $customers array is indexed by customer IDs

// to retrieve customers using a raw SQL statement:
167
$sql = 'SELECT * FROM customer';
Qiang Xue committed
168 169 170 171 172 173 174
$customers = Customer::findBySql($sql)->all();
```

> Tip: In the code above `Customer::STATUS_ACTIVE` is a constant defined in `Customer`. It is a good practice to
  use meaningful constant names rather than hardcoded strings or numbers in your code.


175 176 177
Two shortcut methods are provided to return Active Record instances matching a primary key value or a set of
column values: `findOne()` and `findAll()`. The former returns the first matching instance while the latter
returns all of them. For example,
Qiang Xue committed
178 179 180

```php
// to return a single customer whose ID is 1:
Alexander Makarov committed
181
$customer = Customer::findOne(1);
Qiang Xue committed
182 183

// to return an *active* customer whose ID is 1:
Alexander Makarov committed
184
$customer = Customer::findOne([
Qiang Xue committed
185 186 187
    'id' => 1,
    'status' => Customer::STATUS_ACTIVE,
]);
188 189 190 191 192 193 194 195

// to return customers whose ID is 1, 2 or 3:
$customers = Customer::findAll([1, 2, 3]);

// to return customers whose status is "deleted":
$customer = Customer::findAll([
    'status' => Customer::STATUS_DELETED,
]);
Qiang Xue committed
196 197 198 199 200 201 202 203 204
```


### Retrieving Data in Arrays

Sometimes when you are processing a large amount of data, you may want to use arrays to hold the data
retrieved from database to save memory. This can be done by calling `asArray()`:

```php
Alexander Makarov committed
205
// to return customers in terms of arrays rather than `Customer` objects:
Qiang Xue committed
206
$customers = Customer::find()
207 208
    ->asArray()
    ->all();
Qiang Xue committed
209
// each element of $customers is an array of name-value pairs
Alexander Makarov committed
210 211
```

212 213 214 215 216
Note that while this method saves memory and improves performance it is a step to a lower abstraction
layer and you will loose some features that the active record layer has.
Fetching data using asArray is nearly equal to running a normal query using the [query builder](db-dao.md).
When using asArray the result will be returned just as such a query and no typecasting is performed anymore
so the result may contain string values for fields that are integer when accessed on the active record object.
Alexander Makarov committed
217

Qiang Xue committed
218
### Retrieving Data in Batches
Alexander Makarov committed
219

220
In [Query Builder](db-query-builder.md), we have explained that you may use *batch query* to keep your memory
Qiang Xue committed
221 222
usage under a limit when querying a large amount of data from database. You may use the same technique
in Active Record. For example,
223 224 225

```php
// fetch 10 customers at a time
Qiang Xue committed
226
foreach (Customer::find()->batch(10) as $customers) {
227
    // $customers is an array of 10 or fewer Customer objects
228
}
Qiang Xue committed
229 230
// fetch 10 customers at a time and iterate them one by one
foreach (Customer::find()->each(10) as $customer) {
231
    // $customer is a Customer object
232 233
}
// batch query with eager loading
Qiang Xue committed
234
foreach (Customer::find()->with('orders')->each() as $customer) {
235 236 237
}
```

Alexander Makarov committed
238

Qiang Xue committed
239
Manipulating Data in Database
Qiang Xue committed
240
-----------------------------
Alexander Makarov committed
241

Qiang Xue committed
242 243
Active Record provides the following methods to insert, update and delete a single row in a table associated with
a single Active Record instance:
Alexander Makarov committed
244

245 246 247 248
- [[yii\db\ActiveRecord::save()|save()]]
- [[yii\db\ActiveRecord::insert()|insert()]]
- [[yii\db\ActiveRecord::update()|update()]]
- [[yii\db\ActiveRecord::delete()|delete()]]
Qiang Xue committed
249 250 251 252 253

Active Record also provides the following static methods that apply to a whole table associated with
an Active Record class. Be extremely careful when using these methods as they affect the whole table.
For example, `deleteAll()` will delete ALL rows in the table.

254 255 256 257
- [[yii\db\ActiveRecord::updateCounters()|updateCounters()]]
- [[yii\db\ActiveRecord::updateAll()|updateAll()]]
- [[yii\db\ActiveRecord::updateAllCounters()|updateAllCounters()]]
- [[yii\db\ActiveRecord::deleteAll()|deleteAll()]]
Qiang Xue committed
258

Qiang Xue committed
259 260

The following examples show how to use these methods:
Alexander Makarov committed
261 262 263

```php
// to insert a new customer record
264
$customer = new Customer();
Alexander Makarov committed
265 266 267 268 269
$customer->name = 'James';
$customer->email = 'james@example.com';
$customer->save();  // equivalent to $customer->insert();

// to update an existing customer record
Alexander Makarov committed
270
$customer = Customer::findOne($id);
Alexander Makarov committed
271 272 273 274
$customer->email = 'james@example.com';
$customer->save();  // equivalent to $customer->update();

// to delete an existing customer record
Alexander Makarov committed
275
$customer = Customer::findOne($id);
Alexander Makarov committed
276 277
$customer->delete();

Budi Irawan committed
278 279 280
// to delete several customers
Customer::deleteAll('age > :age AND gender = :gender', [':age' => 20, ':gender' => 'M']);

Qiang Xue committed
281
// to increment the age of ALL customers by 1
Alexander Makarov committed
282
Customer::updateAllCounters(['age' => 1]);
Alexander Makarov committed
283 284
```

Qiang Xue committed
285 286
> Info: The `save()` method will call either `insert()` or `update()`, depending on whether
  the Active Record instance is new or not (internally it will check the value of [[yii\db\ActiveRecord::isNewRecord]]).
Qiang Xue committed
287
  If an Active Record is instantiated via the `new` operator, calling `save()` will
Alexander Makarov committed
288 289
  insert a row in the table; calling `save()` on active record fetched from database will update the corresponding
  row in the table.
Qiang Xue committed
290

Qiang Xue committed
291

Qiang Xue committed
292 293 294
### Data Input and Validation

Because Active Record extends from [[yii\base\Model]], it supports the same data input and validation features
295
as described in [Model](structure-models.md). For example, you may declare validation rules by overwriting the
Qiang Xue committed
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
[[yii\base\Model::rules()|rules()]] method; you may massively assign user input data to an Active Record instance;
and you may call [[yii\base\Model::validate()|validate()]] to trigger data validation.

When you call `save()`, `insert()` or `update()`, these methods will automatically call [[yii\base\Model::validate()|validate()]].
If the validation fails, the corresponding data saving operation will be cancelled.

The following example shows how to use an Active Record to collect/validate user input and save them into database:

```php
// creating a new record
$model = new Customer;
if ($model->load(Yii::$app->request->post()) && $model->save()) {
    // the user input has been collected, validated and saved
}

// updating a record whose primary key is $id
Alexander Makarov committed
312
$model = Customer::findOne($id);
Qiang Xue committed
313 314 315 316 317 318 319 320 321
if ($model === null) {
    throw new NotFoundHttpException;
}
if ($model->load(Yii::$app->request->post()) && $model->save()) {
    // the user input has been collected, validated and saved
}
```


Qiang Xue committed
322 323
### Loading Default Values

Qiang Xue committed
324 325 326
Your table columns may be defined with default values. Sometimes, you may want to pre-populate your
Web form for an Active Record with these values. To do so, call the `loadDefaultValues()` method before
rendering the form:
327 328 329 330

```php
$customer = new Customer();
$customer->loadDefaultValues();
Qiang Xue committed
331
// ... render HTML form for $customer ...
332 333
```

334 335 336 337 338 339 340 341 342 343
If you want to set some initial values for the attributes yourself you can override the `init()` method
of the active record class and set the values there. For example to set the default value for the `status` attribute:

```php
public function init()
{
    parent::init();
    $this->status = 'active';
}
```
Larry Ullman committed
344

Qiang Xue committed
345
Active Record Life Cycles
Larry Ullman committed
346 347
-------------------------

Qiang Xue committed
348 349
It is important to understand the life cycles of Active Record when it is used to manipulate data in database.
These life cycles are typically associated with corresponding events which allow you to inject code
350
to intercept or respond to these events. They are especially useful for developing Active Record [behaviors](concept-behaviors.md).
Qiang Xue committed
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374

When instantiating a new Active Record instance, we will have the following life cycles:

1. constructor
2. [[yii\db\ActiveRecord::init()|init()]]: will trigger an [[yii\db\ActiveRecord::EVENT_INIT|EVENT_INIT]] event

When querying data through the [[yii\db\ActiveRecord::find()|find()]] method, we will have the following life cycles
for EVERY newly populated Active Record instance:

1. constructor
2. [[yii\db\ActiveRecord::init()|init()]]: will trigger an [[yii\db\ActiveRecord::EVENT_INIT|EVENT_INIT]] event
3. [[yii\db\ActiveRecord::afterFind()|afterFind()]]: will trigger an [[yii\db\ActiveRecord::EVENT_AFTER_FIND|EVENT_AFTER_FIND]] event

When calling [[yii\db\ActiveRecord::save()|save()]] to insert or update an ActiveRecord, we will have
the following life cycles:

1. [[yii\db\ActiveRecord::beforeValidate()|beforeValidate()]]: will trigger an [[yii\db\ActiveRecord::EVENT_BEFORE_VALIDATE|EVENT_BEFORE_VALIDATE]] event
2. [[yii\db\ActiveRecord::afterValidate()|afterValidate()]]: will trigger an [[yii\db\ActiveRecord::EVENT_AFTER_VALIDATE|EVENT_AFTER_VALIDATE]] event
3. [[yii\db\ActiveRecord::beforeSave()|beforeSave()]]: will trigger an [[yii\db\ActiveRecord::EVENT_BEFORE_INSERT|EVENT_BEFORE_INSERT]] or [[yii\db\ActiveRecord::EVENT_BEFORE_UPDATE|EVENT_BEFORE_UPDATE]] event
4. perform the actual data insertion or updating
5. [[yii\db\ActiveRecord::afterSave()|afterSave()]]: will trigger an [[yii\db\ActiveRecord::EVENT_AFTER_INSERT|EVENT_AFTER_INSERT]] or [[yii\db\ActiveRecord::EVENT_AFTER_UPDATE|EVENT_AFTER_UPDATE]] event

And Finally when calling [[yii\db\ActiveRecord::delete()|delete()]] to delete an ActiveRecord, we will have
the following life cycles:
Larry Ullman committed
375

Qiang Xue committed
376 377 378
1. [[yii\db\ActiveRecord::beforeDelete()|beforeDelete()]]: will trigger an [[yii\db\ActiveRecord::EVENT_BEFORE_DELETE|EVENT_BEFORE_DELETE]] event
2. perform the actual data deletion
3. [[yii\db\ActiveRecord::afterDelete()|afterDelete()]]: will trigger an [[yii\db\ActiveRecord::EVENT_AFTER_DELETE|EVENT_AFTER_DELETE]] event
Alexander Makarov committed
379

Qiang Xue committed
380

Qiang Xue committed
381 382
Working with Relational Data
----------------------------
Alexander Makarov committed
383

384 385 386
You can use ActiveRecord to also query a table's relational data (i.e., selection of data from Table A can also pull
in related data from Table B). Thanks to ActiveRecord, the relational data returned can be accessed like a property
of the ActiveRecord object associated with the primary table.
Larry Ullman committed
387

Qiang Xue committed
388 389
For example, with an appropriate relation declaration, by accessing `$customer->orders` you may obtain
an array of `Order` objects which represent the orders placed by the specified customer.
Alexander Makarov committed
390

391 392
To declare a relation, define a getter method which returns an [[yii\db\ActiveQuery]] object that has relation
information about the relation context and thus will only query for related records. For example,
Alexander Makarov committed
393 394 395 396

```php
class Customer extends \yii\db\ActiveRecord
{
397 398 399 400 401
    public function getOrders()
    {
        // Customer has_many Order via Order.customer_id -> id
        return $this->hasMany(Order::className(), ['customer_id' => 'id']);
    }
Alexander Makarov committed
402 403 404 405
}

class Order extends \yii\db\ActiveRecord
{
406 407
    public function getCustomer()
    {
408
        // Order has_one Customer via Customer.id -> customer_id
409 410
        return $this->hasOne(Customer::className(), ['id' => 'customer_id']);
    }
Alexander Makarov committed
411 412 413
}
```

414
The methods [[yii\db\ActiveRecord::hasMany()]] and [[yii\db\ActiveRecord::hasOne()]] used in the above
Qiang Xue committed
415 416
are used to model the many-one relationship and one-one relationship in a relational database.
For example, a customer has many orders, and an order has one customer.
417
Both methods take two parameters and return an [[yii\db\ActiveQuery]] object:
Alexander Makarov committed
418

Qiang Xue committed
419
 - `$class`: the name of the class of the related model(s). This should be a fully qualified class name.
Qiang Xue committed
420 421 422 423
 - `$link`: the association between columns from the two tables. This should be given as an array.
   The keys of the array are the names of the columns from the table associated with `$class`,
   while the values of the array are the names of the columns from the declaring class.
   It is a good practice to define relationships based on table foreign keys.
Alexander Makarov committed
424

Qiang Xue committed
425 426
After declaring relations, getting relational data is as easy as accessing a component property
that is defined by the corresponding getter method:
Alexander Makarov committed
427 428

```php
Qiang Xue committed
429
// get the orders of a customer
Alexander Makarov committed
430
$customer = Customer::findOne(1);
Alexander Makarov committed
431
$orders = $customer->orders;  // $orders is an array of Order objects
Qiang Xue committed
432 433 434
```

Behind the scene, the above code executes the following two SQL queries, one for each line of code:
Alexander Makarov committed
435

Qiang Xue committed
436
```sql
437 438
SELECT * FROM customer WHERE id=1;
SELECT * FROM order WHERE customer_id=1;
Alexander Makarov committed
439 440
```

441 442
> Tip: If you access the expression `$customer->orders` again, it will not perform the second SQL query again.
The SQL query is only performed the first time when this expression is accessed. Any further
Qiang Xue committed
443 444 445 446 447 448
accesses will only return the previously fetched results that are cached internally. If you want to re-query
the relational data, simply unset the existing one first: `unset($customer->orders);`.

Sometimes, you may want to pass parameters to a relational query. For example, instead of returning
all orders of a customer, you may want to return only big orders whose subtotal exceeds a specified amount.
To do so, declare a `bigOrders` relation with the following getter method:
Alexander Makarov committed
449 450 451 452

```php
class Customer extends \yii\db\ActiveRecord
{
453 454 455 456 457 458
    public function getBigOrders($threshold = 100)
    {
        return $this->hasMany(Order::className(), ['customer_id' => 'id'])
            ->where('subtotal > :threshold', [':threshold' => $threshold])
            ->orderBy('id');
    }
Alexander Makarov committed
459 460 461
}
```

462 463
Remember that `hasMany()` returns an [[yii\db\ActiveQuery]] object which allows you to customize the query by
calling the methods of [[yii\db\ActiveQuery]].
Qiang Xue committed
464 465 466 467 468 469 470 471

With the above declaration, if you access `$customer->bigOrders`, it will only return the orders
whose subtotal is greater than 100. To specify a different threshold value, use the following code:

```php
$orders = $customer->getBigOrders(200)->all();
```

472 473
> Note: A relation method returns an instance of [[yii\db\ActiveQuery]]. If you access the relation like
an attribute (i.e. a class property), the return value will be the query result of the relation, which could be an instance of [[yii\db\ActiveRecord]],
Qiang Xue committed
474
an array of that, or null, depending the multiplicity of the relation. For example, `$customer->getOrders()` returns
475
an `ActiveQuery` instance, while `$customer->orders` returns an array of `Order` objects (or an empty array if
Qiang Xue committed
476
the query results in nothing).
Qiang Xue committed
477

Qiang Xue committed
478

479 480
Relations with Junction Table
-----------------------------
Qiang Xue committed
481

482
Sometimes, two tables are related together via an intermediary table called [junction table][]. To declare such relations,
483 484
we can customize the [[yii\db\ActiveQuery]] object by calling its [[yii\db\ActiveQuery::via()|via()]] or
[[yii\db\ActiveQuery::viaTable()|viaTable()]] method.
Alexander Makarov committed
485

486
For example, if table `order` and table `item` are related via junction table `order_item`,
Alexander Makarov committed
487 488 489 490 491
we can declare the `items` relation in the `Order` class like the following:

```php
class Order extends \yii\db\ActiveRecord
{
492 493 494
    public function getItems()
    {
        return $this->hasMany(Item::className(), ['id' => 'item_id'])
495
            ->viaTable('order_item', ['order_id' => 'id']);
496
    }
Alexander Makarov committed
497 498 499
}
```

500 501
The [[yii\db\ActiveQuery::via()|via()]] method is similar to [[yii\db\ActiveQuery::viaTable()|viaTable()]] except that
the first parameter of [[yii\db\ActiveQuery::via()|via()]] takes a relation name declared in the ActiveRecord class
502
instead of the junction table name. For example, the above `items` relation can be equivalently declared as follows:
Alexander Makarov committed
503 504 505 506

```php
class Order extends \yii\db\ActiveRecord
{
507 508 509 510 511 512 513 514 515 516
    public function getOrderItems()
    {
        return $this->hasMany(OrderItem::className(), ['order_id' => 'id']);
    }

    public function getItems()
    {
        return $this->hasMany(Item::className(), ['id' => 'item_id'])
            ->via('orderItems');
    }
Alexander Makarov committed
517 518 519
}
```

520
[junction table]: https://en.wikipedia.org/wiki/Junction_table "Junction table on Wikipedia"
521

Alexander Makarov committed
522

Qiang Xue committed
523 524 525 526
Lazy and Eager Loading
----------------------

As described earlier, when you access the related objects the first time, ActiveRecord will perform a DB query
Alexander Makarov committed
527 528 529 530
to retrieve the corresponding data and populate it into the related objects. No query will be performed
if you access the same related objects again. We call this *lazy loading*. For example,

```php
531
// SQL executed: SELECT * FROM customer WHERE id=1
Alexander Makarov committed
532
$customer = Customer::findOne(1);
533
// SQL executed: SELECT * FROM order WHERE customer_id=1
Alexander Makarov committed
534 535 536 537 538
$orders = $customer->orders;
// no SQL executed
$orders2 = $customer->orders;
```

Qiang Xue committed
539
Lazy loading is very convenient to use. However, it may suffer from a performance issue in the following scenario:
Alexander Makarov committed
540 541

```php
542
// SQL executed: SELECT * FROM customer LIMIT 100
Alexander Makarov committed
543 544 545
$customers = Customer::find()->limit(100)->all();

foreach ($customers as $customer) {
546
    // SQL executed: SELECT * FROM order WHERE customer_id=...
547 548
    $orders = $customer->orders;
    // ...handle $orders...
Alexander Makarov committed
549 550 551 552 553
}
```

How many SQL queries will be performed in the above code, assuming there are more than 100 customers in
the database? 101! The first SQL query brings back 100 customers. Then for each customer, a SQL query
Qiang Xue committed
554
is performed to bring back the orders of that customer.
Alexander Makarov committed
555

Carsten Brandt committed
556
To solve the above performance problem, you can use the so-called *eager loading* approach by calling [[yii\db\ActiveQuery::with()]]:
Alexander Makarov committed
557 558

```php
559 560
// SQL executed: SELECT * FROM customer LIMIT 100;
//               SELECT * FROM orders WHERE customer_id IN (1,2,...)
Alexander Makarov committed
561
$customers = Customer::find()->limit(100)
562
    ->with('orders')->all();
Alexander Makarov committed
563 564

foreach ($customers as $customer) {
565 566 567
    // no SQL executed
    $orders = $customer->orders;
    // ...handle $orders...
Alexander Makarov committed
568 569 570
}
```

Qiang Xue committed
571 572 573 574
As you can see, only two SQL queries are needed for the same task!

> Info: In general, if you are eager loading `N` relations among which `M` relations are defined with `via()` or `viaTable()`,
> a total number of `1+M+N` SQL queries will be performed: one query to bring back the rows for the primary table, one for
575
> each of the `M` junction tables corresponding to the `via()` or `viaTable()` calls, and one for each of the `N` related tables.
Alexander Makarov committed
576

Qiang Xue committed
577 578 579 580 581 582 583 584
> Note: When you are customizing `select()` with eager loading, make sure you include the columns that link
> the related models. Otherwise, the related models will not be loaded. For example,

```php
$orders = Order::find()->select(['id', 'amount'])->with('customer')->all();
// $orders[0]->customer is always null. To fix the problem, you should do the following:
$orders = Order::find()->select(['id', 'amount', 'customer_id'])->with('customer')->all();
```
Alexander Makarov committed
585

Qiang Xue committed
586
Sometimes, you may want to customize the relational queries on the fly. This can be
Alexander Makarov committed
587 588 589
done for both lazy loading and eager loading. For example,

```php
Alexander Makarov committed
590
$customer = Customer::findOne(1);
591
// lazy loading: SELECT * FROM order WHERE customer_id=1 AND subtotal>100
Alexander Makarov committed
592 593
$orders = $customer->getOrders()->where('subtotal>100')->all();

594 595
// eager loading: SELECT * FROM customer LIMIT 100
//                SELECT * FROM order WHERE customer_id IN (1,2,...) AND subtotal>100
Alexander Makarov committed
596
$customers = Customer::find()->limit(100)->with([
597 598 599
    'orders' => function($query) {
        $query->andWhere('subtotal>100');
    },
Alexander Makarov committed
600
])->all();
Alexander Makarov committed
601 602 603
```


604 605 606 607 608 609 610 611 612
Inverse Relations
-----------------

Relations can often be defined in pairs. For example, `Customer` may have a relation named `orders` while `Order` may have a relation
named `customer`:

```php
class Customer extends ActiveRecord
{
613 614 615 616 617
    ....
    public function getOrders()
    {
        return $this->hasMany(Order::className(), ['customer_id' => 'id']);
    }
618 619 620 621
}

class Order extends ActiveRecord
{
622 623 624 625 626
    ....
    public function getCustomer()
    {
        return $this->hasOne(Customer::className(), ['id' => 'customer_id']);
    }
627 628 629 630 631 632 633 634
}
```

If we perform the following query, we would find that the `customer` of an order is not the same customer object
that finds those orders, and accessing `customer->orders` will trigger one SQL execution while accessing
the `customer` of an order will trigger another SQL execution:

```php
635
// SELECT * FROM customer WHERE id=1
Alexander Makarov committed
636
$customer = Customer::findOne(1);
637
// echoes "not equal"
638 639
// SELECT * FROM order WHERE customer_id=1
// SELECT * FROM customer WHERE id=1
640
if ($customer->orders[0]->customer === $customer) {
641
    echo 'equal';
642
} else {
643
    echo 'not equal';
644 645 646 647
}
```

To avoid the redundant execution of the last SQL statement, we could declare the inverse relations for the `customer`
648
and the `orders` relations by calling the [[yii\db\ActiveQuery::inverseOf()|inverseOf()]] method, like the following:
649 650 651 652

```php
class Customer extends ActiveRecord
{
653 654 655 656 657
    ....
    public function getOrders()
    {
        return $this->hasMany(Order::className(), ['customer_id' => 'id'])->inverseOf('customer');
    }
658 659 660 661 662 663
}
```

Now if we execute the same query as shown above, we would get:

```php
664
// SELECT * FROM customer WHERE id=1
Alexander Makarov committed
665
$customer = Customer::findOne(1);
666
// echoes "equal"
667
// SELECT * FROM order WHERE customer_id=1
668
if ($customer->orders[0]->customer === $customer) {
669
    echo 'equal';
670
} else {
671
    echo 'not equal';
672 673 674 675 676 677 678
}
```

In the above, we have shown how to use inverse relations in lazy loading. Inverse relations also apply in
eager loading:

```php
679 680
// SELECT * FROM customer
// SELECT * FROM order WHERE customer_id IN (1, 2, ...)
681 682 683
$customers = Customer::find()->with('orders')->all();
// echoes "equal"
if ($customers[0]->orders[0]->customer === $customers[0]) {
684
    echo 'equal';
685
} else {
686
    echo 'not equal';
687 688 689 690
}
```

> Note: Inverse relation cannot be defined with a relation that involves pivoting tables.
691 692
> That is, if your relation is defined with [[yii\db\ActiveQuery::via()|via()]] or [[yii\db\ActiveQuery::viaTable()|viaTable()]],
> you cannot call [[yii\db\ActiveQuery::inverseOf()]] further.
693 694


695 696 697 698
Joining with Relations
----------------------

When working with relational databases, a common task is to join multiple tables and apply various
Carsten Brandt committed
699
query conditions and parameters to the JOIN SQL statement. Instead of calling [[yii\db\ActiveQuery::join()]]
700
explicitly to build up the JOIN query, you may reuse the existing relation definitions and call
Carsten Brandt committed
701
[[yii\db\ActiveQuery::joinWith()]] to achieve this goal. For example,
702 703

```php
704
// find all orders and sort the orders by the customer id and the order id. also eager loading "customer"
705
$orders = Order::find()->joinWith('customer')->orderBy('customer.id, order.id')->all();
706
// find all orders that contain books, and eager loading "books"
707
$orders = Order::find()->innerJoinWith('books')->all();
708 709
```

Carsten Brandt committed
710
In the above, the method [[yii\db\ActiveQuery::innerJoinWith()|innerJoinWith()]] is a shortcut to [[yii\db\ActiveQuery::joinWith()|joinWith()]]
711
with the join type set as `INNER JOIN`.
Qiang Xue committed
712

713 714
You may join with one or multiple relations; you may apply query conditions to the relations on-the-fly;
and you may also join with sub-relations. For example,
Qiang Xue committed
715 716 717 718

```php
// join with multiple relations
// find out the orders that contain books and are placed by customers who registered within the past 24 hours
719
$orders = Order::find()->innerJoinWith([
720 721
    'books',
    'customer' => function ($query) {
722
        $query->where('customer.created_at > ' . (time() - 24 * 3600));
723
    }
Qiang Xue committed
724 725 726 727 728
])->all();
// join with sub-relations: join with books and books' authors
$orders = Order::find()->joinWith('books.author')->all();
```

729 730 731 732
Behind the scene, Yii will first execute a JOIN SQL statement to bring back the primary models
satisfying the conditions applied to the JOIN SQL. It will then execute a query for each relation
and populate the corresponding related records.

Carsten Brandt committed
733
The difference between [[yii\db\ActiveQuery::joinWith()|joinWith()]] and [[yii\db\ActiveQuery::with()|with()]] is that
734 735 736 737 738 739 740 741
the former joins the tables for the primary model class and the related model classes to retrieve
the primary models, while the latter just queries against the table for the primary model class to
retrieve the primary models.

Because of this difference, you may apply query conditions that are only available to a JOIN SQL statement.
For example, you may filter the primary models by the conditions on the related models, like the example
above. You may also sort the primary models using columns from the related tables.

Carsten Brandt committed
742
When using [[yii\db\ActiveQuery::joinWith()|joinWith()]], you are responsible to disambiguate column names.
743
In the above examples, we use `item.id` and `order.id` to disambiguate the `id` column references
744 745
because both of the order table and the item table contain a column named `id`.

Qiang Xue committed
746 747 748
By default, when you join with a relation, the relation will also be eagerly loaded. You may change this behavior
by passing the `$eagerLoading` parameter which specifies whether to eager load the specified relations.

Carsten Brandt committed
749
And also by default, [[yii\db\ActiveQuery::joinWith()|joinWith()]] uses `LEFT JOIN` to join the related tables.
750
You may pass it with the `$joinType` parameter to customize the join type. As a shortcut to the `INNER JOIN` type,
Carsten Brandt committed
751
you may use [[yii\db\ActiveQuery::innerJoinWith()|innerJoinWith()]].
Qiang Xue committed
752 753 754 755 756

Below are some more examples,

```php
// find all orders that contain books, but do not eager loading "books".
757
$orders = Order::find()->innerJoinWith('books', false)->all();
758
// which is equivalent to the above
759
$orders = Order::find()->joinWith('books', false, 'INNER JOIN')->all();
Qiang Xue committed
760
```
761

762
Sometimes when joining two tables, you may need to specify some extra condition in the ON part of the JOIN query.
763
This can be done by calling the [[yii\db\ActiveQuery::onCondition()]] method like the following:
764 765 766 767

```php
class User extends ActiveRecord
{
768 769 770 771
    public function getBooks()
    {
        return $this->hasMany(Item::className(), ['owner_id' => 'id'])->onCondition(['category_id' => 1]);
    }
772 773 774
}
```

775 776
In the above, the [[yii\db\ActiveRecord::hasMany()|hasMany()]] method returns an [[yii\db\ActiveQuery]] instance,
upon which [[yii\db\ActiveQuery::onCondition()|onCondition()]] is called
777 778
to specify that only items whose `category_id` is 1 should be returned.

Carsten Brandt committed
779
When you perform query using [[yii\db\ActiveQuery::joinWith()|joinWith()]], the on-condition will be put in the ON part
780 781 782
of the corresponding JOIN query. For example,

```php
783 784
// SELECT user.* FROM user LEFT JOIN item ON item.owner_id=user.id AND category_id=1
// SELECT * FROM item WHERE owner_id IN (...) AND category_id=1
785
$users = User::find()->joinWith('books')->all();
786 787
```

Carsten Brandt committed
788
Note that if you use eager loading via [[yii\db\ActiveQuery::with()]] or lazy loading, the on-condition will be put
789 790 791
in the WHERE part of the corresponding SQL statement, because there is no JOIN query involved. For example,

```php
792
// SELECT * FROM user WHERE id=10
Alexander Makarov committed
793
$user = User::findOne(10);
794
// SELECT * FROM item WHERE owner_id=10 AND category_id=1
795 796 797
$books = $user->books;
```

798

Alexander Makarov committed
799 800 801 802 803 804
Working with Relationships
--------------------------

ActiveRecord provides the following two methods for establishing and breaking a
relationship between two ActiveRecord objects:

805 806
- [[yii\db\ActiveRecord::link()|link()]]
- [[yii\db\ActiveRecord::unlink()|unlink()]]
Alexander Makarov committed
807 808 809 810 811

For example, given a customer and a new order, we can use the following code to make the
order owned by the customer:

```php
Alexander Makarov committed
812
$customer = Customer::findOne(1);
813
$order = new Order();
Alexander Makarov committed
814 815 816 817
$order->subtotal = 100;
$customer->link('orders', $order);
```

818 819
The [[yii\db\ActiveRecord::link()|link()]] call above will set the `customer_id` of the order to be the primary key
value of `$customer` and then call [[yii\db\ActiveRecord::save()|save()]] to save the order into database.
Alexander Makarov committed
820 821


822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
Cross-DBMS Relations
--------------------

ActiveRecord allows to establish relationship between entities from different DBMS. For example: between relational
database table and MongoDB collection. Such relation does not require any special code:

```php
// Relational database Active Record
class Customer extends \yii\db\ActiveRecord
{
    public static function tableName()
    {
        return 'customer';
    }

    public function getComments()
    {
        // Customer, stored in relational database, has many Comments, stored in MongoDB collection:
        return $this->hasMany(Comment::className(), ['customer_id' => 'id']);
    }
}

// MongoDb Active Record
class Comment extends \yii\mongodb\ActiveRecord
{
    public static function collectionName()
    {
        return 'comment';
    }

    public function getCustomer()
    {
        // Comment, stored in MongoDB collection, has one Customer, stored in relational database:
        return $this->hasOne(Customer::className(), ['id' => 'customer_id']);
    }
}
```

Klimov Paul committed
860
All Active Record features like eager and lazy loading, establishing and breaking a relationship and so on, are
861 862
available for cross-DBMS relations.

Klimov Paul committed
863 864 865
> Note: do not forget Active Record solutions for different DBMS may have specific methods and features, which may not be
  applied for cross-DBMS relations. For example: usage of [[yii\db\ActiveQuery::joinWith()]] will obviously not work with
  relation to the MongoDB collection.
866 867


Qiang Xue committed
868 869
Scopes
------
Alexander Makarov committed
870

871 872 873 874
When you call [[yii\db\ActiveRecord::find()|find()]] or [[yii\db\ActiveRecord::findBySql()|findBySql()]], it returns an
[[yii\db\ActiveQuery|ActiveQuery]] instance.
You may call additional query methods, such as [[yii\db\ActiveQuery::where()|where()]], [[yii\db\ActiveQuery::orderBy()|orderBy()]],
to further specify the query conditions.
875

Qiang Xue committed
876 877 878 879 880 881 882
It is possible that you may want to call the same set of query methods in different places. If this is the case,
you should consider defining the so-called *scopes*. A scope is essentially a method defined in a custom query class that
calls a set of query methods to modify the query object. You can then use a scope like calling a normal query method.

Two steps are required to define a scope. First create a custom query class for your model and define the needed scope
methods in this class. For example, create a `CommentQuery` class for the `Comment` model and define the `active()`
scope method like the following:
Alexander Makarov committed
883 884

```php
885 886
namespace app\models;

887
use yii\db\ActiveQuery;
888 889

class CommentQuery extends ActiveQuery
Alexander Makarov committed
890
{
891 892 893 894 895
    public function active($state = true)
    {
        $this->andWhere(['active' => $state]);
        return $this;
    }
896 897
}
```
Alexander Makarov committed
898

899 900 901 902
Important points are:

1. Class should extend from `yii\db\ActiveQuery` (or another `ActiveQuery` such as `yii\mongodb\ActiveQuery`).
2. A method should be `public` and should return `$this` in order to allow method chaining. It may accept parameters.
903
3. Check [[yii\db\ActiveQuery]] methods that are very useful for modifying query conditions.
904

Alexander Makarov committed
905
Second, override [[yii\db\ActiveRecord::find()]] to use the custom query class instead of the regular [[yii\db\ActiveQuery|ActiveQuery]].
Qiang Xue committed
906
For the example above, you need to write the following code:
907

Carsten Brandt committed
908
```php
909 910 911 912 913 914
namespace app\models;

use yii\db\ActiveRecord;

class Comment extends ActiveRecord
{
Alexander Makarov committed
915 916 917 918 919
    /**
     * @inheritdoc
     * @return CommentQuery
     */
    public static function find()
920
    {
921
        return new CommentQuery(get_called_class());
922
    }
Alexander Makarov committed
923
}
924
```
Alexander Makarov committed
925

926 927 928
That's it. Now you can use your custom scope methods:

```php
929
$comments = Comment::find()->active()->all();
930
$inactiveComments = Comment::find()->active(false)->all();
931 932 933 934 935 936 937
```

You can also use scopes when defining relations. For example,

```php
class Post extends \yii\db\ActiveRecord
{
938 939 940
    public function getActiveComments()
    {
        return $this->hasMany(Comment::className(), ['post_id' => 'id'])->active();
941

942
    }
943
}
Alexander Makarov committed
944 945
```

946 947 948 949
Or use the scopes on-the-fly when performing relational query:

```php
$posts = Post::find()->with([
950 951 952
    'comments' => function($q) {
        $q->active();
    }
953 954
])->all();
```
Alexander Makarov committed
955

956 957 958
### Default Scope

If you used Yii 1.1 before, you may know a concept called *default scope*. A default scope is a scope that
Alexander Makarov committed
959
applies to ALL queries. You can define a default scope easily by overriding [[yii\db\ActiveRecord::find()]]. For example,
960 961

```php
Alexander Makarov committed
962
public static function find()
963
{
Alexander Makarov committed
964
    return parent::find()->where(['deleted' => false]);
965 966 967 968 969 970 971 972
}
```

Note that all your queries should then not use [[yii\db\ActiveQuery::where()|where()]] but
[[yii\db\ActiveQuery::andWhere()|andWhere()]] and [[yii\db\ActiveQuery::orWhere()|orWhere()]]
to not override the default condition.


Qiang Xue committed
973
Transactional operations
974
---------------------
975

976 977 978
There are two ways of dealing with transactions while working with Active Record. First way is doing everything manually
as described in "transactions" section of "[Database basics](db-dao.md)". Another way is to do it by implementing
`transactions` method where you can specify which operations are to be wrapped into transaction per model scenario:
979 980

```php
981
class Post extends \yii\db\ActiveRecord
982
{
983 984 985 986 987 988 989 990 991 992
    public function transactions()
    {
        return [
            'admin' => self::OP_INSERT,
            'api' => self::OP_INSERT | self::OP_UPDATE | self::OP_DELETE,
            // the above is equivalent to the following:
            // 'api' => self::OP_ALL,
        ];
    }
}
993 994
```

995 996 997
In the above `admin` and `api` are model scenarios and constants starting with `OP_` are operations that should
be wrapped in transaction for these sceanarios. Supported operations are `OP_INSERT`, `OP_UPDATE` and `OP_DELETE`.
`OP_ALL` stands for all three.
998

999 1000
Such automatic transactions are especially useful if you're doing additional database changes in `beforeSave`,
`afterSave`, `beforeDelete`, `afterDelete` and want to be sure that both succeeded before they are saved.
1001

1002 1003
Optimistic Locks
--------------
1004

1005 1006 1007 1008
Optimistic locking allows multiple users to access the same record for edits and avoids
potential conflicts. In case when a user attempts to save the record upon some staled data
(because another user has modified the data), a [[\yii\db\StaleObjectException]] exception will be thrown,
and the update or deletion is skipped.
1009

1010
Optimistic locking is only supported by `update()` and `delete()` methods and isn't used by default.
Alexander Makarov committed
1011

1012
To use Optimistic locking:
Qiang Xue committed
1013

1014 1015 1016 1017 1018 1019 1020
1. Create a column to store the version number of each row. The column type should be `BIGINT DEFAULT 0`.
   Override `optimisticLock()` method to return the name of this column.
2. In the Web form that collects the user input, add a hidden field that stores
   the lock version of the recording being updated.
3. In the controller action that does the data updating, try to catch the [[\yii\db\StaleObjectException]]
   and implement necessary business logic (e.g. merging the changes, prompting stated data)
   to resolve the conflict.
Qiang Xue committed
1021 1022

Dirty Attributes
1023
--------------
Qiang Xue committed
1024

1025 1026 1027
An attribute is considered dirty if its value was modified since model was loaded from database or since most recent
data save. When saving record data by calling `save()`, `update()`, `insert()` etc. only dirty attributes are saved
into database. If there are no dirty attributes there's nothing to be saved so no query will be issued at all.
Qiang Xue committed
1028

Alexander Makarov committed
1029 1030 1031
See also
--------

1032
- [Model](structure-models.md)
1033
- [[yii\db\ActiveRecord]]