MySQLなどのリレーショナルデータベースの知識があれば、Laravelをデータベースと接続し、データベースとのやり取りをPHPから簡単に行うことができます。 今回はLaravelのデータベース接続設定を行い、データベースをLaravelフレームワークから利用するための準備までを行います。

Laravelのデータベース接続設定

1年以内に更新されました。
更新日 : 2019年07月10日

MySQLなどのリレーショナルデータベースの知識があれば、Laravelをデータベースと接続し、データベースとのやり取りをPHPから簡単に行うことができます。

今回はLaravelのデータベース接続設定を行い、データベースをLaravelフレームワークから利用するための準備までを行います。

データベース接続設定

今回はMySQLを接続できるような設定を行っていきます。

データベースの接続設定専用のファイルがLaravelには存在します。そのファイルがconfig/database.phpファイルです。このファイルの中身を見ていきます。

<?php

use Illuminate\Support\Str;

return [

    /*
    |--------------------------------------------------------------------------
    | Default Database Connection Name
    |--------------------------------------------------------------------------
    |
    | Here you may specify which of the database connections below you wish
    | to use as your default connection for all database work. Of course
    | you may use many connections at once using the Database library.
    |
    */

    'default' => env('DB_CONNECTION', 'mysql'),

    /*
    |--------------------------------------------------------------------------
    | Database Connections
    |--------------------------------------------------------------------------
    |
    | Here are each of the database connections setup for your application.
    | Of course, examples of configuring each database platform that is
    | supported by Laravel is shown below to make development simple.
    |
    |
    | All database work in Laravel is done through the PHP PDO facilities
    | so make sure you have the driver for your particular database of
    | choice installed on your machine before you begin development.
    |
    */

    'connections' => [

        'sqlite' => [
            'driver' => 'sqlite',
            'url' => env('DATABASE_URL'),
            'database' => env('DB_DATABASE', database_path('database.sqlite')),
            'prefix' => '',
            'foreign_key_constraints' => env('DB_FOREIGN_KEYS', true),
        ],

        'mysql' => [
            'driver' => 'mysql',
            'url' => env('DATABASE_URL'),
            'host' => env('DB_HOST', '127.0.0.1'),
            'port' => env('DB_PORT', '3306'),
            'database' => env('DB_DATABASE', 'forge'),
            'username' => env('DB_USERNAME', 'forge'),
            'password' => env('DB_PASSWORD', ''),
            'unix_socket' => env('DB_SOCKET', ''),
            'charset' => 'utf8mb4',
            'collation' => 'utf8mb4_unicode_ci',
            'prefix' => '',
            'prefix_indexes' => true,
            'strict' => true,
            'engine' => null,
            'options' => extension_loaded('pdo_mysql') ? array_filter([
                PDO::MYSQL_ATTR_SSL_CA => env('MYSQL_ATTR_SSL_CA'),
            ]) : [],
        ],

        'pgsql' => [
            'driver' => 'pgsql',
            'url' => env('DATABASE_URL'),
            'host' => env('DB_HOST', '127.0.0.1'),
            'port' => env('DB_PORT', '5432'),
            'database' => env('DB_DATABASE', 'forge'),
            'username' => env('DB_USERNAME', 'forge'),
            'password' => env('DB_PASSWORD', ''),
            'charset' => 'utf8',
            'prefix' => '',
            'prefix_indexes' => true,
            'schema' => 'public',
            'sslmode' => 'prefer',
        ],

        'sqlsrv' => [
            'driver' => 'sqlsrv',
            'url' => env('DATABASE_URL'),
            'host' => env('DB_HOST', 'localhost'),
            'port' => env('DB_PORT', '1433'),
            'database' => env('DB_DATABASE', 'forge'),
            'username' => env('DB_USERNAME', 'forge'),
            'password' => env('DB_PASSWORD', ''),
            'charset' => 'utf8',
            'prefix' => '',
            'prefix_indexes' => true,
        ],

    ],
…

実際はさらに続きますがこのようになっているかと思います。

このファイルはよく見るとただの大きなPHPの連想配列になっていることがわかります。

いくつかのキー名を見ていきましょう。

  • 'default' => env('DB_CONNECTION', 'mysql')
    defaultキーで、どんなデータベースソフトを使うかを指定しています。デフォルトではMySQLを利用する設定になっています。
  • 'connections' => [...]
    connectionsキーではそれぞれのデータベースソフトの接続設定が記載されています。この部分のmysql接続設定を設定すればMySQLへ接続することができます。

LaravelのデフォルトのデータベースはMySQLとなっているので、connectionsキーのmysql項目を編集すれば接続設定が反映されます。この項目だけを抽出して見ていきましょう。

'mysql' => [
	'driver' => 'mysql',
	'url' => env('DATABASE_URL'),
	'host' => env('DB_HOST', '127.0.0.1'),
	'port' => env('DB_PORT', '3306'),
	'database' => env('DB_DATABASE', 'forge'),
	'username' => env('DB_USERNAME', 'forge'),
	'password' => env('DB_PASSWORD', ''),
	'unix_socket' => env('DB_SOCKET', ''),
	'charset' => 'utf8mb4',
	'collation' => 'utf8mb4_unicode_ci',
	'prefix' => '',
	'prefix_indexes' => true,
	'strict' => true,
	'engine' => null,
	'options' => extension_loaded('pdo_mysql') ? array_filter([
		PDO::MYSQL_ATTR_SSL_CA => env('MYSQL_ATTR_SSL_CA'),
	]) : [],
]

いくつかの接続するための設定がありますが、最重要はhostportdatabaseusernamepasswordです。

これらの項目を見ていくと、env('DB_HOST', '127.0.0.1')のようになっているかと思います。

このenv関数で利用されているのがphpdotenvライブラリです。

phpdotenvライブラリ

Laravelではphpdotenvというライブラリを利用しています。

これはプロジェクト内にある.envファイルに設定値を書き込んで、PHP内で書き込んだ設定値を読み込むことができるライブラリです。

Laravelではこのphpdotenvライブラリを簡単に扱うためのヘルパ関数が用意されています。

つまり、env(設定キー, デフォルト値)というふうに使うことで、.envファイルに設定キーが設定されていれば.envから設定を読み込みます。設定キーが存在しなかった場合にはデフォルト値が利用されます。

そのため、env('DB_HOST', '127.0.0.1')という項目では、.envファイルにDB_HOSTという設定値が設定されていればその設定値を読み込み、設定されていなければ'127.0.0.1'が使用されます。

今回database.phpで設定する設定値はすべてこのenvヘルパ関数が利用されているため、.envファイルを編集して設定値を変更していきましょう。

.envファイルの編集

.envファイルの中を見ていきましょう。プロジェクトフォルダの直下にあるはずです。ない場合には.env.exampleファイルからコピーして.envというファイル名に変更しましょう。

APP_NAME=Laravel
APP_ENV=local
APP_KEY=?????????????????????????
APP_DEBUG=true
APP_URL=http://localhost

LOG_CHANNEL=stack

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=homestead
DB_USERNAME=homestead
DB_PASSWORD=secret

BROADCAST_DRIVER=log
CACHE_DRIVER=file
QUEUE_CONNECTION=sync
SESSION_DRIVER=file
SESSION_LIFETIME=120

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

MAIL_DRIVER=smtp
MAIL_HOST=smtp.mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null

AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=

PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=
PUSHER_APP_CLUSTER=mt1

MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

たくさんの項目がありますが、上の方にDB_HOSTなどのdatabase.php内で存在していたキー名があるかと思います。これらのキー名(DB_HOSTDB_PORTDB_DATABASEDB_USERNAMEDB_PASSWORD)に対応する値(=の右側)を、接続したいデータベースの情報に変更して保存しておきましょう。

変更して保存したら、database.phpが読み込まれる際に、自動で設定が反映されます。

まとめ

以上でDBの接続設定は完了です。.envファイルを編集することで、Laravelアプリケーション全体の設定をほぼ網羅できます。

次の記事でDBの接続がうまく行っているか確認をしてみましょう。