Skip to content

Commit 85e61e7

Browse files
committed
Added note re: mariadb compatibility
1 parent 78f5d2f commit 85e61e7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

readme.md

+6
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ A MySQL session store for [express.js](http://expressjs.com/). Compatible with [
77
* [Installation](#installation)
88
* [Important Notes](#important-notes)
99
* [Session Table Collation](#session-table-collation)
10+
* [MariaDB Compatibility](#mariadb-compatibility)
1011
* [Usage](#usage)
1112
* [Use an existing MySQL connection or pool](#use-an-existing-mysql-connection-or-pool)
1213
* [Closing the session store](#closing-the-session-store)
@@ -38,6 +39,11 @@ Potential gotchas and other important information goes here.
3839
This module creates a database table to save session data. This data is stored in a MySQL text field with the [utf8mb4](https://dev.mysql.com/doc/refman/5.5/en/charset-unicode-utf8mb4.html) collation - added in [MySQL 5.5.3](https://dev.mysql.com/doc/relnotes/mysql/5.5/en/news-5-5-3.html). The reason for this is to fully support the utf8 character set. If you absolutely must use an older version of MySQL, create your sessions table before initializing the `MySQLStore`.
3940

4041

42+
### MariaDB Compatibility
43+
44+
This module will work with MariaDB, but you must follow the usage examples in this readme found [here](#usage) and [here](#use-an-existing-mysql-connection-or-pool). The [mariadb module](https://github.com/mariadb-corporation/mariadb-connector-nodejs) is __not__ supported - please use the [mysql2 module](https://github.com/sidorares/node-mysql2) instead to create a connection or pool to your MariaDB instance.
45+
46+
4147
## Usage
4248

4349
Use with your express session middleware, like this:

0 commit comments

Comments
 (0)