Skip to content

Commit e6b150e

Browse files
committed
Document the serverVersion option in a forward-compatible manner
1 parent e797e8e commit e6b150e

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/en/reference/configuration.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -341,8 +341,10 @@ the corresponding platform class.
341341
You can also pass the ``serverVersion`` option if you want to disable automatic
342342
database platform detection and choose the platform version implementation explicitly.
343343

344-
If you are running a MariaDB database, you should prefix the ``serverVersion``
345-
with ``mariadb-`` (ex: ``mariadb-10.2.12``).
344+
Please specify the full server version as the database server would report it,
345+
e.g. ``8.0.32`` instead of just ``8`` if your server is a MySQL 8.0.32. This
346+
means that if you are running a MariaDB database, you should suffix the
347+
``serverVersion`` with ``-MariaDB`` (ex: ``10.11.2-MariaDB``).
346348

347349
Custom Driver Options
348350
~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)