Skip to content

Commit

Permalink
Merge pull request #9072 from kenjis/docs-query_builder-join
Browse files Browse the repository at this point in the history
docs: update QueryBuilder descriptions for join()
  • Loading branch information
kenjis authored Jul 25, 2024
2 parents 9f76fed + 3d738fc commit fbcc43a
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions user_guide_src/source/database/query_builder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,8 @@ Use the ``$db->newQuery()`` method to make a subquery the main table:
Join
====

.. _query-builder-join:

$builder->join()
----------------

Expand All @@ -270,7 +272,7 @@ RawSql

.. versionadded:: 4.2.0

Since v4.2.0, ``$builder->join()`` accepts a ``CodeIgniter\Database\RawSql`` instance, which expresses raw SQL strings.
Since v4.2.0, ``$builder->join()`` accepts a ``CodeIgniter\Database\RawSql`` instance as the JOIN ON condition, which expresses raw SQL strings.

.. literalinclude:: query_builder/102.php

Expand Down Expand Up @@ -1498,13 +1500,14 @@ Class Reference
.. php:method:: join($table, $cond[, $type = ''[, $escape = null]])
:param string $table: Table name to join
:param string $cond: The JOIN ON condition
:param string|RawSql $cond: The JOIN ON condition
:param string $type: The JOIN type
:param bool $escape: Whether to escape values and identifiers
:returns: ``BaseBuilder`` instance (method chaining)
:rtype: ``BaseBuilder``

Adds a ``JOIN`` clause to a query.
Adds a ``JOIN`` clause to a query. Since v4.2.0, ``RawSql`` can be used
as the JOIN ON condition. See also :ref:`query-builder-join`.

.. php:method:: where($key[, $value = null[, $escape = null]])
Expand Down

0 comments on commit fbcc43a

Please sign in to comment.