weaviate-client
    Preparing search index...

    Interface Cluster

    interface Cluster {
        nodes: <O extends Output = undefined>(
            opts?: NodesOptions<O>,
        ) => Promise<Node<O>[]>;
        queryShardingState: (
            collection: string,
            opts?: QueryShardingStateOptions,
        ) => Promise<
            { collection: string; shards: { replicas: string[]; shard: string }[] },
        >;
        replicate: (args: ReplicateArgs) => Promise<string>;
        replications: Replications;
    }
    Index

    Properties

    nodes queryShardingState replicate replications

    Properties

    nodes: <O extends Output = undefined>(
        opts?: NodesOptions<O>,
    ) => Promise<Node<O>[]>

    Get the status of all nodes in the cluster.

    Type Declaration

      • <O extends Output = undefined>(opts?: NodesOptions<O>): Promise<Node<O>[]>

      • Type Parameters

        Parameters

        Returns Promise<Node<O>[]>

        The status of all nodes in the cluster.

    queryShardingState: (
        collection: string,
        opts?: QueryShardingStateOptions,
    ) => Promise<
        { collection: string; shards: { replicas: string[]; shard: string }[] },
    >

    Query the sharding state of a specific collection.

    Type Declaration

      • (
            collection: string,
            opts?: QueryShardingStateOptions,
        ): Promise<
            { collection: string; shards: { replicas: string[]; shard: string }[] },
        >

      • Parameters

        Returns Promise<{ collection: string; shards: { replicas: string[]; shard: string }[] }>

        The sharding state of the collection.

    replicate: (args: ReplicateArgs) => Promise<string>

    Replicate a shard from one node to another.

    Type Declaration

      • (args: ReplicateArgs): Promise<string>

      • Parameters

        Returns Promise<string>

        The ID of the replication request.

    replications: Replications

    Access replication operations.

    Settings

    Member Visibility

    On This Page

    Properties