數據庫訪問 (DAO)
Yii 包含了一個建立在 PHP PDO 之上的數據訪問層 (DAO). DAO為不同的數據庫提供了一套統一的API. 其中ActiveRecord 提供了數據庫與模型(MVC 中的 M,Model) 的交互,QueryBuilder 用於創建動態的查詢語句. DAO提供了簡單高效的SQL查詢,可以用在與數據庫交互的各個地方.
Yii 默認支持以下數據庫 (DBMS):
配置
開始使用數據庫首先需要配置數據庫連接組件,通過添加 db 組件到應用配置實現("基礎的" Web 應用是 config/web.php),DSN( Data Source Name )是數據源名稱,用於指定數據庫信息.如下所示:
return [ // ... 'components' => [ // ... 'db' => [ 'class' => 'yii\db\Connection', 'dsn' => 'mysql:host=localhost;dbname=mydatabase', // MySQL, MariaDB //'dsn' => 'sqlite:/path/to/database/file', // SQLite //'dsn' => 'pgsql:host=localhost;port=5432;dbname=mydatabase', // PostgreSQL //'dsn' => 'cubrid:dbname=demodb;host=localhost;port=33000', // CUBRID //'dsn' => 'sqlsrv:Server=localhost;Database=mydatabase', // MS SQL Server, sqlsrv driver //'dsn' => 'dblib:host=localhost;dbname=mydatabase', // MS SQL Server, dblib driver //'dsn' => 'mssql:host=localhost;dbname=mydatabase', // MS SQL Server, mssql driver //'dsn' => 'oci:dbname=//localhost:1521/mydatabase', // Oracle 'username' => 'root', //數據庫用戶名 'password' => '', //數據庫密碼 'charset' => 'utf8', ], ], // ... ];
請參考PHP manual獲取更多有關 DSN 格式信息。 配置連接組件後可以使用以下語法訪問:
$connection = \Yii::$app->db;
請參考yii\db\Connection獲取可配置的屬性列表。 如果你想通過ODBC連接數據庫,則需要配置yii\db\Connection::driverName 屬性,例如:
'db' => [ 'class' => 'yii\db\Connection', 'driverName' => 'mysql', 'dsn' => 'odbc:Driver={MySQL};Server=localhost;Database=test', 'username' => 'root', 'password' => '', ],
注意:如果需要同時使用多個數據庫可以定義 多個 連接組件:
return [ // ... 'components' => [ // ... 'db' => [ 'class' => 'yii\db\Connection', 'dsn' => 'mysql:host=localhost;dbname=mydatabase', 'username' => 'root', 'password' => '', 'charset' => 'utf8', ], 'secondDb' => [ 'class' => 'yii\db\Connection', 'dsn' => 'sqlite:/path/to/database/file', ], ], // ... ];
在代碼中通過以下方式使用:
$primaryConnection = \Yii::$app->db; $secondaryConnection = \Yii::$app->secondDb;
如果不想定義數據庫連接為全局應用組件,可以在代碼中直接初始化使用:
$connection = new \yii\db\Connection([ 'dsn' => $dsn, 'username' => $username, 'password' => $password, ]); $connection->open();
小提示:如果在創建了連接後需要執行額外的 SQL 查詢,可以添加以下代碼到應用配置文件:
return [ // ... 'components' => [ // ... 'db' => [ 'class' => 'yii\db\Connection', // ... 'on afterOpen' => function($event) { $event->sender->createCommand("SET time_zone = 'UTC'")->execute(); } ], ], // ... ];
如果執行 SQL 不返回任何數據可使用命令中的 execute 方法:
$command = $connection->createCommand('UPDATE post SET status=1 WHERE id=1'); $command->execute();
你可以使用insert,update,delete 方法,這些方法會根據參數生成合適的SQL並執行.
// INSERT $connection->createCommand()->insert('user', [ 'name' => 'Sam', 'age' => 30, ])->execute(); // INSERT 一次插入多行 $connection->createCommand()->batchInsert('user', ['name', 'age'], [ ['Tom', 30], ['Jane', 20], ['Linda', 25], ])->execute(); // UPDATE $connection->createCommand()->update('user', ['status' => 1], 'age > 30')->execute(); // DELETE $connection->createCommand()->delete('user', 'status = 0')->execute();
引用的表名和列名
大多數時間都使用以下語法來安全地引用表名和列名:
$sql = "SELECT COUNT($column) FROM {{table}}"; $rowCount = $connection->createCommand($sql)->queryScalar();
以上代碼$column 會轉變為引用恰當的列名,而{{table}} 就轉變為引用恰當的表名。 表名有個特殊的變量 {{%Y}} ,如果設置了表前綴使用該變體可以自動在表名前添加前綴:
$sql = "SELECT COUNT($column) FROM {{%$table}}"; $rowCount = $connection->createCommand($sql)->queryScalar();
如果在配置文件如下設置了表前綴,以上代碼將在 tbl_table 這個表查詢結果:
return [ // ... 'components' => [ // ... 'db' => [ // ... 'tablePrefix' => 'tbl_', ], ], ];
手工引用表名和列名的另一個選擇是使用yii\db\Connection::quoteTableName() 和 yii\db\Connection::quoteColumnName():
$column = $connection->quoteColumnName($column); $table = $connection->quoteTableName($table); $sql = "SELECT COUNT($column) FROM $table"; $rowCount = $connection->createCommand($sql)->queryScalar();
預處理語句
為安全傳遞查詢參數可以使用預處理語句,首先應當使用:placeholder占位,再將變量綁定到對應占位符:
$command = $connection->createCommand('SELECT * FROM post WHERE id=:id'); $command->bindValue(':id', $_GET['id']); $post = $command->query();
另一種用法是准備一次預處理語句而執行多次查詢:
$command = $connection->createCommand('DELETE FROM post WHERE id=:id'); $command->bindParam(':id', $id); $id = 1; $command->execute(); $id = 2; $command->execute();
提示,在執行前綁定變量,然後在每個執行中改變變量的值(一般用在循環中)比較高效.
事務
當你需要順序執行多個相關的的query時,你可以把他們封裝到一個事務中去保護數據一致性.Yii提供了一個簡單的接口來實現事務操作. 如下執行 SQL 事務查詢語句:
$transaction = $connection->beginTransaction(); try { $connection->createCommand($sql1)->execute(); $connection->createCommand($sql2)->execute(); // ... 執行其他 SQL 語句 ... $transaction->commit(); } catch(Exception $e) { $transaction->rollBack(); }
我們通過yii\db\Connection::beginTransaction()開始一個事務,通過try catch 捕獲異常.當執行成功,通過yii\db\Transaction::commit()提交事務並結束,當發生異常失敗通過yii\db\Transaction::rollBack()進行事務回滾.
如需要也可以嵌套多個事務:
// 外部事務 $transaction1 = $connection->beginTransaction(); try { $connection->createCommand($sql1)->execute(); // 內部事務 $transaction2 = $connection->beginTransaction(); try { $connection->createCommand($sql2)->execute(); $transaction2->commit(); } catch (Exception $e) { $transaction2->rollBack(); } $transaction1->commit(); } catch (Exception $e) { $transaction1->rollBack(); }
注意你使用的數據庫必須支持Savepoints才能正確地執行,以上代碼在所有關系數據中都可以執行,但是只有支持Savepoints才能保證安全性。
Yii 也支持為事務設置隔離級別isolation levels,當執行事務時會使用數據庫默認的隔離級別,你也可以為事物指定隔離級別. Yii 提供了以下常量作為常用的隔離級別
你可以使用以上常量或者使用一個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_(database_systems)#Isolation_levels
數據庫復制和讀寫分離
很多數據庫支持數據庫復制 http://en.wikipedia.org/wiki/Replication_(computing)#Database_replication">database replication來提高可用性和響應速度. 在數據庫復制中,數據總是從主服務器 到 從服務器. 所有的插入和更新等寫操作在主服務器執行,而讀操作在從服務器執行.
通過配置yii\db\Connection可以實現數據庫復制和讀寫分離.
[ 'class' => 'yii\db\Connection', // 配置主服務器 'dsn' => 'dsn for master server', 'username' => 'master', 'password' => '', // 配置從服務器 'slaveConfig' => [ 'username' => 'slave', 'password' => '', 'attributes' => [ // use a smaller connection timeout PDO::ATTR_TIMEOUT => 10, ], ], // 配置從服務器組 'slaves' => [ ['dsn' => 'dsn for slave server 1'], ['dsn' => 'dsn for slave server 2'], ['dsn' => 'dsn for slave server 3'], ['dsn' => 'dsn for slave server 4'], ], ]
以上的配置實現了一主多從的結構,從服務器用以執行讀查詢,主服務器執行寫入查詢,讀寫分離的功能由後台代碼自動完成.調用者無須關心.例如:
// 使用以上配置創建數據庫連接對象 $db = Yii::createObject($config); // 通過從服務器執行查詢操作 $rows = $db->createCommand('SELECT * FROM user LIMIT 10')->queryAll(); // 通過主服務器執行更新操作 $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來記住那些不能連接的從服務器,使Yii 在一段時間[[yii\db\Connection::serverRetryInterval].內不會重復嘗試連接那些根本不可用的從服務器.
注意:在上述配置中,每個從服務器連接超時時間被指定為10s. 如果在10s內不能連接,則被認為該服務器已經掛掉.你也可以自定義超時參數.
你也可以配置多主多從的結構,例如:
[ 'class' => 'yii\db\Connection', // 配置主服務器 'masterConfig' => [ 'username' => 'master', 'password' => '', 'attributes' => [ // use a smaller connection timeout PDO::ATTR_TIMEOUT => 10, ], ], // 配置主服務器組 'masters' => [ ['dsn' => 'dsn for master server 1'], ['dsn' => 'dsn for master server 2'], ], // 配置從服務器 'slaveConfig' => [ 'username' => 'slave', 'password' => '', 'attributes' => [ // use a smaller connection timeout PDO::ATTR_TIMEOUT => 10, ], ], // 配置從服務器組 'slaves' => [ ['dsn' => 'dsn for slave server 1'], ['dsn' => 'dsn for slave server 2'], ['dsn' => 'dsn for slave server 3'], ['dsn' => 'dsn for slave server 4'], ], ]
上述配置制定了2個主服務器和4個從服務器.Connection組件也支持主服務器的負載均衡和故障轉移,與從服務器不同的是,如果所有主服務器都不可用,則會拋出異常.
注意:當你使用yii\db\Connection::masters來配置一個或多個主服務器時,Connection中關於數據庫連接的其他屬性(例如:dsn,username, password)都會被忽略.
事務默認使用主服務器的連接,並且在事務執行中的所有操作都會使用主服務器的連接,例如:
// 在主服務器連接上開始事務 $transaction = $db->beginTransaction(); try { // 所有的查詢都在主服務器上執行 $rows = $db->createCommand('SELECT * FROM user LIMIT 10')->queryAll(); $db->createCommand("UPDATE user SET username='demo' WHERE id=1")->execute(); $transaction->commit(); } catch(\Exception $e) { $transaction->rollBack(); throw $e; }
如果你想在從服務器上執行事務操作則必須要明確地指定,比如:
$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信息:
$schema = $connection->getSchema();
該實例包括一系列方法來檢索數據庫多方面的信息:
$tables = $schema->getTableNames();
更多信息請參考yii\db\Schema
修改模式
除了基礎的 SQL 查詢,yii\db\Command還包括一系列方法來修改數據庫模式:
使用示例:
// 創建表 $connection->createCommand()->createTable('post', [ 'id' => 'pk', 'title' => 'string', 'text' => 'text', ]);
完整參考請查看yii\db\Command.
SQL查詢示例:
// find the customers whose primary key value is 10 $customers = Customer::findAll(10); $customer = Customer::findOne(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]); $customers = Customer::find()->where(['IN','id',[10,11,12]])->all(); // 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(); // use params binding $customers = Customer::find()->where('age=:age AND status=:status')->addParams([':age'=>30,':status'=>1])->all(); // use index $customers = Customer::find()->indexBy('id')->where(['age' => 30, 'status' => 1])->all(); // get customers count $count = Customer::find()->where(['age' => 30, 'status' => 1])->count(); // add addition condition $customers = Customer::find()->where(['age' => 30, 'status' => 1])->andWhere('score > 100')->orderBy('id DESC')->offset(5)->limit(10)->all(); // find by sql $customers = Customer::findBySql('SELECT * FROM customer WHERE age=30 AND status=1 AND score>100 ORDER BY id DESC LIMIT 5,10')->all();
修改:
// update status for customer-10 $customer = Customer::findOne(10); $customer->status = 1; $customer->update(); // the above code is equivalent to: Customer::updateAll(['status' => 1], 'id = :id',[':id'=>10]);
刪除:
// delete customer-10 Customer::findOne(10)->delete(); // the above code is equivalent to: Customer::deleteAll(['status' => 1], 'id = :id',[':id'=>10]);
--------------------------------使用子查詢------------------------------------------
$subQuery = (new Query())->select('COUNT(*)')->from('customer'); // SELECT `id`, (SELECT COUNT(*) FROM `customer`) AS `count` FROM `customer` $query = (new Query())->select(['id', 'count' => $subQuery])->from('customer');
--------------------------------手寫SQL-------------------------------------------
// select $customers = Yii::$app->db->createCommand('SELECT * FROM customer')->queryAll(); // update Yii::$app->db->createCommand()->update('customer',['status'=>1],'id=10')->execute(); // delete Yii::$app->db->createCommand()->delete('customer','id=10')->execute(); //transaction // outer $transaction1 = $connection->beginTransaction(); try { $connection->createCommand($sql1)->execute(); // internal $transaction2 = $connection->beginTransaction(); try { $connection->createCommand($sql2)->execute(); $transaction2->commit(); } catch (Exception $e) { $transaction2->rollBack(); } $transaction1->commit(); } catch (Exception $e) { $transaction1->rollBack(); }
-----------------------------主從配置--------------------------------------------
[ 'class' => 'yii\db\Connection', // master 'dsn' => 'dsn for master server', 'username' => 'master', 'password' => '', // slaves 'slaveConfig' => [ 'username' => 'slave', 'password' => '', 'attributes' => [ // use a smaller connection timeout PDO::ATTR_TIMEOUT => 10, ], ], 'slaves' => [ ['dsn' => 'dsn for slave server 1'], ['dsn' => 'dsn for slave server 2'], ['dsn' => 'dsn for slave server 3'], ['dsn' => 'dsn for slave server 4'], ], ]