# InstallArchiveOptions interface · @imqueue/pg-prisma

Source: https://imqueue.org/api/pg-prisma/latest/pg-prisma.installarchiveoptions/
Published: 2026-08-01
Author: @imqueue maintainers (https://github.com/imqueue)
Package: @imqueue/pg-prisma 1.0.1 — generated reference, not hand-written

Everything [installArchiving()](https://imqueue.org/api/pg-prisma/latest/pg-prisma.installarchiving/) needs.

**Signature:**

```typescript
export interface InstallArchiveOptions 
```

## Properties


| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [archiveSchema?](https://imqueue.org/api/pg-prisma/latest/pg-prisma.installarchiveoptions.archiveschema/) |  | string | _(Optional)_ Archive schema name (default `archive`). |
| [client](https://imqueue.org/api/pg-prisma/latest/pg-prisma.installarchiveoptions.client/) |  | [ArchiveClient](https://imqueue.org/api/pg-prisma/latest/pg-prisma.archiveclient/) | The raw-SQL surface to install through — a Prisma client or a transaction. |
| [defaultColumn?](https://imqueue.org/api/pg-prisma/latest/pg-prisma.installarchiveoptions.defaultcolumn/) |  | string | _(Optional)_ Default watch column (default `deletedAt`). |
| [defaultPeriodSeconds?](https://imqueue.org/api/pg-prisma/latest/pg-prisma.installarchiveoptions.defaultperiodseconds/) |  | number | _(Optional)_ Default retention in seconds (default 30 days). |
| [jobName?](https://imqueue.org/api/pg-prisma/latest/pg-prisma.installarchiveoptions.jobname/) |  | string | _(Optional)_ pg\_cron job name (default `archive-run`). |
| [models?](https://imqueue.org/api/pg-prisma/latest/pg-prisma.installarchiveoptions.models/) |  | readonly [ArchivableModel](https://imqueue.org/api/pg-prisma/latest/pg-prisma.archivablemodel/)\[\] | _(Optional)_ Tables to register by default (idempotent seed). |
| [schedule?](https://imqueue.org/api/pg-prisma/latest/pg-prisma.installarchiveoptions.schedule/) |  | string | _(Optional)_ pg\_cron schedule for the sweep (default daily at midnight, `0 0 * * *`). |
| [settingsTable?](https://imqueue.org/api/pg-prisma/latest/pg-prisma.installarchiveoptions.settingstable/) |  | string | _(Optional)_ Settings table name within the archive schema (default `_settings`). |
| [silent?](https://imqueue.org/api/pg-prisma/latest/pg-prisma.installarchiveoptions.silent/) |  | boolean | _(Optional)_ Suppress SQL logging for the install DDL (default `true`). |
| [sourceSchema?](https://imqueue.org/api/pg-prisma/latest/pg-prisma.installarchiveoptions.sourceschema/) |  | string | _(Optional)_ Default schema of the watched tables (default `public`). |