Yii2 データベースの読み書き分離構成例

データベースの使用を開始するには、まずデータベース接続コンポーネントを構成する必要があります。これは、アプリケーション構成に db コンポーネントを追加することで実現されます (「基本」Web アプリケーションは config/web.PHP (データ ソース名))。以下に示すように、データベース情報を指定するために使用されるデータ ソース名です。 DSN 形式の詳細については、PHP マニュアルを参照してください。 接続コンポーネントを設定した後、次の構文を使用してアクセスできます:

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',
    ],
  ],
  // ...
];

設定可能なプロパティのリストについては、[[yiidbConnection]] を参照してください。 ODBC 経由でデータベースに接続する場合は、[[yiidbConnection::driverName]] 属性を設定する必要があります。例:

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

注: 複数のデータベースを同時に使用する必要がある場合は、複数の接続コンポーネントを定義できます:

'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;

ヒント: 接続後に追加の SQL クエリを実行する必要がある場合は、アプリケーション構成ファイルに次のコードを追加できます:

$connection = new \yii\db\Connection([
  'dsn' => $dsn,
   'username' => $username,
   'password' => $password,
]);
$connection->open();

SQL 基本クエリ

接続インスタンスを取得したら、[[yiidbCommand]] を通じて SQL クエリを実行できます。

SELECTクエリ

クエリは複数の行を返します:

return [
  // ...
  'components' => [
    // ...
    'db' => [
      'class' => 'yii\db\Connection',
      // ...
      'on afterOpen' => function($event) {
        $event->sender->createCommand("SET time_zone = 'UTC'")->execute();
      }
    ],
  ],
  // ...
];

単一の行を返します:

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

単一の値で複数の行をクエリします:

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

クエリスカラー値/計算値:

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

UPDATE、INSERT、DELETE更新、挿入と削除など

SQLを実行してもデータが返されない場合は、コマンドでexecuteメソッドを使用できます:

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

パラメータに基づいて適切な SQL を生成し、実行する挿入、更新、削除メソッドを使用できます。

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

参照されるテーブル名と列名

ほとんどの場合、テーブル名と列名が参照されます。次の構文を安全に使用してください:

// 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();

上記のコード [[$column]] は適切な列名を参照するように変換され、{{table}} は適切なテーブル名を参照するように変換されます。 テーブル名には特別な変数 {{%Y}} が含まれています。テーブル接頭辞が設定されている場合は、このバリアントを使用してテーブル名の前に接頭辞を自動的に追加します:

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

テーブル接頭辞が構成ファイルに次のように設定します。上記のコードは、tbl_table のこのテーブルに対するクエリ結果を返します。 [[yiidbConnection::quoteColumnName()]]:

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

ステートメントの前処理

クエリ パラメーターを安全に渡すには、まず、prepared ステートメントを使用します。プレースホルダー プレースホルダーを使用してから、変数をバインドします。対応するプレースホルダーに追加します:

return [
  // ...
  'components' => [
    // ...
    'db' => [
      // ...
      'tablePrefix' => 'tbl_',
    ],
  ],
];

別の使用法は、プリペアドステートメントを一度準備して複数のクエリを実行することです:

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

ヒント: 実行前に変数をバインドし、それぞれの変数の値を変更します。実行 (通常はループで使用) 比較 効率的です。

トランザクション

複数の関連するクエリを順番に実行する必要がある場合、データの一貫性を保護するためにそれらをトランザクションにカプセル化することができます。Yii はトランザクション操作を実装するためのシンプルなインターフェースを提供します。次のように SQL トランザクション クエリ ステートメントを実行します。

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

[[yiidbConnection::beginTransaction()|beginTransaction()]] を通じてトランザクションを開始し、実行が成功した場合は try catch を通じて例外をキャッチします。 [[yiidbTransaction:: commit()|commit()]] はトランザクションをコミットして終了します。例外エラーが発生すると、トランザクションは [[yiidbTransaction::rollBack()|rollBack()]] を通じてロールバックされます。必要に応じて複数のトランザクションをネストできます:

$command = $connection->createCommand('DELETE FROM post WHERE id=:id');
$command->bindParam(':id', $id);

$id = 1;
$command->execute();

$id = 2;
$command->execute();

正しく実行するには、使用するデータベースがセーブポイントをサポートしている必要があることに注意してください。上記のコードはすべてのリレーショナル データで実行できますが、セキュリティはセーブポイントをサポートすることによってのみ保証されます。

Yii は、トランザクションの実行時に、データベースのデフォルトの分離レベルを設定することもできます。Yii は、一般的に使用される分離レベルとして次の定数を指定することもできます。 [[yiidbTransaction ::READ_UNCOMMITTED]] - ダーティ リード、反復不可能な読み取り、ファントム リードにつながる可能性がある、変更されたコミットされていないデータの読み取りを許可します

[[yiidbTransaction::READ_COMMITTED]] - 同時トランザクションが送信された後の読み取りを許可します。繰り返しの読み取りやファントム読み取りにつながる可能性のあるダーティ リードを回避できます。

[[yiidbTransaction::REPEATABLE_READ]] - 同じフィールドの複数の読み取りでは一貫した結果が得られ、ファントム読み取りが発生する可能性があります。

[[yiidbTransaction::SERIALIZABLE]] - ACID 原則に完全に従って、ダーティ リード、反復不可能なリード、ファントム リードが発生しないようにします。

上記の定数を使用するか、文字列コマンドを使用して、対応するデータベースでコマンドを実行して分離レベルを設定できます。たとえば、postgres の有効なコマンドは SERIALIZABLE READ ONLY DEFERRABLE です。

注意:某些数据库只能针对连接来设置事务隔离级别，所以你必须要为连接明确制定隔离级别.目前受影响的数据库:MSSQL SQLite

注意:SQLite 只支持两种事务隔离级别，所以你只能设置READ UNCOMMITTED 和 SERIALIZABLE.使用其他隔离级别会抛出异常.

注意:PostgreSQL 不允许在事务开始前设置隔离级别，所以你不能在事务开始时指定隔离级别.你可以在事务开始之后调用[[yii\db\Transaction::setIsolationLevel()]] 来设置.

数据库复制和读写分离

很多数据库支持数据库复制 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|server status cache]]来记住那些不能连接的从服务器，使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|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',
]);

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持PHP中文网。

更多yii2 数据库读写分离配置示例相关文章请关注PHP中文网！