Soft Delete API Resource

A soft delete pattern in an API preserves data by setting a deletedAt timestamp or isArchived boolean instead of permanently removing records. Use this approach when you need to retain database rows for auditing or potential data recovery.

You implement soft delete functionality by running the deleteRecord command with the target ID, which sets a deletion timestamp instead of executing a hard database delete. This ensures the record remains in the database while being marked as deleted.

You filter out soft-deleted records from database SELECT queries by applying the notDeleted helper function. This ensures your query logic automatically excludes rows that have a deletedAt timestamp or isArchived boolean set.

Yes, the soft delete pattern works for auditing by keeping the data in the database while marking it as deleted. This allows you to maintain historical records and perform potential data recovery without losing the original information.

A soft delete marks records as archived using a boolean or timestamp, keeping the database data intact for recovery. A hard delete permanently removes the row and its data from the database, making it unrecoverable without backups.

You should not use a soft delete approach when you need to permanently erase data from the database for compliance or storage optimization. Soft delete retains the full row data, which means the records remain queryable and consume storage space.