Interface BackupCollection

interface BackupCollection {
    create(args): Promise<{
        backend?: string;
        classes?: string[];
        error?: string;
        id?: string;
        path?: string;
        status?: "STARTED" | "TRANSFERRING" | "TRANSFERRED" | "SUCCESS" | "FAILED";
    }>;
    getCreateStatus(args): Promise<{
        backend?: string;
        error?: string;
        id?: string;
        path?: string;
        status?: "STARTED" | "TRANSFERRING" | "TRANSFERRED" | "SUCCESS" | "FAILED";
    }>;
    getRestoreStatus(args): Promise<{
        backend?: string;
        error?: string;
        id?: string;
        path?: string;
        status?: "STARTED" | "TRANSFERRING" | "TRANSFERRED" | "SUCCESS" | "FAILED";
    }>;
    restore(args): Promise<{
        backend?: string;
        classes?: string[];
        error?: string;
        id?: string;
        path?: string;
        status?: "STARTED" | "TRANSFERRING" | "TRANSFERRED" | "SUCCESS" | "FAILED";
    }>;
}

Methods

create getCreateStatus getRestoreStatus restore

Methods

create

  • create(args): Promise<{
        backend?: string;
        classes?: string[];
        error?: string;
        id?: string;
        path?: string;
        status?: "STARTED" | "TRANSFERRING" | "TRANSFERRED" | "SUCCESS" | "FAILED";
    }>

  • Create a backup of this collection.

    Parameters

    Returns Promise<{
        backend?: string;
        classes?: string[];
        error?: string;
        id?: string;
        path?: string;
        status?: "STARTED" | "TRANSFERRING" | "TRANSFERRED" | "SUCCESS" | "FAILED";
    }>

    The response from Weaviate.

getCreateStatus

  • getCreateStatus(args): Promise<{
        backend?: string;
        error?: string;
        id?: string;
        path?: string;
        status?: "STARTED" | "TRANSFERRING" | "TRANSFERRED" | "SUCCESS" | "FAILED";
    }>

  • Get the status of a backup.

    Parameters

    Returns Promise<{
        backend?: string;
        error?: string;
        id?: string;
        path?: string;
        status?: "STARTED" | "TRANSFERRING" | "TRANSFERRED" | "SUCCESS" | "FAILED";
    }>

    The status of the backup.

getRestoreStatus

  • getRestoreStatus(args): Promise<{
        backend?: string;
        error?: string;
        id?: string;
        path?: string;
        status?: "STARTED" | "TRANSFERRING" | "TRANSFERRED" | "SUCCESS" | "FAILED";
    }>

  • Get the status of a restore.

    Parameters

    Returns Promise<{
        backend?: string;
        error?: string;
        id?: string;
        path?: string;
        status?: "STARTED" | "TRANSFERRING" | "TRANSFERRED" | "SUCCESS" | "FAILED";
    }>

    The status of the restore.

restore

  • restore(args): Promise<{
        backend?: string;
        classes?: string[];
        error?: string;
        id?: string;
        path?: string;
        status?: "STARTED" | "TRANSFERRING" | "TRANSFERRED" | "SUCCESS" | "FAILED";
    }>

  • Restore a backup of this collection.

    Parameters

    Returns Promise<{
        backend?: string;
        classes?: string[];
        error?: string;
        id?: string;
        path?: string;
        status?: "STARTED" | "TRANSFERRING" | "TRANSFERRED" | "SUCCESS" | "FAILED";
    }>

    The response from Weaviate.

Settings

Member Visibility

Theme

On This Page

creategetCreateStatusgetRestoreStatusrestore