開始使用資料庫首先需要配置資料庫連接配接元件,通過添加 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, MariaDB8 //'dsn' => 'sqlite:/path/to/database/file', // SQLite9 //'dsn' => 'pgsql:host=localhost;port=5432;dbname=mydatabase', // PostgreSQL10 //'dsn' => 'cubrid:dbname=demodb;host=localhost;port=33000', // CUBRID11 //'dsn' => 'sqlsrv:Server=localhost;Database=mydatabase', // MS SQL Server, sqlsrv driver12 //'dsn' => 'dblib:host=localhost;dbname=mydatabase', // MS SQL Server, dblib driver13 //'dsn' => 'mssql:host=localhost;dbname=mydatabase', // MS SQL Server, mssql driver14 //'dsn' => 'oci:dbname=//localhost:1521/mydatabase', // Oracle15 '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()]] 來設定.
資料庫複制和讀寫分離
很多資料庫支援資料庫複制 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 ]);