CONFIG GET

Syntax text Syntax diagram API methods

CONFIG GET parameter [parameter ...]

Client:

config_get(
    pattern: PatternT,  // Config pattern
    *args: PatternT,
    **kwargs: Any
) → ResponseT

configGet(
    parameters: RedisVariadicArgument  // Pattern or specific configuration parameter names
) → Map<BlobStringReply, BlobStringReply>

configGet(
    pattern: String  // Config pattern
) → Map<String, String>  // Bulk reply

configGet(
    patterns: String...  // Config patterns
) → Map<String, String>  // Bulk reply

configGet(
    parameter: String
) → Map<String, String>

configGet(
    parameters: String...
) → Map<String, String>

configGet(
    parameter: String
) → RedisFuture<Map<String, String>>

configGet(
    parameters: String...
) → RedisFuture<Map<String, String>>

configGet(
    parameter: String
) → Mono<Map<String, String>>

configGet(
    parameters: String...
) → Mono<Map<String, String>>

ConfigGet(
    ctx: context.Context,  // Context
    parameter: string  // Config parameter
) → *MapStringStringCmd

config(
    $subcommand: string,
    $argument: mixed
) → mixed

Available since:: Redis Open Source 2.0.0
Time complexity:: O(N) when N is the number of configuration parameters provided
ACL categories:: @admin, @slow, @dangerous,
Compatibility:: Redis Software and Redis Cloud compatibility

The CONFIG GET command is used to read the configuration parameters of a running Redis server. Not all the configuration parameters are supported in Redis 2.4, while Redis 2.6 can read the whole configuration of a server using this command.

The symmetric command used to alter the configuration at run time is CONFIG SET.

CONFIG GET takes multiple arguments, which are glob-style patterns. Any configuration parameter matching any of the patterns are reported as a list of key-value pairs.

You can obtain a list of all the supported configuration parameters by typing CONFIG GET * in an open redis-cli prompt.

All the supported parameters have the same meaning of the equivalent configuration parameter used in the redis.conf file. The provided link has links to the redis.conf files for Redis version 6.2 and greater. See the Redis souce code repo for earlier versions.

Required arguments

parameter [parameter ...]

One or more configuration parameter names or glob-style patterns to retrieve.

Examples

redis> config get *max-*-entries* maxmemory
 1) "maxmemory"
 2) "0"
 3) "hash-max-listpack-entries"
 4) "512"
 5) "hash-max-ziplist-entries"
 6) "512"
 7) "set-max-intset-entries"
 8) "512"
 9) "zset-max-listpack-entries"
10) "128"
11) "zset-max-ziplist-entries"
12) "128"

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active	Only supports a subset of configuration settings.

Return information

RESP2 RESP3

Array reply: a list of configuration parameters matching the provided arguments.

History

Starting with Redis version 7.0.0: Added the ability to pass multiple pattern parameters in one call