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

2018/08/07 2019/03/02

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\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")');

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

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

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

try {

$tableObjectConnection->execute($insertSql);

} catch (\Cake\ORM\Exception\PersistenceFailedException $e) {

echo $e;

echo $e->getEntity();

}

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

- CakePHP 2.x　3.x CakePHP3

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP 2.3　ログイン、操作履歴、アクセスログ出力

CakePHPでログインや操作履歴などのアクセスログ出力処理を作成します。

: CakePHP3のCakeDC/UsersのUserHelperでログアウトやreCAPTCHAをカスタマイズ

CakeDC謹製Usersプラグインの紹介。UserHelperを利用し、ログアウトのリンクや権限があるときのみ表示されるリンク、プロフィールページへのリンク、reCAPTCHAの設置方法などを解説。

: CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可

CakePHP3のユーザ管理、ログイン認証プラグインである「CakeDC/Users」のメッセージを日本語にする手順の解説とともに、日本語の翻訳ファイルを提供。ファイルを設置すれば日本語になる！

: CakePHP 2.3でファイルをアップロード・その2　ファイル名を乱数で設定

CakePHPのアップロードするファイル名を乱数で変更しセキュリティを高める方法を解説。

: CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その３

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその3で記事を更新する際のファイルの取り回しなどについてを解説。

: cakephp3 カスタムバリデーションを簡易的に実装する方法

CakePHP3の独自のバリデーションをテーブルクラス内に簡単に記述する方法を解説。他のテーブルクラスでは使えないが、記述する量は少なく実装できるため、他で使わない処理を書くのには便利。

: CakePHP 2.3で PDFを作成する方法を調査「mpdf」「TCPDF」「FPDF」

CakePHPで PDFを編集、出力するには「mpdf」「TCPDF」「FPDF」といったプラグインがあり、使い勝手を比較検討しました。TCPDFが一番良さそうでした。

: CakePHP 2.x系　Viewでのコメントの記述方法など

CakePHPにおいて View、ctpファイルでコメントを記述する方法を解説。

: CakePHP 2.3　Search Pluginで検索処理　その４前方一致検索、後方一致検索、不等号による検索、between句による範囲検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で前方一致検索、後方一致検索、不等号による検索、between句による範囲検索の解説です。

: CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。

CakePHP3でajaxを利用する処理の実装方法を解説。プルダウンを変更するとデータベースの値を取得し検索結果の内容を変更するというような処理を想定。CakePHP3.6以降の CSRF対策対応済。