AI agent builder

PING

Syntax text Syntax diagram API methods

PING [message]

Client:

ping(
    **kwargs: Any
) → Union[Awaitable[bool], bool]

parseCommand(
    parser: CommandParser,  // The command parser
    message: RedisArgument  // Optional message to be returned instead of PONG
) → SimpleStringReply | BlobStringReply

ping() → String  // PONG

ping(
    message: String  // The message to echo
) → String  // The message

Ping(
    ctx: context.Context  // Context
) → *StatusCmd

ping(
    $message: ?string  // Optional message
) → mixed

Available since:: Redis Open Source 1.0.0
Time complexity:: O(1)
ACL categories:: @fast, @connection,
Compatibility:: Redis Software and Redis Cloud compatibility

This command returns the bulk string PONG if no argument is provided, otherwise it returns a copy of the provided message as a bulk string.

This command is useful for:

Testing whether a connection is still alive.
Verifying the server's ability to serve data - an error is returned when this isn't the case (for example, during load from persistence data or accessing a stale replica).
Measuring latency.

If the client is subscribed to a channel or a pattern, it will instead return a multi-bulk string with PONG in the first position and an empty bulk string in the second position, unless an argument is provided, in which case it returns a copy of the argument.

Optional arguments

message

A message to return instead of PONG.

Examples

Redis Software and Redis Cloud compatibility

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

Return information

RESP2 RESP3

Any of the following:

Simple string reply: PONG when no argument is provided.
Bulk string reply: the provided argument.