weaviate.cluster package

Module for interacting with Weaviate cluster information

class weaviate.cluster.Cluster(connection: Connection | ConnectionV4)[source]

Bases: object

Cluster class used for cluster information

Initialize a Cluster class instance.

Parameters

connectionweaviate.connect.Connection: Connection object to an active and running Weaviate instance.

get_nodes_status(class_name: str | None = None, output: Literal['minimal', 'verbose'] | None = None) → List[Node][source]

Get the nodes status.

Parameters

class_nameOptional[str]: Get the status for the given class. If not given all classes will be included.
outputOptional[str]: Set the desired output verbosity level. Can be [minimal | verbose], defaults to minimal.

Returns

list: List of nodes and their respective status.

Raises

requests.ConnectionError: If the network connection to weaviate fails.
weaviate.UnexpectedStatusCodeException: If weaviate reports a none OK status.
weaviate.EmptyResponseException: If the response is empty.

Submodules

weaviate.cluster.cluster module

Cluster class definition.

class weaviate.cluster.cluster.Cluster(connection: Connection | ConnectionV4)[source]

Bases: object

Cluster class used for cluster information

Initialize a Cluster class instance.

Parameters

connectionweaviate.connect.Connection: Connection object to an active and running Weaviate instance.

get_nodes_status(class_name: str | None = None, output: Literal['minimal', 'verbose'] | None = None) → List[Node][source]

Get the nodes status.

Parameters

class_nameOptional[str]: Get the status for the given class. If not given all classes will be included.
outputOptional[str]: Set the desired output verbosity level. Can be [minimal | verbose], defaults to minimal.

Returns

list: List of nodes and their respective status.

Raises

requests.ConnectionError: If the network connection to weaviate fails.
weaviate.UnexpectedStatusCodeException: If weaviate reports a none OK status.
weaviate.EmptyResponseException: If the response is empty.

weaviate.cluster.types module

class weaviate.cluster.types.BatchStats[source]

Bases: TypedDict

queueLength: int

ratePerSecond: int

class weaviate.cluster.types.Node[source]

Bases: TypedDict

batchStats: BatchStats

gitHash: str

name: str

shards: List[Shard] | None

stats: Stats

status: str

version: str

class weaviate.cluster.types.Shard

Bases: dict

class: str

name: str

objectCount: int

class weaviate.cluster.types.Stats[source]

Bases: TypedDict

objectCount: int

shardCount: int