summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/client-caching.md
blob: 7bbb439a36b684f450bcbba55a33d0eec60e6a20 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
This command controls the tracking of the keys in the next command executed by
the connection, when tracking is enabled in `OPTIN` or `OPTOUT` mode. Please
check the [client side caching documentation](/topics/client-side-caching) for
background informations.

When tracking is enabled Redis, using the `CLIENT TRACKING` command, it is
possible to specify the `OPTIN` or `OPTOUT` options, so that keys in read only
commands are not automatically remembered by the server to be invalidated later.
When we are in `OPTIN` mode, we can enable the tracking of the keys in the next
command by calling `CLIENT CACHING yes` immediately before it. Similarly when we
are in `OPTOUT` mode, and keys are normally tracked, we can avoid the keys in
the next command to be tracked using `CLIENT CACHING no`.

Basically the command sets a state in the connection, that is valid only for the
next command execution, that will modify the behavior of client tracking.

@return

@simple-string-reply: `OK` or an error if the argument is not yes or no.