Skip to content

Commit f714b1c

Browse files
committed
Update docs for new feature
1 parent 3c8e5fe commit f714b1c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,14 @@ foreach ($groups as $group)
162162
}
163163
```
164164

165+
### Soft Deletes
166+
167+
If your target relations correspond to a CodeIgniter Model that uses [soft deletion](https://codeigniter.com/user_guide/models/model.html#usesoftdeletes)
168+
then you may include the table name in the `array $withDeletedRelations` property to include
169+
soft deleted items. This is particularly helpful for tight relationships, like when an item
170+
`belongsTo` another item that has been soft deleted. `$withDeletedRelations` works on both
171+
Entities and Models.
172+
165173
## Performance
166174

167175
*WARNING*: Be aware that **Relations** relies on a schema generated from the **Schemas**

0 commit comments

Comments
 (0)