Redis Server: CLIENT PAUSE timeout

Description

Redis CLIENT PAUSE command controlled the connection and able to suspend all the Redis clients for the specified amount of time. The command performs the following actions:

• It stops processing all the pending commands from normal and pub/sub clients. However interactions with slaves will continue normally.
• However, it returns OK to the caller ASAP, so the CLIENT PAUSE command execution is not paused by itself.
• When the specified amount of time has elapsed, all the clients are unblocked: this will trigger the processing of all the commands accumulated in the query buffer of every client during the pause.

This command is useful to switch clients from a Redis instance to another one in a controlled way. For example during an instance upgrade the system administrator could do the following:

• Pause the clients using CLIENT PAUSE
• Wait a few seconds to make sure the slaves processed the latest replication stream from the master.
• Turn one of the slaves into a master.
• Reconfigure clients to connect with the new master.

Syntax:

Basic syntax of redis CLIENT PAUSE command is shown below:

CLIENT PAUSE timeout 

Available since

2.9.50.

Return Value

Simple string reply: The command returns OK or an error if the timeout is invalid.

Return Value Type

String

Previous: CLIENT GETNAME
Next: CLIENT SETNAME