Skip to content

Commit c92ae74

Browse files
committed
docs: improve and update the config table
1 parent 96beafa commit c92ae74

1 file changed

Lines changed: 13 additions & 19 deletions

File tree

user_guide_src/source/database/configuration.rst

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -113,34 +113,28 @@ Explanation of Values:
113113
**username** The username used to connect to the database.
114114
**password** The password used to connect to the database.
115115
**database** The name of the database you want to connect to.
116-
**DBDriver** The database type. e.g.,: MySQLi, Postgre, etc. The case must match the driver name
116+
**DBDriver** The database type. e.g.,: ``MySQLi``, ``Postgres``, etc. The case must match the driver name
117117
**DBPrefix** An optional table prefix which will added to the table name when running
118118
:doc:`Query Builder <query_builder>` queries. This permits multiple CodeIgniter
119119
installations to share one database.
120120
**pConnect** true/false (boolean) - Whether to use a persistent connection.
121121
**DBDebug** true/false (boolean) - Whether database errors should be displayed.
122122
**charset** The character set used in communicating with the database.
123-
**DBCollat** The character collation used in communicating with the database
124-
125-
.. note:: Only used in the 'MySQLi' driver.
126-
127-
**swapPre** A default table prefix that should be swapped with dbprefix. This is useful for distributed
123+
**DBCollat** The character collation used in communicating with the database (``MySQLi`` only)
124+
**swapPre** A default table prefix that should be swapped with ``DBPrefix``. This is useful for distributed
128125
applications where you might run manually written queries, and need the prefix to still be
129126
customizable by the end user.
130-
**schema** The database schema, default value varies by driver. Used by PostgreSQL and SQLSRV drivers.
127+
**schema** The database schema, default value varies by driver. Used by ``Postgres`` and ``SQLSRV`` drivers.
131128
**encrypt** Whether or not to use an encrypted connection.
132-
133-
- 'sqlsrv' and 'pdo/sqlsrv' drivers accept true/false
134-
- 'MySQLi' and 'pdo/mysql' drivers accept an array with the following options:
135-
136-
- 'ssl_key' - Path to the private key file
137-
- 'ssl_cert' - Path to the public key certificate file
138-
- 'ssl_ca' - Path to the certificate authority file
139-
- 'ssl_capath' - Path to a directory containing trusted CA certificates in PEM format
140-
- 'ssl_cipher' - List of *allowed* ciphers to be used for the encryption, separated by colons (':')
141-
- 'ssl_verify' - true/false; Whether to verify the server certificate or not ('MySQLi' only)
142-
143-
**compress** Whether or not to use client compression (MySQL only).
129+
``SQLSRV`` drivers accept true/false
130+
``MySQLi`` drivers accept an array with the following options:
131+
* ``ssl_key`` - Path to the private key file
132+
* ``ssl_cert`` - Path to the public key certificate file
133+
* ``ssl_ca`` - Path to the certificate authority file
134+
* ``ssl_capath`` - Path to a directory containing trusted CA certificates in PEM format
135+
* ``ssl_cipher`` - List of *allowed* ciphers to be used for the encryption, separated by colons (``:``)
136+
* ``ssl_verify`` - true/false; Whether to verify the server certificate or not (``MySQLi`` only)
137+
**compress** Whether or not to use client compression (``MySQLi`` only).
144138
**strictOn** true/false (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL
145139
while developing an application.
146140
**port** The database port number. To use this value you have to add a line to the database config array.

0 commit comments

Comments
 (0)