КОМАНДА

COMMAND DOCS

COMMAND DOCS [command-name [command-name ...]]

Доступно с версии:

7.0.0

Сложность по времени:

O(N), где N — количество команд для поиска

Категории ACL:

@slow, @connection,

Возвращает документальную информацию о командах.

По умолчанию ответ включает все команды сервера. Можно использовать необязательный аргумент имя_команды для указания одного или нескольких имён команд.

Для каждой возвращённой команды в ответе содержится карта. В карту могут быть включены следующие ключи:

• summary: краткое описание команды.
• since: версия Redis, в которой была добавлена команда (или для команд модулей, версия модуля).
• group: функциональная группа, к которой относится команда. Возможные значения:
  • bitmap
  • cluster
  • connection
  • generic
  • geo
  • hash
  • hyperloglog
  • list
  • module
  • pubsub
  • scripting
  • sentinel
  • server
  • set
  • sorted-set
  • stream
  • string
  • transactions
• complexity: краткое объяснение сложности по времени команды.
• doc_flags: массив флагов документации. Возможные значения:
  • deprecated: команда устарела.
  • syscmd: системная команда, не предназначенная для вызова пользователями.
• deprecated_since: версия Redis, в которой команда устарела (или для команд модулей, версия модуля).
• replaced_by: альтернатива устаревшей команде.
• history: массив исторических заметок, описывающих изменения в поведении или аргументах команды. Каждый элемент — массив из двух элементов:
  1. Версия Redis, к которой относится запись.
  2. Описание изменения.
• arguments: массив карт, описывающих аргументы команды. Подробнее см. страницу аргументы команд Redis.

Возврат

Массивный ответ: карта в виде плоского массива, как описано выше.

Примеры

COMMAND DOCS SET