yii2 數據庫操作詳解

開始使用數據庫首先需要配置數據庫連接組件，通過添加 db 組件到應用配置實現（"基礎的" Web 應用是 config/web.php），DSN( Data Source Name )是數據源名稱，用於指定數據庫信息.如下所示：

 1 return [
 2     // ...
 3     'components' => [
 4         // ...
 5         'db' => [
 6             'class' => 'yii\db\Connection',
 7             'dsn' => 'mysql:host=localhost;dbname=mydatabase', // MySQL, MariaDB
 8             //'dsn' => 'sqlite:/path/to/database/file', // SQLite
 9             //'dsn' => 'pgsql:host=localhost;port=5432;dbname=mydatabase', // PostgreSQL
10             //'dsn' => 'cubrid:dbname=demodb;host=localhost;port=33000', // CUBRID
11             //'dsn' => 'sqlsrv:Server=localhost;Database=mydatabase', // MS SQL Server, sqlsrv driver
12             //'dsn' => 'dblib:host=localhost;dbname=mydatabase', // MS SQL Server, dblib driver
13             //'dsn' => 'mssql:host=localhost;dbname=mydatabase', // MS SQL Server, mssql driver
14             //'dsn' => 'oci:dbname=//localhost:1521/mydatabase', // Oracle
15             'username' => 'root', //數據庫用戶名
16             'password' => '', //數據庫密碼
17             'charset' => 'utf8',
18         ],
19     ],
20     // ...
21 ];

請參考PHP manual獲取更多有關 DSN 格式信息。配置連接組件后可以使用以下語法訪問：

1 $connection = \Yii::$app->db;

請參考[[yii\db\Connection]]獲取可配置的屬性列表。如果你想通過ODBC連接數據庫，則需要配置[[yii\db\Connection::driverName]] 屬性，例如:

1 'db' => [
2     'class' => 'yii\db\Connection',
3     'driverName' => 'mysql',
4     'dsn' => 'odbc:Driver={MySQL};Server=localhost;Database=test',
5     'username' => 'root',
6     'password' => '',
7 ],

注意:如果需要同時使用多個數據庫可以定義多個連接組件：

 1 return [
 2     // ...
 3     'components' => [
 4         // ...
 5         'db' => [
 6             'class' => 'yii\db\Connection',
 7             'dsn' => 'mysql:host=localhost;dbname=mydatabase', 
 8             'username' => 'root',
 9             'password' => '',
10             'charset' => 'utf8',
11         ],
12         'secondDb' => [
13             'class' => 'yii\db\Connection',
14             'dsn' => 'sqlite:/path/to/database/file', 
15         ],
16     ],
17     // ...
18 ];

在代碼中通過以下方式使用:

1 $primaryConnection = \Yii::$app->db;
2 $secondaryConnection = \Yii::$app->secondDb;

如果不想定義數據庫連接為全局應用組件，可以在代碼中直接初始化使用：

1 $connection = new \yii\db\Connection([
2     'dsn' => $dsn,
3      'username' => $username,
4      'password' => $password,
5 ]);
6 $connection->open();

小提示：如果在創建了連接后需要執行額外的 SQL 查詢，可以添加以下代碼到應用配置文件：

 1 return [
 2     // ...
 3     'components' => [
 4         // ...
 5         'db' => [
 6             'class' => 'yii\db\Connection',
 7             // ...
 8             'on afterOpen' => function($event) {
 9                 $event->sender->createCommand("SET time_zone = 'UTC'")->execute();
10             }
11         ],
12     ],
13     // ...
14 ];

SQL 基礎查詢

一旦有了連接實例就可以通過[[yii\db\Command]]執行 SQL 查詢。

SELECT 查詢

查詢返回多行：

1 $command = $connection->createCommand('SELECT * FROM post');
2 $posts = $command->queryAll();

返回單行：

1 $command = $connection->createCommand('SELECT * FROM post WHERE id=1');
2 $post = $command->queryOne();

查詢多行單值：

1 $command = $connection->createCommand('SELECT title FROM post');
2 $titles = $command->queryColumn();

查詢標量值/計算值：

1 $command = $connection->createCommand('SELECT COUNT(*) FROM post');
2 $postCount = $command->queryScalar();

