Skip to content

Commit

Permalink
Merge pull request codeigniter4#7131 from kenjis/fix-docs-database/co…
Browse files Browse the repository at this point in the history
…nfiguration.rst

docs: improve database/configuration.rst
  • Loading branch information
kenjis authored Jan 19, 2023
2 parents 67295eb + dd06ddb commit 001f928
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
1 change: 1 addition & 0 deletions system/Database/Database.php
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ protected function parseDSN(array $params): array
/**
* Initialize database driver.
*
* @param string $driver Driver name. FQCN can be used.
* @param array|object $argument
*
* @return BaseConnection|BaseUtils|Forge
Expand Down
5 changes: 3 additions & 2 deletions user_guide_src/source/database/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,14 +118,15 @@ 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. e.g.,: ``MySQLi``, ``Postgres``, etc. The case must match the driver name.
You can set a fully qualified classname to use your custom driver.
**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.
**pConnect** true/false (boolean) - Whether to use a persistent connection.
**DBDebug** true/false (boolean) - Whether to throw exceptions or not when database errors occur.
**charset** The character set used in communicating with the database.
**DBCollat** The character collation used in communicating with the database (``MySQLi`` only)
**DBCollat** The character collation used in communicating with the database (``MySQLi`` only).
**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.
Expand Down

0 comments on commit 001f928

Please sign in to comment.