For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Type Alias: Partition

type Partition = object;

Provides information on a partition within a broker node.

Properties​

health​

health: "healthy" | "unhealthy" | "dead";

Describes the current health of the partition.

partitionId​

partitionId: number;

The unique ID of this partition.

role​

role: "leader" | "follower" | "inactive";

Describes the Raft role of the broker for a given partition.

state​

state: "unknown" | "joining" | "active" | "leaving" | "recovering" | "learner";

Describes the current operational state of the partition within the cluster configuration.