Interface BackupCollection

interface BackupCollection {
    create(args: BackupCollectionArgs): Promise<BackupReturn>;
    getCreateStatus(args: BackupStatusArgs): Promise<BackupStatusReturn>;
    getRestoreStatus(args: BackupStatusArgs): Promise<BackupStatusReturn>;
    restore(args: BackupCollectionArgs): Promise<BackupReturn>;
}

Index

Methods

create getCreateStatus getRestoreStatus restore

Methods

create

create(args: BackupCollectionArgs): Promise<BackupReturn>
Create a backup of this collection.
Parameters
- args: BackupCollectionArgs
  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/src/backup/collection.ts:44

getCreateStatus

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

Throws
If the input is invalid.
- Defined in packages/core/src/backup/collection.ts:52

getRestoreStatus

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

Throws
If the input is invalid.
- Defined in packages/core/src/backup/collection.ts:60

restore

restore(args: BackupCollectionArgs): Promise<BackupReturn>
Restore a backup of this collection.
Parameters
- args: BackupCollectionArgs
  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/src/backup/collection.ts:70