CakePHP3で生の SQLの実行はConnectionManagerを使う

CakePHP3でクリエビルダーを使わず生の SQL文を実行する方法を解説

CakePHP3で生の SQL文を実行する方法を解説

　
CakePHP3で直接 SQL文を実行する方法を解説します。
　
【参考サイト】CookBook　データベースの基本
https://book.cakephp.org/3.0/ja/orm/database-basics.html
　
CakePHP3において、直接 SQL文を実行する方法は、上記の CakePHP3の Cookbookにも書いてあるのですが、非常に簡単で、データベースにアクセスする方法としては基本形のようです。
　
　
ただ、CakePHP3のようなフレームワークを使う理由は、SQL文を作成しなくても簡単にデータベースにアクセスできるから、といったこともあるワケですが、より簡単にアクセスするには、クエリービルダーを利用します。
　
【参考サイト】CookBook　クエリービルダー
https://book.cakephp.org/3.0/ja/orm/database-basics.html
　
　
今回の記事は、クエリービルダーでは対応できないデータベースへのアクセスを、SQL文を作成して対応する方法を解説します。
　

　

CakePHP3で生の SQL文を実行する方法・基本形

　
生の SQL文を実行する方法は、以下のようになります。
　

use Cake\Datasource\ConnectionManager;
 
$connection = ConnectionManager::get('default');
$results = $connection->execute('SELECT * FROM articles')->fetchAll('assoc');

　
クリエービルダーを使ってデータベースにアクセスするときは「use Cake\ORM\TableRegistry;」を使いますが、生の SQL文を実行するときは「use Cake\Datasource\ConnectionManager;」を記述します。
　
　
「ConnectionManager::get('default');」の「default」は、データベース名、テーブル名などではないことには注意が必要です。
　
この「default」は、データベースの接続設定です。
　
「/config/app.php」にデータベースに関する設定項目として「Datasources」があり、その中で「default」「test」の設定を記述しているかと思います。
　
この「default」を使います、という指定です。
　
逆に言うと、1つの処理の流れの中で、「default」で設定しているデータベースではないデータベースに接続して処理をしたい場合には、「default」とは違うデータベースへの接続設定を作成し、この「ConnectionManager」を利用して接続できます。
　
　

CakePHP3で生の SQL文を実行する方法・INSERT文、UPDATE文、DELETE文

　
前項で紹介したのは SELECT文ですが、INSERT文、UPDATE文、DELETE文でも同じです。
　
INSERT文の場合は下記の様になります。
　

use Cake\Datasource\ConnectionManager;
 
$connection = ConnectionManager::get('default');
$connection->execute('INSERT INTO articles (col_1, col_2, col_3) value ("aaa", "bbb", "ccc")');

　
上記と同じように SQL文を UPDATE文、DELETE文に変えることでその処理を実行することができます。
　
　

CakePHP3で生の SQL文を実行する方法・プリペアードステートメントを利用する方法

　
続いて、プリペアードステートメントを使って SQL文の処理を行う場合の解説を行います。
　
前項で解説した、INSERT文をプリペアードステートメントを用いて書き直すと下記の様になります。
　

use Cake\Datasource\ConnectionManager;
 
$connection = ConnectionManager::get('default');
// INSERTの SQL文を生成
$insertSql   = 'INSERT INTO articles (col_1, col_2, col_3) value (?, ?, ?)';
// INSERTする値を配列として作成
$insertArray = ["aaa", "bbb", "ccc"];
// SQL文の実行
$connection->execute($insertSql, $insertArray);

　
上記のソース中にコメントを書いていますので問題ないかと思いますが、SQL文と値となる配列を別々に作成し、「$connection->execute()」の引数として記述するだけです。
　

　

CakePHP3で Insert On Duplicate Key Update構文を利用する

　
今回、私が生の SQL文を実行する必要があった理由は、Insert On Duplicate Key Update構文を使用するためでした。
　
CakePHP3ではクリエビルダーを使って Insert On Duplicate Key Update構文を実行する方法が分からず、生の SQL文を書いて Insert On Duplicate Key Update構文を実行しようとしたため、今回の生の SQL文を実行する方法が必要でした。
　
Insert On Duplicate Key Update構文を、プリペアードステートメントを利用して実行しようとすると、下記の様になります。
　

use Cake\Datasource\ConnectionManager;
 
// INSERTの SQL文を生成
$insertSql   = 'INSERT INTO articles (col_1, col_2, col_3) value (?, ?, ?)
                ON DUPLICATE KEY UPDATE col_1 = ?,col_2 = ?,col_3 = ?';
// INSERTする値を配列として作成
$insertArray = ["aaa", "bbb", "ccc", "aaa", "bbb", "ccc"];
// SQL文の実行
$connection->execute($insertSql, $insertArray);

　
　
CakePHP2で開発しているときも同じ必要性があったのですが、その時も生の SQL文を実行する方法で対処しています。
その時に書いた記事が下記にあります。
　
Insert On Duplicate Key Update構文の使い方
CakePHP 2.3でOn Duplicate Key構文を実装
　
　

SQL文を実行したときのエラーログを取得する方法

　
今回の記事の趣旨とは違いますが、CakePHP3で SQL文を実行してエラーになったとき、どのようなエラーなのかを確認するため、エラーログを取得する場合は下記のような記述を行います。
　

try {
	$tableObjectConnection->execute($insertSql);
} catch (\Cake\ORM\Exception\PersistenceFailedException $e) {
	echo $e;
	echo $e->getEntity();
}

　
詳しい使い方は「CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説」に記事を書いていますので、そちらも参照してください。
　
　

CakePHP3の関連記事