Soft Delete

// Mark deletedAt with @softDelete
interface User {
  id: number;
  email: string;
  name: string;
  // @softDelete
  deletedAt: string;   // added automatically to the table
}

// Tables without @softDelete are unaffected — no extra column

// Default behavior: WHERE deletedAt IS NULL is injected on every query

const users = await User.getAll();
// SELECT * FROM users WHERE deletedAt IS NULL

const user = await User.get({ email: 'joe@example.com' });
// WHERE email = 'joe@example.com' AND deletedAt IS NULL

// .delete() on a soft-delete model sets deletedAt, not removes the row
await User.delete({ id: 42 });
// UPDATE users SET deletedAt = '2024-01-15T10:30:00Z' WHERE id = 42

// The row is now invisible to all standard queries
const user = await User.get({ id: 42 }); // null

// .withTrashed() — include soft-deleted rows
const allUsers = await User.softDelete()
  .withTrashed()
  .get();
// SELECT * FROM users (no deletedAt filter)

// Combine with other clauses
const suspendedAdmins = await User.softDelete()
  .withTrashed()
  .where('role', '=', 'admin')
  .get();

// .onlyTrashed() — return only soft-deleted rows
const deleted = await User.softDelete()
  .onlyTrashed()
  .get();
// SELECT * FROM users WHERE deletedAt IS NOT NULL

// .restore(filter) — un-delete: sets deletedAt = NULL
await User.restore({ id: 42 });
// UPDATE users SET deletedAt = NULL WHERE id = 42

// User is now visible in standard queries again
const user = await User.get({ id: 42 }); // found

// To permanently remove a soft-delete row,
// use the query builder with whereRaw to bypass the auto-filter

await User.softDelete()
  .withTrashed()
  .where('id', '=', 42)
  // No direct hardDelete method — use deleteMany after withTrashed
  // or use orm.adapter.exec() for raw DELETE