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

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 simple 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 a RESP2 client is subscribed to a channel, pattern, or shard channel, PING returns a two-element array instead. The first element is the bulk string pong (lowercase). The second is a copy of message if you provide one, or an empty bulk string if you don't. RESP3 clients get the standard reply whether or not they're subscribed.

Optional arguments

message

A message to return instead of PONG.

Examples

redis> PING
PONG
redis> PING "hello world"
"hello world"

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.
Array reply: "pong" and either the provided argument or an empty bulk string, when the client is in subscribed mode.