Interface Backup

interface Backup {
    cancel(args: BackupCancelArgs): Promise<boolean>;
    create(args: BackupArgs<BackupConfigCreate>): Promise<BackupReturn>;
    getCreateStatus(args: BackupStatusArgs): Promise<BackupStatusReturn>;
    getRestoreStatus(args: BackupStatusArgs): Promise<BackupStatusReturn>;
    list(backend: Backend, opts?: ListBackupOptions): Promise<BackupReturn[]>;
    restore(args: BackupArgs<BackupConfigRestore>): Promise<BackupReturn>;
}

Index

Methods

cancel create getCreateStatus getRestoreStatus list restore

Methods

cancel

cancel(args: BackupCancelArgs): Promise<boolean>
Cancel a backup.
Parameters
- args: BackupCancelArgs
  The arguments for the request.
Returns Promise<boolean>
Whether the backup was canceled.

Throws
If the input is invalid.

Throws
If the backup cancellation fails.
- Defined in packages/core/dist/src/backup/client.d.ts:14

create

create(args: BackupArgs<BackupConfigCreate>): Promise<BackupReturn>
Create a backup of the database.
Parameters
- args: BackupArgs<BackupConfigCreate>
  The arguments for the request.
Returns Promise<BackupReturn>
The response from Weaviate.

Throws
If the input is invalid.

Throws
If the backup creation fails.

Throws
If the backup creation is canceled.
- Defined in packages/core/dist/src/backup/client.d.ts:24

getCreateStatus

getCreateStatus(args: BackupStatusArgs): Promise<BackupStatusReturn>
Get the status of a backup creation.
Parameters
- args: BackupStatusArgs
  The arguments for the request.
Returns Promise<BackupStatusReturn>
The status of the backup creation.

Throws
If the input is invalid.
- Defined in packages/core/dist/src/backup/client.d.ts:32

getRestoreStatus

getRestoreStatus(args: BackupStatusArgs): Promise<BackupStatusReturn>
Get the status of a backup restore.
Parameters
- args: BackupStatusArgs
  The arguments for the request.
Returns Promise<BackupStatusReturn>
The status of the backup restore.

Throws
If the input is invalid.
- Defined in packages/core/dist/src/backup/client.d.ts:40

list

list(backend: Backend, opts?: ListBackupOptions): Promise<BackupReturn[]>
List existing backups (completed and in-progress) created in a given backend.
Parameters
- backend: Backend
  Backend whence to list backups.
- Optionalopts: ListBackupOptions
  The options available when listing backups.
Returns Promise<BackupReturn[]>
The response from Weaviate.
- Defined in packages/core/dist/src/backup/client.d.ts:57

restore

restore(args: BackupArgs<BackupConfigRestore>): Promise<BackupReturn>
Restore a backup of the database.
Parameters
- args: BackupArgs<BackupConfigRestore>
  The arguments for the request.
Returns Promise<BackupReturn>
The response from Weaviate.

Throws
If the input is invalid.

Throws
If the backup restoration fails.

Throws
If the backup restoration is canceled.
- Defined in packages/core/dist/src/backup/client.d.ts:50