Skip to content

Commit f89ec81

Browse files
authored
Merge pull request #7449 from kenjis/docs-dbdriver
docs: improve database driver description
2 parents a3a35df + a82fded commit f89ec81

File tree

3 files changed

+10
-9
lines changed

3 files changed

+10
-9
lines changed

user_guide_src/source/database/configuration.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,9 @@ Explanation of Values:
118118
**database** The name of the database you want to connect to.
119119

120120
.. note:: CodeIgniter doesn't support dots (``.``) in the database, table, and column names.
121-
**DBDriver** The database driver name. e.g.,: ``MySQLi``, ``Postgres``, etc. The case must match the driver name.
121+
**DBDriver** The database driver name. The case must match the driver name.
122122
You can set a fully qualified classname to use your custom driver.
123+
Supported drivers: ``MySQLi``, ``Postgre``, ``SQLite3``, ``SQLSRV``, and ``OCI8``.
123124
**DBPrefix** An optional table prefix which will added to the table name when running
124125
:doc:`Query Builder <query_builder>` queries. This permits multiple CodeIgniter
125126
installations to share one database.
@@ -130,7 +131,7 @@ Explanation of Values:
130131
**swapPre** A default table prefix that should be swapped with ``DBPrefix``. This is useful for distributed
131132
applications where you might run manually written queries, and need the prefix to still be
132133
customizable by the end user.
133-
**schema** The database schema, default value varies by driver. (Used by ``Postgres`` and ``SQLSRV``.)
134+
**schema** The database schema, default value varies by driver. (Used by ``Postgre`` and ``SQLSRV``.)
134135
**encrypt** Whether or not to use an encrypted connection.
135136
``SQLSRV`` driver accepts true/false
136137
``MySQLi`` driver accepts an array with the following options:
@@ -152,7 +153,7 @@ Explanation of Values:
152153
**busyTimeout** milliseconds (int) - Sleeps for a specified amount of time when a table is locked (``SQLite3`` only).
153154
=============== ===========================================================================================================
154155

155-
.. note:: Depending on what database driver you are using (``MySQLi``, ``Postgres``,
156+
.. note:: Depending on what database driver you are using (``MySQLi``, ``Postgre``,
156157
etc.) not all values will be needed. For example, when using ``SQLite3`` you
157158
will not need to supply a username or password, and the database name
158159
will be the path to your database file.

user_guide_src/source/database/helpers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Example:
5858
$db->getPlatform()
5959
==================
6060

61-
Outputs the database platform you are running (MySQL, MS SQL, Postgres,
61+
Outputs the database platform (DBDriver) you are running (MySQLi, SQLSRV, Postgre,
6262
etc...):
6363

6464
.. literalinclude:: helpers/003.php

user_guide_src/source/intro/requirements.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ Supported Databases
4949
A database is required for most web application programming.
5050
Currently supported databases are:
5151

52-
- MySQL via the *MySQLi* driver (version 5.1 and above only)
53-
- PostgreSQL via the *Postgre* driver
54-
- SQLite3 via the *SQLite3* driver
55-
- MSSQL via the *SQLSRV* driver (version 2005 and above only)
56-
- Oracle via the *OCI8* driver (version 12.1 and above only)
52+
- MySQL via the ``MySQLi`` driver (version 5.1 and above only)
53+
- PostgreSQL via the ``Postgre`` driver
54+
- SQLite3 via the ``SQLite3`` driver
55+
- Microsoft SQL Server via the ``SQLSRV`` driver (version 2005 and above only)
56+
- Oracle Database via the ``OCI8`` driver (version 12.1 and above only)
5757

5858
Not all of the drivers have been converted/rewritten for CodeIgniter4.
5959
The list below shows the outstanding ones.

0 commit comments

Comments
 (0)