[Laravel] Laravelで接続先チェックしたいとき

Tech

※ 本記事はアフィリエイト広告(Amazonアソシエイト)を含みます。

[Laravel] Laravelで接続先チェックしたいとき

あまり遭遇したくはないものの、一応チェックしておくべきなので。

「ステージングのつもりで本番DBを見ていた」「.env を直したのに古いDBにつながっている」——どちらも、今どこにつながっているかを確認すれば一発で分かります。

tinker で確認する

php artisan tinker

起動したら、この2つを打ちます。

DB::connection()->getConfig();
DB::connection()->getPdo();
コマンド分かること
getConfig()Laravel が使おうとしている接続設定(host・database・username など)の配列
getPdo()実際に接続できるか。成功すれば PDO オブジェクト、失敗すれば例外とエラーメッセージ

getConfig() で設定の中身を見て、getPdo() で本当につながるかを試す。この順番で見ると、「設定が違う」のか「設定は合っているのに届かない」のかを切り分けられます。

ほかにも、ピンポイントで見たいときはこのあたり。

DB::connection()->getDatabaseName();     // 接続先のDB名
config('database.default');              // デフォルト接続名(mysql など)
config('database.connections.mysql.host');

tinker 便利だなーって。

.env がちゃんと読めていないとき

getConfig() の結果が .env と違う場合、たいていは設定キャッシュが原因です。

php artisan config:clear

キャッシュ類をまとめて消すなら optimize:clear。

php artisan optimize:clear

⚠️ 逆に php artisan config:cache(や optimize)を実行すると、その時点の設定が固定されて、以降 .env を書き換えても反映されなくなります。本番デプロイ用のコマンドなので、開発中に「直したのに変わらない」となったらまずこれを疑う。

コマンド一発で確認する

比較的新しい Laravel(9 系の途中以降)なら、tinker を開かなくても確認できます。

php artisan db:show     # 接続先・DBのバージョン・テーブル数など
php artisan about       # 環境や、設定がキャッシュされているかどうか

about の出力に「Config: CACHED」と出ていたら、上の設定キャッシュが効いている状態です。

Docker 環境の場合

Docker で動かしているなら、確認もコンテナの中で。

docker compose exec app php artisan tinker

ホスト側で実行すると、ホストの PHP とホストから見た接続先で動いてしまい、まったく別の結果になります。DB_HOST の考え方はdocker-compose.yml の記載に合わせてなかったから接続できなかったに書きました。

まとめ

  • getConfig() で設定を見て、getPdo() で実際につながるかを試す
  • .env と違う → php artisan config:clear(まとめて消すなら optimize:clear)
  • 新しめの Laravel なら db:show / about が手軽
  • Docker ならコンテナの中で実行する

Laravel, php