weaviate-client
    Preparing search index...

    Interface Replications

    interface Replications {
        cancel: (id: string) => Promise<void>;
        delete: (id: string) => Promise<void>;
        deleteAll: () => Promise<void>;
        get: (
            id: string,
            opts?: { includeHistory?: boolean },
        ) => Promise<
            | {
                collection: string;
                id: string;
                scheduledForCancel: NonNullable<boolean | undefined>;
                scheduledForDelete: NonNullable<boolean | undefined>;
                shard: string;
                sourceNode: string;
                status: {
                    errors: { message: string; whenErroredUnixMs: number }[];
                    state: NonNullable<
                        | "REGISTERED"
                        | "HYDRATING"
                        | "FINALIZING"
                        | "DEHYDRATING"
                        | "READY"
                        | "CANCELLED"
                        | undefined,
                    >;
                    whenStartedUnixMs: number;
                };
                statusHistory: {
                    errors: { message: string; whenErroredUnixMs: number }[];
                    state: NonNullable<
                        | "REGISTERED"
                        | "HYDRATING"
                        | "FINALIZING"
                        | "DEHYDRATING"
                        | "READY"
                        | "CANCELLED"
                        | undefined,
                    >;
                    whenStartedUnixMs: number;
                }[];
                targetNode: string;
                type: NonNullable<"COPY" | "MOVE">;
                uncancelable: NonNullable<boolean | undefined>;
                whenStartedUnixMs: number;
            }
            | null,
        >;
        query: (
            opts?: QueryReplicationOpsOptions,
        ) => Promise<
            {
                collection: string;
                id: string;
                scheduledForCancel: NonNullable<boolean | undefined>;
                scheduledForDelete: NonNullable<boolean | undefined>;
                shard: string;
                sourceNode: string;
                status: {
                    errors: { message: string; whenErroredUnixMs: number }[];
                    state: NonNullable<
                        | "REGISTERED"
                        | "HYDRATING"
                        | "FINALIZING"
                        | "DEHYDRATING"
                        | "READY"
                        | "CANCELLED"
                        | undefined,
                    >;
                    whenStartedUnixMs: number;
                };
                statusHistory: {
                    errors: { message: string; whenErroredUnixMs: number }[];
                    state: NonNullable<
                        | "REGISTERED"
                        | "HYDRATING"
                        | "FINALIZING"
                        | "DEHYDRATING"
                        | "READY"
                        | "CANCELLED"
                        | undefined,
                    >;
                    whenStartedUnixMs: number;
                }[];
                targetNode: string;
                type: NonNullable<"COPY" | "MOVE">;
                uncancelable: NonNullable<boolean | undefined>;
                whenStartedUnixMs: number;
            }[],
        >;
    }
    Index

    Properties

    cancel delete deleteAll get query

    Properties

    cancel: (id: string) => Promise<void>

    Cancel a replication operation.

    Type Declaration

      • (id: string): Promise<void>

      • Parameters

        • id: string

          The ID of the replication operation to cancel.

        Returns Promise<void>

        A promise that resolves when the operation is cancelled.

    delete: (id: string) => Promise<void>

    Delete a replication operation.

    Type Declaration

      • (id: string): Promise<void>

      • Parameters

        • id: string

          The ID of the replication operation to delete.

        Returns Promise<void>

        A promise that resolves when the operation is deleted.

    deleteAll: () => Promise<void>

    Delete all replication operations.

    Type Declaration

      • (): Promise<void>

      • Returns Promise<void>

        A promise that resolves when all operations are deleted.

    get: (
        id: string,
        opts?: { includeHistory?: boolean },
    ) => Promise<
        | {
            collection: string;
            id: string;
            scheduledForCancel: NonNullable<boolean | undefined>;
            scheduledForDelete: NonNullable<boolean | undefined>;
            shard: string;
            sourceNode: string;
            status: {
                errors: { message: string; whenErroredUnixMs: number }[];
                state: NonNullable<
                    | "REGISTERED"
                    | "HYDRATING"
                    | "FINALIZING"
                    | "DEHYDRATING"
                    | "READY"
                    | "CANCELLED"
                    | undefined,
                >;
                whenStartedUnixMs: number;
            };
            statusHistory: {
                errors: { message: string; whenErroredUnixMs: number }[];
                state: NonNullable<
                    | "REGISTERED"
                    | "HYDRATING"
                    | "FINALIZING"
                    | "DEHYDRATING"
                    | "READY"
                    | "CANCELLED"
                    | undefined,
                >;
                whenStartedUnixMs: number;
            }[];
            targetNode: string;
            type: NonNullable<"COPY" | "MOVE">;
            uncancelable: NonNullable<boolean | undefined>;
            whenStartedUnixMs: number;
        }
        | null,
    >

    Get a specific replication operation by ID.

    Type Declaration

      • (
            id: string,
            opts?: { includeHistory?: boolean },
        ): Promise<
            | {
                collection: string;
                id: string;
                scheduledForCancel: NonNullable<boolean | undefined>;
                scheduledForDelete: NonNullable<boolean | undefined>;
                shard: string;
                sourceNode: string;
                status: {
                    errors: { message: string; whenErroredUnixMs: number }[];
                    state: NonNullable<
                        | "REGISTERED"
                        | "HYDRATING"
                        | "FINALIZING"
                        | "DEHYDRATING"
                        | "READY"
                        | "CANCELLED"
                        | undefined,
                    >;
                    whenStartedUnixMs: number;
                };
                statusHistory: {
                    errors: { message: string; whenErroredUnixMs: number }[];
                    state: NonNullable<
                        | "REGISTERED"
                        | "HYDRATING"
                        | "FINALIZING"
                        | "DEHYDRATING"
                        | "READY"
                        | "CANCELLED"
                        | undefined,
                    >;
                    whenStartedUnixMs: number;
                }[];
                targetNode: string;
                type: NonNullable<"COPY" | "MOVE">;
                uncancelable: NonNullable<boolean | undefined>;
                whenStartedUnixMs: number;
            }
            | null,
        >

      • Parameters

        • id: string

          The ID of the replication operation to get.

        • Optionalopts: { includeHistory?: boolean }
          • OptionalincludeHistory?: boolean

            Whether to include the status history in the response.

        Returns Promise<
            | {
                collection: string;
                id: string;
                scheduledForCancel: NonNullable<boolean | undefined>;
                scheduledForDelete: NonNullable<boolean | undefined>;
                shard: string;
                sourceNode: string;
                status: {
                    errors: { message: string; whenErroredUnixMs: number }[];
                    state: NonNullable<
                        | "REGISTERED"
                        | "HYDRATING"
                        | "FINALIZING"
                        | "DEHYDRATING"
                        | "READY"
                        | "CANCELLED"
                        | undefined,
                    >;
                    whenStartedUnixMs: number;
                };
                statusHistory: {
                    errors: { message: string; whenErroredUnixMs: number }[];
                    state: NonNullable<
                        | "REGISTERED"
                        | "HYDRATING"
                        | "FINALIZING"
                        | "DEHYDRATING"
                        | "READY"
                        | "CANCELLED"
                        | undefined,
                    >;
                    whenStartedUnixMs: number;
                }[];
                targetNode: string;
                type: NonNullable<"COPY" | "MOVE">;
                uncancelable: NonNullable<boolean | undefined>;
                whenStartedUnixMs: number;
            }
            | null,
        >

        The replication operation or null if not found.

    query: (
        opts?: QueryReplicationOpsOptions,
    ) => Promise<
        {
            collection: string;
            id: string;
            scheduledForCancel: NonNullable<boolean | undefined>;
            scheduledForDelete: NonNullable<boolean | undefined>;
            shard: string;
            sourceNode: string;
            status: {
                errors: { message: string; whenErroredUnixMs: number }[];
                state: NonNullable<
                    | "REGISTERED"
                    | "HYDRATING"
                    | "FINALIZING"
                    | "DEHYDRATING"
                    | "READY"
                    | "CANCELLED"
                    | undefined,
                >;
                whenStartedUnixMs: number;
            };
            statusHistory: {
                errors: { message: string; whenErroredUnixMs: number }[];
                state: NonNullable<
                    | "REGISTERED"
                    | "HYDRATING"
                    | "FINALIZING"
                    | "DEHYDRATING"
                    | "READY"
                    | "CANCELLED"
                    | undefined,
                >;
                whenStartedUnixMs: number;
            }[];
            targetNode: string;
            type: NonNullable<"COPY" | "MOVE">;
            uncancelable: NonNullable<boolean | undefined>;
            whenStartedUnixMs: number;
        }[],
    >

    Query all replication operations with optional filters.

    Type Declaration

      • (
            opts?: QueryReplicationOpsOptions,
        ): Promise<
            {
                collection: string;
                id: string;
                scheduledForCancel: NonNullable<boolean | undefined>;
                scheduledForDelete: NonNullable<boolean | undefined>;
                shard: string;
                sourceNode: string;
                status: {
                    errors: { message: string; whenErroredUnixMs: number }[];
                    state: NonNullable<
                        | "REGISTERED"
                        | "HYDRATING"
                        | "FINALIZING"
                        | "DEHYDRATING"
                        | "READY"
                        | "CANCELLED"
                        | undefined,
                    >;
                    whenStartedUnixMs: number;
                };
                statusHistory: {
                    errors: { message: string; whenErroredUnixMs: number }[];
                    state: NonNullable<
                        | "REGISTERED"
                        | "HYDRATING"
                        | "FINALIZING"
                        | "DEHYDRATING"
                        | "READY"
                        | "CANCELLED"
                        | undefined,
                    >;
                    whenStartedUnixMs: number;
                }[];
                targetNode: string;
                type: NonNullable<"COPY" | "MOVE">;
                uncancelable: NonNullable<boolean | undefined>;
                whenStartedUnixMs: number;
            }[],
        >

      • Parameters

        Returns Promise<
            {
                collection: string;
                id: string;
                scheduledForCancel: NonNullable<boolean | undefined>;
                scheduledForDelete: NonNullable<boolean | undefined>;
                shard: string;
                sourceNode: string;
                status: {
                    errors: { message: string; whenErroredUnixMs: number }[];
                    state: NonNullable<
                        | "REGISTERED"
                        | "HYDRATING"
                        | "FINALIZING"
                        | "DEHYDRATING"
                        | "READY"
                        | "CANCELLED"
                        | undefined,
                    >;
                    whenStartedUnixMs: number;
                };
                statusHistory: {
                    errors: { message: string; whenErroredUnixMs: number }[];
                    state: NonNullable<
                        | "REGISTERED"
                        | "HYDRATING"
                        | "FINALIZING"
                        | "DEHYDRATING"
                        | "READY"
                        | "CANCELLED"
                        | undefined,
                    >;
                    whenStartedUnixMs: number;
                }[];
                targetNode: string;
                type: NonNullable<"COPY" | "MOVE">;
                uncancelable: NonNullable<boolean | undefined>;
                whenStartedUnixMs: number;
            }[],
        >

        A list of replication operations matching the query.

    Settings

    Member Visibility

    On This Page

    Properties