UPDATE, INSERT, DELETE 更新、插入和刪除等

如果執行 SQL 不返回任何數據可使用命令中的 execute 方法：

1 $command = $connection->createCommand('UPDATE post SET status=1 WHERE id=1');
2 $command->execute();

你可以使用insert,update,delete 方法，這些方法會根據參數生成合適的SQL並執行.

 1 // INSERT
 2 $connection->createCommand()->insert('user', [
 3     'name' => 'Sam',
 4     'age' => 30,
 5 ])->execute();
 6 
 7 // INSERT 一次插入多行
 8 $connection->createCommand()->batchInsert('user', ['name', 'age'], [
 9     ['Tom', 30],
10     ['Jane', 20],
11     ['Linda', 25],
12 ])->execute();
13 
14 // UPDATE
15 $connection->createCommand()->update('user', ['status' => 1], 'age > 30')->execute();
16 
17 // DELETE
18 $connection->createCommand()->delete('user', 'status = 0')->execute();

引用的表名和列名

大多數時間都使用以下語法來安全地引用表名和列名：

1 $sql = "SELECT COUNT([[$column]]) FROM {{table}}";
2 $rowCount = $connection->createCommand($sql)->queryScalar();

以上代碼[[$column]] 會轉變為引用恰當的列名，而{{table}} 就轉變為引用恰當的表名。表名有個特殊的變量 {{%Y}} ，如果設置了表前綴使用該變體可以自動在表名前添加前綴：

1 $sql = "SELECT COUNT([[$column]]) FROM {{%$table}}";
2 $rowCount = $connection->createCommand($sql)->queryScalar();

如果在配置文件如下設置了表前綴，以上代碼將在 tbl_table 這個表查詢結果：

 1 return [
 2     // ...
 3     'components' => [
 4         // ...
 5         'db' => [
 6             // ...
 7             'tablePrefix' => 'tbl_',
 8         ],
 9     ],
10 ];

手工引用表名和列名的另一個選擇是使用[[yii\db\Connection::quoteTableName()]] 和 [[yii\db\Connection::quoteColumnName()]]：

1 $column = $connection->quoteColumnName($column);
2 $table = $connection->quoteTableName($table);
3 $sql = "SELECT COUNT($column) FROM $table";
4 $rowCount = $connection->createCommand($sql)->queryScalar();

預處理語句

為安全傳遞查詢參數可以使用預處理語句,首先應當使用:placeholder占位，再將變量綁定到對應占位符：

$command = $connection->createCommand('SELECT * FROM post WHERE id=:id');
$command->bindValue(':id', $_GET['id']);
$post = $command->query();

另一種用法是准備一次預處理語句而執行多次查詢：

1 $command = $connection->createCommand('DELETE FROM post WHERE id=:id');
2 $command->bindParam(':id', $id);
3 
4 $id = 1;
5 $command->execute();
6 
7 $id = 2;
8 $command->execute();

提示，在執行前綁定變量，然后在每個執行中改變變量的值（一般用在循環中）比較高效.

事務

當你需要順序執行多個相關的的query時，你可以把他們封裝到一個事務中去保護數據一致性.Yii提供了一個簡單的接口來實現事務操作. 如下執行 SQL 事務查詢語句：

1 $transaction = $connection->beginTransaction();
2 try {
3     $connection->createCommand($sql1)->execute();
4      $connection->createCommand($sql2)->execute();
5     // ... 執行其他 SQL 語句 ...
6     $transaction->commit();
7 } catch(Exception $e) {
8     $transaction->rollBack();
9 }

我們通過[[yii\db\Connection::beginTransaction()|beginTransaction()]]開始一個事務，通過try catch 捕獲異常.當執行成功，通過[[yii\db\Transaction::commit()|commit()]]提交事務並結束，當發生異常失敗通過[[yii\db\Transaction::rollBack()|rollBack()]]進行事務回滾.

