Skip to content

docs(skills): master_detail deleteBehavior admits cascade/restrict only — drop the set_null teaching #9689 refuses#11869

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
hotlong merged 1 commit into from
Aug 25, 2026
+7 −7
Merged

docs(skills): master_detail deleteBehavior admits cascade/restrict only — drop the set_null teaching #9689 refuses #11869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions skills/objectstack-data/rules/field-types.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,8 +68,8 @@ options: [

| Type | When to Use | Key Config |
|:-----|:------------|:-----------|
| `lookup` | Reference another object (independent) | `reference`, `lookupFilters`, `multiple` |
| `master_detail` | Parent–child with lifecycle control | `reference`, `deleteBehavior` (cascade/restrict/set_null) |
| `lookup` | Reference another object (independent) | `reference`, `lookupFilters`, `multiple`, `deleteBehavior` |
| `master_detail` | Parent–child with lifecycle control | `reference`, `deleteBehavior` (`cascade`/`restrict` — `set_null` is refused) |
| `tree` | Hierarchical self-reference | `reference` |
| `user` | Person picker — a lookup specialized to `sys_user` (assignee, watchers). Stored identically to `lookup` | `multiple` (collaborators), `defaultValue: 'current_user'` |

Expand Down
10 changes: 5 additions & 5 deletions skills/objectstack-data/rules/relationships.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ Guide for modeling relationships between objects using `lookup`, `master_detail`

### Use `lookup` When:
- Child record can exist independently
- Parent deletion should not affect child
- Parent deletion should not affect child (`deleteBehavior: 'set_null'`)
- No roll-up aggregations needed
- Relationship is optional
- **Example:** `task.assigned_to → user` (task can exist without assignment)
Expand DownExpand Up@@ -150,19 +150,19 @@ export default ObjectSchema.create({

## Delete Behaviors

Configure `deleteBehavior` on `master_detail` relationships:
Configure `deleteBehavior` on `master_detail` — `cascade` or `restrict` **only**;
an authored `set_null` is refused at publish (it would orphan the detail row).

| Behavior | Effect | Use Case |
|:---------|:-------|:---------|
| `cascade` | Delete all child records | Invoice → Line Items |
| `restrict` | Prevent parent deletion if children exist | Department → Employees |
| `set_null` | Set child reference to null | Manager → Employees (manager leaves) |

```typescript
{
type: 'master_detail',
reference: 'parent_object',
deleteBehavior: 'cascade', // or 'restrict' or 'set_null'
deleteBehavior: 'cascade', // or 'restrict' — 'set_null' is refused here
}
```

Expand DownExpand Up@@ -402,7 +402,7 @@ export default ObjectSchema.create({
1. **Use lookup by default** — Only use master_detail when lifecycle coupling is required
2. **Unique constraints on junctions** — Prevent duplicate many-to-many entries
3. **Meaningful junction names** — Use descriptive names like `project_assignment` not `project_employee`
4. **deleteBehavior on master_detail** — Always specify cascade/restrict/set_null
4. **deleteBehavior on master_detail** — Always specify `cascade` or `restrict`
5. **Required on master_detail** — Child should always require parent
6. **Roll-ups for aggregation** — Use summary fields on parent for counts/sums
7. **lookupFilters for scoping** — Limit lookup options to relevant records (`lookupFilters: [{ field, operator: 'eq', value }]`)
Expand Down
Loading