Download documentation

Choose the products and versions you want. Everything arrives as one .tar.gz, with a directory per product.

Format

This page

	Products	Version
	Develop with Redis Clients, data types, programmability, and Redis for AI. RedisVL is listed separately.
	Libraries and tools Client libraries, observability, and cloud integrations. Redis Data Integration is listed separately.
	RedisVL
	Redis Software
	Redis Cloud
	Redis for Kubernetes
	Redis Open Source
	Redis Iris context engine
	Redis Feature Form
	Redis Insight
	Redis Data Integration
	Glossary
	Command reference

COMMAND GETKEYS

Syntax text Syntax diagram API methods

COMMAND GETKEYS command [arg [arg ...]]

Client:

command_getkeys(
    command: str,
    *args: Any,
    **kwargs: Any
) → list

commandGetKeys(
    args: String...
) → List<String>

commandGetkeys(
    args: String...
) → List<String>

commandGetkeys(
    args: String...
) → RedisFuture<List<String>>

commandGetkeys(
    args: String...
) → Flux<String>

CommandGetKeys(
    ctx: context.Context,  // Context
    commands: ...interface{}
) → *StringSliceCmd

command(
    $subcommand: string,
    $args: mixed
) → array

Available since:: Redis Open Source 2.8.13
Time complexity:: O(N) where N is the number of arguments to the command
ACL categories:: @slow, @connection,
Compatibility:: Redis Software and Redis Cloud compatibility

COMMAND GETKEYS is a helper command to let you find the keys from the provided Redis command.

COMMAND describes how Redis identifies key names for each command, including firstkey, key specifications, and movablekeys. For some commands, Redis can identify the keys only by parsing the full command. Use COMMAND GETKEYS or COMMAND GETKEYSANDFLAGS to get the key names directly from the Redis command parser.

Required arguments

command

The name of the command to analyze.

Optional arguments

arg [arg ...]

The arguments that would be passed to the command.

Examples

redis> COMMAND GETKEYS MSET a b c d e f
1) "a"
2) "c"
3) "e"
redis> COMMAND GETKEYS EVAL "not consulted" 3 key1 key2 key3 arg1 arg2 arg3 argN
1) "key1"
2) "key2"
3) "key3"
redis> COMMAND GETKEYS SORT mylist ALPHA STORE outlist
1) "mylist"
2) "outlist"

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

Return information

RESP2 RESP3

Array reply: list of keys from the given command.