xgroup_create(
name: KeyT,
groupname: GroupT,
id: StreamIdT = "$",
mkstream: bool = False,
entries_read: Optional[int] = None
) → ResponseT
XGROUP_CREATE(
key: RedisArgument,
group: RedisArgument,
id: RedisArgument,
options?: XGroupCreateOptions
) → Any
Possible errors
- BUSYGROUP:
SimpleError (test with err.message.startsWith('BUSYGROUP'))
- NOGROUP:
SimpleError (test with err.message.startsWith('NOGROUP'))
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
xgroupCreate(
key: byte[],
consumer: byte[],
id: byte[],
makeStream: boolean
) → String
xgroupCreate(
key: String,
groupName: String,
makeStream: StreamEntryID id final boolean
) → String
xgroupCreate(
key: String,
groupName: String,
id: StreamEntryID,
makeStream: boolean
) → String
Possible errors
- BUSYGROUP:
JedisDataException
- NOGROUP:
JedisDataException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
xgroupCreate(
streamOffset: StreamOffset<K>, // name of the stream containing the offset to set.
group: K // name of the consumer group.
) → String // simple-reply true if successful. @since 5.2
xgroupCreate(
streamOffset: StreamOffset<K>, // name of the stream containing the offset to set.
group: K, // name of the consumer group.
args: XGroupCreateArgs
) → String // simple-reply true if successful. @since 5.2
Possible errors
- BUSYGROUP:
RedisBusyException
- NOGROUP:
RedisCommandExecutionException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
xgroupCreate(
streamOffset: StreamOffset<K>, // name of the stream containing the offset to set.
group: K // name of the consumer group.
) → RedisFuture<String> // simple-reply true if successful. @since 5.2
xgroupCreate(
streamOffset: StreamOffset<K>, // name of the stream containing the offset to set.
group: K, // name of the consumer group.
args: XGroupCreateArgs
) → RedisFuture<String> // simple-reply true if successful. @since 5.2
Possible errors
- BUSYGROUP:
RedisBusyException
- NOGROUP:
RedisCommandExecutionException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
xgroupCreate(
streamOffset: StreamOffset<K>, // name of the stream containing the offset to set.
group: K // name of the consumer group.
) → Mono<String> // simple-reply true if successful. @since 5.2
xgroupCreate(
streamOffset: StreamOffset<K>, // name of the stream containing the offset to set.
group: K, // name of the consumer group.
args: XGroupCreateArgs
) → Mono<String> // simple-reply true if successful. @since 5.2
Possible errors
- BUSYGROUP:
RedisBusyException
- NOGROUP:
RedisCommandExecutionException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
XGroupCreate(
ctx: context.Context,
stream: Any,
group: Any,
start: string
) → *StatusCmd
XGroupCreateMkStream(
ctx: context.Context,
stream: Any,
group: Any,
start: string
) → *StatusCmd
Possible errors
- BUSYGROUP:
redis.Error (test with redis.HasErrorPrefix(err, "BUSYGROUP"))
- NOGROUP:
redis.Error (test with redis.HasErrorPrefix(err, "NOGROUP"))
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
StreamCreateConsumerGroup(
key: RedisKey, // The key of the stream.
groupName: RedisValue, // The name of the group to create.
position: RedisValue?, // The position to begin reading the stream. Defaults to NewMessages.
flags: CommandFlags // The flags to use for this operation.
) → bool // true if the group was created, false otherwise.
StreamCreateConsumerGroup(
key: RedisKey, // The key of the stream.
groupName: RedisValue, // The name of the group to create.
position: RedisValue?, // The position to begin reading the stream. Defaults to NewMessages.
createStream: bool, // Create the stream if it does not already exist.
flags: CommandFlags // The flags to use for this operation.
) → bool // true if the group was created, false otherwise.
StreamCreateConsumerGroup(
key: RedisKey, // The key of the stream.
groupName: RedisValue, // The name of the group to create.
position: RedisValue?, // The position to begin reading the stream. Defaults to NewMessages.
flags: CommandFlags // The flags to use for this operation.
) → bool // true if the group was created, false otherwise.
StreamCreateConsumerGroup(
key: RedisKey, // The key of the stream.
groupName: RedisValue, // The name of the group to create.
position: RedisValue?, // The position to begin reading the stream. Defaults to NewMessages.
createStream: bool, // Create the stream if it does not already exist.
flags: CommandFlags // The flags to use for this operation.
) → bool // true if the group was created, false otherwise.
Possible errors
- BUSYGROUP:
RedisServerException
- NOGROUP:
RedisServerException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
StreamCreateConsumerGroup(
key: RedisKey, // The key of the stream.
groupName: RedisValue, // The name of the group to create.
position: RedisValue?, // The position to begin reading the stream. Defaults to NewMessages.
flags: CommandFlags // The flags to use for this operation.
) → bool // true if the group was created, false otherwise.
StreamCreateConsumerGroup(
key: RedisKey, // The key of the stream.
groupName: RedisValue, // The name of the group to create.
position: RedisValue?, // The position to begin reading the stream. Defaults to NewMessages.
createStream: bool, // Create the stream if it does not already exist.
flags: CommandFlags // The flags to use for this operation.
) → bool // true if the group was created, false otherwise.
StreamCreateConsumerGroup(
key: RedisKey, // The key of the stream.
groupName: RedisValue, // The name of the group to create.
position: RedisValue?, // The position to begin reading the stream. Defaults to NewMessages.
flags: CommandFlags // The flags to use for this operation.
) → bool // true if the group was created, false otherwise.
StreamCreateConsumerGroup(
key: RedisKey, // The key of the stream.
groupName: RedisValue, // The name of the group to create.
position: RedisValue?, // The position to begin reading the stream. Defaults to NewMessages.
createStream: bool, // Create the stream if it does not already exist.
flags: CommandFlags // The flags to use for this operation.
) → bool // true if the group was created, false otherwise.
Possible errors
- BUSYGROUP:
RedisServerException
- NOGROUP:
RedisServerException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
create(
$key: string,
$group: string,
$id: string,
bool $mkStream = false: Any,
?string $entriesRead = null: Any
) → Status
Possible errors
- BUSYGROUP:
Predis\Response\ServerException (test with $e->getErrorType() === 'BUSYGROUP')
- NOGROUP:
Predis\Response\ServerException (test with $e->getErrorType() === 'NOGROUP')
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
xgroup_create(
key: K,
group: G,
id: ID
) → ()
xgroup_create_mkstream(
key: K,
group: G,
id: ID
) → ()
Possible errors
- BUSYGROUP:
ErrorKind::Extension (test with err.code() == Some("BUSYGROUP"))
- NOGROUP:
ErrorKind::Extension (test with err.code() == Some("NOGROUP"))
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
xgroup_create(
key: K,
group: G,
id: ID
) → ()
xgroup_create_mkstream(
key: K,
group: G,
id: ID
) → ()
Possible errors
- BUSYGROUP:
ErrorKind::Extension (test with err.code() == Some("BUSYGROUP"))
- NOGROUP:
ErrorKind::Extension (test with err.code() == Some("NOGROUP"))
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
