Skip to content

Document detach & deletedAtColumn flags. #159

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
LukeTowers merged 5 commits into from
Oct 18, 2023
Merged

Document detach & deletedAtColumn flags. #159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
49be4f3
add other pivot-based relations to `detach` flag
mjauvin Sep 30, 2023
3dbac73
add note about deletedAtColumn for soft deleting pivot-based relations
mjauvin Sep 30, 2023
62978e6
remove empty line
mjauvin Sep 30, 2023
3f461c5
Update database/traits.md
LukeTowers Oct 10, 2023
929a09e
Remove empty line again
LukeTowers Oct 10, 2023
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
2 changes: 1 addition & 1 deletion database/relations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Argument | Description
`scope` | filters the relation using a supplied scope method.
`push` | if set to false, this relation will not be saved via `push`, default: true.
`delete` | if set to true, the related model will be deleted if the primary model is deleted or relationship is destroyed, default: false.
`detach` | if set to false the related model will not be automatically detached if the primary model is deleted or the relationship is destroyed. Used by `belongsToMany` relationships only, default: true.
`detach` | if set to false the related model will not be automatically detached if the primary model is deleted or the relationship is destroyed. Used by `belongsToMany`, `morphToMany` and `morphedByMany` relationships only, default: true.
`count` | if set to true, the result contains a `count` column only, used for counting relations, default: false.

Example filter using **order** and **conditions**:
Expand Down
1 change: 1 addition & 0 deletions database/traits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,6 +622,7 @@ class User extends Model
}
```

> **NOTE:** If the soft deleting relation is using a pivot table, you can set the `deletedAtColumn` option on the relation definition to change the column that will hold the soft deletion date in the pivot table, otherwise, it defaults to `deleted_at`.
> **NOTE:** If the related model does not use the soft delete trait, it will be treated the same as the `delete` option and deleted permanently.

Under these same conditions, when the primary model is restored, all the related models that use the `softDelete` option will also be restored.
Expand Down