WARNING: You are browsing the documentation for Symfony 4.2 which is not maintained anymore. Consider upgrading your projects to Symfony 4.3.

You are browsing the Symfony 4.2 documentation, which changes significantly from Symfony 3.x. If your app doesn't use Symfony 4.2 yet, browse the Symfony 3.4 documentation.

How to Use MongoDbSessionHandler to Store Sessions in a MongoDB Database

4.2 version

Maintained

3.4 4.3 current 4.4 5.0 master

Unmaintained

2.7 2.8 3.0 3.1 3.2 3.3 4.0 4.1

How to Use MongoDbSessionHandler to Store Sessions in a MongoDB Database
- Setting Up the MongoDB Collection

How to Use MongoDbSessionHandler to Store Sessions in a MongoDB Database¶

The default Symfony session storage writes the session information to files. Some medium to large websites use a NoSQL database called MongoDB to store the session values instead of files, because databases are easier to use and scale in a multi-webserver environment.

Symfony has a built-in solution for NoSQL database session storage called MongoDbSessionHandler. To use this, you will need to:

Register a MongoDbSessionHandler service;
Configure this under framework.session.handler_id configuration.

To see how to configure a similar handler, see How to Use PdoSessionHandler to Store Sessions in the Database.

Setting Up the MongoDB Collection¶

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. From the MongoDB shell:

use session_db
db.session.ensureIndex( { "expires_at": 1 }, { expireAfterSeconds: 0 } )

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.