Back to Redis

XGROUP CREATECONSUMER

content/commands/xgroup-createconsumer.md

latest1.2 KB
Original Source

Create a consumer named <consumername> in the consumer group <groupname> of the stream that's stored at <key>.

Consumers are also created automatically whenever an operation, such as [XREADGROUP]({{< relref "/commands/xreadgroup" >}}), references a consumer that doesn't exist. This is valid for [XREADGROUP]({{< relref "/commands/xreadgroup" >}}) only when there is data in the stream.

Redis Software and Redis Cloud compatibility

| Redis Software | Redis Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> | |:----------------------|:-----------------|:------| | <span title="Supported">✅ Standard</span> <span title="Supported"><nobr>✅ Active-Active</nobr></span> | <span title="Supported">✅ Standard</span> <span title="Supported"><nobr>✅ Active-Active</nobr></span> | |

Return information

{{< multitabs id="xgroup-createconsumer-return-info" tab1="RESP2" tab2="RESP3" >}}

Integer reply: the number of created consumers, either 0 or 1.

-tab-sep-

Integer reply: the number of created consumers, either 0 or 1.

{{< /multitabs >}}