Skip to content

Commit 5c86c5c

Browse files
committed
docs: add versionadded
1 parent f9d09b9 commit 5c86c5c

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

user_guide_src/source/database/query_builder.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -908,6 +908,8 @@ Upsert
908908
$builder->upsert()
909909
------------------
910910

911+
.. versionadded:: 4.3.0
912+
911913
Generates an upsert string based on the data you supply, and runs the
912914
query. You can either pass an **array** or an **object** to the
913915
method. By default a constraint will be defined in order. A primary
@@ -929,6 +931,8 @@ The first parameter is an object.
929931
$builder->getCompiledUpsert()
930932
-----------------------------
931933

934+
.. versionadded:: 4.3.0
935+
932936
Compiles the upsert query just like ``$builder->upsert()`` but does not
933937
*run* the query. This method simply returns the SQL query as a string.
934938

@@ -944,6 +948,8 @@ upsertBatch
944948
$builder->upsertBatch()
945949
-----------------------
946950

951+
.. versionadded:: 4.3.0
952+
947953
Generates an upsert string based on the data you supply, and runs the
948954
query. You can either pass an **array** or an **object** to the
949955
method. By default a constraint will be defined in order. A primary
@@ -967,6 +973,8 @@ You can also upsert from a query:
967973
$builder->onConstraint()
968974
------------------------
969975

976+
.. versionadded:: 4.3.0
977+
970978
Allows manually setting constraint to be used for upsert. This does
971979
not work with MySQL because MySQL checks all constraints by default.
972980

@@ -976,6 +984,9 @@ This method accepts a string or an array of columns.
976984

977985
$builder->updateFields()
978986
------------------------
987+
988+
.. versionadded:: 4.3.0
989+
979990
Allows manually setting the fields to be updated when performing upserts.
980991

981992
.. literalinclude:: query_builder/110.php
@@ -1146,6 +1157,8 @@ method, or ``emptyTable()``.
11461157
$builder->deleteBatch()
11471158
-----------------------
11481159

1160+
.. versionadded:: 4.3.0
1161+
11491162
Generates a batch **DELETE** statement based on a set of data.
11501163

11511164
.. literalinclude:: query_builder/118.php
@@ -1198,6 +1211,8 @@ When
11981211
$builder->when()
11991212
----------------
12001213

1214+
.. versionadded:: 4.3.0
1215+
12011216
This allows modifying the query based on a condition without breaking out of the
12021217
query builder chain. The first parameter is the condition, and it should evaluate
12031218
to a boolean. The second parameter is a callable that will be ran
@@ -1223,6 +1238,8 @@ WhenNot
12231238
$builder->whenNot()
12241239
-------------------
12251240

1241+
.. versionadded:: 4.3.0
1242+
12261243
This works exactly the same way as ``$builder->when()`` except that it will
12271244
only run the callable when the condition evaluates to ``false``, instead of ``true`` like ``when()``.
12281245

@@ -1415,6 +1432,8 @@ Class Reference
14151432

14161433
.. php:method:: setQueryAsData($query[, $alias[, $columns = null]])
14171434
1435+
.. versionadded:: 4.3.0
1436+
14181437
:param BaseBuilder|RawSql $query: Instance of the BaseBuilder or RawSql
14191438
:param string|null $alias: Alias for query
14201439
:param array|string|null $columns: Array or comma delimited string of columns in the query

0 commit comments

Comments
 (0)