Skip to content

Commit

Permalink
docs: move content in table to section below
Browse files Browse the repository at this point in the history
  • Loading branch information
kenjis committed Mar 18, 2024
1 parent fd6d674 commit c1518a2
Showing 1 changed file with 21 additions and 13 deletions.
34 changes: 21 additions & 13 deletions user_guide_src/source/database/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,9 @@ and decode it in the constructor in the Config class:

.. _database-config-explanation-of-values:

**********************
Explanation of Values:
**********************
*********************
Explanation of Values
*********************

================ ===========================================================================================================
Name Config Description
Expand All @@ -164,15 +164,9 @@ Explanation of Values:
applications where you might run manually written queries, and need the prefix to still be
customizable by the end user.
**schema** The database schema, default value varies by driver. (Used by ``Postgre`` and ``SQLSRV``.)
**encrypt** Whether or not to use an encrypted connection.
``SQLSRV`` driver accepts true/false
``MySQLi`` driver accepts an array with the following options:
* ``ssl_key`` - Path to the private key file
* ``ssl_cert`` - Path to the public key certificate file
* ``ssl_ca`` - Path to the certificate authority file
* ``ssl_capath`` - Path to a directory containing trusted CA certificates in PEM format
* ``ssl_cipher`` - List of *allowed* ciphers to be used for the encryption, separated by colons (``:``)
* ``ssl_verify`` - true/false; Whether to verify the server certificate or not (``MySQLi`` only)
**encrypt** Whether or not to use an encrypted connection. (``MySQLi`` and ``SQLSRV`` only).
``SQLSRV`` driver accepts true/false.
See :ref:`MySQLi encrypt <mysqli-encrypt>` for ``MySQLi`` settings.
**compress** Whether or not to use client compression (``MySQLi`` only).
**strictOn** true/false (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL
while developing an application (``MySQLi`` only).
Expand Down Expand Up @@ -205,4 +199,18 @@ the ``'hostname'`` setting. CodeIgniter's MySQLi driver will notice this and con
connection properly.

.. literalinclude:: configuration/011.php
:lines: 11-18
:lines: 11-18

.. _mysqli-encrypt:

encrypt
-------

MySQLi driver accepts an array with the following options:

* ``ssl_key`` - Path to the private key file
* ``ssl_cert`` - Path to the public key certificate file
* ``ssl_ca`` - Path to the certificate authority file
* ``ssl_capath`` - Path to a directory containing trusted CA certificates in PEM format
* ``ssl_cipher`` - List of *allowed* ciphers to be used for the encryption, separated by colons (``:``)
* ``ssl_verify`` - true/false; Whether to verify the server certificate or not

0 comments on commit c1518a2

Please sign in to comment.