SoftDeletable.md

//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE                                                                  //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-02-23                                            //
//////////////////////////////////////////////////////////////////////////////////////////////

Index / Types / SoftDeletable

SoftDeletable Type

Adds soft-delete capability to a model.

Soft-deleted records are excluded from default queries via access policies. The deletedAt timestamp is used for data retention compliance — records older than the configured retention window are permanently purged by a background job.

Defined in: mixins.zmodel

Declaration · mixins.zmodel

type SoftDeletable {
    deletedAt DateTime?
    deletedBy String?
}

📋 Fields

All fields defined on this entity, including inherited fields from mixins and parent models.

Field	Type	Required	Default	Attributes	Description
deletedAt	DateTime?	No	—	—	When the record was soft-deleted, or null if active.
deletedBy	String?	No	—	—	The ID of the user who performed the deletion, for audit purposes.

📍 Used By

Models and fields that reference this type.

• Article — deletedAt, deletedBy
• Comment — deletedAt, deletedBy
• User — deletedAt, deletedBy

---

📚 References

• ZModel types — ZenStack documentation

---

Next: Timestamps