Store Sessions in a Database ¶
Symfony stores sessions in files by default. If your application is served by multiple servers, you'll need to use a database instead to make sessions work across different servers.
Symfony can store sessions in all kinds of databases (relational, NoSQL and key-value) but recommends key-value databases like Redis to get best performance.
Store Sessions in a key-value Database (Redis) ¶
This section assumes that you have a fully-working Redis server and have also installed and configured the phpredis extension.
You have two different options to use Redis to store sessions:
(1) The first PHP-based option is to configure Redis session handler directly in
the server php.ini
file:
1 2 3 |
; php.ini
session.save_handler = redis
session.save_path = "tcp://192.168.0.178:6379?auth=REDIS_PASSWORD"
|
- The second Symfony-based option is to configure Redis sessions as follows.2 つ目の Symfony ベースのオプションは、次のように Redis セッションを構成することです。
First, define a Symfony service for the connection to the Redis server:
-
YAML
YAML
-
XML
XML
-
PHP
PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
# config/services.yaml
services:
# ...
Redis:
# you can also use \RedisArray, \RedisCluster or \Predis\Client classes
class: Redis
calls:
- connect:
- '%env(REDIS_HOST)%'
- '%env(int:REDIS_PORT)%'
# uncomment the following if your Redis server requires a password
# - auth:
# - '%env(REDIS_PASSWORD)%'
# uncomment the following if your Redis server requires a user and a password (when user is not default)
# - auth:
# - ['%env(REDIS_USER)%','%env(REDIS_PASSWORD)%']
|
Now pass this \Redis
connection as an argument of the service associated to the
RedisSessionHandler.
This argument can also be a \RedisArray
, \RedisCluster
, \Predis\Client
,
and RedisProxy
:
-
YAML
YAML
-
XML
XML
-
PHP
PHP
1 2 3 4 5 6 7 8 9 10 |
# config/services.yaml
services:
# ...
Symfony\Component\HttpFoundation\Session\Storage\Handler\RedisSessionHandler:
arguments:
- '@Redis'
# you can optionally pass an array of options. The only options are 'prefix' and 'ttl',
# which define the prefix to use for the keys to avoid collision on the Redis server
# and the expiration time for any given entry (in seconds), defaults are 'sf_s' and null:
# - { 'prefix': 'my_prefix', 'ttl': 600 }
|
Next, use the handler_id configuration option to tell Symfony to use this service as the session handler:
-
YAML
YAML
-
XML
XML
-
PHP
PHP
1 2 3 4 5 |
# config/packages/framework.yaml
framework:
# ...
session:
handler_id: Symfony\Component\HttpFoundation\Session\Storage\Handler\RedisSessionHandler
|
That's all! Symfony will now use your Redis server to read and write the session data. The main drawback of this solution is that Redis does not perform session locking, so you can face race conditions when accessing sessions. For example, you may see an "Invalid CSRF token" error because two requests were made in parallel and only the first one stored the CSRF token in the session.
See also
If you use Memcached instead of Redis, follow a similar approach but replace
RedisSessionHandler
by MemcachedSessionHandler.
Store Sessions in a Relational Database (MariaDB, MySQL, PostgreSQL) ¶
Symfony includes a PdoSessionHandler to store sessions in relational databases like MariaDB, MySQL and PostgreSQL. To use it, first register a new handler service with your database credentials:
-
YAML
YAML
-
XML
XML
-
PHP
PHP
1 2 3 4 5 6 7 8 9 10 11 |
# config/services.yaml
services:
# ...
Symfony\Component\HttpFoundation\Session\Storage\Handler\PdoSessionHandler:
arguments:
- '%env(DATABASE_URL)%'
# you can also use PDO configuration, but requires passing two arguments
# - 'mysql:dbname=mydatabase; host=myhost; port=myport'
# - { db_username: myuser, db_password: mypassword }
|
Tip
When using MySQL as the database, the DSN defined in DATABASE_URL
can
contain the charset
and unix_socket
options as query string parameters.
Next, use the handler_id configuration option to tell Symfony to use this service as the session handler:
-
YAML
YAML
-
XML
XML
-
PHP
PHP
1 2 3 4 5 |
# config/packages/framework.yaml
framework:
session:
# ...
handler_id: Symfony\Component\HttpFoundation\Session\Storage\Handler\PdoSessionHandler
|
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:
-
YAML
YAML
-
XML
XML
-
PHP
PHP
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' }
|
These are parameters that you can configure:
db_table
(defaultsessions
):-
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
(defaultsess_id
):-
The name of the column where to store the session ID (column type:
VARCHAR(128)
);セッション ID を格納する列の名前 (列の型: VARCHAR(128)); db_data_col
(defaultsess_data
):-
The name of the column where to store the session data (column type:
BLOB
);セッション データを格納する列の名前 (列の型: BLOB)。 db_time_col
(defaultsess_time
):-
The name of the column where to store the session creation timestamp (column type:
INTEGER
);セッション作成のタイムスタンプを格納する列の名前 (列の型: INTEGER)。 db_lifetime_col
(defaultsess_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) andLOCK_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
|
MariaDB/MySQL ¶
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;
|
Note
A BLOB
column type (which is the one used by default by createTable()
)
stores up to 64 kb. If the user session data exceeds this, an exception may
be thrown or their session will be silently reset. Consider using a MEDIUMBLOB
if you need more space.
PostgreSQL ¶
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);
|
Microsoft SQL Server ¶
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)
);
|
Store Sessions in a NoSQL Database (MongoDB) ¶
Symfony includes a MongoDbSessionHandler to store sessions in the MongoDB NoSQL database. First, make sure to have a working MongoDB connection in your Symfony application as explained in the DoctrineMongoDBBundle configuration article.
Then, register a new handler service for MongoDbSessionHandler
and pass it
the MongoDB connection as argument:
-
YAML
YAML
-
XML
XML
-
PHP
PHP
1 2 3 4 5 6 7 |
# config/services.yaml
services:
# ...
Symfony\Component\HttpFoundation\Session\Storage\Handler\MongoDbSessionHandler:
arguments:
- '@doctrine_mongodb.odm.default_connection'
|
Next, use the handler_id configuration option to tell Symfony to use this service as the session handler:
-
YAML
YAML
-
XML
XML
-
PHP
PHP
1 2 3 4 5 |
# config/packages/framework.yaml
framework:
session:
# ...
handler_id: Symfony\Component\HttpFoundation\Session\Storage\Handler\MongoDbSessionHandler
|
Note
MongoDB ODM 1.x only works with the legacy driver, which is no longer
supported by the Symfony session class. Install the alcaeus/mongo-php-adapter
package to retrieve the underlying \MongoDB\Client
object or upgrade to
MongoDB ODM 2.0.
That's all! Symfony will now use your MongoDB server to read and write the session data. You do not need to do anything to initialize your session collection. However, you may want to add an index to improve garbage collection performance. Run this from the MongoDB shell:
1 2 |
use session_db
db.session.createIndex( { "expires_at": 1 }, { expireAfterSeconds: 0 } )
|
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:
-
YAML
YAML
-
XML
XML
-
PHP
PHP
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' }
|
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
(defaultdata
):-
The name of the field where to store the session data;
セッション データを格納するフィールドの名前。
time_field
(defaulttime
):-
The name of the field where to store the session creation timestamp;
セッション作成のタイムスタンプを格納するフィールドの名前。
expiry_field
(defaultexpires_at
):-
The name of the field where to store the session lifetime.
セッションの有効期間を格納するフィールドの名前。