如需要也可以嵌套多個事務：

 1 // 外部事務
 2 $transaction1 = $connection->beginTransaction();
 3 try {
 4     $connection->createCommand($sql1)->execute();
 5 
 6     // 內部事務
 7     $transaction2 = $connection->beginTransaction();
 8     try {
 9         $connection->createCommand($sql2)->execute();
10         $transaction2->commit();
11     } catch (Exception $e) {
12         $transaction2->rollBack();
13     }
14 
15     $transaction1->commit();
16 } catch (Exception $e) {
17     $transaction1->rollBack();
18 }

注意你使用的數據庫必須支持Savepoints才能正確地執行，以上代碼在所有關系數據中都可以執行，但是只有支持Savepoints才能保證安全性。

Yii 也支持為事務設置隔離級別isolation levels，當執行事務時會使用數據庫默認的隔離級別，你也可以為事物指定隔離級別. Yii 提供了以下常量作為常用的隔離級別

[[\yii\db\Transaction::READ_UNCOMMITTED]] - 允許讀取改變了的還未提交的數據,可能導致臟讀、不可重復讀和幻讀
[[\yii\db\Transaction::READ_COMMITTED]] - 允許並發事務提交之后讀取，可以避免臟讀，可能導致重復讀和幻讀。
[[\yii\db\Transaction::REPEATABLE_READ]] - 對相同字段的多次讀取結果一致，可導致幻讀。
[[\yii\db\Transaction::SERIALIZABLE]] - 完全服從ACID的原則，確保不發生臟讀、不可重復讀和幻讀。

你可以使用以上常量或者使用一個string字符串命令，在對應數據庫中執行該命令用以設置隔離級別，比如對於postgres有效的命令為SERIALIZABLE READ ONLY DEFERRABLE.

注意:某些數據庫只能針對連接來設置事務隔離級別，所以你必須要為連接明確制定隔離級別.目前受影響的數據庫:MSSQL SQLite

注意:SQLite 只支持兩種事務隔離級別，所以你只能設置READ UNCOMMITTED 和 SERIALIZABLE.使用其他隔離級別會拋出異常.

注意:PostgreSQL 不允許在事務開始前設置隔離級別，所以你不能在事務開始時指定隔離級別.你可以在事務開始之后調用[[yii\db\Transaction::setIsolationLevel()]] 來設置.

關於隔離級別[isolation levels]: http://en.wikipedia.org/wiki/Isolation_%28database_systems%29#Isolation_levels

數據庫復制和讀寫分離

很多數據庫支持數據庫復制 database replication來提高可用性和響應速度. 在數據庫復制中，數據總是從主服務器 到 從服務器. 所有的插入和更新等寫操作在主服務器執行，而讀操作在從服務器執行.

通過配置[[yii\db\Connection]]可以實現數據庫復制和讀寫分離.

 1 [
 2     'class' => 'yii\db\Connection',
 3 
 4     // 配置主服務器
 5     'dsn' => 'dsn for master server',
 6     'username' => 'master',
 7     'password' => '',
 8 
 9     // 配置從服務器
10     'slaveConfig' => [
11         'username' => 'slave',
12         'password' => '',
13         'attributes' => [
14             // use a smaller connection timeout
15             PDO::ATTR_TIMEOUT => 10,
16         ],
17     ],
18 
19     // 配置從服務器組
20     'slaves' => [
21         ['dsn' => 'dsn for slave server 1'],
22         ['dsn' => 'dsn for slave server 2'],
23         ['dsn' => 'dsn for slave server 3'],
24         ['dsn' => 'dsn for slave server 4'],
25     ],
26 ]

以上的配置實現了一主多從的結構，從服務器用以執行讀查詢，主服務器執行寫入查詢，讀寫分離的功能由后台代碼自動完成.調用者無須關心.例如：

1 // 使用以上配置創建數據庫連接對象
2 $db = Yii::createObject($config);
3 
4 // 通過從服務器執行查詢操作
5 $rows = $db->createCommand('SELECT * FROM user LIMIT 10')->queryAll();
6 
7 // 通過主服務器執行更新操作
8 $db->createCommand("UPDATE user SET username='demo' WHERE id=1")->execute();

注意:通過[[yii\db\Command::execute()]] 執行的查詢被認為是寫操作，所有使用[[yii\db\Command]]來執行的其他查詢方法被認為是讀操作.你可以通過$db->slave得到當前正在使用能夠的從服務器.

