Skip to content

docs: improve database driver description #7449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 26, 2023
Merged

docs: improve database driver description #7449

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d14be8a
docs: fix database name and change text decoration for driver names
kenjis Apr 25, 2023
76ed847
docs: list all supported drivers
kenjis Apr 25, 2023
a994125
docs: fix incorrect driver name
kenjis Apr 26, 2023
a82fded
docs: fix incorrect examples
kenjis Apr 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions user_guide_src/source/database/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,9 @@ Explanation of Values:
**database** The name of the database you want to connect to.

.. note:: CodeIgniter doesn't support dots (``.``) in the database, table, and column names.
**DBDriver** The database driver name. e.g.,: ``MySQLi``, ``Postgres``, etc. The case must match the driver name.
**DBDriver** The database driver name. The case must match the driver name.
You can set a fully qualified classname to use your custom driver.
Supported drivers: ``MySQLi``, ``Postgre``, ``SQLite3``, ``SQLSRV``, and ``OCI8``.
**DBPrefix** An optional table prefix which will added to the table name when running
:doc:`Query Builder <query_builder>` queries. This permits multiple CodeIgniter
installations to share one database.
Expand All @@ -130,7 +131,7 @@ Explanation of Values:
**swapPre** A default table prefix that should be swapped with ``DBPrefix``. This is useful for distributed
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 ``Postgres`` and ``SQLSRV``.)
**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:
Expand All @@ -152,7 +153,7 @@ Explanation of Values:
**busyTimeout** milliseconds (int) - Sleeps for a specified amount of time when a table is locked (``SQLite3`` only).
=============== ===========================================================================================================

.. note:: Depending on what database driver you are using (``MySQLi``, ``Postgres``,
.. note:: Depending on what database driver you are using (``MySQLi``, ``Postgre``,
etc.) not all values will be needed. For example, when using ``SQLite3`` you
will not need to supply a username or password, and the database name
will be the path to your database file.
2 changes: 1 addition & 1 deletion user_guide_src/source/database/helpers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Example:
$db->getPlatform()
==================

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

.. literalinclude:: helpers/003.php
Expand Down
10 changes: 5 additions & 5 deletions user_guide_src/source/intro/requirements.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ Supported Databases
A database is required for most web application programming.
Currently supported databases are:

- MySQL via the *MySQLi* driver (version 5.1 and above only)
- PostgreSQL via the *Postgre* driver
- SQLite3 via the *SQLite3* driver
- MSSQL via the *SQLSRV* driver (version 2005 and above only)
- Oracle via the *OCI8* driver (version 12.1 and above only)
- MySQL via the ``MySQLi`` driver (version 5.1 and above only)
- PostgreSQL via the ``Postgre`` driver
Copy link
Collaborator

@ddevsr ddevsr Apr 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- PostgreSQL via the ``Postgre`` driver
- PostgreSQL via the ``Postgre`` driver

Not consistent in configuration file, use Postgres or Postgre? I am not using PostgreSQL

Copy link
Member Author

@kenjis kenjis Apr 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! It is the directory name for the driver. That is Postgre.

- SQLite3 via the ``SQLite3`` driver
- Microsoft SQL Server via the ``SQLSRV`` driver (version 2005 and above only)
- Oracle Database via the ``OCI8`` driver (version 12.1 and above only)

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