InstallArchiveOptions interface

archiveSchema?

string

(Optional) Archive schema name (default archive).

client

ArchiveClient

The raw-SQL surface to install through — a Prisma client or a transaction.

defaultColumn?

string

(Optional) Default watch column (default deletedAt).

defaultPeriodSeconds?

number

(Optional) Default retention in seconds (default 30 days).

jobName?

string

(Optional) pg_cron job name (default archive-run).

models?

readonly ArchivableModel[]

(Optional) Tables to register by default (idempotent seed).

schedule?

string

(Optional) pg_cron schedule for the sweep (default daily at midnight, 0 0 * * *).

settingsTable?

string

(Optional) Settings table name within the archive schema (default _settings).

silent?

boolean

(Optional) Suppress SQL logging for the install DDL (default true).

sourceSchema?

string

(Optional) Default schema of the watched tables (default public).