0c3b8b7e90
This is an attempt to normalize/formalize command summaries. Main actions performed: * Starts with the continuation of the phrase "The XXXX command, when called, ..." for user commands. * Starts with "An internal command...", "A container command...", etc... when applicable. * Always uses periods. * Refrains from referring to other commands. If this is needed, backquotes should be used for command names. * Tries to be very clear about the data type when applicable. * Tries to mention additional effects, e.g. "The key is created if it doesn't exist" and "The set is deleted if the last member is removed." * Prefers being terse over verbose. * Tries to be consistent.
81 lines
3.2 KiB
JSON
81 lines
3.2 KiB
JSON
{
|
|
"TRACKINGINFO": {
|
|
"summary": "Returns information about server-assisted client-side caching for the connection.",
|
|
"complexity": "O(1)",
|
|
"group": "connection",
|
|
"since": "6.2.0",
|
|
"arity": 2,
|
|
"container": "CLIENT",
|
|
"function": "clientCommand",
|
|
"command_flags": [
|
|
"NOSCRIPT",
|
|
"LOADING",
|
|
"STALE",
|
|
"SENTINEL"
|
|
],
|
|
"acl_categories": [
|
|
"CONNECTION"
|
|
],
|
|
"reply_schema": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"flags": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"const": "off",
|
|
"description": "The connection isn't using server assisted client side caching."
|
|
},
|
|
{
|
|
"const": "on",
|
|
"description": "Server assisted client side caching is enabled for the connection."
|
|
},
|
|
{
|
|
"const": "bcast",
|
|
"description": "The client uses broadcasting mode."
|
|
},
|
|
{
|
|
"const": "optin",
|
|
"description": "The client does not cache keys by default."
|
|
},
|
|
{
|
|
"const": "optout",
|
|
"description": "The client caches keys by default."
|
|
},
|
|
{
|
|
"const": "caching-yes",
|
|
"description": "The next command will cache keys (exists only together with optin)."
|
|
},
|
|
{
|
|
"const": "caching-no",
|
|
"description": "The next command won't cache keys (exists only together with optout)."
|
|
},
|
|
{
|
|
"const": "noloop",
|
|
"description": "The client isn't notified about keys modified by itself."
|
|
},
|
|
{
|
|
"const": "broken_redirect",
|
|
"description": "The client ID used for redirection isn't valid anymore."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"redirect": {
|
|
"type": "integer",
|
|
"description": "The client ID used for notifications redirection, or -1 when none."
|
|
},
|
|
"prefixes": {
|
|
"type": "array",
|
|
"description": "List of key prefixes for which notifications are sent to the client.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|