Skip to content

docs: improve database #6732

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
kenjis merged 2 commits into from
Oct 21, 2022
Merged

docs: improve database #6732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4be77e
docs: add note of dots in database/table/column names
kenjis Oct 21, 2022
51f4d4d
docs: fix RST format
kenjis Oct 21, 2022
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
6 changes: 3 additions & 3 deletions user_guide_src/source/database/call_function.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Custom Function Calls
:local:
:depth: 2

$db->callFunction();
============================
$db->callFunction()
===================

This function enables you to call PHP database functions that are not
natively included in CodeIgniter, in a platform-independent manner. For
Expand All @@ -17,7 +17,7 @@ do so like this:

.. literalinclude:: call_function/001.php

You must supply the name of the function, **without** the mysql\_
You must supply the name of the function, **without** the ``mysql_``
prefix, in the first parameter. The prefix is added automatically based
on which database driver is currently being used. This permits you to
run the same function on different database platforms. Obviously, not all
Expand Down
2 changes: 2 additions & 0 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 @@ -113,6 +113,8 @@ Explanation of Values:
**username** The username used to connect to the database.
**password** The password used to connect to the database.
**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 type. e.g.,: ``MySQLi``, ``Postgres``, etc. The case must match the driver name
**DBPrefix** An optional table prefix which will added to the table name when running
:doc:`Query Builder <query_builder>` queries. This permits multiple CodeIgniter
Expand Down
2 changes: 2 additions & 0 deletions user_guide_src/source/database/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The following page contains example code showing how the database class
is used. For complete details please read the individual pages
describing each function.

.. note:: CodeIgniter doesn't support dots (``.``) in the database, table, and column names.

.. contents::
:local:
:depth: 2
Expand Down
2 changes: 2 additions & 0 deletions user_guide_src/source/database/queries.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Queries
Query Basics
************

.. note:: CodeIgniter doesn't support dots (``.``) in the database, table, and column names.

Regular Queries
===============

Expand Down
2 changes: 2 additions & 0 deletions user_guide_src/source/database/query_builder.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ the query syntax is generated by each database adapter. It also allows
for safer queries, since the values are escaped automatically by the
system.

.. note:: CodeIgniter doesn't support dots (``.``) in the database, table, and column names.

.. contents::
:local:
:depth: 2
Expand Down