Interface Backup

interface Backup {
    cancel(args): Promise<boolean>;
    create(args): Promise<BackupReturn>;
    getCreateStatus(args): Promise<BackupStatusReturn>;
    getRestoreStatus(args): Promise<BackupStatusReturn>;
    list(backend): Promise<BackupReturn[]>;
    restore(args): Promise<BackupReturn>;
}

Methods

cancel create getCreateStatus getRestoreStatus list restore

Methods

cancel

  • cancel(args): 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.

create

  • create(args): Promise<BackupReturn>

  • Create a backup of the database.

    Parameters

    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.

getCreateStatus

  • getCreateStatus(args): Promise<BackupStatusReturn>

  • Get the status of a backup creation.

    Parameters

    Returns Promise<BackupStatusReturn>

    The status of the backup creation.

    Throws

    If the input is invalid.

getRestoreStatus

  • getRestoreStatus(args): Promise<BackupStatusReturn>

  • Get the status of a backup restore.

    Parameters

    Returns Promise<BackupStatusReturn>

    The status of the backup restore.

    Throws

    If the input is invalid.

list

  • list(backend): Promise<BackupReturn[]>

  • List existing backups (completed and in-progress) created in a given backend.

    Parameters

    • backend: Backend

      Backend whence to list backups.

    Returns Promise<BackupReturn[]>

    The response from Weaviate.

restore

  • restore(args): Promise<BackupReturn>

  • Restore a backup of the database.

    Parameters

    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.

Settings

Member Visibility

Theme

On This Page

cancelcreategetCreateStatusgetRestoreStatuslistrestore