Skip to content

basalt / backup/src / BackupPluginOptions

Interface: BackupPluginOptions ​

Defined in: backup/src/index.ts:19

Extends ​

Properties ​

clock? ​

> optional clock?: () => Date

Defined in: backup/src/postgres.ts:53

Returns ​

Date

Inherited from ​

PostgresBackupOptions.clock


connectionUrl ​

> connectionUrl: string

Defined in: backup/src/postgres.ts:43

Inherited from ​

PostgresBackupOptions.connectionUrl


disk ​

> disk: string | Disk

Defined in: backup/src/index.ts:20


logger? ​

> optional logger?: Logger

Defined in: backup/src/postgres.ts:51

Inherited from ​

PostgresBackupOptions.logger


pgDumpPath? ​

> optional pgDumpPath?: string

Defined in: backup/src/postgres.ts:46

Inherited from ​

PostgresBackupOptions.pgDumpPath


pgRestorePath? ​

> optional pgRestorePath?: string

Defined in: backup/src/postgres.ts:47

Inherited from ​

PostgresBackupOptions.pgRestorePath


prefix? ​

> optional prefix?: string

Defined in: backup/src/postgres.ts:45

Inherited from ​

PostgresBackupOptions.prefix


retention? ​

> optional retention?: number

Defined in: backup/src/postgres.ts:50

Inherited from ​

PostgresBackupOptions.retention


runner? ​

> optional runner?: CommandRunner

Defined in: backup/src/postgres.ts:52

Inherited from ​

PostgresBackupOptions.runner


schedule? ​

> optional schedule?: BackupScheduleOptions

Defined in: backup/src/index.ts:21


tenancy? ​

> optional tenancy?: TenantIterator

Defined in: backup/src/index.ts:23

Iterator supplied by the application for the all-tenants schedule.


tenantDatabaseUrl? ​

> optional tenantDatabaseUrl?: (tenantId) => string | Promise<string>

Defined in: backup/src/postgres.ts:49

Parameters ​

tenantId ​

string

Returns ​

string | Promise<string>

Inherited from ​

PostgresBackupOptions.tenantDatabaseUrl


tenantSchemaPrefix? ​

> optional tenantSchemaPrefix?: string

Defined in: backup/src/postgres.ts:48

Inherited from ​

PostgresBackupOptions.tenantSchemaPrefix

Released under the MIT License.