Type Alias BackupArgs<C>

The arguments required to create and restore backups.

type BackupArgs<C extends BackupConfigCreate | BackupConfigRestore> = {
    backend: Backend;
    backupId: string;
    config?: C;
    excludeCollections?: string[];
    includeCollections?: string[];
    waitForCompletion?: boolean;
}

Type Parameters

C extends BackupConfigCreate | BackupConfigRestore

Index

Properties

backend backupId config? excludeCollections? includeCollections? waitForCompletion?

Properties

backend

backend: Backend

The backend to use for the backup.

backupId

backupId: string

The ID of the backup.

`Optional`config

config?: C

The configuration options for the backup.

`Optional`excludeCollections

excludeCollections?: string[]

The collections to exclude from the backup.

`Optional`includeCollections

includeCollections?: string[]

The collections to include in the backup.

`Optional`waitForCompletion

waitForCompletion?: boolean

Whether to wait for the backup to complete.