AI agent builder

CLUSTER KEYSLOT

Syntax text Syntax diagram API methods

CLUSTER KEYSLOT key

Client:

No method signature available for this client.

parseCommand(
    parser: CommandParser,  // The Redis command parser
    key: RedisArgument  // The key to get the hash slot for
) → NumberReply

clusterKeySlot(
    key: String
) → long  // OK

clusterKeyslot(
    key: K  // The key to get the hash slot for
) → Long  // The hash slot number

clusterKeyslot(
    key: K  // The key to get the hash slot for
) → RedisFuture<Long>  // The hash slot number

clusterKeyslot(
    key: K  // The key to get the hash slot for
) → Mono<Long>  // The hash slot number

ClusterKeySlot(
    ctx: context.Context,
    key: string
) → *IntCmd

Available since:: Redis Open Source 3.0.0
Time complexity:: O(N) where N is the number of bytes in the key
ACL categories:: @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Returns an integer identifying the hash slot the specified key hashes to. This command is mainly useful for debugging and testing, since it exposes via an API the underlying Redis implementation of the hashing algorithm. Example use cases for this command:

Client libraries may use Redis in order to test their own hashing algorithm, generating random keys and hashing them with both their local implementation and using Redis CLUSTER KEYSLOT command, then checking if the result is the same.
Humans may use this command in order to check what is the hash slot, and then the associated Redis Cluster node, responsible for a given key.

The command uses the full Redis Cluster hashing algorithm, including support for hash tags. If a key contains a valid hash tag, Redis hashes only the part of the key between { and }. You can use hash tags to force multiple keys into the same hash slot so they are handled by the same node.

Required arguments

key

The key name to compute the hash slot for.

Examples

> CLUSTER KEYSLOT somekey
(integer) 11058
> CLUSTER KEYSLOT foo{hash_tag}
(integer) 2515
> CLUSTER KEYSLOT bar{hash_tag}
(integer) 2515

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active	Only supported with the OSS cluster API.

Return information

RESP2 RESP3

Integer reply: The hash slot number for the specified key