hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-15 14:03:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

database docs utfmb4 collation and some versions of mysql/mariadb

Browse Source
This commit is contained in:
Chico Venancio
2018-06-08 12:55:02 -03:00
parent 8c48f3b856
commit c75eddb730
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/source/reference/database.md
View File

@@ -42,7 +42,7 @@ We recommend using PostgreSQL for production if you are unsure whether to use
MySQL or PostgreSQL or if you do not have a strong preference. There is MySQL or PostgreSQL or if you do not have a strong preference. There is
additional configuration required for MySQL that is not needed for PostgreSQL. additional configuration required for MySQL that is not needed for PostgreSQL.
### MySQL ### MySQL / MariaDB
- You should use the `pymysql` sqlalchemy provider (the other one, MySQLdb, - You should use the `pymysql` sqlalchemy provider (the other one, MySQLdb,
isn't available for py3). isn't available for py3).
@@ -52,7 +52,11 @@ additional configuration required for MySQL that is not needed for PostgreSQL.
from the hub will be idle for longer than most connections. This behavior from the hub will be idle for longer than most connections. This behavior
will lead to frustrating 'the connection has gone away' errors from will lead to frustrating 'the connection has gone away' errors from
sqlalchemy if `pool_recycle` is not set. sqlalchemy if `pool_recycle` is not set.
- If you use utf8mb4 collation with MySQL earlier than 5.7.7 or MariaDB earlier
than 10.2.1 you may get an '1709, Index column size too large' error. To fix
this you need to set 'innodb_large_prefix' to enabled and
'innodb_file_format' to 'Barracuda' to allow for the index sizes jupyterhub
uses. 'row_format' will be set to 'DYNAMIC' as long as those options are set
correctly. Later versions of MariaDB and MySQL should set these values by
default, as well as have a default DYNAMIC row_format and pose no trouble to
users.