Skip to content

Commit 5a02915

Browse files
committed
docs: add $deletedField explanation
1 parent 1278fc2 commit 5a02915

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

user_guide_src/source/models/model.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,8 @@ qualified name of a class** that can be used with the Result object's ``getCusto
124124
method. Using the special ``::class`` constant of the class will allow most IDEs to
125125
auto-complete the name and allow functions like refactoring to better understand your code.
126126

127+
.. _model-use-soft-deletes:
128+
127129
$useSoftDeletes
128130
---------------
129131

@@ -154,7 +156,7 @@ $useTimestamps
154156

155157
This boolean value determines whether the current date is automatically added to all inserts
156158
and updates. If true, will set the current time in the format specified by ``$dateFormat``. This
157-
requires that the table have columns named **created_at** and **updated_at** in the appropriate
159+
requires that the table have columns named **created_at**, **updated_at** and **deleted_at** in the appropriate
158160
data type.
159161

160162
$dateFormat
@@ -177,7 +179,10 @@ $updatedField
177179
Specifies which database field should use for keep data record update timestamp.
178180
Leave it empty to avoid update it (even ``$useTimestamps`` is enabled).
179181

182+
$deletedField
183+
-------------
180184

185+
Specifies which database field should use for soft deletions. See :ref:`model-use-soft-deletes`.
181186

182187
$validationRules
183188
----------------

0 commit comments

Comments
 (0)