Type alias HotBackupOptions

HotBackupOptions: {
    allowInconsistent?: boolean;
    force?: boolean;
    label?: string;
    timeout?: number;
}

(Enterprise Edition only.) Options for creating a hot backup.

Optional allowInconsistent?: boolean

If set to true and no global transaction lock can be acquired within the given timeout, a possibly inconsistent backup is taken.

Default: false
Optional force?: boolean

(Enterprise Edition cluster only.) If set to true and no global transaction lock can be acquired within the given timeout, all running transactions are forcefully aborted to ensure that a consistent backup can be created.

Default: false.
Optional label?: string

Label to appended to the backup's identifier.

Default: If omitted or empty, a UUID will be generated.
Optional timeout?: number

Time in seconds that the operation will attempt to get a consistent snapshot.

Default: 120.