mirror of
https://github.com/redis/redis.git
synced 2026-04-21 03:01:35 -04:00
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.
59 lines
1.4 KiB
JSON
59 lines
1.4 KiB
JSON
{
|
|
"ENCODING": {
|
|
"summary": "Returns the internal encoding of a Redis object.",
|
|
"complexity": "O(1)",
|
|
"group": "generic",
|
|
"since": "2.2.3",
|
|
"arity": 3,
|
|
"container": "OBJECT",
|
|
"function": "objectCommand",
|
|
"command_flags": [
|
|
"READONLY"
|
|
],
|
|
"acl_categories": [
|
|
"KEYSPACE"
|
|
],
|
|
"command_tips": [
|
|
"NONDETERMINISTIC_OUTPUT"
|
|
],
|
|
"key_specs": [
|
|
{
|
|
"flags": [
|
|
"RO"
|
|
],
|
|
"begin_search": {
|
|
"index": {
|
|
"pos": 2
|
|
}
|
|
},
|
|
"find_keys": {
|
|
"range": {
|
|
"lastkey": 0,
|
|
"step": 1,
|
|
"limit": 0
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"arguments": [
|
|
{
|
|
"name": "key",
|
|
"type": "key",
|
|
"key_spec_index": 0
|
|
}
|
|
],
|
|
"reply_schema": {
|
|
"oneOf": [
|
|
{
|
|
"description": "key doesn't exist",
|
|
"type": "null"
|
|
},
|
|
{
|
|
"description": "encoding of the object",
|
|
"type": "string"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|