Skip to content

Commit 1009b8f

Browse files
committed
docs: list available drivers first
1 parent c1518a2 commit 1009b8f

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

user_guide_src/source/database/configuration.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -159,25 +159,25 @@ Explanation of Values
159159
**pConnect** true/false (boolean) - Whether to use a persistent connection.
160160
**DBDebug** true/false (boolean) - Whether to throw exceptions or not when database errors occur.
161161
**charset** The character set used in communicating with the database.
162-
**DBCollat** The character collation used in communicating with the database (``MySQLi`` only).
162+
**DBCollat** (``MySQLi`` only) The character collation used in communicating with the database.
163163
**swapPre** A default table prefix that should be swapped with ``DBPrefix``. This is useful for distributed
164164
applications where you might run manually written queries, and need the prefix to still be
165165
customizable by the end user.
166-
**schema** The database schema, default value varies by driver. (Used by ``Postgre`` and ``SQLSRV``.)
167-
**encrypt** Whether or not to use an encrypted connection. (``MySQLi`` and ``SQLSRV`` only).
166+
**schema** (``Postgre`` and ``SQLSRV`` only) The database schema, default value varies by driver.
167+
**encrypt** (``MySQLi`` and ``SQLSRV`` only) Whether or not to use an encrypted connection.
168168
``SQLSRV`` driver accepts true/false.
169169
See :ref:`MySQLi encrypt <mysqli-encrypt>` for ``MySQLi`` settings.
170-
**compress** Whether or not to use client compression (``MySQLi`` only).
171-
**strictOn** true/false (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL
172-
while developing an application (``MySQLi`` only).
170+
**compress** (``MySQLi`` only) Whether or not to use client compression.
171+
**strictOn** (``MySQLi`` only) true/false (boolean) - Whether to force "Strict Mode" connections, good for ensuring
172+
strict SQL while developing an application.
173173
**port** The database port number - Empty string ``''`` for default port (or dynamic port with ``SQLSRV``).
174-
**foreignKeys** true/false (boolean) - Whether or not to enable Foreign Key constraint (``SQLite3`` only).
174+
**foreignKeys** (``SQLite3`` only) true/false (boolean) - Whether or not to enable Foreign Key constraint.
175175

176176
.. important:: SQLite3 Foreign Key constraint is disabled by default.
177177
See `SQLite documentation <https://www.sqlite.org/pragma.html#pragma_foreign_keys>`_.
178178
To enforce Foreign Key constraint, set this config item to true.
179-
**busyTimeout** milliseconds (int) - Sleeps for a specified amount of time when a table is locked (``SQLite3`` only).
180-
**numberNative** true/false (boolean) - Whether or not to enable MYSQLI_OPT_INT_AND_FLOAT_NATIVE (``MySQLi`` only).
179+
**busyTimeout** (``SQLite3`` only) milliseconds (int) - Sleeps for a specified amount of time when a table is locked.
180+
**numberNative** (``MySQLi`` only) true/false (boolean) - Whether or not to enable MYSQLI_OPT_INT_AND_FLOAT_NATIVE.
181181
================ ===========================================================================================================
182182

183183
.. note:: Depending on what database driver you are using (``MySQLi``, ``Postgre``,

0 commit comments

Comments
 (0)