Store Sessions in a Database ¶

Configuring the Session Table and Column Names ¶

The table used to store sessions is called sessions by default and defines certain column names. You can configure these values with the second argument passed to the PdoSessionHandler service:

1
2
3
4
5
6
7
8

# config/services.yaml
services:
    # ...

    Symfony\Component\HttpFoundation\Session\Storage\Handler\PdoSessionHandler:
        arguments:
            - '%env(DATABASE_URL)%'
            - { db_table: 'customer_session', db_id_col: 'guid' }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

<!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <service id="Symfony\Component\HttpFoundation\Session\Storage\Handler\PdoSessionHandler" public="false">
            <argument>%env(DATABASE_URL)%</argument>
            <argument type="collection">
                <argument key="db_table">customer_session</argument>
                <argument key="db_id_col">guid</argument>
            </argument>
        </service>
    </services>
</container>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use Symfony\Component\HttpFoundation\Session\Storage\Handler\PdoSessionHandler;

return static function (ContainerConfigurator $container) {
    $services = $configurator->services();

    $services->set(PdoSessionHandler::class)
        ->args([
            env('DATABASE_URL'),
            ['db_table' => 'customer_session', 'db_id_col' => 'guid'],
        ])
    ;
};

These are parameters that you can configure:

db_table (default sessions):

The name of the session table in your database;

データベース内のセッション テーブルの名前。

db_username: (default: '')

The username used to connect when using the PDO configuration (when using the connection based on the DATABASE_URL env var, it overrides the username defined in the env var).

PDO 構成を使用するときに接続に使用されるユーザー名 (DATABASE_URL 環境変数に基づく接続を使用する場合、環境変数で定義されたユーザー名をオーバーライドします)。

db_password: (default: '')

The password used to connect when using the PDO configuration (when using the connection based on the DATABASE_URL env var, it overrides the password defined in the env var).

PDO 構成を使用するときに接続に使用されるパスワード (DATABASE_URL 環境変数に基づく接続を使用する場合、環境変数で定義されたパスワードをオーバーライドします)。

db_id_col (default sess_id):

The name of the column where to store the session ID (column type: VARCHAR(128));

セッション ID を格納する列の名前 (列の型: VARCHAR(128));

db_data_col (default sess_data):

The name of the column where to store the session data (column type: BLOB);

セッション データを格納する列の名前 (列の型: BLOB)。

db_time_col (default sess_time):

The name of the column where to store the session creation timestamp (column type: INTEGER);

セッション作成のタイムスタンプを格納する列の名前 (列の型: INTEGER)。

db_lifetime_col (default sess_lifetime):

The name of the column where to store the session lifetime (column type: INTEGER);

セッションの有効期間を格納する列の名前 (列の型: INTEGER)。

db_connection_options (default: [])

An array of driver-specific connection options;

ドライバー固有の接続オプションの配列。

lock_mode (default: LOCK_TRANSACTIONAL)

The strategy for locking the database to avoid race conditions. Possible values are LOCK_NONE (no locking), LOCK_ADVISORY (application-level locking) and LOCK_TRANSACTIONAL (row-level locking).

競合状態を回避するためにデータベースをロックするための戦略。可能な値は、LOCK_NONE (ロックなし)、LOCK_ADVISORY (アプリケーションレベルのロック)、および LOCK_TRANSACTIONAL (行レベルのロック) です。

Preparing the Database to Store Sessions ¶

Before storing sessions in the database, you must create the table that stores the information. The session handler provides a method called createTable() to set up this table for you according to the database engine used:

1
2
3
4
5

try {
    $sessionHandlerService->createTable();
} catch (\PDOException $exception) {
    // the table could not be created for some reason
}

If you prefer to set up the table yourself, it's recommended to generate an empty database migration with the following command:

1

$ php bin/console doctrine:migrations:generate

Then, find the appropriate SQL for your database below, add it to the migration file and run the migration with the following command:

1

$ php bin/console doctrine:migrations:migrate

1
2
3
4
5
6
7

CREATE TABLE `sessions` (
    `sess_id` VARBINARY(128) NOT NULL PRIMARY KEY,
    `sess_data` BLOB NOT NULL,
    `sess_lifetime` INTEGER UNSIGNED NOT NULL,
    `sess_time` INTEGER UNSIGNED NOT NULL,
    INDEX `sessions_sess_lifetime_idx` (`sess_lifetime`)
) COLLATE utf8mb4_bin, ENGINE = InnoDB;

1
2
3
4
5
6
7

CREATE TABLE sessions (
    sess_id VARCHAR(128) NOT NULL PRIMARY KEY,
    sess_data BYTEA NOT NULL,
    sess_lifetime INTEGER NOT NULL,
    sess_time INTEGER NOT NULL
);
CREATE INDEX sessions_sess_lifetime_idx ON sessions (sess_lifetime);

1
2
3
4
5
6
7

CREATE TABLE sessions (
    sess_id VARCHAR(128) NOT NULL PRIMARY KEY,
    sess_data NVARCHAR(MAX) NOT NULL,
    sess_lifetime INTEGER NOT NULL,
    sess_time INTEGER NOT NULL,
    INDEX sessions_sess_lifetime_idx (sess_lifetime)
);

Configuring the Session Field Names ¶

The collection used to store sessions defines certain field names. You can configure these values with the second argument passed to the MongoDbSessionHandler service:

1
2
3
4
5
6
7
8

# config/services.yaml
services:
    # ...

    Symfony\Component\HttpFoundation\Session\Storage\Handler\MongoDbSessionHandler:
        arguments:
            - '@doctrine_mongodb.odm.default_connection'
            - { id_field: '_guid', 'expiry_field': 'eol' }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

<!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <service id="Symfony\Component\HttpFoundation\Session\Storage\Handler\MongoDbSessionHandler" public="false">
            <argument type="service">doctrine_mongodb.odm.default_connection</argument>
            <argument type="collection">
                <argument key="id_field">_guid</argument>
                <argument key="expiry_field">eol</argument>
            </argument>
        </service>
    </services>
</container>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use Symfony\Component\HttpFoundation\Session\Storage\Handler\MongoDbSessionHandler;

return static function (ContainerConfigurator $container) {
    $services = $configurator->services();

    $services->set(MongoDbSessionHandler::class)
        ->args([
            service('doctrine_mongodb.odm.default_connection'),
            ['id_field' => '_guid', 'expiry_field' => 'eol'],
        ])
    ;
};

These are parameters that you can configure:

id_field (default _id):

The name of the field where to store the session ID;

セッション ID を格納するフィールドの名前。

data_field (default data):

The name of the field where to store the session data;

セッション データを格納するフィールドの名前。

time_field (default time):

The name of the field where to store the session creation timestamp;

セッション作成のタイムスタンプを格納するフィールドの名前。

expiry_field (default expires_at):

The name of the field where to store the session lifetime.

セッションの有効期間を格納するフィールドの名前。