XGROUP

XGROUP CREATE

XGROUP CREATE key group <id | $> [MKSTREAM]
  [ENTRIESREAD entries-read]

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

5.0.0

Сложность вычислений:

O(1)

Категории ACL:

@write, @stream, @slow,

Создаёт новую группу потребителей, уникально идентифицированную <groupname>, для потока, хранящегося по адресу <key>

Каждая группа имеет уникальное имя в заданном потоке. Если группа с таким же именем уже существует, команда возвращает ошибку -BUSYGROUP

Аргумент команды <id> указывает последнюю доставленную запись в потоке с точки зрения новой группы. Специальный идентификатор $ — это идентификатор последней записи в потоке, но вы можете заменить его любым допустимым идентификатором.

Например, если вы хотите, чтобы потребители группы получали весь поток с самого начала, используйте ноль в качестве начального идентификатора для группы потребителей:

XGROUP CREATE mystream mygroup 0

По умолчанию команда XGROUP CREATE ожидает, что целевой поток существует, и возвращает ошибку, если этого нет. Если поток не существует, вы можете создать его автоматически с длиной 0, используя необязательную подкоманду MKSTREAM в качестве последнего аргумента после <id>

XGROUP CREATE mystream mygroup $ MKSTREAM

Для отслеживания задержки группы потребителей укажите необязательный аргумент entries_read с произвольным идентификатором. Произвольный идентификатор — это любой идентификатор, который не является идентификатором первой, последней записи потока или идентификатором «0-0». Используйте его, чтобы узнать, сколько записей находится между произвольным идентификатором (исключая его) и последней записью потока. Установите entries_read в значение entries_added потока, уменьшенное на количество записей.

Возвращаемое значение

Простой строковый ответ: OK при успехе.

История

• Начиная с версии Redis 7.0.0: Добавлен аргумент entries_read.