CakePHP3で生の SQLの実行はConnectionManagerを使う
2018/08/08
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文を実行する方法は、以下のようになります。
1 2 3 4 |
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文の場合は下記の様になります。
1 2 3 4 |
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文をプリペアードステートメントを用いて書き直すと下記の様になります。
1 2 3 4 5 6 7 8 9 |
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構文を、プリペアードステートメントを利用して実行しようとすると、下記の様になります。
1 2 3 4 5 6 7 8 9 |
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文を実行してエラーになったとき、どのようなエラーなのかを確認するため、エラーログを取得する場合は下記のような記述を行います。
1 2 3 4 5 6 |
try { $tableObjectConnection->execute($insertSql); } catch (\Cake\ORM\Exception\PersistenceFailedException $e) { echo $e; echo $e->getEntity(); } |
詳しい使い方は「CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説」に記事を書いていますので、そちらも参照してください。
CakePHP3の関連記事
CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説CakePHP3のキャッシュをクリアする方法「bin/cake cache clear_all」を使う
CakePHP3のルーティング(routes.php)の変更が反映されない時はキャッシュのクリアを
Google Analytics APIを CakePHP3で動かしてレポートデータを取得する方法の解説
CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法
CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い
CakePHP3で生の SQLの実行はConnectionManagerを使う
CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説
CakePHP3のデバッグキット(DebugKit)を強制的に有効、無効に変更する方法
CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法
その他の「CakePHP3」に関する記事一覧
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
CakePHP3のCakeDC/Usersのログイン後のリダイレクトを設定解説
CakeDC謹製Usersプラグインの紹介。ログイン認証後にリダイレクトする先の設定方法についての解説と実運用するために必要なコツを解説。便利な仕組みも仕様の理解があって初めてうまく使いこなせる。
-
-
CakePHP 2.3で saveの便利な使い方・サンプルソース付き
CakePHPのレコードを保存、更新する際に使う Saveを詳細解説します。
-
-
CakePHPを学ぶ際にはオブジェクト指向を学ぼう
CakePHPはオブジェクト指向で書かれていますので、CakePHPを学ぶにはオブジェクト指向も学びましょう。
-
-
CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その2
CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその2でバリデーションなどの実用的なカスタマイズ方法を解説。
-
-
CakePHP3で値を入力直後にバリデーションする方法解説
CakePHP3でバリデーションの実行を保存する時から入力情報を受け取るときに変更する処理の解説。CakePHP3ではnewEntity()の処理でバリデートするため1行追加で対応可能。
-
-
CakePHP 2.3 Search Pluginで検索処理 その3入力エリア一つで複数の項目を同時に検索する方法
CakePHPの検索プラグイン Search Pluginの検索処理の中で入力エリア一つで複数の項目を同時に検索する方法を解説。
-
-
CakePHP 2.3 Search Pluginで検索処理 その2表示件数を動的に変える方法
CakePHPの検索プラグイン Search Pluginの検索処理の中で動的に表示件数を変える方法です。
-
-
CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法
CakePHP3でPHPExcelを利用してエクセルを編集、出力するサンプルソース+解説。PHPExcelのインストール方法の解説からファイル保存とダウンロードの方法なども解説。
-
-
CakePHP3のメール送信の処理・テンプレート使用・添付ファイル送信も解説
CakePHP3からメールを送信する方法解説。基本的な記述方法を基にして、テンプレートを使う方法、ファイルを添付する方法へと拡張しながら解説。
-
-
CakePHP 2.3 Search Pluginで検索処理 その4前方一致検索、後方一致検索、不等号による検索、between句による範囲検索
CakePHPの検索プラグイン Search Pluginの検索処理の中で前方一致検索、後方一致検索、不等号による検索、between句による範囲検索の解説です。