Connection組件支持從服務器的負載均衡和故障轉移，當第一次執行讀查詢時，會隨即選擇一個從服務器進行連接，如果連接失敗則又選擇另一個，如果所有從服務器都不可用，則會連接主服務器。你可以配置[[yii\db\Connection::serverStatusCache|server status cache]]來記住那些不能連接的從服務器，使Yii 在一段時間[[yii\db\Connection::serverRetryInterval].內不會重復嘗試連接那些根本不可用的從服務器.

注意:在上述配置中，每個從服務器連接超時時間被指定為10s. 如果在10s內不能連接，則被認為該服務器已經掛掉.你也可以自定義超時參數.

你也可以配置多主多從的結構，例如:

 1 [
 2     'class' => 'yii\db\Connection',
 3 
 4     // 配置主服務器
 5     'masterConfig' => [
 6         'username' => 'master',
 7         'password' => '',
 8         'attributes' => [
 9             // use a smaller connection timeout
10             PDO::ATTR_TIMEOUT => 10,
11         ],
12     ],
13 
14     // 配置主服務器組
15     'masters' => [
16         ['dsn' => 'dsn for master server 1'],
17         ['dsn' => 'dsn for master server 2'],
18     ],
19 
20     // 配置從服務器
21     'slaveConfig' => [
22         'username' => 'slave',
23         'password' => '',
24         'attributes' => [
25             // use a smaller connection timeout
26             PDO::ATTR_TIMEOUT => 10,
27         ],
28     ],
29 
30     // 配置從服務器組
31     'slaves' => [
32         ['dsn' => 'dsn for slave server 1'],
33         ['dsn' => 'dsn for slave server 2'],
34         ['dsn' => 'dsn for slave server 3'],
35         ['dsn' => 'dsn for slave server 4'],
36     ],
37 ]

上述配置制定了2個主服務器和4個從服務器.Connection組件也支持主服務器的負載均衡和故障轉移，與從服務器不同的是，如果所有主服務器都不可用，則會拋出異常.

注意:當你使用[[yii\db\Connection::masters|masters]]來配置一個或多個主服務器時，Connection中關於數據庫連接的其他屬性（例如：dsn, username, password）都會被忽略.

事務默認使用主服務器的連接，並且在事務執行中的所有操作都會使用主服務器的連接，例如:

 1 // 在主服務器連接上開始事務
 2 $transaction = $db->beginTransaction();
 3 
 4 try {
 5     // 所有的查詢都在主服務器上執行
 6     $rows = $db->createCommand('SELECT * FROM user LIMIT 10')->queryAll();
 7     $db->createCommand("UPDATE user SET username='demo' WHERE id=1")->execute();
 8 
 9     $transaction->commit();
10 } catch(\Exception $e) {
11     $transaction->rollBack();
12     throw $e;
13 }

如果你想在從服務器上執行事務操作則必須要明確地指定，比如:

1 $transaction = $db->slave->beginTransaction();

有時你想強制使用主服務器來執行讀查詢，你可以調用seMaster()方法.

 
                      $rows  
                      =  
                      $db 
                      ->useMaster( 
                      function  
                      ( 
                      $db 
                      ) { 
                     
                      return  
                      $db 
                      ->createCommand( 
                      'SELECT * FROM user LIMIT 10' 
                      )->queryAll(); 
                     
                      });

你也可以設置$db->enableSlaves 為false來使所有查詢都在主服務器上執行.

操作數據庫模式

獲得模式信息

你可以通過 [[yii\db\Schema]]實例來獲取Schema信息:

1 $schema = $connection->getSchema();

該實例包括一系列方法來檢索數據庫多方面的信息：

1 $tables = $schema->getTableNames();

更多信息請參考[[yii\db\Schema]]

修改模式

除了基礎的 SQL 查詢，[[yii\db\Command]]還包括一系列方法來修改數據庫模式：

創建/重命名/刪除/清空表
增加/重命名/刪除/修改字段
增加/刪除主鍵
增加/刪除外鍵
創建/刪除索引

使用示例:

1 // 創建表
2 $connection->createCommand()->createTable('post', [
3     'id' => 'pk',
4     'title' => 'string',
5     'text' => 'text',
6 ]);