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.
56 lines
1.5 KiB
JSON
56 lines
1.5 KiB
JSON
{
|
|
"FLUSHDB": {
|
|
"summary": "Remove all keys from the current database.",
|
|
"complexity": "O(N) where N is the number of keys in the selected database",
|
|
"group": "server",
|
|
"since": "1.0.0",
|
|
"arity": -1,
|
|
"function": "flushdbCommand",
|
|
"history": [
|
|
[
|
|
"4.0.0",
|
|
"Added the `ASYNC` flushing mode modifier."
|
|
],
|
|
[
|
|
"6.2.0",
|
|
"Added the `SYNC` flushing mode modifier."
|
|
]
|
|
],
|
|
"command_flags": [
|
|
"WRITE"
|
|
],
|
|
"acl_categories": [
|
|
"KEYSPACE",
|
|
"DANGEROUS"
|
|
],
|
|
"command_tips": [
|
|
"REQUEST_POLICY:ALL_SHARDS",
|
|
"RESPONSE_POLICY:ALL_SUCCEEDED"
|
|
],
|
|
"reply_schema": {
|
|
"const": "OK"
|
|
},
|
|
"arguments": [
|
|
{
|
|
"name": "flush-type",
|
|
"type": "oneof",
|
|
"optional": true,
|
|
"arguments": [
|
|
{
|
|
"name": "async",
|
|
"type": "pure-token",
|
|
"token": "ASYNC",
|
|
"since": "4.0.0"
|
|
},
|
|
{
|
|
"name": "sync",
|
|
"type": "pure-token",
|
|
"token": "SYNC",
|
|
"since": "6.2.0"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|