From d14be8ac6acf1d64b82172c808a7ac2ee8c0d02f Mon Sep 17 00:00:00 2001 From: kenjis Date: Tue, 25 Apr 2023 13:30:54 +0900 Subject: [PATCH 1/4] docs: fix database name and change text decoration for driver names --- user_guide_src/source/intro/requirements.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/user_guide_src/source/intro/requirements.rst b/user_guide_src/source/intro/requirements.rst index b029fa74b488..3f089222324c 100644 --- a/user_guide_src/source/intro/requirements.rst +++ b/user_guide_src/source/intro/requirements.rst @@ -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 + - 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. From 76ed847a766f000ac6d933da14fc2a433f62f473 Mon Sep 17 00:00:00 2001 From: kenjis Date: Tue, 25 Apr 2023 13:31:31 +0900 Subject: [PATCH 2/4] docs: list all supported drivers --- user_guide_src/source/database/configuration.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/user_guide_src/source/database/configuration.rst b/user_guide_src/source/database/configuration.rst index b5a768439ccc..4aa2a4fcc882 100644 --- a/user_guide_src/source/database/configuration.rst +++ b/user_guide_src/source/database/configuration.rst @@ -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``, ``Postgres``, ``SQLite3``, ``SQLSRV``, and ``OCI8``. **DBPrefix** An optional table prefix which will added to the table name when running :doc:`Query Builder ` queries. This permits multiple CodeIgniter installations to share one database. From a994125d2132e98524307966a01ee8f97e68c8f2 Mon Sep 17 00:00:00 2001 From: kenjis Date: Wed, 26 Apr 2023 12:38:54 +0900 Subject: [PATCH 3/4] docs: fix incorrect driver name Postgres -> Postgre --- user_guide_src/source/database/configuration.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/user_guide_src/source/database/configuration.rst b/user_guide_src/source/database/configuration.rst index 4aa2a4fcc882..b9bf95eb9181 100644 --- a/user_guide_src/source/database/configuration.rst +++ b/user_guide_src/source/database/configuration.rst @@ -120,7 +120,7 @@ Explanation of Values: .. note:: CodeIgniter doesn't support dots (``.``) in the database, table, and column names. **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``, ``Postgres``, ``SQLite3``, ``SQLSRV``, and ``OCI8``. + 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 ` queries. This permits multiple CodeIgniter installations to share one database. @@ -131,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: @@ -153,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. From a82fded893b891d9a2ef257129bdbc2ce46b7e2b Mon Sep 17 00:00:00 2001 From: kenjis Date: Wed, 26 Apr 2023 12:39:45 +0900 Subject: [PATCH 4/4] docs: fix incorrect examples --- user_guide_src/source/database/helpers.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/user_guide_src/source/database/helpers.rst b/user_guide_src/source/database/helpers.rst index c092edef3076..0d640f6422e1 100644 --- a/user_guide_src/source/database/helpers.rst +++ b/user_guide_src/source/database/helpers.rst @@ -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