Skip to content

Commit 73f44df

Browse files
authored
Merge pull request #6941 from kenjis/fix-docs-database-configuration.rst
docs: fix database/configuration.rst
2 parents 0723f67 + 737a62b commit 73f44df

2 files changed

Lines changed: 10 additions & 19 deletions

File tree

user_guide_src/source/database/configuration.rst

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -113,12 +113,12 @@ Explanation of Values:
113113
=============== ===========================================================================================================
114114
**dsn** The DSN connect string (an all-in-one configuration sequence).
115115
**hostname** The hostname of your database server. Often this is 'localhost'.
116-
**username** The username used to connect to the database.
117-
**password** The password used to connect to the database.
116+
**username** The username used to connect to the database. (``SQLite3`` does not use this.)
117+
**password** The password used to connect to the database. (``SQLite3`` does not use this.)
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 type. e.g.,: ``MySQLi``, ``Postgres``, etc. The case must match the driver name
121+
**DBDriver** The database driver name. e.g.,: ``MySQLi``, ``Postgres``, etc. The case must match the driver name
122122
**DBPrefix** An optional table prefix which will added to the table name when running
123123
:doc:`Query Builder <query_builder>` queries. This permits multiple CodeIgniter
124124
installations to share one database.
@@ -129,10 +129,10 @@ Explanation of Values:
129129
**swapPre** A default table prefix that should be swapped with ``DBPrefix``. This is useful for distributed
130130
applications where you might run manually written queries, and need the prefix to still be
131131
customizable by the end user.
132-
**schema** The database schema, default value varies by driver. Used by ``Postgres`` and ``SQLSRV`` drivers.
132+
**schema** The database schema, default value varies by driver. (Used by ``Postgres`` and ``SQLSRV``.)
133133
**encrypt** Whether or not to use an encrypted connection.
134-
``SQLSRV`` drivers accept true/false
135-
``MySQLi`` drivers accept an array with the following options:
134+
``SQLSRV`` driver accepts true/false
135+
``MySQLi`` driver accepts an array with the following options:
136136
* ``ssl_key`` - Path to the private key file
137137
* ``ssl_cert`` - Path to the public key certificate file
138138
* ``ssl_ca`` - Path to the certificate authority file
@@ -142,18 +142,15 @@ Explanation of Values:
142142
**compress** Whether or not to use client compression (``MySQLi`` only).
143143
**strictOn** true/false (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL
144144
while developing an application.
145-
**port** The database port number. To use this value you have to add a line to the database config array.
146-
147-
.. literalinclude:: configuration/009.php
145+
**port** The database port number.
148146
**foreignKeys** true/false (boolean) - Whether or not to enable Foreign Key constraint (``SQLite3`` only).
149147

150148
.. important:: SQLite3 Foreign Key constraint is disabled by default.
151149
See `SQLite documentation <https://www.sqlite.org/pragma.html#pragma_foreign_keys>`_.
152150
To enforce Foreign Key constraint, set this config item to true.
153151
=============== ===========================================================================================================
154152

155-
.. note:: Depending on what database platform you are using (MySQL, PostgreSQL,
156-
etc.) not all values will be needed. For example, when using SQLite you
153+
.. note:: Depending on what database driver you are using (``MySQLi``, ``Postgres``,
154+
etc.) not all values will be needed. For example, when using ``SQLite3`` you
157155
will not need to supply a username or password, and the database name
158-
will be the path to your database file. The information above assumes
159-
you are using MySQL.
156+
will be the path to your database file.

user_guide_src/source/database/configuration/009.php

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)