【決定版】CodeIgniterで複数のデータベースを繋ぐ3つの方法とサンプルコード

2024-07-03

CodeIgniterで複数のデータベースに接続する方法

複数データベース接続が必要となるケースとしては、以下のようなものが挙げられます。

異なるアプリケーションやシステム間でデータを共有する場合
読み込み専用のデータベースと書き込み専用のデータベースを別々に利用する場合
異なるデータベーススキーマを持つ複数のデータベースにアクセスする場合

複数のデータベース接続方法

CodeIgniterで複数のデータベースに接続するには、主に以下の2つの方法があります。

設定ファイルによる接続

これは、最も一般的な方法です。まず、application/config/database.php ファイルに、接続するそれぞれのデータベースの設定を追加します。以下の例は、db1 と db2 という2つのデータベースに接続する設定例です。

$db['db1'] = array(
   'dsn'   => 'mysql://user:password@host:port/dbname',
   'dbdriver' => 'mysqli',
   'active' => TRUE,
   'pconnect' => FALSE,
   'db_debug' => FALSE,
   'cache_on' => FALSE,
   'cache_dir' => '',
   'cache_ttl' => 0,
   'char_set' => 'utf8',
   'dbcollat' => 'utf8_general_ci',
   'swap_pre' => '',
   'auto_reconnect' => TRUE,
   'stricton' => FALSE,
);

$db['db2'] = array(
   'dsn'   => 'mysql://user:password@host:port/dbname',
   'dbdriver' => 'mysqli',
   'active' => FALSE,
   'pconnect' => FALSE,
   'db_debug' => FALSE,
   'cache_on' => FALSE,
   'cache_dir' => '',
   'cache_ttl' => 0,
   'char_set' => 'utf8',
   'dbcollat' => 'utf8_general_ci',
   'swap_pre' => '',
   'auto_reconnect' => TRUE,
   'stricton' => FALSE,
);

上記の例では、$db['db1'] がデフォルトの接続となり、$db['db2'] は別の接続として設定されています。

load->database() メソッドによる接続

この方法は、個別にデータベース接続オブジェクトを作成する場合に便利です。以下の例は、db2 というデータベースに接続するオブジェクトを作成する例です。

$this->load->database('db2', TRUE);
$db2 = $this->db;

上記の例では、$db2 変数に db2 データベースへの接続オブジェクトが格納されます。

具体的なデータベース操作

それぞれのデータベースに接続したら、通常の CodeIgniter のデータベース操作と同様に、クエリを実行したり、データを操作したりすることができます。

例：db1 データベースからデータを取得

$this->db->select('name, email')->from('users')->get()->result();

$data = array(
   'name' => 'Taro Yamada',
   'email' => '[email protected]'
);
$this->db->insert('users', $data);

注意事項

複数のデータベース接続を使用する場合は、接続ごとに適切なデータベースを選択するように注意する必要があります。
複数のデータベースで同じテーブル名を使用している場合は、テーブル名に接頭辞を付けるなどして区別する必要があります。
トランザクション処理は、同一のデータベース上でのみ実行できます。

複数のデータベース接続を実装する際には、データベースの負荷分散やセキュリティなどの点も考慮する必要があります。

CodeIgniterで複数のデータベースに接続するサンプルコード

// application/config/database.php

$db['db1'] = array(
   'dsn'   => 'mysql://user:password@host:port/dbname1',
   'dbdriver' => 'mysqli',
   'active' => TRUE,
   'pconnect' => FALSE,
   'db_debug' => FALSE,
   'cache_on' => FALSE,
   'cache_dir' => '',
   'cache_ttl' => 0,
   'char_set' => 'utf8',
   'dbcollat' => 'utf8_general_ci',
   'swap_pre' => '',
   'auto_reconnect' => TRUE,
   'stricton' => FALSE,
);

$db['db2'] = array(
   'dsn'   => 'mysql://user:password@host:port/dbname2',
   'dbdriver' => 'mysqli',
   'active' => FALSE,
   'pconnect' => FALSE,
   'db_debug' => FALSE,
   'cache_on' => FALSE,
   'cache_dir' => '',
   'cache_ttl' => 0,
   'char_set' => 'utf8',
   'dbcollat' => 'utf8_general_ci',
   'swap_pre' => '',
   'auto_reconnect' => TRUE,
   'stricton' => FALSE,
);

コントローラーでのデータベース操作

// application/controllers/MyController.php

class MyController extends CI_Controller {

   public function index() {
       // db1 データベースからデータを取得
       $this->db->select('name, email')->from('users')->get()->result();

       // db2 データベースにデータを挿入
       $data = array(
           'name' => 'Taro Yamada',
           'email' => '[email protected]'
       );
       $this->db->insert('users', $data);
   }
}

このコードでは、application/config/database.php ファイルに db1 と db2 という2つのデータベースの設定を追加しています。

そして、MyController クラスの index() メソッドでは、それぞれ以下の操作を行っています。

db1 データベースから users テーブルの name と email カラムの値を取得
db2 データベースの users テーブルに新しいレコードを挿入

上記はあくまでも一例であり、実際のアプリケーションでは、必要に応じてコードを修正する必要があります。

注意事項

上記のコードは、MySQL を使用していることを前提としています。他のデータベースを使用する場合は、接続設定を変更する必要があります。
トランザクション処理は、同一のデータベース上でのみ実行できます。複数のデータベースにまたがるトランザクションが必要な場合は、適切なライブラリやツールを使用する必要があります。

CodeIgniter で複数のデータベース接続を使用するには、様々な方法があります。上記以外にも、状況に応じて適切な方法を選択してください。

CodeIgniterで複数のデータベースに接続するその他の方法

Database() クラスを拡張して、独自の接続方法を実装することができます。この方法は、複雑な接続要件や、独自のデータベースライブラリを使用する場合に役立ちます。

サードパーティ製ライブラリの使用

CodeIgniter には、複数のデータベース接続を容易にするサードパーティ製ライブラリがいくつか用意されています。これらのライブラリは、追加機能や、複雑な接続シナリオを処理するためのサポートを提供することがあります。

ドライバーレベルでの接続

データベースドライバーレベルで接続を直接操作することもできます。これは、低レベルな制御が必要な場合や、CodeIgniter の組み込み接続機能では実現できない機能が必要な場合に役立ちます。

データベース抽象レイヤ (DAL) の使用

DAL を使用すると、データベース接続の複雑さを隠蔽し、アプリケーションコードをより簡潔にすることができます。DAL は、複数のデータベースとの接続を管理し、共通のインターフェースを提供することができます。

それぞれの方法の比較

方法	利点	欠点
設定ファイルによる接続	シンプルで使いやすい	複雑な接続要件には向いていない
`Database()` クラスの拡張	柔軟性が高い	開発と保守が複雑になる可能性がある
サードパーティ製ライブラリの使用	追加機能やサポートを利用できる	ライブラリに依存することになる
ドライバーレベルでの接続	低レベルな制御が可能	専門知識が必要
DAL の使用	コードを簡潔にできる	設定と設定が複雑になる可能性がある