From 85470f0e1bf7525009f1302ae63ac73af81a6a50 Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Tue, 10 Nov 2026 10:46:42 +0000 Subject: [PATCH] DOC-7292 Add API mappings for the new Redis 8.12 commands Adds data/command-api-mapping/ entries for BITRANGEINTARRAY, SADDEX, SEXPIRE, SPEXPIRE, SEXPIREAT, SPEXPIREAT, STTL, SPTTL, SEXPIRETIME, SPEXPIRETIME, SPERSIST and BLESS SET/CLEAR/GET/SCAN (15 files), and regenerates data/command-api-mapping.json (additions only). Signatures were read from each client's default branch on 2026-11-10, not from a release. None of these APIs is in a stable release yet, so this PR is parked until the clients ship (see the park manifest). Per-client state on 2026-11-10: - redis_py: all 15 typed on master; in v8.2.0b1 except BITRANGEINTARRAY; none in v8.1.0 (latest stable). - node_redis: all 15; only BLESS confirmed shipped (6.3.1, 6.4.0-beta.0). - go-redis, redis_rb: all 15 on master, none in v9.23.0 / v6.0.0. - php (predis): BLESS shipped in 3.7.1; set expiry on main only (#1749); BITRANGEINTARRAY only in open PR #1754, so it is NOT mapped. - jedis: 14 on master (BLESS #4773, set expiry #4828), none in v8.1.0-beta2; BITRANGEINTARRAY only in open PR #4830, NOT mapped. - lettuce: all 15 on main (BITRANGEINTARRAY #3992 merged 2026-11-09), none in a tag. - nredisstack/SE.Redis and redis-rs: nothing on the default branch, so no entries. SE.Redis has the work on its 8.12 branch behind SER011. Learned: - The 2026-11-07 PR scan was already stale for lettuce and jedis; re-read the default branch rather than trusting the scan. - git's default diff of the regenerated merged file shows ~44k changed lines for what is an 8.5k-line pure addition; check with `git diff --patience`. - Several upstream tests gate these commands at 8.11.x while the commands ship in 8.12 (redis-py 8.11.240, predis 8.11.0); not a docs problem, but do not copy those gates. - go-redis BlessScan is node-local (cursor), and node_redis BLESS SCAN returns a transformed {cursor, keys} object; descriptions are left empty. Co-Authored-By: Claude Sonnet 5.5 --- data/command-api-mapping.json | 44506 +++++++++------- .../command-api-mapping/BITRANGEINTARRAY.json | 347 + data/command-api-mapping/BLESS CLEAR.json | 217 + data/command-api-mapping/BLESS GET.json | 167 + data/command-api-mapping/BLESS SCAN.json | 466 + data/command-api-mapping/BLESS SET.json | 217 + data/command-api-mapping/SADDEX.json | 590 + data/command-api-mapping/SEXPIRE.json | 1079 + data/command-api-mapping/SEXPIREAT.json | 1397 + data/command-api-mapping/SEXPIRETIME.json | 312 + data/command-api-mapping/SPERSIST.json | 312 + data/command-api-mapping/SPEXPIRE.json | 1079 + data/command-api-mapping/SPEXPIREAT.json | 1397 + data/command-api-mapping/SPEXPIRETIME.json | 312 + data/command-api-mapping/SPTTL.json | 312 + data/command-api-mapping/STTL.json | 312 + 16 files changed, 35027 insertions(+), 17995 deletions(-) create mode 100644 data/command-api-mapping/BITRANGEINTARRAY.json create mode 100644 data/command-api-mapping/BLESS CLEAR.json create mode 100644 data/command-api-mapping/BLESS GET.json create mode 100644 data/command-api-mapping/BLESS SCAN.json create mode 100644 data/command-api-mapping/BLESS SET.json create mode 100644 data/command-api-mapping/SADDEX.json create mode 100644 data/command-api-mapping/SEXPIRE.json create mode 100644 data/command-api-mapping/SEXPIREAT.json create mode 100644 data/command-api-mapping/SEXPIRETIME.json create mode 100644 data/command-api-mapping/SPERSIST.json create mode 100644 data/command-api-mapping/SPEXPIRE.json create mode 100644 data/command-api-mapping/SPEXPIREAT.json create mode 100644 data/command-api-mapping/SPEXPIRETIME.json create mode 100644 data/command-api-mapping/SPTTL.json create mode 100644 data/command-api-mapping/STTL.json diff --git a/data/command-api-mapping.json b/data/command-api-mapping.json index be2885e63b..1ed81e022e 100644 --- a/data/command-api-mapping.json +++ b/data/command-api-mapping.json @@ -12866,1685 +12866,1706 @@ ] } }, - "BLMOVE": { + "BITRANGEINTARRAY": { "api_calls": { "redis_py": [ { - "signature": "blmove(, first_list: str,, second_list: str,, timeout: int,, src: str = \"LEFT\",, dest: str = \"RIGHT\",)", + "signature": "bitrangeintarray(key: KeyT, start: int, end: int, mode: str | None = None, limit: int | None = None, zeros: bool = False)", "params": [ { - "name": "first_list", - "type": "str", + "name": "key", + "type": "KeyT", "description": "" }, { - "name": "second_list", - "type": "str", + "name": "start", + "type": "int", "description": "" }, { - "name": "timeout", + "name": "end", "type": "int", "description": "" }, { - "name": "src", - "type": "str = \"LEFT\"", + "name": "mode", + "type": "str | None", "description": "" }, { - "name": "dest", - "type": "str = \"RIGHT\"", + "name": "limit", + "type": "int | None", + "description": "" + }, + { + "name": "zeros", + "type": "bool", "description": "" } ], "returns": { - "type": "ResponseT", + "type": "list[int]", "description": "" } } ], - "jedis": [ + "node_redis": [ { - "signature": "String blmove(final String srcKey, final String dstKey, final ListDirection from final ListDirection to, final double timeout)", + "signature": "bitRangeIntArray(key: RedisArgument, start: number | string, end: number | string, options?: BitRangeIntArrayOptions)", "params": [ { - "name": "srcKey", - "type": "String", + "name": "key", + "type": "RedisArgument", "description": "" }, { - "name": "dstKey", - "type": "String", + "name": "start", + "type": "number | string", "description": "" }, { - "name": "to", - "type": "ListDirection from final ListDirection", - "description": "can be LEFT or RIGHT" + "name": "end", + "type": "number | string", + "description": "" }, { - "name": "timeout", - "type": "double", - "description": "seconds to block. A timeout of zero can be used to block indefinitely." + "name": "options?", + "type": "BitRangeIntArrayOptions", + "description": "" } ], "returns": { - "type": "String", - "description": "The element being popped and pushed" + "type": "ArrayReply", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "BitRangeIntArray(ctx context.Context, key string, start, end int64) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "start", + "type": "int64", + "description": "" + }, + { + "name": "end", + "type": "int64", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" } }, { - "signature": "String blmove(String srcKey, String dstKey, ListDirection from, ListDirection to, double timeout)", + "signature": "BitRangeIntArrayWithArgs(ctx context.Context, key string, start, end int64, args *BitRangeIntArrayArgs) *IntSliceCmd", "params": [ { - "name": "srcKey", - "type": "String", + "name": "ctx", + "type": "context.Context", "description": "" }, { - "name": "dstKey", - "type": "String", + "name": "key", + "type": "string", "description": "" }, { - "name": "from", - "type": "ListDirection", - "description": "can be LEFT or RIGHT" + "name": "start", + "type": "int64", + "description": "" }, { - "name": "to", - "type": "ListDirection", - "description": "can be LEFT or RIGHT" + "name": "end", + "type": "int64", + "description": "" }, { - "name": "timeout", - "type": "double", - "description": "seconds to block. A timeout of zero can be used to block indefinitely." + "name": "args", + "type": "*BitRangeIntArrayArgs", + "description": "" } ], "returns": { - "type": "String", - "description": "The element being popped and pushed" + "type": "*IntSliceCmd", + "description": "" } } ], - "lettuce_sync": [ + "redis_rb": [ { - "signature": "V blmove(K source, K destination, LMoveArgs args, long timeout)", + "signature": "bitrangeintarray(key, start, stop, scale: nil, limit: nil, zeros: false)", "params": [ { - "name": "source", - "type": "K", - "description": "the source key." + "name": "key", + "type": "String", + "description": "" }, { - "name": "destination", + "name": "start", + "type": "Integer", + "description": "" + }, + { + "name": "stop", + "type": "Integer", + "description": "" + }, + { + "name": "scale", + "type": "String, Symbol", + "description": "" + }, + { + "name": "limit", + "type": "Integer", + "description": "" + }, + { + "name": "zeros", + "type": "Boolean", + "description": "" + } + ], + "returns": { + "type": "Array", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List bitrangeintarray(K key, long start, long end)", + "params": [ + { + "name": "key", "type": "K", - "description": "the destination type: key." + "description": "the key, must not be null." }, { - "name": "args", - "type": "LMoveArgs", - "description": "command arguments to configure source and destination directions." + "name": "start", + "type": "long", + "description": "the first byte of the range, inclusive; negative values count from the end." }, { - "name": "timeout", + "name": "end", "type": "long", - "description": "the timeout in seconds." + "description": "the last byte of the range, inclusive; negative values count from the end." } ], "returns": { - "type": "V", - "description": "V bulk-string-reply the element being popped and pushed. @since 6.1.3" + "type": "List", + "description": "the bit offsets, possibly empty, never null." } }, { - "signature": "V blmove(K source, K destination, LMoveArgs args, double timeout)", + "signature": "List bitrangeintarray(K key, long start, long end, BitRangeIntArrayArgs args)", "params": [ { - "name": "source", + "name": "key", "type": "K", - "description": "the source key." + "description": "the key, must not be null." }, { - "name": "destination", - "type": "K", - "description": "the destination type: key." + "name": "start", + "type": "long", + "description": "the first index of the range, inclusive, in the unit of args; negative values count from the end." }, { - "name": "args", - "type": "LMoveArgs", - "description": "command arguments to configure source and destination directions." + "name": "end", + "type": "long", + "description": "the last index of the range, inclusive, in the unit of args; negative values count from the end." }, { - "name": "timeout", - "type": "double", - "description": "the timeout in seconds." + "name": "args", + "type": "BitRangeIntArrayArgs", + "description": "the unit, limit and clear-bit options, must not be null." } ], "returns": { - "type": "V", - "description": "V bulk-string-reply the element being popped and pushed. @since 6.1.3" + "type": "List", + "description": "the bit offsets, possibly empty, never null." } } ], "lettuce_async": [ { - "signature": "RedisFuture blmove(K source, K destination, LMoveArgs args, long timeout)", + "signature": "RedisFuture> bitrangeintarray(K key, long start, long end)", "params": [ { - "name": "source", - "type": "K", - "description": "the source key." - }, - { - "name": "destination", + "name": "key", "type": "K", - "description": "the destination type: key." + "description": "the key, must not be null." }, { - "name": "args", - "type": "LMoveArgs", - "description": "command arguments to configure source and destination directions." + "name": "start", + "type": "long", + "description": "the first byte of the range, inclusive; negative values count from the end." }, { - "name": "timeout", + "name": "end", "type": "long", - "description": "the timeout in seconds." + "description": "the last byte of the range, inclusive; negative values count from the end." } ], "returns": { - "type": "RedisFuture", - "description": "V bulk-string-reply the element being popped and pushed. @since 6.1.3" + "type": "RedisFuture>", + "description": "the bit offsets, possibly empty, never null." } }, { - "signature": "RedisFuture blmove(K source, K destination, LMoveArgs args, double timeout)", + "signature": "RedisFuture> bitrangeintarray(K key, long start, long end, BitRangeIntArrayArgs args)", "params": [ { - "name": "source", + "name": "key", "type": "K", - "description": "the source key." + "description": "the key, must not be null." }, { - "name": "destination", - "type": "K", - "description": "the destination type: key." + "name": "start", + "type": "long", + "description": "the first index of the range, inclusive, in the unit of args; negative values count from the end." }, { - "name": "args", - "type": "LMoveArgs", - "description": "command arguments to configure source and destination directions." + "name": "end", + "type": "long", + "description": "the last index of the range, inclusive, in the unit of args; negative values count from the end." }, { - "name": "timeout", - "type": "double", - "description": "the timeout in seconds." + "name": "args", + "type": "BitRangeIntArrayArgs", + "description": "the unit, limit and clear-bit options, must not be null." } ], "returns": { - "type": "RedisFuture", - "description": "V bulk-string-reply the element being popped and pushed. @since 6.1.3" + "type": "RedisFuture>", + "description": "the bit offsets, possibly empty, never null." } } ], "lettuce_reactive": [ { - "signature": "Mono blmove(K source, K destination, LMoveArgs args, long timeout)", + "signature": "Flux bitrangeintarray(K key, long start, long end)", "params": [ { - "name": "source", - "type": "K", - "description": "the source key." - }, - { - "name": "destination", + "name": "key", "type": "K", - "description": "the destination type: key." + "description": "the key, must not be null." }, { - "name": "args", - "type": "LMoveArgs", - "description": "command arguments to configure source and destination directions." + "name": "start", + "type": "long", + "description": "the first byte of the range, inclusive; negative values count from the end." }, { - "name": "timeout", + "name": "end", "type": "long", - "description": "the timeout in seconds." + "description": "the last byte of the range, inclusive; negative values count from the end." } ], "returns": { - "type": "Mono", - "description": "V bulk-string-reply the element being popped and pushed. @since 6.1.3" + "type": "Flux", + "description": "the bit offsets, possibly none." } }, { - "signature": "Mono blmove(K source, K destination, LMoveArgs args, double timeout)", + "signature": "Flux bitrangeintarray(K key, long start, long end, BitRangeIntArrayArgs args)", "params": [ { - "name": "source", + "name": "key", "type": "K", - "description": "the source key." + "description": "the key, must not be null." }, { - "name": "destination", - "type": "K", - "description": "the destination type: key." + "name": "start", + "type": "long", + "description": "the first index of the range, inclusive, in the unit of args; negative values count from the end." }, { - "name": "args", - "type": "LMoveArgs", - "description": "command arguments to configure source and destination directions." + "name": "end", + "type": "long", + "description": "the last index of the range, inclusive, in the unit of args; negative values count from the end." }, { - "name": "timeout", - "type": "double", - "description": "the timeout in seconds." + "name": "args", + "type": "BitRangeIntArrayArgs", + "description": "the unit, limit and clear-bit options, must not be null." } ], "returns": { - "type": "Mono", - "description": "V bulk-string-reply the element being popped and pushed. @since 6.1.3" + "type": "Flux", + "description": "the bit offsets, possibly none." } } - ], - "go-redis": [ + ] + } + }, + "BLESS CLEAR": { + "api_calls": { + "redis_py": [ { - "signature": "BLMove(ctx context.Context, source, destination, srcpos, destpos string, timeout time.Duration)", + "signature": "bless_clear(name: KeyT, flag: BlessFlag)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" - }, - { - "name": "source", - "type": "Any", - "description": "" - }, - { - "name": "destination", - "type": "Any", - "description": "" - }, - { - "name": "srcpos", - "type": "Any", - "description": "" - }, - { - "name": "destpos", - "type": "string", + "name": "name", + "type": "KeyT", "description": "" }, { - "name": "timeout", - "type": "time.Duration", + "name": "flag", + "type": "BlessFlag", "description": "" } ], "returns": { - "type": "*StringCmd", + "type": "int", "description": "" } } ], - "ioredis": [ + "node_redis": [ { - "signature": "blmove(source: RedisKey, destination: RedisKey, left: \"LEFT\", left1: \"LEFT\", timeout: number | string, callback?: Callback)", + "signature": "blessClear(key: RedisArgument, flag: BlessFlag)", "params": [ { - "name": "source", - "type": "RedisKey", - "description": "" - }, - { - "name": "destination", - "type": "RedisKey", - "description": "" - }, - { - "name": "left", - "type": "\"LEFT\"", - "description": "" - }, - { - "name": "left1", - "type": "\"LEFT\"", - "description": "" - }, - { - "name": "timeout", - "type": "number | string", + "name": "key", + "type": "RedisArgument", "description": "" }, { - "name": "callback?", - "type": "Callback", + "name": "flag", + "type": "BlessFlag", "description": "" } ], "returns": { - "type": "Any", + "type": "NumberReply", "description": "" } - }, + } + ], + "go-redis": [ { - "signature": "blmove(source: RedisKey, destination: RedisKey, left: \"LEFT\", right: \"RIGHT\", timeout: number | string, callback?: Callback)", + "signature": "BlessClear(ctx context.Context, key string, flag BlessFlag) *IntCmd", "params": [ { - "name": "source", - "type": "RedisKey", - "description": "" - }, - { - "name": "destination", - "type": "RedisKey", - "description": "" - }, - { - "name": "left", - "type": "\"LEFT\"", - "description": "" - }, - { - "name": "right", - "type": "\"RIGHT\"", + "name": "ctx", + "type": "context.Context", "description": "" }, { - "name": "timeout", - "type": "number | string", + "name": "key", + "type": "string", "description": "" }, { - "name": "callback?", - "type": "Callback", + "name": "flag", + "type": "BlessFlag", "description": "" } ], "returns": { - "type": "Any", + "type": "*IntCmd", "description": "" } - }, + } + ], + "php": [ { - "signature": "blmove(source: RedisKey, destination: RedisKey, right: \"RIGHT\", left: \"LEFT\", timeout: number | string, callback?: Callback)", + "signature": "clear(string $key, string $flag)", "params": [ { - "name": "source", - "type": "RedisKey", - "description": "" - }, - { - "name": "destination", - "type": "RedisKey", - "description": "" - }, - { - "name": "right", - "type": "\"RIGHT\"", + "name": "$key", + "type": "string", "description": "" }, { - "name": "left", - "type": "\"LEFT\"", + "name": "$flag", + "type": "string", "description": "" - }, + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "bless_clear(key, flag)", + "params": [ { - "name": "timeout", - "type": "number | string", + "name": "key", + "type": "String", "description": "" }, { - "name": "callback?", - "type": "Callback", + "name": "flag", + "type": "String", "description": "" } ], "returns": { - "type": "Any", + "type": "Boolean", "description": "" } - }, + } + ], + "lettuce_sync": [ { - "signature": "blmove(source: RedisKey, destination: RedisKey, right: \"RIGHT\", right1: \"RIGHT\", timeout: number | string, callback?: Callback)", + "signature": "Boolean blessClear(K key, BlessFlag flag)", "params": [ { - "name": "source", - "type": "RedisKey", - "description": "" + "name": "key", + "type": "K", + "description": "the key, must not be null." }, { - "name": "destination", - "type": "RedisKey", - "description": "" - }, + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to turn off, must not be null." + } + ], + "returns": { + "type": "Boolean", + "description": "true if the flag was turned off, false if it was not set on key." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture blessClear(K key, BlessFlag flag)", + "params": [ { - "name": "right", - "type": "\"RIGHT\"", - "description": "" + "name": "key", + "type": "K", + "description": "the key, must not be null." }, { - "name": "right1", - "type": "\"RIGHT\"", - "description": "" - }, + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to turn off, must not be null." + } + ], + "returns": { + "type": "RedisFuture", + "description": "true if the flag was turned off, false if it was not set on key." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono blessClear(K key, BlessFlag flag)", + "params": [ { - "name": "timeout", - "type": "number | string", - "description": "" + "name": "key", + "type": "K", + "description": "the key, must not be null." }, { - "name": "callback?", - "type": "Callback", - "description": "" + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to turn off, must not be null." } ], "returns": { - "type": "Any", - "description": "" + "type": "Mono", + "description": "true if the flag was turned off, false if it was not set on key." } } ], - "redis_rs_sync": [ + "jedis": [ { - "signature": "blmove(srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, timeout: f64)", + "signature": "long blessClear(byte[] key, BlessFlag flag)", "params": [ { - "name": "srckey", - "type": "S", - "description": "" - }, - { - "name": "dstkey", - "type": "D", + "name": "key", + "type": "byte[]", "description": "" }, { - "name": "src_dir", - "type": "Direction", + "name": "flag", + "type": "BlessFlag", "description": "" - }, + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long blessClear(String key, BlessFlag flag)", + "params": [ { - "name": "dst_dir", - "type": "Direction", + "name": "key", + "type": "String", "description": "" }, { - "name": "timeout", - "type": "f64", + "name": "flag", + "type": "BlessFlag", "description": "" } ], "returns": { - "type": "(Option)", + "type": "long", "description": "" } } - ], - "redis_rs_async": [ + ] + } + }, + "BLESS GET": { + "api_calls": { + "redis_py": [ { - "signature": "blmove(srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, timeout: f64)", + "signature": "bless_get(name: KeyT)", "params": [ { - "name": "srckey", - "type": "S", + "name": "name", + "type": "KeyT", "description": "" - }, - { - "name": "dstkey", - "type": "D", - "description": "" - }, + } + ], + "returns": { + "type": "list[bytes | str]", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "blessGet(key: RedisArgument)", + "params": [ { - "name": "src_dir", - "type": "Direction", + "name": "key", + "type": "RedisArgument", "description": "" - }, + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "BlessGet(ctx context.Context, key string) *StringSliceCmd", + "params": [ { - "name": "dst_dir", - "type": "Direction", + "name": "ctx", + "type": "context.Context", "description": "" }, { - "name": "timeout", - "type": "f64", + "name": "key", + "type": "string", "description": "" } ], "returns": { - "type": "(Option)", + "type": "*StringSliceCmd", "description": "" } } ], - "nredisstack_sync": [ + "php": [ { - "signature": "BLMove(RedisKey source, RedisKey destination, ListSide sourceSide, ListSide destinationSide, double timeout)", + "signature": "get(string $key)", "params": [ { - "name": "source", - "type": "RedisKey", - "description": "The key of the source list." - }, - { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination list." - }, - { - "name": "sourceSide", - "type": "ListSide", - "description": "What side of the source list to remove from." - }, - { - "name": "destinationSide", - "type": "ListSide", - "description": "What side of the destination list to move to." - }, - { - "name": "timeout", - "type": "double", - "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." + "name": "$key", + "type": "string", + "description": "" } ], "returns": { - "type": "RedisValue?", - "description": "The element being popped and pushed, or null if the server timeout expires." + "type": "array", + "description": "" } - }, + } + ], + "redis_rb": [ { - "signature": "ListMove(RedisKey sourceKey, RedisKey destinationKey, ListSide sourceSide, ListSide destinationSide, CommandFlags flags = CommandFlags.None)", + "signature": "bless_get(key)", "params": [ { - "name": "sourceKey", - "type": "RedisKey", - "description": "The key of the list to remove from." - }, - { - "name": "destinationKey", - "type": "RedisKey", - "description": "The key of the list to move to." - }, - { - "name": "sourceSide", - "type": "ListSide", - "description": "What side of the sourceKey list to remove from." - }, - { - "name": "destinationSide", - "type": "ListSide", - "description": "What side of the destinationKey list to move to." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "key", + "type": "String", + "description": "" } ], "returns": { - "type": "RedisValue", - "description": "The element being popped and pushed or Null if there is no element to move." + "type": "Array", + "description": "" } - }, + } + ], + "lettuce_sync": [ { - "signature": "ListMove(RedisKey sourceKey, RedisKey destinationKey, ListSide sourceSide, ListSide destinationSide, CommandFlags flags = CommandFlags.None)", + "signature": "List blessGet(K key)", "params": [ { - "name": "sourceKey", - "type": "RedisKey", - "description": "The key of the list to remove from." - }, - { - "name": "destinationKey", - "type": "RedisKey", - "description": "The key of the list to move to." - }, - { - "name": "sourceSide", - "type": "ListSide", - "description": "What side of the sourceKey list to remove from." - }, - { - "name": "destinationSide", - "type": "ListSide", - "description": "What side of the destinationKey list to move to." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "key", + "type": "K", + "description": "the key, must not be null." } ], "returns": { - "type": "RedisValue", - "description": "The element being popped and pushed or Null if there is no element to move." + "type": "List", + "description": "List array-reply the active blessing flags of key, empty if the key is not blessed." } } ], - "nredisstack_async": [ + "lettuce_async": [ { - "signature": "ListMove(RedisKey sourceKey, RedisKey destinationKey, ListSide sourceSide, ListSide destinationSide, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture> blessGet(K key)", "params": [ { - "name": "sourceKey", - "type": "RedisKey", - "description": "The key of the list to remove from." - }, - { - "name": "destinationKey", - "type": "RedisKey", - "description": "The key of the list to move to." - }, - { - "name": "sourceSide", - "type": "ListSide", - "description": "What side of the sourceKey list to remove from." - }, - { - "name": "destinationSide", - "type": "ListSide", - "description": "What side of the destinationKey list to move to." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "key", + "type": "K", + "description": "the key, must not be null." } ], "returns": { - "type": "RedisValue", - "description": "The element being popped and pushed or Null if there is no element to move." + "type": "RedisFuture>", + "description": "List array-reply the active blessing flags of key, empty if the key is not blessed." } - }, + } + ], + "lettuce_reactive": [ { - "signature": "ListMove(RedisKey sourceKey, RedisKey destinationKey, ListSide sourceSide, ListSide destinationSide, CommandFlags flags = CommandFlags.None)", + "signature": "Flux blessGet(K key)", "params": [ { - "name": "sourceKey", - "type": "RedisKey", - "description": "The key of the list to remove from." - }, - { - "name": "destinationKey", - "type": "RedisKey", - "description": "The key of the list to move to." - }, - { - "name": "sourceSide", - "type": "ListSide", - "description": "What side of the sourceKey list to remove from." - }, - { - "name": "destinationSide", - "type": "ListSide", - "description": "What side of the destinationKey list to move to." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "key", + "type": "K", + "description": "the key, must not be null." } ], "returns": { - "type": "RedisValue", - "description": "The element being popped and pushed or Null if there is no element to move." + "type": "Flux", + "description": "the active blessing flags of key; completes empty if the key is not blessed." } } ], - "php": [ + "jedis": [ { - "signature": "blmove(string $source, string $destination, string $where, string $to, int $timeout)", + "signature": "List blessGet(byte[] key)", "params": [ { - "name": "$source", - "type": "string", - "description": "" - }, - { - "name": "$destination", - "type": "string", - "description": "" - }, - { - "name": "$where", - "type": "string", - "description": "" - }, - { - "name": "$to", - "type": "string", - "description": "" - }, - { - "name": "$timeout", - "type": "int", + "name": "key", + "type": "byte[]", "description": "" } ], "returns": { - "type": "string", + "type": "List", "description": "" } - } - ], - "redis_rb": [ + }, { - "signature": "blmove(source, destination, where_source, where_destination, timeout: 0)", + "signature": "List blessGet(String key)", "params": [ { - "name": "source", - "type": "String", - "description": "source key" - }, - { - "name": "destination", + "name": "key", "type": "String", - "description": "destination key" - }, - { - "name": "where_source", - "type": "String, Symbol", - "description": "LEFT or RIGHT" - }, - { - "name": "where_destination", - "type": "String, Symbol", - "description": "LEFT or RIGHT" - }, - { - "name": "timeout", - "type": "Float, Integer", - "description": "timeout in seconds" + "description": "" } ], "returns": { - "type": "nil, String", - "description": "the element, or nil when the source key does not exist or the timeout expired" + "type": "List", + "description": "" } } ] } }, - "BLMPOP": { + "BLESS SCAN": { "api_calls": { "redis_py": [ { - "signature": "blmpop(, timeout: float,, numkeys: int,, *args: str,, direction: str,, count: Optional[int] = 1,)", + "signature": "bless_scan(cursor: int, flag: BlessFlag, count: int | None = None, **kwargs)", "params": [ { - "name": "timeout", - "type": "float", - "description": "" - }, - { - "name": "numkeys", + "name": "cursor", "type": "int", "description": "" }, { - "name": "*args", - "type": "str", + "name": "flag", + "type": "BlessFlag", "description": "" }, { - "name": "direction", - "type": "str", + "name": "count", + "type": "int | None", "description": "" }, { - "name": "count", - "type": "Optional[int] = 1", + "name": "**kwargs", + "type": "Any", "description": "" } ], "returns": { - "type": "Optional[list]", + "type": "tuple[int, list[bytes | str]]", "description": "" } } ], - "jedis": [ + "node_redis": [ { - "signature": "KeyValue> blmpop(double timeout, ListDirection direction, String... keys)", + "signature": "blessScan(cursor: RedisArgument, flag: BlessFlag, options?: BlessScanOptions)", "params": [ { - "name": "timeout", - "type": "double", - "description": "seconds to block. A timeout of zero can be used to block indefinitely." + "name": "cursor", + "type": "RedisArgument", + "description": "" }, { - "name": "direction", - "type": "ListDirection", + "name": "flag", + "type": "BlessFlag", "description": "" }, { - "name": "keys", - "type": "String...", + "name": "options?", + "type": "BlessScanOptions", "description": "" } ], "returns": { - "type": "KeyValue>", - "description": "The element being popped and pushed" + "type": "{ cursor: BlobStringReply; keys: ArrayReply }", + "description": "" } - }, + } + ], + "go-redis": [ { - "signature": "KeyValue> blmpop(double timeout, ListDirection direction, int count, String... keys)", + "signature": "BlessScan(ctx context.Context, cursor uint64, flag BlessFlag, count int64) *ScanCmd", "params": [ { - "name": "timeout", - "type": "double", - "description": "seconds to block. A timeout of zero can be used to block indefinitely." + "name": "ctx", + "type": "context.Context", + "description": "" }, { - "name": "direction", - "type": "ListDirection", + "name": "cursor", + "type": "uint64", "description": "" }, { - "name": "count", - "type": "int", + "name": "flag", + "type": "BlessFlag", "description": "" }, { - "name": "keys", - "type": "String...", + "name": "count", + "type": "int64", "description": "" } ], "returns": { - "type": "KeyValue>", - "description": "The element being popped and pushed" + "type": "*ScanCmd", + "description": "" } - }, + } + ], + "php": [ { - "signature": "KeyValue> blmpop(double timeout, ListDirection direction, String... keys)", + "signature": "scan($cursor, string $flag, ?array $options = null)", "params": [ { - "name": "timeout", - "type": "double", - "description": "seconds to block. A timeout of zero can be used to block indefinitely." + "name": "$cursor", + "type": "mixed", + "description": "" }, { - "name": "direction", - "type": "ListDirection", + "name": "$flag", + "type": "string", "description": "" }, { - "name": "keys", - "type": "String...", + "name": "$options", + "type": "?array", "description": "" } ], "returns": { - "type": "KeyValue>", - "description": "The element being popped and pushed" + "type": "array|mixed", + "description": "" } - }, + } + ], + "redis_rb": [ { - "signature": "KeyValue> blmpop(double timeout, ListDirection direction, int count, String... keys)", + "signature": "bless_scan(cursor, flag, count: nil)", "params": [ { - "name": "timeout", - "type": "double", - "description": "seconds to block. A timeout of zero can be used to block indefinitely." - }, - { - "name": "direction", - "type": "ListDirection", + "name": "cursor", + "type": "String, Integer", "description": "" }, { - "name": "count", - "type": "int", + "name": "flag", + "type": "String", "description": "" }, { - "name": "keys", - "type": "String...", + "name": "count", + "type": "Integer", "description": "" } ], "returns": { - "type": "KeyValue>", - "description": "The element being popped and pushed" + "type": "Array(String, Array)", + "description": "" } } ], "lettuce_sync": [ { - "signature": "KeyValue> blmpop(long timeout, LMPopArgs args, K... keys)", + "signature": "KeyScanCursor blessScan(BlessFlag flag)", "params": [ { - "name": "timeout", - "type": "long", - "description": "the timeout in seconds." + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." + } + ], + "returns": { + "type": "KeyScanCursor", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "KeyScanCursor blessScan(BlessFlag flag, BlessScanArgs scanArgs)", + "params": [ + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." }, { - "name": "args", - "type": "LMPopArgs", - "description": "the additional command arguments." + "name": "scanArgs", + "type": "BlessScanArgs", + "description": "scan arguments, can be null." + } + ], + "returns": { + "type": "KeyScanCursor", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "KeyScanCursor blessScan(ScanCursor scanCursor, BlessFlag flag)", + "params": [ + { + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan, must not be null." }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." } ], "returns": { - "type": "KeyValue>", - "description": "KeyValue<K,V> array-reply specifically. null when key does not exist or the timeout was exceeded. @since 6.2" + "type": "KeyScanCursor", + "description": "KeyScanCursor scan cursor." } }, { - "signature": "KeyValue> blmpop(double timeout, LMPopArgs args, K... keys)", + "signature": "KeyScanCursor blessScan(ScanCursor scanCursor, BlessFlag flag, BlessScanArgs scanArgs)", "params": [ { - "name": "timeout", - "type": "double", - "description": "the timeout in seconds." + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan, must not be null." }, { - "name": "args", - "type": "LMPopArgs", - "description": "the additional command arguments." + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "scanArgs", + "type": "BlessScanArgs", + "description": "scan arguments, can be null." } ], "returns": { - "type": "KeyValue>", - "description": "KeyValue<K,V> array-reply specifically. null when key does not exist or the timeout was exceeded. @since 6.2" + "type": "KeyScanCursor", + "description": "KeyScanCursor scan cursor." } } ], "lettuce_async": [ { - "signature": "RedisFuture>> blmpop(long timeout, LMPopArgs args, K... keys)", + "signature": "RedisFuture> blessScan(BlessFlag flag)", "params": [ { - "name": "timeout", - "type": "long", - "description": "the timeout in seconds." - }, - { - "name": "args", - "type": "LMPopArgs", - "description": "the additional command arguments." - }, - { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." } ], "returns": { - "type": "RedisFuture>>", - "description": "KeyValue<K,V> array-reply specifically. null when key does not exist or the timeout was exceeded. @since 6.2" + "type": "RedisFuture>", + "description": "KeyScanCursor scan cursor." } }, { - "signature": "RedisFuture>> blmpop(double timeout, LMPopArgs args, K... keys)", + "signature": "RedisFuture> blessScan(BlessFlag flag, BlessScanArgs scanArgs)", "params": [ { - "name": "timeout", - "type": "double", - "description": "the timeout in seconds." - }, - { - "name": "args", - "type": "LMPopArgs", - "description": "the additional command arguments." + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "scanArgs", + "type": "BlessScanArgs", + "description": "scan arguments, can be null." } ], "returns": { - "type": "RedisFuture>>", - "description": "KeyValue<K,V> array-reply specifically. null when key does not exist or the timeout was exceeded. @since 6.2" + "type": "RedisFuture>", + "description": "KeyScanCursor scan cursor." } - } - ], - "lettuce_reactive": [ + }, { - "signature": "Mono>> blmpop(long timeout, LMPopArgs args, K... keys)", + "signature": "RedisFuture> blessScan(ScanCursor scanCursor, BlessFlag flag)", "params": [ { - "name": "timeout", - "type": "long", - "description": "the timeout in seconds." - }, - { - "name": "args", - "type": "LMPopArgs", - "description": "the additional command arguments." + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan, must not be null." }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." } ], "returns": { - "type": "Mono>>", - "description": "KeyValue<K,V> array-reply specifically. null when key does not exist or the timeout was exceeded. @since 6.2" + "type": "RedisFuture>", + "description": "KeyScanCursor scan cursor." } }, { - "signature": "Mono>> blmpop(double timeout, LMPopArgs args, K... keys)", + "signature": "RedisFuture> blessScan(ScanCursor scanCursor, BlessFlag flag, BlessScanArgs scanArgs)", "params": [ { - "name": "timeout", - "type": "double", - "description": "the timeout in seconds." + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan, must not be null." }, { - "name": "args", - "type": "LMPopArgs", - "description": "the additional command arguments." + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "scanArgs", + "type": "BlessScanArgs", + "description": "scan arguments, can be null." } ], "returns": { - "type": "Mono>>", - "description": "KeyValue<K,V> array-reply specifically. null when key does not exist or the timeout was exceeded. @since 6.2" + "type": "RedisFuture>", + "description": "KeyScanCursor scan cursor." } } ], - "go-redis": [ + "lettuce_reactive": [ { - "signature": "BLMPop(ctx context.Context, timeout time.Duration, direction string, count int64, keys ...string)", + "signature": "Mono> blessScan(BlessFlag flag)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" - }, - { - "name": "timeout", - "type": "time.Duration", - "description": "" - }, - { - "name": "direction", - "type": "string", - "description": "" - }, - { - "name": "count", - "type": "int64", - "description": "" - }, - { - "name": "keys", - "type": "...string", - "description": "" + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." } ], "returns": { - "type": "*KeyValuesCmd", - "description": "" + "type": "Mono>", + "description": "KeyScanCursor scan cursor." } - } - ], - "ioredis": [ + }, { - "signature": "blmpop(...args: [, timeout: number | string, numkeys: number | string, ...keys: RedisKey[], left: \"LEFT\", callback: Callback<[key: string, members: string[]] | null>, ])", + "signature": "Mono> blessScan(BlessFlag flag, BlessScanArgs scanArgs)", "params": [ { - "name": "...args", - "type": "[, timeout", - "description": "" + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." + }, + { + "name": "scanArgs", + "type": "BlessScanArgs", + "description": "scan arguments, can be null." } ], "returns": { - "type": "Any", - "description": "" + "type": "Mono>", + "description": "KeyScanCursor scan cursor." } }, { - "signature": "blmpop(...args: [, timeout: number | string, numkeys: number | string, keys: RedisKey[], left: \"LEFT\", callback: Callback<[key: string, members: string[]] | null>, ])", + "signature": "Mono> blessScan(ScanCursor scanCursor, BlessFlag flag)", "params": [ { - "name": "...args", - "type": "[, timeout", - "description": "" + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan, must not be null." + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." } ], "returns": { - "type": "Any", - "description": "" + "type": "Mono>", + "description": "KeyScanCursor scan cursor." } }, { - "signature": "blmpop(...args: [, timeout: number | string, numkeys: number | string, ...keys: RedisKey[], left: \"LEFT\", ])", + "signature": "Mono> blessScan(ScanCursor scanCursor, BlessFlag flag, BlessScanArgs scanArgs)", "params": [ { - "name": "...args", - "type": "[, timeout", - "description": "" + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan, must not be null." + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." + }, + { + "name": "scanArgs", + "type": "BlessScanArgs", + "description": "scan arguments, can be null." } ], "returns": { - "type": "Any", - "description": "" + "type": "Mono>", + "description": "KeyScanCursor scan cursor." } - }, + } + ], + "jedis": [ { - "signature": "blmpop(...args: [, timeout: number | string, numkeys: number | string, keys: RedisKey[], left: \"LEFT\", ])", + "signature": "ScanResult blessScan(byte[] cursor, BlessFlag flag)", "params": [ { - "name": "...args", - "type": "[, timeout", + "name": "cursor", + "type": "byte[]", "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "blmpop(...args: [, timeout: number | string, numkeys: number | string, ...keys: RedisKey[], left: \"LEFT\", countToken: \"COUNT\", count: number | string, callback: Callback<[key: string, members: string[]] | null>, ])", - "params": [ + }, { - "name": "...args", - "type": "[, timeout", + "name": "flag", + "type": "BlessFlag", "description": "" } ], "returns": { - "type": "Any", + "type": "ScanResult", "description": "" } - } - ], - "redis_rs_sync": [ + }, { - "signature": "blmpop(timeout: f64, numkeys: usize, key: K, dir: Direction, count: usize)", + "signature": "ScanResult blessScan(byte[] cursor, BlessFlag flag, int count)", "params": [ { - "name": "timeout", - "type": "f64", - "description": "" - }, - { - "name": "numkeys", - "type": "usize", - "description": "" - }, - { - "name": "key", - "type": "K", + "name": "cursor", + "type": "byte[]", "description": "" }, { - "name": "dir", - "type": "Direction", + "name": "flag", + "type": "BlessFlag", "description": "" }, { "name": "count", - "type": "usize", + "type": "int", "description": "" } ], "returns": { - "type": "(Option<[String", + "type": "ScanResult", "description": "" } - } - ], - "redis_rs_async": [ + }, { - "signature": "blmpop(timeout: f64, numkeys: usize, key: K, dir: Direction, count: usize)", + "signature": "ScanResult blessScan(String cursor, BlessFlag flag)", "params": [ { - "name": "timeout", - "type": "f64", + "name": "cursor", + "type": "String", "description": "" }, { - "name": "numkeys", - "type": "usize", + "name": "flag", + "type": "BlessFlag", "description": "" - }, + } + ], + "returns": { + "type": "ScanResult", + "description": "" + } + }, + { + "signature": "ScanResult blessScan(String cursor, BlessFlag flag, int count)", + "params": [ { - "name": "key", - "type": "K", + "name": "cursor", + "type": "String", "description": "" }, { - "name": "dir", - "type": "Direction", + "name": "flag", + "type": "BlessFlag", "description": "" }, { "name": "count", - "type": "usize", + "type": "int", "description": "" } ], "returns": { - "type": "(Option<[String", + "type": "ScanResult", "description": "" } } - ], - "nredisstack_sync": [ + ] + } + }, + "BLESS SET": { + "api_calls": { + "redis_py": [ { - "signature": "BLMPop(double timeout, RedisKey[] keys, ListSide listSide, long? count = null)", + "signature": "bless_set(name: KeyT, flag: BlessFlag)", "params": [ { - "name": "timeout", - "type": "double", - "description": "" - }, - { - "name": "keys", - "type": "RedisKey[]", - "description": "" - }, - { - "name": "listSide", - "type": "ListSide", + "name": "name", + "type": "KeyT", "description": "" }, { - "name": "count", - "type": "long?", + "name": "flag", + "type": "BlessFlag", "description": "" } ], "returns": { - "type": "Tuple>?", + "type": "int", "description": "" } - }, + } + ], + "node_redis": [ { - "signature": "BLMPop(double timeout, RedisKey key, ListSide listSide, long? count = null)", + "signature": "blessSet(key: RedisArgument, flag: BlessFlag)", "params": [ - { - "name": "timeout", - "type": "double", - "description": "" - }, { "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "listSide", - "type": "ListSide", + "type": "RedisArgument", "description": "" }, { - "name": "count", - "type": "long?", + "name": "flag", + "type": "BlessFlag", "description": "" } ], "returns": { - "type": "Tuple>?", + "type": "NumberReply", "description": "" } - }, + } + ], + "go-redis": [ { - "signature": "BLMPop(db, timeout, [key], listSide, count)", + "signature": "BlessSet(ctx context.Context, key string, flag BlessFlag) *IntCmd", "params": [ { - "name": "db", - "type": "Any", - "description": "" - }, - { - "name": "timeout", - "type": "Any", - "description": "" - }, - { - "name": "[key]", - "type": "Any", + "name": "ctx", + "type": "context.Context", "description": "" }, { - "name": "listSide", - "type": "Any", + "name": "key", + "type": "string", "description": "" }, { - "name": "count", - "type": "Any", + "name": "flag", + "type": "BlessFlag", "description": "" } ], "returns": { - "type": "return", + "type": "*IntCmd", "description": "" } } ], "php": [ { - "signature": "blmpop(int $timeout, array $keys, string $modifier = 'left', int $count = 1)", + "signature": "set(string $key, string $flag)", "params": [ { - "name": "$timeout", - "type": "int", + "name": "$key", + "type": "string", "description": "" }, { - "name": "$keys", - "type": "array", + "name": "$flag", + "type": "string", "description": "" - }, + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "bless_set(key, flag)", + "params": [ { - "name": "string $modifier = 'left'", - "type": "Any", + "name": "key", + "type": "String", "description": "" }, { - "name": "int $count = 1", - "type": "Any", + "name": "flag", + "type": "String", "description": "" } ], "returns": { - "type": "array", + "type": "Boolean", "description": "" } } ], - "redis_rb": [ + "lettuce_sync": [ { - "signature": "blmpop(timeout, *keys, modifier: \"LEFT\", count: nil)", + "signature": "Boolean blessSet(K key, BlessFlag flag)", "params": [ { - "name": "timeout", - "type": "Float", - "description": "maximum number of seconds to block" + "name": "key", + "type": "K", + "description": "the key, must not be null." }, { - "name": "*keys", - "type": "String, Array", - "description": "one or more keys with lists" - }, + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to turn on, must not be null." + } + ], + "returns": { + "type": "Boolean", + "description": "true if the flag was turned on, false if it was already set on key." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture blessSet(K key, BlessFlag flag)", + "params": [ { - "name": "modifier", - "type": "String", - "description": "LEFT or RIGHT" + "name": "key", + "type": "K", + "description": "the key, must not be null." }, { - "name": "count", - "type": "Integer", - "description": "a number of elements to pop" + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to turn on, must not be null." } ], "returns": { - "type": "Array>", - "description": "list of popped elements or nil" + "type": "RedisFuture", + "description": "true if the flag was turned on, false if it was already set on key." } } - ] - } - }, - "BLPOP": { - "api_calls": { - "redis_py": [ + ], + "lettuce_reactive": [ { - "signature": "blpop(keys: List, timeout: Optional[Number] = 0)", + "signature": "Mono blessSet(K key, BlessFlag flag)", "params": [ { - "name": "keys", - "type": "List", - "description": "" + "name": "key", + "type": "K", + "description": "the key, must not be null." }, { - "name": "timeout", - "type": "Optional[Number] = 0", - "description": "" + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to turn on, must not be null." } ], "returns": { - "type": "Union[Awaitable[list], list]", - "description": "" + "type": "Mono", + "description": "true if the flag was turned on, false if it was already set on key." } } ], "jedis": [ { - "signature": "List blpop(final int timeout, final String... keys)", + "signature": "long blessSet(byte[] key, BlessFlag flag)", "params": [ { - "name": "timeout", - "type": "int", + "name": "key", + "type": "byte[]", "description": "" }, { - "name": "keys", - "type": "String...", + "name": "flag", + "type": "BlessFlag", "description": "" } ], "returns": { - "type": "List", + "type": "long", "description": "" } }, { - "signature": "KeyValue blpop(final double timeout, final String... keys)", + "signature": "long blessSet(String key, BlessFlag flag)", "params": [ { - "name": "timeout", - "type": "double", + "name": "key", + "type": "String", "description": "" }, { - "name": "keys", - "type": "String...", + "name": "flag", + "type": "BlessFlag", "description": "" } ], "returns": { - "type": "KeyValue", + "type": "long", "description": "" } - }, + } + ] + } + }, + "BLMOVE": { + "api_calls": { + "redis_py": [ { - "signature": "List blpop(final int timeout, final String key)", + "signature": "blmove(, first_list: str,, second_list: str,, timeout: int,, src: str = \"LEFT\",, dest: str = \"RIGHT\",)", "params": [ + { + "name": "first_list", + "type": "str", + "description": "" + }, + { + "name": "second_list", + "type": "str", + "description": "" + }, { "name": "timeout", "type": "int", "description": "" }, { - "name": "key", - "type": "String", + "name": "src", + "type": "str = \"LEFT\"", + "description": "" + }, + { + "name": "dest", + "type": "str = \"RIGHT\"", "description": "" } ], "returns": { - "type": "List", + "type": "ResponseT", "description": "" } - }, + } + ], + "jedis": [ { - "signature": "KeyValue blpop(double timeout, String key)", + "signature": "String blmove(final String srcKey, final String dstKey, final ListDirection from final ListDirection to, final double timeout)", "params": [ { - "name": "timeout", - "type": "double", + "name": "srcKey", + "type": "String", "description": "" }, { - "name": "key", + "name": "dstKey", "type": "String", "description": "" + }, + { + "name": "to", + "type": "ListDirection from final ListDirection", + "description": "can be LEFT or RIGHT" + }, + { + "name": "timeout", + "type": "double", + "description": "seconds to block. A timeout of zero can be used to block indefinitely." } ], "returns": { - "type": "KeyValue", - "description": "" + "type": "String", + "description": "The element being popped and pushed" } }, { - "signature": "List blpop(int timeout, String... keys)", + "signature": "String blmove(String srcKey, String dstKey, ListDirection from, ListDirection to, double timeout)", "params": [ { - "name": "timeout", - "type": "int", + "name": "srcKey", + "type": "String", "description": "" }, { - "name": "keys", - "type": "String...", + "name": "dstKey", + "type": "String", "description": "" + }, + { + "name": "from", + "type": "ListDirection", + "description": "can be LEFT or RIGHT" + }, + { + "name": "to", + "type": "ListDirection", + "description": "can be LEFT or RIGHT" + }, + { + "name": "timeout", + "type": "double", + "description": "seconds to block. A timeout of zero can be used to block indefinitely." } ], "returns": { - "type": "List", - "description": "" + "type": "String", + "description": "The element being popped and pushed" } } ], "lettuce_sync": [ { - "signature": "KeyValue blpop(long timeout, K... keys)", + "signature": "V blmove(K source, K destination, LMoveArgs args, long timeout)", "params": [ + { + "name": "source", + "type": "K", + "description": "the source key." + }, + { + "name": "destination", + "type": "K", + "description": "the destination type: key." + }, + { + "name": "args", + "type": "LMoveArgs", + "description": "command arguments to configure source and destination directions." + }, { "name": "timeout", "type": "long", "description": "the timeout in seconds." - }, - { - "name": "keys", - "type": "K...", - "description": "the keys." } ], "returns": { - "type": "KeyValue", - "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" + "type": "V", + "description": "V bulk-string-reply the element being popped and pushed. @since 6.1.3" } }, { - "signature": "KeyValue blpop(double timeout, K... keys)", + "signature": "V blmove(K source, K destination, LMoveArgs args, double timeout)", "params": [ + { + "name": "source", + "type": "K", + "description": "the source key." + }, + { + "name": "destination", + "type": "K", + "description": "the destination type: key." + }, + { + "name": "args", + "type": "LMoveArgs", + "description": "command arguments to configure source and destination directions." + }, { "name": "timeout", "type": "double", "description": "the timeout in seconds." - }, - { - "name": "keys", - "type": "K...", - "description": "the keys." } ], "returns": { - "type": "KeyValue", - "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" + "type": "V", + "description": "V bulk-string-reply the element being popped and pushed. @since 6.1.3" } } ], "lettuce_async": [ { - "signature": "RedisFuture> blpop(long timeout, K... keys)", + "signature": "RedisFuture blmove(K source, K destination, LMoveArgs args, long timeout)", "params": [ + { + "name": "source", + "type": "K", + "description": "the source key." + }, + { + "name": "destination", + "type": "K", + "description": "the destination type: key." + }, + { + "name": "args", + "type": "LMoveArgs", + "description": "command arguments to configure source and destination directions." + }, { "name": "timeout", "type": "long", "description": "the timeout in seconds." - }, - { - "name": "keys", - "type": "K...", - "description": "the keys." } ], "returns": { - "type": "RedisFuture>", - "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" + "type": "RedisFuture", + "description": "V bulk-string-reply the element being popped and pushed. @since 6.1.3" } }, { - "signature": "RedisFuture> blpop(double timeout, K... keys)", + "signature": "RedisFuture blmove(K source, K destination, LMoveArgs args, double timeout)", "params": [ + { + "name": "source", + "type": "K", + "description": "the source key." + }, + { + "name": "destination", + "type": "K", + "description": "the destination type: key." + }, + { + "name": "args", + "type": "LMoveArgs", + "description": "command arguments to configure source and destination directions." + }, { "name": "timeout", "type": "double", "description": "the timeout in seconds." - }, - { - "name": "keys", - "type": "K...", - "description": "the keys." } ], "returns": { - "type": "RedisFuture>", - "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" + "type": "RedisFuture", + "description": "V bulk-string-reply the element being popped and pushed. @since 6.1.3" } } ], "lettuce_reactive": [ { - "signature": "Mono> blpop(long timeout, K... keys)", + "signature": "Mono blmove(K source, K destination, LMoveArgs args, long timeout)", "params": [ + { + "name": "source", + "type": "K", + "description": "the source key." + }, + { + "name": "destination", + "type": "K", + "description": "the destination type: key." + }, + { + "name": "args", + "type": "LMoveArgs", + "description": "command arguments to configure source and destination directions." + }, { "name": "timeout", "type": "long", "description": "the timeout in seconds." - }, - { - "name": "keys", - "type": "K...", - "description": "the keys." } ], "returns": { - "type": "Mono>", - "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" + "type": "Mono", + "description": "V bulk-string-reply the element being popped and pushed. @since 6.1.3" } }, { - "signature": "Mono> blpop(double timeout, K... keys)", + "signature": "Mono blmove(K source, K destination, LMoveArgs args, double timeout)", "params": [ + { + "name": "source", + "type": "K", + "description": "the source key." + }, + { + "name": "destination", + "type": "K", + "description": "the destination type: key." + }, + { + "name": "args", + "type": "LMoveArgs", + "description": "command arguments to configure source and destination directions." + }, { "name": "timeout", "type": "double", "description": "the timeout in seconds." - }, - { - "name": "keys", - "type": "K...", - "description": "the keys." } ], "returns": { - "type": "Mono>", - "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" + "type": "Mono", + "description": "V bulk-string-reply the element being popped and pushed. @since 6.1.3" } } ], "go-redis": [ { - "signature": "BLPop(ctx context.Context, timeout time.Duration, keys ...string)", + "signature": "BLMove(ctx context.Context, source, destination, srcpos, destpos string, timeout time.Duration)", "params": [ { "name": "ctx", @@ -14552,29 +14573,69 @@ "description": "" }, { - "name": "timeout", - "type": "time.Duration", + "name": "source", + "type": "Any", "description": "" }, { - "name": "keys", - "type": "...string", + "name": "destination", + "type": "Any", + "description": "" + }, + { + "name": "srcpos", + "type": "Any", + "description": "" + }, + { + "name": "destpos", + "type": "string", + "description": "" + }, + { + "name": "timeout", + "type": "time.Duration", "description": "" } ], "returns": { - "type": "*StringSliceCmd", + "type": "*StringCmd", "description": "" } } ], "ioredis": [ { - "signature": "blpop(...args: [, ...keys: RedisKey[], timeout: number | string, callback: Callback<[string, string] | null>, ])", + "signature": "blmove(source: RedisKey, destination: RedisKey, left: \"LEFT\", left1: \"LEFT\", timeout: number | string, callback?: Callback)", "params": [ { - "name": "...args", - "type": "[, ...keys", + "name": "source", + "type": "RedisKey", + "description": "" + }, + { + "name": "destination", + "type": "RedisKey", + "description": "" + }, + { + "name": "left", + "type": "\"LEFT\"", + "description": "" + }, + { + "name": "left1", + "type": "\"LEFT\"", + "description": "" + }, + { + "name": "timeout", + "type": "number | string", + "description": "" + }, + { + "name": "callback?", + "type": "Callback", "description": "" } ], @@ -14584,11 +14645,36 @@ } }, { - "signature": "blpop(...args: [, keys: RedisKey[], timeout: number | string, callback: Callback<[string, string] | null>, ])", + "signature": "blmove(source: RedisKey, destination: RedisKey, left: \"LEFT\", right: \"RIGHT\", timeout: number | string, callback?: Callback)", "params": [ { - "name": "...args", - "type": "[, keys", + "name": "source", + "type": "RedisKey", + "description": "" + }, + { + "name": "destination", + "type": "RedisKey", + "description": "" + }, + { + "name": "left", + "type": "\"LEFT\"", + "description": "" + }, + { + "name": "right", + "type": "\"RIGHT\"", + "description": "" + }, + { + "name": "timeout", + "type": "number | string", + "description": "" + }, + { + "name": "callback?", + "type": "Callback", "description": "" } ], @@ -14598,11 +14684,36 @@ } }, { - "signature": "blpop(...args: [...keys: RedisKey[], timeout: number | string])", + "signature": "blmove(source: RedisKey, destination: RedisKey, right: \"RIGHT\", left: \"LEFT\", timeout: number | string, callback?: Callback)", "params": [ { - "name": "...args", - "type": "[...keys", + "name": "source", + "type": "RedisKey", + "description": "" + }, + { + "name": "destination", + "type": "RedisKey", + "description": "" + }, + { + "name": "right", + "type": "\"RIGHT\"", + "description": "" + }, + { + "name": "left", + "type": "\"LEFT\"", + "description": "" + }, + { + "name": "timeout", + "type": "number | string", + "description": "" + }, + { + "name": "callback?", + "type": "Callback", "description": "" } ], @@ -14612,11 +14723,36 @@ } }, { - "signature": "blpop(...args: [keys: RedisKey[], timeout: number | string])", + "signature": "blmove(source: RedisKey, destination: RedisKey, right: \"RIGHT\", right1: \"RIGHT\", timeout: number | string, callback?: Callback)", "params": [ { - "name": "...args", - "type": "[keys", + "name": "source", + "type": "RedisKey", + "description": "" + }, + { + "name": "destination", + "type": "RedisKey", + "description": "" + }, + { + "name": "right", + "type": "\"RIGHT\"", + "description": "" + }, + { + "name": "right1", + "type": "\"RIGHT\"", + "description": "" + }, + { + "name": "timeout", + "type": "number | string", + "description": "" + }, + { + "name": "callback?", + "type": "Callback", "description": "" } ], @@ -14628,11 +14764,26 @@ ], "redis_rs_sync": [ { - "signature": "blpop(key: K, timeout: f64)", + "signature": "blmove(srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, timeout: f64)", "params": [ { - "name": "key", - "type": "K", + "name": "srckey", + "type": "S", + "description": "" + }, + { + "name": "dstkey", + "type": "D", + "description": "" + }, + { + "name": "src_dir", + "type": "Direction", + "description": "" + }, + { + "name": "dst_dir", + "type": "Direction", "description": "" }, { @@ -14642,18 +14793,33 @@ } ], "returns": { - "type": "(Option<[String", + "type": "(Option)", "description": "" } } ], "redis_rs_async": [ { - "signature": "blpop(key: K, timeout: f64)", + "signature": "blmove(srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, timeout: f64)", "params": [ { - "name": "key", - "type": "K", + "name": "srckey", + "type": "S", + "description": "" + }, + { + "name": "dstkey", + "type": "D", + "description": "" + }, + { + "name": "src_dir", + "type": "Direction", + "description": "" + }, + { + "name": "dst_dir", + "type": "Direction", "description": "" }, { @@ -14663,19 +14829,34 @@ } ], "returns": { - "type": "(Option<[String", + "type": "(Option)", "description": "" } } ], "nredisstack_sync": [ { - "signature": "BLPop(RedisKey[] keys, double timeout)", + "signature": "BLMove(RedisKey source, RedisKey destination, ListSide sourceSide, ListSide destinationSide, double timeout)", "params": [ { - "name": "keys", - "type": "RedisKey[]", - "description": "" + "name": "source", + "type": "RedisKey", + "description": "The key of the source list." + }, + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination list." + }, + { + "name": "sourceSide", + "type": "ListSide", + "description": "What side of the source list to remove from." + }, + { + "name": "destinationSide", + "type": "ListSide", + "description": "What side of the destination list to move to." }, { "name": "timeout", @@ -14684,83 +14865,208 @@ } ], "returns": { - "type": "Tuple?", - "description": "A value, together with the key it was popped from, or null if the server timeoutexpires." + "type": "RedisValue?", + "description": "The element being popped and pushed, or null if the server timeout expires." } }, { - "signature": "BLPop(RedisKey key, double timeout)", + "signature": "ListMove(RedisKey sourceKey, RedisKey destinationKey, ListSide sourceSide, ListSide destinationSide, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", + "name": "sourceKey", "type": "RedisKey", - "description": "The key to check." + "description": "The key of the list to remove from." }, { - "name": "timeout", - "type": "double", - "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." + "name": "destinationKey", + "type": "RedisKey", + "description": "The key of the list to move to." + }, + { + "name": "sourceSide", + "type": "ListSide", + "description": "What side of the sourceKey list to remove from." + }, + { + "name": "destinationSide", + "type": "ListSide", + "description": "What side of the destinationKey list to move to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Tuple?", - "description": "A value, together with the key it was popped from, or null if the server timeoutexpires." + "type": "RedisValue", + "description": "The element being popped and pushed or Null if there is no element to move." } }, { - "signature": "BLPop(db, [key], timeout)", + "signature": "ListMove(RedisKey sourceKey, RedisKey destinationKey, ListSide sourceSide, ListSide destinationSide, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "db", - "type": "Any", - "description": "The IDatabase class where this extension method is applied." + "name": "sourceKey", + "type": "RedisKey", + "description": "The key of the list to remove from." }, { - "name": "[key]", - "type": "Any", - "description": "" + "name": "destinationKey", + "type": "RedisKey", + "description": "The key of the list to move to." }, { - "name": "timeout", - "type": "Any", - "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." + "name": "sourceSide", + "type": "ListSide", + "description": "What side of the sourceKey list to remove from." + }, + { + "name": "destinationSide", + "type": "ListSide", + "description": "What side of the destinationKey list to move to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "return", - "description": "A value, together with the key it was popped from, or null if the server timeoutexpires." + "type": "RedisValue", + "description": "The element being popped and pushed or Null if there is no element to move." + } + } + ], + "nredisstack_async": [ + { + "signature": "ListMove(RedisKey sourceKey, RedisKey destinationKey, ListSide sourceSide, ListSide destinationSide, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "sourceKey", + "type": "RedisKey", + "description": "The key of the list to remove from." + }, + { + "name": "destinationKey", + "type": "RedisKey", + "description": "The key of the list to move to." + }, + { + "name": "sourceSide", + "type": "ListSide", + "description": "What side of the sourceKey list to remove from." + }, + { + "name": "destinationSide", + "type": "ListSide", + "description": "What side of the destinationKey list to move to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "RedisValue", + "description": "The element being popped and pushed or Null if there is no element to move." + } + }, + { + "signature": "ListMove(RedisKey sourceKey, RedisKey destinationKey, ListSide sourceSide, ListSide destinationSide, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "sourceKey", + "type": "RedisKey", + "description": "The key of the list to remove from." + }, + { + "name": "destinationKey", + "type": "RedisKey", + "description": "The key of the list to move to." + }, + { + "name": "sourceSide", + "type": "ListSide", + "description": "What side of the sourceKey list to remove from." + }, + { + "name": "destinationSide", + "type": "ListSide", + "description": "What side of the destinationKey list to move to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "RedisValue", + "description": "The element being popped and pushed or Null if there is no element to move." } } ], "php": [ { - "signature": "blpop(array|string $keys, int|float $timeout)", + "signature": "blmove(string $source, string $destination, string $where, string $to, int $timeout)", "params": [ { - "name": "$keys", - "type": "array|string", + "name": "$source", + "type": "string", + "description": "" + }, + { + "name": "$destination", + "type": "string", + "description": "" + }, + { + "name": "$where", + "type": "string", + "description": "" + }, + { + "name": "$to", + "type": "string", "description": "" }, { "name": "$timeout", - "type": "int|float", + "type": "int", "description": "" } ], "returns": { - "type": "array|null", + "type": "string", "description": "" } } ], "redis_rb": [ { - "signature": "blpop(*args)", + "signature": "blmove(source, destination, where_source, where_destination, timeout: 0)", "params": [ { - "name": "*args", - "type": "String, Array", - "description": "one or more keys to perform the blocking pop on" + "name": "source", + "type": "String", + "description": "source key" + }, + { + "name": "destination", + "type": "String", + "description": "destination key" + }, + { + "name": "where_source", + "type": "String, Symbol", + "description": "LEFT or RIGHT" + }, + { + "name": "where_destination", + "type": "String, Symbol", + "description": "LEFT or RIGHT" }, { "name": "timeout", @@ -14769,43 +15075,63 @@ } ], "returns": { - "type": "nil, [String, String]", - "description": "tuple of the list that was popped from and element" + "type": "nil, String", + "description": "the element, or nil when the source key does not exist or the timeout expired" } } ] } }, - "BRPOP": { + "BLMPOP": { "api_calls": { "redis_py": [ { - "signature": "brpop(keys: List, timeout: Optional[Number] = 0)", + "signature": "blmpop(, timeout: float,, numkeys: int,, *args: str,, direction: str,, count: Optional[int] = 1,)", "params": [ { - "name": "keys", - "type": "List", + "name": "timeout", + "type": "float", "description": "" }, { - "name": "timeout", - "type": "Optional[Number] = 0", + "name": "numkeys", + "type": "int", + "description": "" + }, + { + "name": "*args", + "type": "str", + "description": "" + }, + { + "name": "direction", + "type": "str", + "description": "" + }, + { + "name": "count", + "type": "Optional[int] = 1", "description": "" } ], "returns": { - "type": "Union[Awaitable[list], list]", + "type": "Optional[list]", "description": "" } } ], "jedis": [ { - "signature": "List brpop(final int timeout, final String... keys)", + "signature": "KeyValue> blmpop(double timeout, ListDirection direction, String... keys)", "params": [ { "name": "timeout", - "type": "int", + "type": "double", + "description": "seconds to block. A timeout of zero can be used to block indefinitely." + }, + { + "name": "direction", + "type": "ListDirection", "description": "" }, { @@ -14815,16 +15141,26 @@ } ], "returns": { - "type": "List", - "description": "" + "type": "KeyValue>", + "description": "The element being popped and pushed" } }, { - "signature": "KeyValue brpop(final double timeout, final String... keys)", + "signature": "KeyValue> blmpop(double timeout, ListDirection direction, int count, String... keys)", "params": [ { "name": "timeout", "type": "double", + "description": "seconds to block. A timeout of zero can be used to block indefinitely." + }, + { + "name": "direction", + "type": "ListDirection", + "description": "" + }, + { + "name": "count", + "type": "int", "description": "" }, { @@ -14834,53 +15170,49 @@ } ], "returns": { - "type": "KeyValue", - "description": "" + "type": "KeyValue>", + "description": "The element being popped and pushed" } }, { - "signature": "List brpop(final int timeout, final String key)", + "signature": "KeyValue> blmpop(double timeout, ListDirection direction, String... keys)", "params": [ { "name": "timeout", - "type": "int", + "type": "double", + "description": "seconds to block. A timeout of zero can be used to block indefinitely." + }, + { + "name": "direction", + "type": "ListDirection", "description": "" }, { - "name": "key", - "type": "String", + "name": "keys", + "type": "String...", "description": "" } ], "returns": { - "type": "List", - "description": "" + "type": "KeyValue>", + "description": "The element being popped and pushed" } }, { - "signature": "KeyValue brpop(double timeout, String key)", + "signature": "KeyValue> blmpop(double timeout, ListDirection direction, int count, String... keys)", "params": [ { "name": "timeout", "type": "double", - "description": "" + "description": "seconds to block. A timeout of zero can be used to block indefinitely." }, { - "name": "key", - "type": "String", + "name": "direction", + "type": "ListDirection", "description": "" - } - ], - "returns": { - "type": "KeyValue", - "description": "" - } - }, - { - "signature": "List brpop(int timeout, String... keys)", - "params": [ + }, { - "name": "timeout", + "name": "count", "type": "int", "description": "" }, @@ -14891,20 +15223,25 @@ } ], "returns": { - "type": "List", - "description": "" + "type": "KeyValue>", + "description": "The element being popped and pushed" } } ], "lettuce_sync": [ { - "signature": "KeyValue brpop(long timeout, K... keys)", + "signature": "KeyValue> blmpop(long timeout, LMPopArgs args, K... keys)", "params": [ { "name": "timeout", "type": "long", "description": "the timeout in seconds." }, + { + "name": "args", + "type": "LMPopArgs", + "description": "the additional command arguments." + }, { "name": "keys", "type": "K...", @@ -14912,18 +15249,23 @@ } ], "returns": { - "type": "KeyValue", - "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" + "type": "KeyValue>", + "description": "KeyValue<K,V> array-reply specifically. null when key does not exist or the timeout was exceeded. @since 6.2" } }, { - "signature": "KeyValue brpop(double timeout, K... keys)", + "signature": "KeyValue> blmpop(double timeout, LMPopArgs args, K... keys)", "params": [ { "name": "timeout", "type": "double", "description": "the timeout in seconds." }, + { + "name": "args", + "type": "LMPopArgs", + "description": "the additional command arguments." + }, { "name": "keys", "type": "K...", @@ -14931,20 +15273,25 @@ } ], "returns": { - "type": "KeyValue", - "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" + "type": "KeyValue>", + "description": "KeyValue<K,V> array-reply specifically. null when key does not exist or the timeout was exceeded. @since 6.2" } } ], "lettuce_async": [ { - "signature": "RedisFuture> brpop(long timeout, K... keys)", + "signature": "RedisFuture>> blmpop(long timeout, LMPopArgs args, K... keys)", "params": [ { "name": "timeout", "type": "long", "description": "the timeout in seconds." }, + { + "name": "args", + "type": "LMPopArgs", + "description": "the additional command arguments." + }, { "name": "keys", "type": "K...", @@ -14952,18 +15299,23 @@ } ], "returns": { - "type": "RedisFuture>", - "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" + "type": "RedisFuture>>", + "description": "KeyValue<K,V> array-reply specifically. null when key does not exist or the timeout was exceeded. @since 6.2" } }, { - "signature": "RedisFuture> brpop(double timeout, K... keys)", + "signature": "RedisFuture>> blmpop(double timeout, LMPopArgs args, K... keys)", "params": [ { "name": "timeout", "type": "double", "description": "the timeout in seconds." }, + { + "name": "args", + "type": "LMPopArgs", + "description": "the additional command arguments." + }, { "name": "keys", "type": "K...", @@ -14971,20 +15323,25 @@ } ], "returns": { - "type": "RedisFuture>", - "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" + "type": "RedisFuture>>", + "description": "KeyValue<K,V> array-reply specifically. null when key does not exist or the timeout was exceeded. @since 6.2" } } ], "lettuce_reactive": [ { - "signature": "Mono> brpop(long timeout, K... keys)", + "signature": "Mono>> blmpop(long timeout, LMPopArgs args, K... keys)", "params": [ { "name": "timeout", "type": "long", "description": "the timeout in seconds." }, + { + "name": "args", + "type": "LMPopArgs", + "description": "the additional command arguments." + }, { "name": "keys", "type": "K...", @@ -14992,18 +15349,23 @@ } ], "returns": { - "type": "Mono>", - "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" + "type": "Mono>>", + "description": "KeyValue<K,V> array-reply specifically. null when key does not exist or the timeout was exceeded. @since 6.2" } }, { - "signature": "Mono> brpop(double timeout, K... keys)", + "signature": "Mono>> blmpop(double timeout, LMPopArgs args, K... keys)", "params": [ { "name": "timeout", "type": "double", "description": "the timeout in seconds." }, + { + "name": "args", + "type": "LMPopArgs", + "description": "the additional command arguments." + }, { "name": "keys", "type": "K...", @@ -15011,14 +15373,14 @@ } ], "returns": { - "type": "Mono>", - "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" + "type": "Mono>>", + "description": "KeyValue<K,V> array-reply specifically. null when key does not exist or the timeout was exceeded. @since 6.2" } } ], "go-redis": [ { - "signature": "BRPop(ctx context.Context, timeout time.Duration, keys ...string)", + "signature": "BLMPop(ctx context.Context, timeout time.Duration, direction string, count int64, keys ...string)", "params": [ { "name": "ctx", @@ -15030,6 +15392,16 @@ "type": "time.Duration", "description": "" }, + { + "name": "direction", + "type": "string", + "description": "" + }, + { + "name": "count", + "type": "int64", + "description": "" + }, { "name": "keys", "type": "...string", @@ -15037,18 +15409,18 @@ } ], "returns": { - "type": "*StringSliceCmd", + "type": "*KeyValuesCmd", "description": "" } } ], "ioredis": [ { - "signature": "brpop(...args: [, ...keys: RedisKey[], timeout: number | string, callback: Callback<[string, string] | null>, ])", + "signature": "blmpop(...args: [, timeout: number | string, numkeys: number | string, ...keys: RedisKey[], left: \"LEFT\", callback: Callback<[key: string, members: string[]] | null>, ])", "params": [ { "name": "...args", - "type": "[, ...keys", + "type": "[, timeout", "description": "" } ], @@ -15058,11 +15430,11 @@ } }, { - "signature": "brpop(...args: [, keys: RedisKey[], timeout: number | string, callback: Callback<[string, string] | null>, ])", + "signature": "blmpop(...args: [, timeout: number | string, numkeys: number | string, keys: RedisKey[], left: \"LEFT\", callback: Callback<[key: string, members: string[]] | null>, ])", "params": [ { "name": "...args", - "type": "[, keys", + "type": "[, timeout", "description": "" } ], @@ -15072,11 +15444,11 @@ } }, { - "signature": "brpop(...args: [...keys: RedisKey[], timeout: number | string])", + "signature": "blmpop(...args: [, timeout: number | string, numkeys: number | string, ...keys: RedisKey[], left: \"LEFT\", ])", "params": [ { "name": "...args", - "type": "[...keys", + "type": "[, timeout", "description": "" } ], @@ -15086,11 +15458,25 @@ } }, { - "signature": "brpop(...args: [keys: RedisKey[], timeout: number | string])", + "signature": "blmpop(...args: [, timeout: number | string, numkeys: number | string, keys: RedisKey[], left: \"LEFT\", ])", "params": [ { "name": "...args", - "type": "[keys", + "type": "[, timeout", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "blmpop(...args: [, timeout: number | string, numkeys: number | string, ...keys: RedisKey[], left: \"LEFT\", countToken: \"COUNT\", count: number | string, callback: Callback<[key: string, members: string[]] | null>, ])", + "params": [ + { + "name": "...args", + "type": "[, timeout", "description": "" } ], @@ -15102,16 +15488,31 @@ ], "redis_rs_sync": [ { - "signature": "brpop(key: K, timeout: f64)", + "signature": "blmpop(timeout: f64, numkeys: usize, key: K, dir: Direction, count: usize)", "params": [ + { + "name": "timeout", + "type": "f64", + "description": "" + }, + { + "name": "numkeys", + "type": "usize", + "description": "" + }, { "name": "key", "type": "K", "description": "" }, { - "name": "timeout", - "type": "f64", + "name": "dir", + "type": "Direction", + "description": "" + }, + { + "name": "count", + "type": "usize", "description": "" } ], @@ -15123,16 +15524,31 @@ ], "redis_rs_async": [ { - "signature": "brpop(key: K, timeout: f64)", + "signature": "blmpop(timeout: f64, numkeys: usize, key: K, dir: Direction, count: usize)", "params": [ + { + "name": "timeout", + "type": "f64", + "description": "" + }, + { + "name": "numkeys", + "type": "usize", + "description": "" + }, { "name": "key", "type": "K", "description": "" }, { - "name": "timeout", - "type": "f64", + "name": "dir", + "type": "Direction", + "description": "" + }, + { + "name": "count", + "type": "usize", "description": "" } ], @@ -15144,50 +15560,75 @@ ], "nredisstack_sync": [ { - "signature": "BRPop(RedisKey[] keys, double timeout)", + "signature": "BLMPop(double timeout, RedisKey[] keys, ListSide listSide, long? count = null)", "params": [ + { + "name": "timeout", + "type": "double", + "description": "" + }, { "name": "keys", "type": "RedisKey[]", "description": "" }, { - "name": "timeout", - "type": "double", - "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." + "name": "listSide", + "type": "ListSide", + "description": "" + }, + { + "name": "count", + "type": "long?", + "description": "" } ], "returns": { - "type": "Tuple?", - "description": "A value, together with the key it was popped from, or null if the server timeoutexpires." + "type": "Tuple>?", + "description": "" } }, { - "signature": "BRPop(RedisKey key, double timeout)", + "signature": "BLMPop(double timeout, RedisKey key, ListSide listSide, long? count = null)", "params": [ + { + "name": "timeout", + "type": "double", + "description": "" + }, { "name": "key", "type": "RedisKey", - "description": "The key to check." + "description": "" }, { - "name": "timeout", - "type": "double", - "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." + "name": "listSide", + "type": "ListSide", + "description": "" + }, + { + "name": "count", + "type": "long?", + "description": "" } ], "returns": { - "type": "Tuple?", - "description": "A value, together with the key it was popped from, or null if the server timeoutexpires." + "type": "Tuple>?", + "description": "" } }, { - "signature": "BRPop(db, [key], timeout)", + "signature": "BLMPop(db, timeout, [key], listSide, count)", "params": [ { "name": "db", "type": "Any", - "description": "The IDatabase class where this extension method is applied." + "description": "" + }, + { + "name": "timeout", + "type": "Any", + "description": "" }, { "name": "[key]", @@ -15195,75 +15636,95 @@ "description": "" }, { - "name": "timeout", + "name": "listSide", "type": "Any", - "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." + "description": "" + }, + { + "name": "count", + "type": "Any", + "description": "" } ], "returns": { "type": "return", - "description": "A value, together with the key it was popped from, or null if the server timeoutexpires." + "description": "" } } ], "php": [ { - "signature": "brpop(array|string $keys, int|float $timeout)", + "signature": "blmpop(int $timeout, array $keys, string $modifier = 'left', int $count = 1)", "params": [ + { + "name": "$timeout", + "type": "int", + "description": "" + }, { "name": "$keys", - "type": "array|string", + "type": "array", "description": "" }, { - "name": "$timeout", - "type": "int|float", + "name": "string $modifier = 'left'", + "type": "Any", + "description": "" + }, + { + "name": "int $count = 1", + "type": "Any", "description": "" } ], "returns": { - "type": "array|null", + "type": "array", "description": "" } } ], "redis_rb": [ { - "signature": "brpop(*args)", + "signature": "blmpop(timeout, *keys, modifier: \"LEFT\", count: nil)", "params": [ { - "name": "*args", + "name": "timeout", + "type": "Float", + "description": "maximum number of seconds to block" + }, + { + "name": "*keys", "type": "String, Array", - "description": "one or more keys to perform the blocking pop on" + "description": "one or more keys with lists" }, { - "name": "timeout", - "type": "Float, Integer", - "description": "timeout in seconds" + "name": "modifier", + "type": "String", + "description": "LEFT or RIGHT" + }, + { + "name": "count", + "type": "Integer", + "description": "a number of elements to pop" } ], "returns": { - "type": "nil, [String, String]", - "description": "tuple of the list that was popped from and element" + "type": "Array>", + "description": "list of popped elements or nil" } } ] } }, - "BRPOPLPUSH": { + "BLPOP": { "api_calls": { "redis_py": [ { - "signature": "brpoplpush(src: KeyT, dst: KeyT, timeout: Optional[Number] = 0)", + "signature": "blpop(keys: List, timeout: Optional[Number] = 0)", "params": [ { - "name": "src", - "type": "KeyT", - "description": "" - }, - { - "name": "dst", - "type": "KeyT", + "name": "keys", + "type": "List", "description": "" }, { @@ -15273,64 +15734,111 @@ } ], "returns": { - "type": "Union[Awaitable[Optional[str]], Optional[str]]", + "type": "Union[Awaitable[list], list]", "description": "" } } ], "jedis": [ { - "signature": "String brpoplpush(final String source, final String destination, final int timeout)", + "signature": "List blpop(final int timeout, final String... keys)", "params": [ { - "name": "source", - "type": "String", + "name": "timeout", + "type": "int", "description": "" }, { - "name": "destination", - "type": "String", + "name": "keys", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "KeyValue blpop(final double timeout, final String... keys)", + "params": [ + { + "name": "timeout", + "type": "double", "description": "" }, + { + "name": "keys", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "KeyValue", + "description": "" + } + }, + { + "signature": "List blpop(final int timeout, final String key)", + "params": [ { "name": "timeout", "type": "int", - "description": "seconds to block. A timeout of zero can be used to block indefinitely." + "description": "" + }, + { + "name": "key", + "type": "String", + "description": "" } ], "returns": { - "type": "String", - "description": "The element being popped from source and pushed to destination @deprecated Use ListCommands#blmove(String, String, ListDirection, ListDirection, double) with ListDirection#RIGHT and ListDirection#LEFT. Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 6.2.0." + "type": "List", + "description": "" } }, { - "signature": "String brpoplpush(String source, String destination, int timeout)", + "signature": "KeyValue blpop(double timeout, String key)", "params": [ { - "name": "source", - "type": "String", + "name": "timeout", + "type": "double", "description": "" }, { - "name": "destination", + "name": "key", "type": "String", "description": "" - }, + } + ], + "returns": { + "type": "KeyValue", + "description": "" + } + }, + { + "signature": "List blpop(int timeout, String... keys)", + "params": [ { "name": "timeout", "type": "int", - "description": "seconds to block. A timeout of zero can be used to block indefinitely." + "description": "" + }, + { + "name": "keys", + "type": "String...", + "description": "" } ], "returns": { - "type": "String", - "description": "The element being popped from source and pushed to destination @deprecated Use ListCommands#blmove(String, String, ListDirection, ListDirection, double) with ListDirection#RIGHT and ListDirection#LEFT. Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 6.2.0." + "type": "List", + "description": "" } } ], "lettuce_sync": [ { - "signature": "V brpoplpush(long timeout, K source, K destination)", + "signature": "KeyValue blpop(long timeout, K... keys)", "params": [ { "name": "timeout", @@ -15338,23 +15846,18 @@ "description": "the timeout in seconds." }, { - "name": "source", - "type": "K", - "description": "the source key." - }, - { - "name": "destination", - "type": "K", - "description": "the destination type: key." + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "V", - "description": "V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @since 6.1.3" + "type": "KeyValue", + "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" } }, { - "signature": "V brpoplpush(double timeout, K source, K destination)", + "signature": "KeyValue blpop(double timeout, K... keys)", "params": [ { "name": "timeout", @@ -15362,25 +15865,20 @@ "description": "the timeout in seconds." }, { - "name": "source", - "type": "K", - "description": "the source key." - }, - { - "name": "destination", - "type": "K", - "description": "the destination type: key." + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "V", - "description": "V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @since 6.1.3" + "type": "KeyValue", + "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" } } ], "lettuce_async": [ { - "signature": "RedisFuture brpoplpush(long timeout, K source, K destination)", + "signature": "RedisFuture> blpop(long timeout, K... keys)", "params": [ { "name": "timeout", @@ -15388,23 +15886,18 @@ "description": "the timeout in seconds." }, { - "name": "source", - "type": "K", - "description": "the source key." - }, - { - "name": "destination", - "type": "K", - "description": "the destination type: key." + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "RedisFuture", - "description": "V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @since 6.1.3" + "type": "RedisFuture>", + "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" } }, { - "signature": "RedisFuture brpoplpush(double timeout, K source, K destination)", + "signature": "RedisFuture> blpop(double timeout, K... keys)", "params": [ { "name": "timeout", @@ -15412,25 +15905,20 @@ "description": "the timeout in seconds." }, { - "name": "source", - "type": "K", - "description": "the source key." - }, - { - "name": "destination", - "type": "K", - "description": "the destination type: key." + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "RedisFuture", - "description": "V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @since 6.1.3" + "type": "RedisFuture>", + "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" } } ], "lettuce_reactive": [ { - "signature": "Mono brpoplpush(long timeout, K source, K destination)", + "signature": "Mono> blpop(long timeout, K... keys)", "params": [ { "name": "timeout", @@ -15438,23 +15926,18 @@ "description": "the timeout in seconds." }, { - "name": "source", - "type": "K", - "description": "the source key." - }, - { - "name": "destination", - "type": "K", - "description": "the destination type: key." + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "Mono", - "description": "V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @since 6.1.3" + "type": "Mono>", + "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" } }, { - "signature": "Mono brpoplpush(double timeout, K source, K destination)", + "signature": "Mono> blpop(double timeout, K... keys)", "params": [ { "name": "timeout", @@ -15462,25 +15945,20 @@ "description": "the timeout in seconds." }, { - "name": "source", - "type": "K", - "description": "the source key." - }, - { - "name": "destination", - "type": "K", - "description": "the destination type: key." + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "Mono", - "description": "V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @since 6.1.3" + "type": "Mono>", + "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" } } ], "go-redis": [ { - "signature": "BRPopLPush(ctx context.Context, source, destination string, timeout time.Duration)", + "signature": "BLPop(ctx context.Context, timeout time.Duration, keys ...string)", "params": [ { "name": "ctx", @@ -15488,49 +15966,71 @@ "description": "" }, { - "name": "source", - "type": "Any", - "description": "" - }, - { - "name": "destination", - "type": "string", + "name": "timeout", + "type": "time.Duration", "description": "" }, { - "name": "timeout", - "type": "time.Duration", + "name": "keys", + "type": "...string", "description": "" } ], "returns": { - "type": "*StringCmd", + "type": "*StringSliceCmd", "description": "" } } ], "ioredis": [ { - "signature": "brpoplpush(source: RedisKey, destination: RedisKey, timeout: number | string, callback?: Callback)", + "signature": "blpop(...args: [, ...keys: RedisKey[], timeout: number | string, callback: Callback<[string, string] | null>, ])", "params": [ { - "name": "source", - "type": "RedisKey", + "name": "...args", + "type": "[, ...keys", "description": "" - }, + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "blpop(...args: [, keys: RedisKey[], timeout: number | string, callback: Callback<[string, string] | null>, ])", + "params": [ { - "name": "destination", - "type": "RedisKey", + "name": "...args", + "type": "[, keys", "description": "" - }, + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "blpop(...args: [...keys: RedisKey[], timeout: number | string])", + "params": [ { - "name": "timeout", - "type": "number | string", + "name": "...args", + "type": "[...keys", "description": "" - }, + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "blpop(...args: [keys: RedisKey[], timeout: number | string])", + "params": [ { - "name": "callback?", - "type": "Callback", + "name": "...args", + "type": "[keys", "description": "" } ], @@ -15542,16 +16042,11 @@ ], "redis_rs_sync": [ { - "signature": "brpoplpush(srckey: S, dstkey: D, timeout: f64)", + "signature": "blpop(key: K, timeout: f64)", "params": [ { - "name": "srckey", - "type": "S", - "description": "" - }, - { - "name": "dstkey", - "type": "D", + "name": "key", + "type": "K", "description": "" }, { @@ -15561,23 +16056,18 @@ } ], "returns": { - "type": "(Option)", + "type": "(Option<[String", "description": "" } } ], "redis_rs_async": [ { - "signature": "brpoplpush(srckey: S, dstkey: D, timeout: f64)", + "signature": "blpop(key: K, timeout: f64)", "params": [ { - "name": "srckey", - "type": "S", - "description": "" - }, - { - "name": "dstkey", - "type": "D", + "name": "key", + "type": "K", "description": "" }, { @@ -15587,24 +16077,38 @@ } ], "returns": { - "type": "(Option)", + "type": "(Option<[String", "description": "" } } ], "nredisstack_sync": [ { - "signature": "BRPopLPush(RedisKey source, RedisKey destination, double timeout)", + "signature": "BLPop(RedisKey[] keys, double timeout)", "params": [ { - "name": "source", - "type": "RedisKey", - "description": "The key of the source list." + "name": "keys", + "type": "RedisKey[]", + "description": "" }, { - "name": "destination", + "name": "timeout", + "type": "double", + "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." + } + ], + "returns": { + "type": "Tuple?", + "description": "A value, together with the key it was popped from, or null if the server timeoutexpires." + } + }, + { + "signature": "BLPop(RedisKey key, double timeout)", + "params": [ + { + "name": "key", "type": "RedisKey", - "description": "The key of the destination list." + "description": "The key to check." }, { "name": "timeout", @@ -15613,23 +16117,42 @@ } ], "returns": { - "type": "RedisValue?", - "description": "The element being popped and pushed, or null if the server timeout expires." + "type": "Tuple?", + "description": "A value, together with the key it was popped from, or null if the server timeoutexpires." } - } - ], - "php": [ + }, { - "signature": "brpoplpush(string $source, string $destination, int|float $timeout)", + "signature": "BLPop(db, [key], timeout)", "params": [ { - "name": "$source", - "type": "string", + "name": "db", + "type": "Any", + "description": "The IDatabase class where this extension method is applied." + }, + { + "name": "[key]", + "type": "Any", "description": "" }, { - "name": "$destination", - "type": "string", + "name": "timeout", + "type": "Any", + "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." + } + ], + "returns": { + "type": "return", + "description": "A value, together with the key it was popped from, or null if the server timeoutexpires." + } + } + ], + "php": [ + { + "signature": "blpop(array|string $keys, int|float $timeout)", + "params": [ + { + "name": "$keys", + "type": "array|string", "description": "" }, { @@ -15639,24 +16162,19 @@ } ], "returns": { - "type": "string|null", + "type": "array|null", "description": "" } } ], "redis_rb": [ { - "signature": "brpoplpush(source, destination, timeout: 0)", + "signature": "blpop(*args)", "params": [ { - "name": "source", - "type": "String", - "description": "source key" - }, - { - "name": "destination", - "type": "String", - "description": "destination key" + "name": "*args", + "type": "String, Array", + "description": "one or more keys to perform the blocking pop on" }, { "name": "timeout", @@ -15665,68 +16183,43 @@ } ], "returns": { - "type": "nil, String", - "description": "the element was popped and pushed" + "type": "nil, [String, String]", + "description": "tuple of the list that was popped from and element" } } ] } }, - "BZMPOP": { + "BRPOP": { "api_calls": { "redis_py": [ { - "signature": "bzmpop(, timeout: float,, numkeys: int,, keys: List[str],, min: Optional[bool] = False,, max: Optional[bool] = False,, count: Optional[int] = 1,)", + "signature": "brpop(keys: List, timeout: Optional[Number] = 0)", "params": [ - { - "name": "timeout", - "type": "float", - "description": "" - }, - { - "name": "numkeys", - "type": "int", - "description": "" - }, { "name": "keys", - "type": "List[str]", - "description": "" - }, - { - "name": "min", - "type": "Optional[bool] = False", - "description": "" - }, - { - "name": "max", - "type": "Optional[bool] = False", + "type": "List", "description": "" }, { - "name": "count", - "type": "Optional[int] = 1", + "name": "timeout", + "type": "Optional[Number] = 0", "description": "" } ], "returns": { - "type": "Optional[list]", + "type": "Union[Awaitable[list], list]", "description": "" } } ], "jedis": [ { - "signature": "KeyValue> bzmpop(double timeout, SortedSetOption option, String... keys)", + "signature": "List brpop(final int timeout, final String... keys)", "params": [ { "name": "timeout", - "type": "double", - "description": "" - }, - { - "name": "option", - "type": "SortedSetOption", + "type": "int", "description": "" }, { @@ -15736,28 +16229,18 @@ } ], "returns": { - "type": "KeyValue>", + "type": "List", "description": "" } }, { - "signature": "KeyValue> bzmpop(double timeout, SortedSetOption option, int count, String... keys)", + "signature": "KeyValue brpop(final double timeout, final String... keys)", "params": [ { "name": "timeout", "type": "double", "description": "" }, - { - "name": "option", - "type": "SortedSetOption", - "description": "" - }, - { - "name": "count", - "type": "int", - "description": "" - }, { "name": "keys", "type": "String...", @@ -15765,133 +16248,77 @@ } ], "returns": { - "type": "KeyValue>", + "type": "KeyValue", "description": "" } - } - ], - "lettuce_sync": [ - { - "signature": "KeyValue> bzmpop(long timeout, ZPopArgs args, K... keys)", - "params": [ - { - "name": "timeout", - "type": "long", - "description": "the timeout in seconds." - }, - { - "name": "args", - "type": "ZPopArgs", - "description": "the command args." - }, - { - "name": "keys", - "type": "K...", - "description": "the keys." - } - ], - "returns": { - "type": "KeyValue>", - "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" - } }, { - "signature": "KeyValue>> bzmpop(long timeout, long count, ZPopArgs args, K... keys)", + "signature": "List brpop(final int timeout, final String key)", "params": [ { "name": "timeout", - "type": "long", - "description": "the timeout in seconds." - }, - { - "name": "count", - "type": "long", - "description": "number of elements to pop." - }, - { - "name": "args", - "type": "ZPopArgs", - "description": "the command args." + "type": "int", + "description": "" }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "key", + "type": "String", + "description": "" } ], "returns": { - "type": "KeyValue>>", - "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" + "type": "List", + "description": "" } }, { - "signature": "KeyValue> bzmpop(double timeout, ZPopArgs args, K... keys)", + "signature": "KeyValue brpop(double timeout, String key)", "params": [ { "name": "timeout", "type": "double", - "description": "the timeout in seconds." - }, - { - "name": "args", - "type": "ZPopArgs", - "description": "the command args." + "description": "" }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "key", + "type": "String", + "description": "" } ], "returns": { - "type": "KeyValue>", - "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" + "type": "KeyValue", + "description": "" } }, { - "signature": "KeyValue>> bzmpop(double timeout, int count, ZPopArgs args, K... keys)", + "signature": "List brpop(int timeout, String... keys)", "params": [ { "name": "timeout", - "type": "double", - "description": "the timeout in seconds." - }, - { - "name": "count", "type": "int", - "description": "number of elements to pop." - }, - { - "name": "args", - "type": "ZPopArgs", - "description": "the command args." + "description": "" }, { "name": "keys", - "type": "K...", - "description": "the keys." + "type": "String...", + "description": "" } ], "returns": { - "type": "KeyValue>>", - "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" + "type": "List", + "description": "" } } ], - "lettuce_async": [ + "lettuce_sync": [ { - "signature": "RedisFuture>> bzmpop(long timeout, ZPopArgs args, K... keys)", + "signature": "KeyValue brpop(long timeout, K... keys)", "params": [ { "name": "timeout", "type": "long", "description": "the timeout in seconds." }, - { - "name": "args", - "type": "ZPopArgs", - "description": "the command args." - }, { "name": "keys", "type": "K...", @@ -15899,28 +16326,18 @@ } ], "returns": { - "type": "RedisFuture>>", - "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" + "type": "KeyValue", + "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" } }, { - "signature": "RedisFuture>>> bzmpop(long timeout, long count, ZPopArgs args, K... keys)", + "signature": "KeyValue brpop(double timeout, K... keys)", "params": [ { "name": "timeout", - "type": "long", + "type": "double", "description": "the timeout in seconds." }, - { - "name": "count", - "type": "long", - "description": "number of elements to pop." - }, - { - "name": "args", - "type": "ZPopArgs", - "description": "the command args." - }, { "name": "keys", "type": "K...", @@ -15928,23 +16345,20 @@ } ], "returns": { - "type": "RedisFuture>>>", - "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" + "type": "KeyValue", + "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" } - }, + } + ], + "lettuce_async": [ { - "signature": "RedisFuture>> bzmpop(double timeout, ZPopArgs args, K... keys)", + "signature": "RedisFuture> brpop(long timeout, K... keys)", "params": [ { "name": "timeout", - "type": "double", + "type": "long", "description": "the timeout in seconds." }, - { - "name": "args", - "type": "ZPopArgs", - "description": "the command args." - }, { "name": "keys", "type": "K...", @@ -15952,28 +16366,18 @@ } ], "returns": { - "type": "RedisFuture>>", - "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" + "type": "RedisFuture>", + "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" } }, { - "signature": "RedisFuture>>> bzmpop(double timeout, int count, ZPopArgs args, K... keys)", + "signature": "RedisFuture> brpop(double timeout, K... keys)", "params": [ { "name": "timeout", "type": "double", "description": "the timeout in seconds." }, - { - "name": "count", - "type": "int", - "description": "number of elements to pop." - }, - { - "name": "args", - "type": "ZPopArgs", - "description": "the command args." - }, { "name": "keys", "type": "K...", @@ -15981,78 +16385,20 @@ } ], "returns": { - "type": "RedisFuture>>>", - "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" + "type": "RedisFuture>", + "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" } } ], "lettuce_reactive": [ { - "signature": "Mono>> bzmpop(long timeout, ZPopArgs args, K... keys)", - "params": [ - { - "name": "timeout", - "type": "long", - "description": "the timeout in seconds." - }, - { - "name": "args", - "type": "ZPopArgs", - "description": "the command args." - }, - { - "name": "keys", - "type": "K...", - "description": "the keys." - } - ], - "returns": { - "type": "Mono>>", - "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" - } - }, - { - "signature": "Mono>>> bzmpop(long timeout, long count, ZPopArgs args, K... keys)", + "signature": "Mono> brpop(long timeout, K... keys)", "params": [ { "name": "timeout", "type": "long", "description": "the timeout in seconds." }, - { - "name": "count", - "type": "long", - "description": "number of elements to pop." - }, - { - "name": "args", - "type": "ZPopArgs", - "description": "the command args." - }, - { - "name": "keys", - "type": "K...", - "description": "the keys." - } - ], - "returns": { - "type": "Mono>>>", - "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" - } - }, - { - "signature": "Mono>> bzmpop(double timeout, ZPopArgs args, K... keys)", - "params": [ - { - "name": "timeout", - "type": "double", - "description": "the timeout in seconds." - }, - { - "name": "args", - "type": "ZPopArgs", - "description": "the command args." - }, { "name": "keys", "type": "K...", @@ -16060,28 +16406,18 @@ } ], "returns": { - "type": "Mono>>", - "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" + "type": "Mono>", + "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" } }, { - "signature": "Mono>>> bzmpop(double timeout, int count, ZPopArgs args, K... keys)", + "signature": "Mono> brpop(double timeout, K... keys)", "params": [ { "name": "timeout", "type": "double", "description": "the timeout in seconds." }, - { - "name": "count", - "type": "int", - "description": "number of elements to pop." - }, - { - "name": "args", - "type": "ZPopArgs", - "description": "the command args." - }, { "name": "keys", "type": "K...", @@ -16089,14 +16425,14 @@ } ], "returns": { - "type": "Mono>>>", - "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" + "type": "Mono>", + "description": "KeyValue<K,V> array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3" } } ], "go-redis": [ { - "signature": "BZMPop(ctx context.Context, timeout time.Duration, order string, count int64, keys ...string)", + "signature": "BRPop(ctx context.Context, timeout time.Duration, keys ...string)", "params": [ { "name": "ctx", @@ -16108,16 +16444,6 @@ "type": "time.Duration", "description": "" }, - { - "name": "order", - "type": "string", - "description": "" - }, - { - "name": "count", - "type": "int64", - "description": "" - }, { "name": "keys", "type": "...string", @@ -16125,23 +16451,18 @@ } ], "returns": { - "type": "*ZSliceWithKeyCmd", + "type": "*StringSliceCmd", "description": "" } } ], - "node_redis": [ + "ioredis": [ { - "signature": "BZMPOP(timeout: number, ...args: ZMPopArguments)", + "signature": "brpop(...args: [, ...keys: RedisKey[], timeout: number | string, callback: Callback<[string, string] | null>, ])", "params": [ - { - "name": "timeout", - "type": "number", - "description": "" - }, { "name": "...args", - "type": "ZMPopArguments", + "type": "[, ...keys", "description": "" } ], @@ -16149,15 +16470,13 @@ "type": "Any", "description": "" } - } - ], - "ioredis": [ + }, { - "signature": "bzmpop(...args: [, timeout: number | string, numkeys: number | string, ...keys: RedisKey[], min: \"MIN\", callback: Callback, ])", + "signature": "brpop(...args: [, keys: RedisKey[], timeout: number | string, callback: Callback<[string, string] | null>, ])", "params": [ { "name": "...args", - "type": "[, timeout", + "type": "[, keys", "description": "" } ], @@ -16167,11 +16486,11 @@ } }, { - "signature": "bzmpop(...args: [, timeout: number | string, numkeys: number | string, keys: RedisKey[], min: \"MIN\", callback: Callback, ])", + "signature": "brpop(...args: [...keys: RedisKey[], timeout: number | string])", "params": [ { "name": "...args", - "type": "[, timeout", + "type": "[...keys", "description": "" } ], @@ -16181,39 +16500,11 @@ } }, { - "signature": "bzmpop(...args: [, timeout: number | string, numkeys: number | string, ...keys: RedisKey[], min: \"MIN\", ])", + "signature": "brpop(...args: [keys: RedisKey[], timeout: number | string])", "params": [ { "name": "...args", - "type": "[, timeout", - "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "bzmpop(...args: [, timeout: number | string, numkeys: number | string, keys: RedisKey[], min: \"MIN\", ])", - "params": [ - { - "name": "...args", - "type": "[, timeout", - "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "bzmpop(...args: [, timeout: number | string, numkeys: number | string, ...keys: RedisKey[], min: \"MIN\", countToken: \"COUNT\", count: number | string, callback: Callback, ])", - "params": [ - { - "name": "...args", - "type": "[, timeout", + "type": "[keys", "description": "" } ], @@ -16225,175 +16516,92 @@ ], "redis_rs_sync": [ { - "signature": "bzmpop_max(timeout: f64, keys: K, count: isize)", + "signature": "brpop(key: K, timeout: f64)", "params": [ { - "name": "timeout", - "type": "f64", - "description": "" - }, - { - "name": "keys", + "name": "key", "type": "K", "description": "" }, - { - "name": "count", - "type": "isize", - "description": "" - } - ], - "returns": { - "type": "(Option<(String, Vec<(String, f64)>)>)", - "description": "" - } - }, - { - "signature": "bzmpop_min(timeout: f64, keys: K, count: isize)", - "params": [ { "name": "timeout", "type": "f64", "description": "" - }, - { - "name": "keys", - "type": "K", - "description": "" - }, - { - "name": "count", - "type": "isize", - "description": "" } ], "returns": { - "type": "(Option<(String, Vec<(String, f64)>)>)", + "type": "(Option<[String", "description": "" } } ], "redis_rs_async": [ { - "signature": "bzmpop_max(timeout: f64, keys: K, count: isize)", + "signature": "brpop(key: K, timeout: f64)", "params": [ { - "name": "timeout", - "type": "f64", - "description": "" - }, - { - "name": "keys", + "name": "key", "type": "K", "description": "" }, - { - "name": "count", - "type": "isize", - "description": "" - } - ], - "returns": { - "type": "(Option<(String, Vec<(String, f64)>)>)", - "description": "" - } - }, - { - "signature": "bzmpop_min(timeout: f64, keys: K, count: isize)", - "params": [ { "name": "timeout", "type": "f64", "description": "" - }, - { - "name": "keys", - "type": "K", - "description": "" - }, - { - "name": "count", - "type": "isize", - "description": "" } ], "returns": { - "type": "(Option<(String, Vec<(String, f64)>)>)", + "type": "(Option<[String", "description": "" } } ], "nredisstack_sync": [ { - "signature": "BZMPop(double timeout, RedisKey[] keys, MinMaxModifier minMaxModifier, long? count = null)", + "signature": "BRPop(RedisKey[] keys, double timeout)", "params": [ - { - "name": "timeout", - "type": "double", - "description": "" - }, { "name": "keys", "type": "RedisKey[]", "description": "" }, { - "name": "minMaxModifier", - "type": "MinMaxModifier", - "description": "" - }, - { - "name": "count", - "type": "long?", - "description": "" + "name": "timeout", + "type": "double", + "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." } ], "returns": { - "type": "Tuple>?", - "description": "" + "type": "Tuple?", + "description": "A value, together with the key it was popped from, or null if the server timeoutexpires." } }, { - "signature": "BZMPop(double timeout, RedisKey key, MinMaxModifier minMaxModifier, long? count = null)", + "signature": "BRPop(RedisKey key, double timeout)", "params": [ - { - "name": "timeout", - "type": "double", - "description": "" - }, { "name": "key", "type": "RedisKey", - "description": "" - }, - { - "name": "minMaxModifier", - "type": "MinMaxModifier", - "description": "" + "description": "The key to check." }, { - "name": "count", - "type": "long?", - "description": "" + "name": "timeout", + "type": "double", + "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." } ], "returns": { - "type": "Tuple>?", - "description": "" + "type": "Tuple?", + "description": "A value, together with the key it was popped from, or null if the server timeoutexpires." } }, { - "signature": "BZMPop(db, timeout, [key], minMaxModifier, count)", + "signature": "BRPop(db, [key], timeout)", "params": [ { "name": "db", "type": "Any", - "description": "" - }, - { - "name": "timeout", - "type": "Any", - "description": "" + "description": "The IDatabase class where this extension method is applied." }, { "name": "[key]", @@ -16401,133 +16609,142 @@ "description": "" }, { - "name": "minMaxModifier", - "type": "Any", - "description": "" - }, - { - "name": "count", + "name": "timeout", "type": "Any", - "description": "" + "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." } ], "returns": { "type": "return", - "description": "" + "description": "A value, together with the key it was popped from, or null if the server timeoutexpires." } } ], "php": [ { - "signature": "bzmpop(int $timeout, array $keys, string $modifier = 'min', int $count = 1)", + "signature": "brpop(array|string $keys, int|float $timeout)", "params": [ - { - "name": "$timeout", - "type": "int", - "description": "" - }, { "name": "$keys", - "type": "array", - "description": "" - }, - { - "name": "string $modifier = 'min'", - "type": "Any", + "type": "array|string", "description": "" }, { - "name": "int $count = 1", - "type": "Any", + "name": "$timeout", + "type": "int|float", "description": "" } ], "returns": { - "type": "array", + "type": "array|null", "description": "" } } ], "redis_rb": [ { - "signature": "bzmpop(timeout, *keys, modifier: \"MIN\", count: nil)", + "signature": "brpop(*args)", "params": [ { - "name": "timeout", - "type": "Float", - "description": "maximum number of seconds to block" - }, - { - "name": "*keys", + "name": "*args", "type": "String, Array", - "description": "one or more keys with sorted sets" - }, - { - "name": "modifier", - "type": "String", - "description": "MIN or MAX" + "description": "one or more keys to perform the blocking pop on" }, { - "name": "count", - "type": "Integer", - "description": "a number of members to pop" + "name": "timeout", + "type": "Float, Integer", + "description": "timeout in seconds" } ], "returns": { - "type": "Array>", - "description": "list of popped elements and scores" + "type": "nil, [String, String]", + "description": "tuple of the list that was popped from and element" } } ] } }, - "BZPOPMAX": { + "BRPOPLPUSH": { "api_calls": { "redis_py": [ { - "signature": "bzpopmax(keys: KeysT, timeout: TimeoutSecT = 0)", + "signature": "brpoplpush(src: KeyT, dst: KeyT, timeout: Optional[Number] = 0)", "params": [ { - "name": "keys", - "type": "KeysT", + "name": "src", + "type": "KeyT", + "description": "" + }, + { + "name": "dst", + "type": "KeyT", "description": "" }, { "name": "timeout", - "type": "TimeoutSecT = 0", + "type": "Optional[Number] = 0", "description": "" } ], "returns": { - "type": "ResponseT", + "type": "Union[Awaitable[Optional[str]], Optional[str]]", "description": "" } } ], "jedis": [ { - "signature": "KeyValue bzpopmax(double timeout, String... keys)", + "signature": "String brpoplpush(final String source, final String destination, final int timeout)", "params": [ + { + "name": "source", + "type": "String", + "description": "" + }, + { + "name": "destination", + "type": "String", + "description": "" + }, { "name": "timeout", - "type": "double", + "type": "int", + "description": "seconds to block. A timeout of zero can be used to block indefinitely." + } + ], + "returns": { + "type": "String", + "description": "The element being popped from source and pushed to destination @deprecated Use ListCommands#blmove(String, String, ListDirection, ListDirection, double) with ListDirection#RIGHT and ListDirection#LEFT. Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 6.2.0." + } + }, + { + "signature": "String brpoplpush(String source, String destination, int timeout)", + "params": [ + { + "name": "source", + "type": "String", "description": "" }, { - "name": "keys", - "type": "String...", + "name": "destination", + "type": "String", "description": "" + }, + { + "name": "timeout", + "type": "int", + "description": "seconds to block. A timeout of zero can be used to block indefinitely." } ], "returns": { - "type": "KeyValue", - "description": "BLPOP returns a two-elements array via a multi bulk reply in order to return both the unblocking key and the popped value. When a non-zero timeout is specified, and the BLPOP operation timed out, the return value is a nil multi bulk reply. Most connection values will return false or nil accordingly to the programming language used." + "type": "String", + "description": "The element being popped from source and pushed to destination @deprecated Use ListCommands#blmove(String, String, ListDirection, ListDirection, double) with ListDirection#RIGHT and ListDirection#LEFT. Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 6.2.0." } } ], "lettuce_sync": [ { - "signature": "KeyValue> bzpopmax(long timeout, K... keys)", + "signature": "V brpoplpush(long timeout, K source, K destination)", "params": [ { "name": "timeout", @@ -16535,18 +16752,23 @@ "description": "the timeout in seconds." }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "source", + "type": "K", + "description": "the source key." + }, + { + "name": "destination", + "type": "K", + "description": "the destination type: key." } ], "returns": { - "type": "KeyValue>", - "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" + "type": "V", + "description": "V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @since 6.1.3" } }, { - "signature": "KeyValue> bzpopmax(double timeout, K... keys)", + "signature": "V brpoplpush(double timeout, K source, K destination)", "params": [ { "name": "timeout", @@ -16554,20 +16776,25 @@ "description": "the timeout in seconds." }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "source", + "type": "K", + "description": "the source key." + }, + { + "name": "destination", + "type": "K", + "description": "the destination type: key." } ], "returns": { - "type": "KeyValue>", - "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" + "type": "V", + "description": "V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @since 6.1.3" } } ], "lettuce_async": [ { - "signature": "RedisFuture>> bzpopmax(long timeout, K... keys)", + "signature": "RedisFuture brpoplpush(long timeout, K source, K destination)", "params": [ { "name": "timeout", @@ -16575,18 +16802,23 @@ "description": "the timeout in seconds." }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "source", + "type": "K", + "description": "the source key." + }, + { + "name": "destination", + "type": "K", + "description": "the destination type: key." } ], "returns": { - "type": "RedisFuture>>", - "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" + "type": "RedisFuture", + "description": "V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @since 6.1.3" } }, { - "signature": "RedisFuture>> bzpopmax(double timeout, K... keys)", + "signature": "RedisFuture brpoplpush(double timeout, K source, K destination)", "params": [ { "name": "timeout", @@ -16594,20 +16826,25 @@ "description": "the timeout in seconds." }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "source", + "type": "K", + "description": "the source key." + }, + { + "name": "destination", + "type": "K", + "description": "the destination type: key." } ], "returns": { - "type": "RedisFuture>>", - "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" + "type": "RedisFuture", + "description": "V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @since 6.1.3" } } ], "lettuce_reactive": [ { - "signature": "Mono>> bzpopmax(long timeout, K... keys)", + "signature": "Mono brpoplpush(long timeout, K source, K destination)", "params": [ { "name": "timeout", @@ -16615,18 +16852,23 @@ "description": "the timeout in seconds." }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "source", + "type": "K", + "description": "the source key." + }, + { + "name": "destination", + "type": "K", + "description": "the destination type: key." } ], "returns": { - "type": "Mono>>", - "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" + "type": "Mono", + "description": "V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @since 6.1.3" } }, { - "signature": "Mono>> bzpopmax(double timeout, K... keys)", + "signature": "Mono brpoplpush(double timeout, K source, K destination)", "params": [ { "name": "timeout", @@ -16634,20 +16876,25 @@ "description": "the timeout in seconds." }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "source", + "type": "K", + "description": "the source key." + }, + { + "name": "destination", + "type": "K", + "description": "the destination type: key." } ], "returns": { - "type": "Mono>>", - "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" + "type": "Mono", + "description": "V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @since 6.1.3" } } ], "go-redis": [ { - "signature": "BZPopMax(ctx context.Context, timeout time.Duration, keys ...string)", + "signature": "BRPopLPush(ctx context.Context, source, destination string, timeout time.Duration)", "params": [ { "name": "ctx", @@ -16655,92 +16902,49 @@ "description": "" }, { - "name": "timeout", - "type": "time.Duration", + "name": "source", + "type": "Any", "description": "" }, { - "name": "keys", - "type": "...string", - "description": "" - } - ], - "returns": { - "type": "*ZWithKeyCmd", - "description": "" - } - } - ], - "node_redis": [ - { - "signature": "BZPOPMAX(keys: RedisVariadicArgument, timeout: number)", - "params": [ - { - "name": "keys", - "type": "RedisVariadicArgument", + "name": "destination", + "type": "string", "description": "" }, { "name": "timeout", - "type": "number", + "type": "time.Duration", "description": "" } ], "returns": { - "type": "Any", + "type": "*StringCmd", "description": "" } } ], "ioredis": [ { - "signature": "bzpopmax(...args: [, ...keys: RedisKey[], timeout: number | string, callback: Callback<[key: string, member: string, score: string] | null>, ])", + "signature": "brpoplpush(source: RedisKey, destination: RedisKey, timeout: number | string, callback?: Callback)", "params": [ { - "name": "...args", - "type": "[, ...keys", + "name": "source", + "type": "RedisKey", "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "bzpopmax(...args: [, keys: RedisKey[], timeout: number | string, callback: Callback<[key: string, member: string, score: string] | null>, ])", - "params": [ + }, { - "name": "...args", - "type": "[, keys", + "name": "destination", + "type": "RedisKey", "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "bzpopmax(...args: [...keys: RedisKey[], timeout: number | string])", - "params": [ + }, { - "name": "...args", - "type": "[...keys", + "name": "timeout", + "type": "number | string", "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "bzpopmax(...args: [keys: RedisKey[], timeout: number | string])", - "params": [ + }, { - "name": "...args", - "type": "[keys", + "name": "callback?", + "type": "Callback", "description": "" } ], @@ -16752,11 +16956,16 @@ ], "redis_rs_sync": [ { - "signature": "bzpopmax(key: K, timeout: f64)", + "signature": "brpoplpush(srckey: S, dstkey: D, timeout: f64)", "params": [ { - "name": "key", - "type": "K", + "name": "srckey", + "type": "S", + "description": "" + }, + { + "name": "dstkey", + "type": "D", "description": "" }, { @@ -16766,18 +16975,23 @@ } ], "returns": { - "type": "(Option<(String, String, f64)>)", + "type": "(Option)", "description": "" } } ], "redis_rs_async": [ { - "signature": "bzpopmax(key: K, timeout: f64)", + "signature": "brpoplpush(srckey: S, dstkey: D, timeout: f64)", "params": [ { - "name": "key", - "type": "K", + "name": "srckey", + "type": "S", + "description": "" + }, + { + "name": "dstkey", + "type": "D", "description": "" }, { @@ -16787,19 +17001,24 @@ } ], "returns": { - "type": "(Option<(String, String, f64)>)", + "type": "(Option)", "description": "" } } ], "nredisstack_sync": [ { - "signature": "BZPopMax(RedisKey[] keys, double timeout)", + "signature": "BRPopLPush(RedisKey source, RedisKey destination, double timeout)", "params": [ { - "name": "keys", - "type": "RedisKey[]", - "description": "" + "name": "source", + "type": "RedisKey", + "description": "The key of the source list." + }, + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination list." }, { "name": "timeout", @@ -16808,130 +17027,122 @@ } ], "returns": { - "type": "Tuple?", - "description": "A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires." + "type": "RedisValue?", + "description": "The element being popped and pushed, or null if the server timeout expires." } - }, + } + ], + "php": [ { - "signature": "BZPopMax(RedisKey key, double timeout)", + "signature": "brpoplpush(string $source, string $destination, int|float $timeout)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The key to check." + "name": "$source", + "type": "string", + "description": "" }, { - "name": "timeout", - "type": "double", - "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." - } - ], - "returns": { - "type": "Tuple?", - "description": "A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires." - } - }, - { - "signature": "BZPopMax(db, [key], timeout)", - "params": [ - { - "name": "db", - "type": "Any", - "description": "The IDatabase class where this extension method is applied." - }, - { - "name": "[key]", - "type": "Any", - "description": "" - }, - { - "name": "timeout", - "type": "Any", - "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." - } - ], - "returns": { - "type": "return", - "description": "A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires." - } - } - ], - "php": [ - { - "signature": "bzpopmax(array $keys, int $timeout)", - "params": [ - { - "name": "$keys", - "type": "array", + "name": "$destination", + "type": "string", "description": "" }, { "name": "$timeout", - "type": "int", + "type": "int|float", "description": "" } ], "returns": { - "type": "array", + "type": "string|null", "description": "" } } ], "redis_rb": [ { - "signature": "bzpopmax(*args)", + "signature": "brpoplpush(source, destination, timeout: 0)", "params": [ { - "name": "*args", - "type": "Array", - "description": "one or multiple keys of the sorted sets" + "name": "source", + "type": "String", + "description": "source key" + }, + { + "name": "destination", + "type": "String", + "description": "destination key" }, { "name": "timeout", - "type": "Integer", - "description": "the maximum number of seconds to block" + "type": "Float, Integer", + "description": "timeout in seconds" } ], "returns": { - "type": "Array", - "description": "a tuple of key, member and score" + "type": "nil, String", + "description": "the element was popped and pushed" } } ] } }, - "BZPOPMIN": { + "BZMPOP": { "api_calls": { "redis_py": [ { - "signature": "bzpopmin(keys: KeysT, timeout: TimeoutSecT = 0)", + "signature": "bzmpop(, timeout: float,, numkeys: int,, keys: List[str],, min: Optional[bool] = False,, max: Optional[bool] = False,, count: Optional[int] = 1,)", "params": [ + { + "name": "timeout", + "type": "float", + "description": "" + }, + { + "name": "numkeys", + "type": "int", + "description": "" + }, { "name": "keys", - "type": "KeysT", + "type": "List[str]", "description": "" }, { - "name": "timeout", - "type": "TimeoutSecT = 0", + "name": "min", + "type": "Optional[bool] = False", + "description": "" + }, + { + "name": "max", + "type": "Optional[bool] = False", + "description": "" + }, + { + "name": "count", + "type": "Optional[int] = 1", "description": "" } ], "returns": { - "type": "ResponseT", + "type": "Optional[list]", "description": "" } } ], "jedis": [ { - "signature": "KeyValue bzpopmin(double timeout, String... keys)", + "signature": "KeyValue> bzmpop(double timeout, SortedSetOption option, String... keys)", "params": [ { "name": "timeout", "type": "double", "description": "" }, + { + "name": "option", + "type": "SortedSetOption", + "description": "" + }, { "name": "keys", "type": "String...", @@ -16939,20 +17150,54 @@ } ], "returns": { - "type": "KeyValue", - "description": "BLPOP returns a two-elements array via a multi bulk reply in order to return both the unblocking key and the popped value. When a non-zero timeout is specified, and the BLPOP operation timed out, the return value is a nil multi bulk reply. Most connection values will return false or nil accordingly to the programming language used." + "type": "KeyValue>", + "description": "" + } + }, + { + "signature": "KeyValue> bzmpop(double timeout, SortedSetOption option, int count, String... keys)", + "params": [ + { + "name": "timeout", + "type": "double", + "description": "" + }, + { + "name": "option", + "type": "SortedSetOption", + "description": "" + }, + { + "name": "count", + "type": "int", + "description": "" + }, + { + "name": "keys", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "KeyValue>", + "description": "" } } ], "lettuce_sync": [ { - "signature": "KeyValue> bzpopmin(long timeout, K... keys)", + "signature": "KeyValue> bzmpop(long timeout, ZPopArgs args, K... keys)", "params": [ { "name": "timeout", "type": "long", "description": "the timeout in seconds." }, + { + "name": "args", + "type": "ZPopArgs", + "description": "the command args." + }, { "name": "keys", "type": "K...", @@ -16961,17 +17206,51 @@ ], "returns": { "type": "KeyValue>", - "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" + "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" } }, { - "signature": "KeyValue> bzpopmin(double timeout, K... keys)", + "signature": "KeyValue>> bzmpop(long timeout, long count, ZPopArgs args, K... keys)", + "params": [ + { + "name": "timeout", + "type": "long", + "description": "the timeout in seconds." + }, + { + "name": "count", + "type": "long", + "description": "number of elements to pop." + }, + { + "name": "args", + "type": "ZPopArgs", + "description": "the command args." + }, + { + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], + "returns": { + "type": "KeyValue>>", + "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" + } + }, + { + "signature": "KeyValue> bzmpop(double timeout, ZPopArgs args, K... keys)", "params": [ { "name": "timeout", "type": "double", "description": "the timeout in seconds." }, + { + "name": "args", + "type": "ZPopArgs", + "description": "the command args." + }, { "name": "keys", "type": "K...", @@ -16980,19 +17259,53 @@ ], "returns": { "type": "KeyValue>", - "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" + "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" + } + }, + { + "signature": "KeyValue>> bzmpop(double timeout, int count, ZPopArgs args, K... keys)", + "params": [ + { + "name": "timeout", + "type": "double", + "description": "the timeout in seconds." + }, + { + "name": "count", + "type": "int", + "description": "number of elements to pop." + }, + { + "name": "args", + "type": "ZPopArgs", + "description": "the command args." + }, + { + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], + "returns": { + "type": "KeyValue>>", + "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" } } ], "lettuce_async": [ { - "signature": "RedisFuture>> bzpopmin(long timeout, K... keys)", + "signature": "RedisFuture>> bzmpop(long timeout, ZPopArgs args, K... keys)", "params": [ { "name": "timeout", "type": "long", "description": "the timeout in seconds." }, + { + "name": "args", + "type": "ZPopArgs", + "description": "the command args." + }, { "name": "keys", "type": "K...", @@ -17001,17 +17314,51 @@ ], "returns": { "type": "RedisFuture>>", - "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" + "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" } }, { - "signature": "RedisFuture>> bzpopmin(double timeout, K... keys)", + "signature": "RedisFuture>>> bzmpop(long timeout, long count, ZPopArgs args, K... keys)", + "params": [ + { + "name": "timeout", + "type": "long", + "description": "the timeout in seconds." + }, + { + "name": "count", + "type": "long", + "description": "number of elements to pop." + }, + { + "name": "args", + "type": "ZPopArgs", + "description": "the command args." + }, + { + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], + "returns": { + "type": "RedisFuture>>>", + "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" + } + }, + { + "signature": "RedisFuture>> bzmpop(double timeout, ZPopArgs args, K... keys)", "params": [ { "name": "timeout", "type": "double", "description": "the timeout in seconds." }, + { + "name": "args", + "type": "ZPopArgs", + "description": "the command args." + }, { "name": "keys", "type": "K...", @@ -17020,19 +17367,53 @@ ], "returns": { "type": "RedisFuture>>", - "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" + "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" + } + }, + { + "signature": "RedisFuture>>> bzmpop(double timeout, int count, ZPopArgs args, K... keys)", + "params": [ + { + "name": "timeout", + "type": "double", + "description": "the timeout in seconds." + }, + { + "name": "count", + "type": "int", + "description": "number of elements to pop." + }, + { + "name": "args", + "type": "ZPopArgs", + "description": "the command args." + }, + { + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], + "returns": { + "type": "RedisFuture>>>", + "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" } } ], "lettuce_reactive": [ { - "signature": "Mono>> bzpopmin(long timeout, K... keys)", + "signature": "Mono>> bzmpop(long timeout, ZPopArgs args, K... keys)", "params": [ { "name": "timeout", "type": "long", "description": "the timeout in seconds." }, + { + "name": "args", + "type": "ZPopArgs", + "description": "the command args." + }, { "name": "keys", "type": "K...", @@ -17041,17 +17422,51 @@ ], "returns": { "type": "Mono>>", - "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" + "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" } }, { - "signature": "Mono>> bzpopmin(double timeout, K... keys)", + "signature": "Mono>>> bzmpop(long timeout, long count, ZPopArgs args, K... keys)", + "params": [ + { + "name": "timeout", + "type": "long", + "description": "the timeout in seconds." + }, + { + "name": "count", + "type": "long", + "description": "number of elements to pop." + }, + { + "name": "args", + "type": "ZPopArgs", + "description": "the command args." + }, + { + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], + "returns": { + "type": "Mono>>>", + "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" + } + }, + { + "signature": "Mono>> bzmpop(double timeout, ZPopArgs args, K... keys)", "params": [ { "name": "timeout", "type": "double", "description": "the timeout in seconds." }, + { + "name": "args", + "type": "ZPopArgs", + "description": "the command args." + }, { "name": "keys", "type": "K...", @@ -17060,13 +17475,42 @@ ], "returns": { "type": "Mono>>", - "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" + "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" + } + }, + { + "signature": "Mono>>> bzmpop(double timeout, int count, ZPopArgs args, K... keys)", + "params": [ + { + "name": "timeout", + "type": "double", + "description": "the timeout in seconds." + }, + { + "name": "count", + "type": "int", + "description": "number of elements to pop." + }, + { + "name": "args", + "type": "ZPopArgs", + "description": "the command args." + }, + { + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], + "returns": { + "type": "Mono>>>", + "description": "ScoredValue<V> the removed elements or KeyValue#empty(). @since 6.3" } } ], "go-redis": [ { - "signature": "BZPopMin(ctx context.Context, timeout time.Duration, keys ...string)", + "signature": "BZMPop(ctx context.Context, timeout time.Duration, order string, count int64, keys ...string)", "params": [ { "name": "ctx", @@ -17078,6 +17522,16 @@ "type": "time.Duration", "description": "" }, + { + "name": "order", + "type": "string", + "description": "" + }, + { + "name": "count", + "type": "int64", + "description": "" + }, { "name": "keys", "type": "...string", @@ -17085,23 +17539,23 @@ } ], "returns": { - "type": "*ZWithKeyCmd", + "type": "*ZSliceWithKeyCmd", "description": "" } } ], "node_redis": [ { - "signature": "BZPOPMIN(keys: RedisVariadicArgument, timeout: number)", + "signature": "BZMPOP(timeout: number, ...args: ZMPopArguments)", "params": [ { - "name": "keys", - "type": "RedisVariadicArgument", + "name": "timeout", + "type": "number", "description": "" }, { - "name": "timeout", - "type": "number", + "name": "...args", + "type": "ZMPopArguments", "description": "" } ], @@ -17113,11 +17567,11 @@ ], "ioredis": [ { - "signature": "bzpopmin(...args: [, ...keys: RedisKey[], timeout: number | string, callback: Callback<[key: string, member: string, score: string] | null>, ])", + "signature": "bzmpop(...args: [, timeout: number | string, numkeys: number | string, ...keys: RedisKey[], min: \"MIN\", callback: Callback, ])", "params": [ { "name": "...args", - "type": "[, ...keys", + "type": "[, timeout", "description": "" } ], @@ -17127,11 +17581,11 @@ } }, { - "signature": "bzpopmin(...args: [, keys: RedisKey[], timeout: number | string, callback: Callback<[key: string, member: string, score: string] | null>, ])", + "signature": "bzmpop(...args: [, timeout: number | string, numkeys: number | string, keys: RedisKey[], min: \"MIN\", callback: Callback, ])", "params": [ { "name": "...args", - "type": "[, keys", + "type": "[, timeout", "description": "" } ], @@ -17141,11 +17595,11 @@ } }, { - "signature": "bzpopmin(...args: [...keys: RedisKey[], timeout: number | string])", + "signature": "bzmpop(...args: [, timeout: number | string, numkeys: number | string, ...keys: RedisKey[], min: \"MIN\", ])", "params": [ { "name": "...args", - "type": "[...keys", + "type": "[, timeout", "description": "" } ], @@ -17155,11 +17609,11 @@ } }, { - "signature": "bzpopmin(...args: [keys: RedisKey[], timeout: number | string])", + "signature": "bzmpop(...args: [, timeout: number | string, numkeys: number | string, keys: RedisKey[], min: \"MIN\", ])", "params": [ { "name": "...args", - "type": "[keys", + "type": "[, timeout", "description": "" } ], @@ -17167,1114 +17621,1144 @@ "type": "Any", "description": "" } - } - ], - "redis_rs_sync": [ + }, { - "signature": "bzpopmin(key: K, timeout: f64)", + "signature": "bzmpop(...args: [, timeout: number | string, numkeys: number | string, ...keys: RedisKey[], min: \"MIN\", countToken: \"COUNT\", count: number | string, callback: Callback, ])", "params": [ { - "name": "key", - "type": "K", - "description": "" - }, - { - "name": "timeout", - "type": "f64", + "name": "...args", + "type": "[, timeout", "description": "" } ], "returns": { - "type": "(Option<(String, String, f64)>)", + "type": "Any", "description": "" } } ], - "redis_rs_async": [ + "redis_rs_sync": [ { - "signature": "bzpopmin(key: K, timeout: f64)", + "signature": "bzmpop_max(timeout: f64, keys: K, count: isize)", "params": [ { - "name": "key", + "name": "timeout", + "type": "f64", + "description": "" + }, + { + "name": "keys", "type": "K", "description": "" }, { - "name": "timeout", - "type": "f64", + "name": "count", + "type": "isize", "description": "" } ], "returns": { - "type": "(Option<(String, String, f64)>)", + "type": "(Option<(String, Vec<(String, f64)>)>)", "description": "" } - } - ], - "nredisstack_sync": [ + }, { - "signature": "BZPopMin(RedisKey[] keys, double timeout)", + "signature": "bzmpop_min(timeout: f64, keys: K, count: isize)", "params": [ + { + "name": "timeout", + "type": "f64", + "description": "" + }, { "name": "keys", - "type": "RedisKey[]", + "type": "K", "description": "" }, { - "name": "timeout", - "type": "double", - "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." + "name": "count", + "type": "isize", + "description": "" } ], "returns": { - "type": "Tuple?", - "description": "A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires." + "type": "(Option<(String, Vec<(String, f64)>)>)", + "description": "" } - }, + } + ], + "redis_rs_async": [ { - "signature": "BZPopMin(RedisKey key, double timeout)", + "signature": "bzmpop_max(timeout: f64, keys: K, count: isize)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The key to check." + "name": "timeout", + "type": "f64", + "description": "" }, { - "name": "timeout", - "type": "double", - "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." + "name": "keys", + "type": "K", + "description": "" + }, + { + "name": "count", + "type": "isize", + "description": "" } ], "returns": { - "type": "Tuple?", - "description": "A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires." + "type": "(Option<(String, Vec<(String, f64)>)>)", + "description": "" } }, { - "signature": "BZPopMin(db, [key], timeout)", + "signature": "bzmpop_min(timeout: f64, keys: K, count: isize)", "params": [ { - "name": "db", - "type": "Any", - "description": "The IDatabase class where this extension method is applied." + "name": "timeout", + "type": "f64", + "description": "" }, { - "name": "[key]", - "type": "Any", + "name": "keys", + "type": "K", "description": "" }, { - "name": "timeout", - "type": "Any", - "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." + "name": "count", + "type": "isize", + "description": "" } ], "returns": { - "type": "return", - "description": "A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires." + "type": "(Option<(String, Vec<(String, f64)>)>)", + "description": "" } } ], - "php": [ + "nredisstack_sync": [ { - "signature": "bzpopmin(array $keys, int $timeout)", + "signature": "BZMPop(double timeout, RedisKey[] keys, MinMaxModifier minMaxModifier, long? count = null)", "params": [ { - "name": "$keys", - "type": "array", + "name": "timeout", + "type": "double", "description": "" }, { - "name": "$timeout", - "type": "int", + "name": "keys", + "type": "RedisKey[]", + "description": "" + }, + { + "name": "minMaxModifier", + "type": "MinMaxModifier", + "description": "" + }, + { + "name": "count", + "type": "long?", "description": "" } ], "returns": { - "type": "array", + "type": "Tuple>?", "description": "" } - } - ], - "redis_rb": [ + }, { - "signature": "bzpopmin(*args)", + "signature": "BZMPop(double timeout, RedisKey key, MinMaxModifier minMaxModifier, long? count = null)", "params": [ { - "name": "*args", - "type": "Array", - "description": "one or multiple keys of the sorted sets" + "name": "timeout", + "type": "double", + "description": "" }, { - "name": "timeout", - "type": "Integer", - "description": "the maximum number of seconds to block" + "name": "key", + "type": "RedisKey", + "description": "" + }, + { + "name": "minMaxModifier", + "type": "MinMaxModifier", + "description": "" + }, + { + "name": "count", + "type": "long?", + "description": "" } ], "returns": { - "type": "Array", - "description": "a tuple of key, member and score" + "type": "Tuple>?", + "description": "" } - } - ] - } - }, - "CF.ADD": { - "api_calls": { - "redis_py": [ + }, { - "signature": "add(key, item)", + "signature": "BZMPop(db, timeout, [key], minMaxModifier, count)", "params": [ { - "name": "key", - "type": "str", - "description": "The name of the Cuckoo filter" + "name": "db", + "type": "Any", + "description": "" }, { - "name": "item", - "type": "str", - "description": "The item to add" + "name": "timeout", + "type": "Any", + "description": "" + }, + { + "name": "[key]", + "type": "Any", + "description": "" + }, + { + "name": "minMaxModifier", + "type": "Any", + "description": "" + }, + { + "name": "count", + "type": "Any", + "description": "" } ], "returns": { - "type": "bool", - "description": "True on success" + "type": "return", + "description": "" } } ], - "jedis": [ + "php": [ { - "signature": "boolean cfAdd(String key, String item)", + "signature": "bzmpop(int $timeout, array $keys, string $modifier = 'min', int $count = 1)", "params": [ { - "name": "key", - "type": "String", - "description": "The name of the Cuckoo filter" + "name": "$timeout", + "type": "int", + "description": "" }, { - "name": "item", - "type": "String", - "description": "The item to add" + "name": "$keys", + "type": "array", + "description": "" + }, + { + "name": "string $modifier = 'min'", + "type": "Any", + "description": "" + }, + { + "name": "int $count = 1", + "type": "Any", + "description": "" } ], "returns": { - "type": "boolean", - "description": "true on success" + "type": "array", + "description": "" } } ], - "go-redis": [ + "redis_rb": [ { - "signature": "CFAdd(ctx context.Context, key string, element interface{}) *BoolCmd", + "signature": "bzmpop(timeout, *keys, modifier: \"MIN\", count: nil)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" + "name": "timeout", + "type": "Float", + "description": "maximum number of seconds to block" }, { - "name": "key", - "type": "string", - "description": "The name of the Cuckoo filter" + "name": "*keys", + "type": "String, Array", + "description": "one or more keys with sorted sets" }, { - "name": "element", - "type": "interface{}", - "description": "The item to add" + "name": "modifier", + "type": "String", + "description": "MIN or MAX" + }, + { + "name": "count", + "type": "Integer", + "description": "a number of members to pop" } ], "returns": { - "type": "*BoolCmd", - "description": "Boolean command result" + "type": "Array>", + "description": "list of popped elements and scores" } } - ], - "node_redis": [ + ] + } + }, + "BZPOPMAX": { + "api_calls": { + "redis_py": [ { - "signature": "CF.ADD(key: RedisArgument, item: RedisArgument)", + "signature": "bzpopmax(keys: KeysT, timeout: TimeoutSecT = 0)", "params": [ { - "name": "key", - "type": "RedisArgument", - "description": "The name of the Cuckoo filter" + "name": "keys", + "type": "KeysT", + "description": "" }, { - "name": "item", - "type": "RedisArgument", - "description": "The item to add" + "name": "timeout", + "type": "TimeoutSecT = 0", + "description": "" } ], "returns": { - "type": "boolean", - "description": "true on success" + "type": "ResponseT", + "description": "" } } ], - "nredisstack_sync": [ + "jedis": [ { - "signature": "bool Add(RedisKey key, RedisValue item)", + "signature": "KeyValue bzpopmax(double timeout, String... keys)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The name of the Cuckoo filter" + "name": "timeout", + "type": "double", + "description": "" }, { - "name": "item", - "type": "RedisValue", - "description": "The item to add" + "name": "keys", + "type": "String...", + "description": "" } ], "returns": { - "type": "bool", - "description": "true on success" + "type": "KeyValue", + "description": "BLPOP returns a two-elements array via a multi bulk reply in order to return both the unblocking key and the popped value. When a non-zero timeout is specified, and the BLPOP operation timed out, the return value is a nil multi bulk reply. Most connection values will return false or nil accordingly to the programming language used." } } ], - "nredisstack_async": [ + "lettuce_sync": [ { - "signature": "async Task AddAsync(RedisKey key, RedisValue item)", + "signature": "KeyValue> bzpopmax(long timeout, K... keys)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The name of the Cuckoo filter" + "name": "timeout", + "type": "long", + "description": "the timeout in seconds." }, { - "name": "item", - "type": "RedisValue", - "description": "The item to add" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "Task", - "description": "true on success" + "type": "KeyValue>", + "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" } - } - ], - "php": [ + }, { - "signature": "cfadd(string $key, $item)", + "signature": "KeyValue> bzpopmax(double timeout, K... keys)", "params": [ { - "name": "$key", - "type": "string", - "description": "The name of the Cuckoo filter" + "name": "timeout", + "type": "double", + "description": "the timeout in seconds." }, { - "name": "$item", - "type": "mixed", - "description": "The item to add" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "mixed", - "description": "Result of the operation" + "type": "KeyValue>", + "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" } } - ] - } - }, - "CF.ADDNX": { - "api_calls": { - "redis_py": [ + ], + "lettuce_async": [ { - "signature": "addnx(key, item)", + "signature": "RedisFuture>> bzpopmax(long timeout, K... keys)", "params": [ { - "name": "key", - "type": "str", - "description": "The name of the Cuckoo filter" + "name": "timeout", + "type": "long", + "description": "the timeout in seconds." }, { - "name": "item", - "type": "str", - "description": "The item to add" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "bool", - "description": "True if added, False if already exists" + "type": "RedisFuture>>", + "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" } - } - ], - "jedis": [ + }, { - "signature": "boolean cfAddNx(String key, String item)", + "signature": "RedisFuture>> bzpopmax(double timeout, K... keys)", "params": [ { - "name": "key", - "type": "String", - "description": "The name of the Cuckoo filter" + "name": "timeout", + "type": "double", + "description": "the timeout in seconds." }, { - "name": "item", - "type": "String", - "description": "The item to add" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "boolean", - "description": "true if added, false if already exists" + "type": "RedisFuture>>", + "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" } } ], - "go-redis": [ + "lettuce_reactive": [ { - "signature": "CFAddNX(ctx context.Context, key string, element interface{}) *BoolCmd", + "signature": "Mono>> bzpopmax(long timeout, K... keys)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" - }, - { - "name": "key", - "type": "string", - "description": "The name of the Cuckoo filter" + "name": "timeout", + "type": "long", + "description": "the timeout in seconds." }, { - "name": "element", - "type": "interface{}", - "description": "The item to add" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "*BoolCmd", - "description": "Boolean command result" + "type": "Mono>>", + "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" } - } - ], - "node_redis": [ + }, { - "signature": "CF.ADDNX(key: RedisArgument, item: RedisArgument)", + "signature": "Mono>> bzpopmax(double timeout, K... keys)", "params": [ { - "name": "key", - "type": "RedisArgument", - "description": "The name of the Cuckoo filter" + "name": "timeout", + "type": "double", + "description": "the timeout in seconds." }, { - "name": "item", - "type": "RedisArgument", - "description": "The item to add" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "boolean", - "description": "true if added, false if already exists" + "type": "Mono>>", + "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" } } ], - "nredisstack_sync": [ + "go-redis": [ { - "signature": "bool AddNX(RedisKey key, RedisValue item)", + "signature": "BZPopMax(ctx context.Context, timeout time.Duration, keys ...string)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The name of the Cuckoo filter" + "name": "ctx", + "type": "context.Context", + "description": "" }, { - "name": "item", - "type": "RedisValue", - "description": "The item to add" + "name": "timeout", + "type": "time.Duration", + "description": "" + }, + { + "name": "keys", + "type": "...string", + "description": "" } ], "returns": { - "type": "bool", - "description": "true if added, false if already exists" + "type": "*ZWithKeyCmd", + "description": "" } } ], - "nredisstack_async": [ + "node_redis": [ { - "signature": "async Task AddNXAsync(RedisKey key, RedisValue item)", + "signature": "BZPOPMAX(keys: RedisVariadicArgument, timeout: number)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The name of the Cuckoo filter" + "name": "keys", + "type": "RedisVariadicArgument", + "description": "" }, { - "name": "item", - "type": "RedisValue", - "description": "The item to add" + "name": "timeout", + "type": "number", + "description": "" } ], "returns": { - "type": "Task", - "description": "true if added, false if already exists" + "type": "Any", + "description": "" } } ], - "php": [ + "ioredis": [ { - "signature": "cfaddnx(string $key, $item)", + "signature": "bzpopmax(...args: [, ...keys: RedisKey[], timeout: number | string, callback: Callback<[key: string, member: string, score: string] | null>, ])", "params": [ { - "name": "$key", - "type": "string", - "description": "The name of the Cuckoo filter" - }, - { - "name": "$item", - "type": "mixed", - "description": "The item to add" + "name": "...args", + "type": "[, ...keys", + "description": "" } ], "returns": { - "type": "mixed", - "description": "Result of the operation" + "type": "Any", + "description": "" } - } - ] - } - }, - "CF.COUNT": { - "api_calls": { - "redis_py": [ + }, { - "signature": "count(key, item)", + "signature": "bzpopmax(...args: [, keys: RedisKey[], timeout: number | string, callback: Callback<[key: string, member: string, score: string] | null>, ])", "params": [ { - "name": "key", - "type": "str", - "description": "The name of the Cuckoo filter" - }, - { - "name": "item", - "type": "str", - "description": "The item to count" + "name": "...args", + "type": "[, keys", + "description": "" } ], "returns": { - "type": "int", - "description": "Number of times the item exists in the filter" + "type": "Any", + "description": "" } - } - ], - "jedis": [ + }, { - "signature": "long cfCount(String key, String item)", + "signature": "bzpopmax(...args: [...keys: RedisKey[], timeout: number | string])", "params": [ { - "name": "key", - "type": "String", - "description": "The name of the Cuckoo filter" - }, - { - "name": "item", - "type": "String", - "description": "The item to count" + "name": "...args", + "type": "[...keys", + "description": "" } ], "returns": { - "type": "long", - "description": "Number of times the item exists" + "type": "Any", + "description": "" } - } - ], - "go-redis": [ + }, { - "signature": "CFCount(ctx context.Context, key string, element interface{}) *IntCmd", + "signature": "bzpopmax(...args: [keys: RedisKey[], timeout: number | string])", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" - }, - { - "name": "key", - "type": "string", - "description": "The name of the Cuckoo filter" - }, - { - "name": "element", - "type": "interface{}", - "description": "The item to count" + "name": "...args", + "type": "[keys", + "description": "" } ], "returns": { - "type": "*IntCmd", - "description": "Integer command result" + "type": "Any", + "description": "" } } ], - "node_redis": [ + "redis_rs_sync": [ { - "signature": "CF.COUNT(key: RedisArgument, item: RedisArgument)", + "signature": "bzpopmax(key: K, timeout: f64)", "params": [ { "name": "key", - "type": "RedisArgument", - "description": "The name of the Cuckoo filter" + "type": "K", + "description": "" }, { - "name": "item", - "type": "RedisArgument", - "description": "The item to count" + "name": "timeout", + "type": "f64", + "description": "" } ], "returns": { - "type": "number", - "description": "Number of times the item exists" + "type": "(Option<(String, String, f64)>)", + "description": "" } } ], - "nredisstack_sync": [ + "redis_rs_async": [ { - "signature": "long Count(RedisKey key, RedisValue item)", + "signature": "bzpopmax(key: K, timeout: f64)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The name of the Cuckoo filter" + "type": "K", + "description": "" }, { - "name": "item", - "type": "RedisValue", - "description": "The item to count" + "name": "timeout", + "type": "f64", + "description": "" } ], "returns": { - "type": "long", - "description": "Number of times the item exists" + "type": "(Option<(String, String, f64)>)", + "description": "" } } ], - "nredisstack_async": [ + "nredisstack_sync": [ { - "signature": "async Task CountAsync(RedisKey key, RedisValue item)", + "signature": "BZPopMax(RedisKey[] keys, double timeout)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The name of the Cuckoo filter" + "name": "keys", + "type": "RedisKey[]", + "description": "" }, { - "name": "item", - "type": "RedisValue", - "description": "The item to count" + "name": "timeout", + "type": "double", + "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." } ], "returns": { - "type": "Task", - "description": "Number of times the item exists" + "type": "Tuple?", + "description": "A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires." } - } - ], - "php": [ + }, { - "signature": "cfcount(string $key, $item)", + "signature": "BZPopMax(RedisKey key, double timeout)", "params": [ { - "name": "$key", - "type": "string", - "description": "The name of the Cuckoo filter" + "name": "key", + "type": "RedisKey", + "description": "The key to check." }, { - "name": "$item", - "type": "mixed", - "description": "The item to count" + "name": "timeout", + "type": "double", + "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." } ], "returns": { - "type": "int", - "description": "Number of times the item exists" + "type": "Tuple?", + "description": "A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires." } - } - ] - } - }, - "CF.DEL": { - "api_calls": { - "redis_py": [ + }, { - "signature": "delete(key, item)", + "signature": "BZPopMax(db, [key], timeout)", "params": [ { - "name": "key", - "type": "str", - "description": "The name of the Cuckoo filter" + "name": "db", + "type": "Any", + "description": "The IDatabase class where this extension method is applied." }, { - "name": "item", - "type": "str", - "description": "The item to delete" + "name": "[key]", + "type": "Any", + "description": "" + }, + { + "name": "timeout", + "type": "Any", + "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." } ], "returns": { - "type": "bool", - "description": "True if deleted, False if not found" + "type": "return", + "description": "A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires." } } ], - "jedis": [ + "php": [ { - "signature": "boolean cfDel(String key, String item)", + "signature": "bzpopmax(array $keys, int $timeout)", "params": [ { - "name": "key", - "type": "String", - "description": "The name of the Cuckoo filter" + "name": "$keys", + "type": "array", + "description": "" }, { - "name": "item", - "type": "String", - "description": "The item to delete" + "name": "$timeout", + "type": "int", + "description": "" } ], "returns": { - "type": "boolean", - "description": "true if deleted, false if not found" + "type": "array", + "description": "" } } ], - "go-redis": [ + "redis_rb": [ { - "signature": "CFDel(ctx context.Context, key string, element interface{}) *BoolCmd", + "signature": "bzpopmax(*args)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" - }, - { - "name": "key", - "type": "string", - "description": "The name of the Cuckoo filter" + "name": "*args", + "type": "Array", + "description": "one or multiple keys of the sorted sets" }, { - "name": "element", - "type": "interface{}", - "description": "The item to delete" + "name": "timeout", + "type": "Integer", + "description": "the maximum number of seconds to block" } ], "returns": { - "type": "*BoolCmd", - "description": "Boolean command result" + "type": "Array", + "description": "a tuple of key, member and score" } } - ], - "node_redis": [ + ] + } + }, + "BZPOPMIN": { + "api_calls": { + "redis_py": [ { - "signature": "CF.DEL(key: RedisArgument, item: RedisArgument)", + "signature": "bzpopmin(keys: KeysT, timeout: TimeoutSecT = 0)", "params": [ { - "name": "key", - "type": "RedisArgument", - "description": "The name of the Cuckoo filter" + "name": "keys", + "type": "KeysT", + "description": "" }, { - "name": "item", - "type": "RedisArgument", - "description": "The item to delete" + "name": "timeout", + "type": "TimeoutSecT = 0", + "description": "" } ], "returns": { - "type": "boolean", - "description": "true if deleted, false if not found" + "type": "ResponseT", + "description": "" } } ], - "nredisstack_sync": [ + "jedis": [ { - "signature": "bool Del(RedisKey key, RedisValue item)", + "signature": "KeyValue bzpopmin(double timeout, String... keys)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The name of the Cuckoo filter" + "name": "timeout", + "type": "double", + "description": "" }, { - "name": "item", - "type": "RedisValue", - "description": "The item to delete" + "name": "keys", + "type": "String...", + "description": "" } ], "returns": { - "type": "bool", - "description": "true if deleted, false if not found" + "type": "KeyValue", + "description": "BLPOP returns a two-elements array via a multi bulk reply in order to return both the unblocking key and the popped value. When a non-zero timeout is specified, and the BLPOP operation timed out, the return value is a nil multi bulk reply. Most connection values will return false or nil accordingly to the programming language used." } } ], - "nredisstack_async": [ + "lettuce_sync": [ { - "signature": "async Task DelAsync(RedisKey key, RedisValue item)", + "signature": "KeyValue> bzpopmin(long timeout, K... keys)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The name of the Cuckoo filter" + "name": "timeout", + "type": "long", + "description": "the timeout in seconds." }, { - "name": "item", - "type": "RedisValue", - "description": "The item to delete" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "Task", - "description": "true if deleted, false if not found" + "type": "KeyValue>", + "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" } - } - ], - "php": [ + }, { - "signature": "cfdel(string $key, $item)", + "signature": "KeyValue> bzpopmin(double timeout, K... keys)", "params": [ { - "name": "$key", - "type": "string", - "description": "The name of the Cuckoo filter" + "name": "timeout", + "type": "double", + "description": "the timeout in seconds." }, { - "name": "$item", - "type": "mixed", - "description": "The item to delete" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "mixed", - "description": "Result of the operation" + "type": "KeyValue>", + "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" } } - ] - } - }, - "CF.EXISTS": { - "api_calls": { - "redis_py": [ + ], + "lettuce_async": [ { - "signature": "exists(key, item)", + "signature": "RedisFuture>> bzpopmin(long timeout, K... keys)", "params": [ { - "name": "key", - "type": "str", - "description": "The name of the Cuckoo filter" + "name": "timeout", + "type": "long", + "description": "the timeout in seconds." }, { - "name": "item", - "type": "str", - "description": "The item to check" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "bool", - "description": "True if item may exist, False if certainly doesn't" + "type": "RedisFuture>>", + "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" } - } - ], - "jedis": [ + }, { - "signature": "boolean cfExists(String key, String item)", + "signature": "RedisFuture>> bzpopmin(double timeout, K... keys)", "params": [ { - "name": "key", - "type": "String", - "description": "The name of the Cuckoo filter" + "name": "timeout", + "type": "double", + "description": "the timeout in seconds." }, { - "name": "item", - "type": "String", - "description": "The item to check" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "boolean", - "description": "true if item may exist" + "type": "RedisFuture>>", + "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" } } ], - "go-redis": [ + "lettuce_reactive": [ { - "signature": "CFExists(ctx context.Context, key string, element interface{}) *BoolCmd", + "signature": "Mono>> bzpopmin(long timeout, K... keys)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" - }, - { - "name": "key", - "type": "string", - "description": "The name of the Cuckoo filter" + "name": "timeout", + "type": "long", + "description": "the timeout in seconds." }, { - "name": "element", - "type": "interface{}", - "description": "The item to check" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "*BoolCmd", - "description": "Boolean command result" + "type": "Mono>>", + "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" } - } - ], - "node_redis": [ + }, { - "signature": "CF.EXISTS(key: RedisArgument, item: RedisArgument)", + "signature": "Mono>> bzpopmin(double timeout, K... keys)", "params": [ { - "name": "key", - "type": "RedisArgument", - "description": "The name of the Cuckoo filter" + "name": "timeout", + "type": "double", + "description": "the timeout in seconds." }, { - "name": "item", - "type": "RedisArgument", - "description": "The item to check" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "boolean", - "description": "true if item may exist" + "type": "Mono>>", + "description": "KeyValue<K, ScoredValue<V>> multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3" } } ], - "nredisstack_sync": [ + "go-redis": [ { - "signature": "bool Exists(RedisKey key, RedisValue item)", + "signature": "BZPopMin(ctx context.Context, timeout time.Duration, keys ...string)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The name of the Cuckoo filter" + "name": "ctx", + "type": "context.Context", + "description": "" }, { - "name": "item", - "type": "RedisValue", - "description": "The item to check" + "name": "timeout", + "type": "time.Duration", + "description": "" + }, + { + "name": "keys", + "type": "...string", + "description": "" } ], "returns": { - "type": "bool", - "description": "true if item may exist" + "type": "*ZWithKeyCmd", + "description": "" } } ], - "nredisstack_async": [ + "node_redis": [ { - "signature": "async Task ExistsAsync(RedisKey key, RedisValue item)", + "signature": "BZPOPMIN(keys: RedisVariadicArgument, timeout: number)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The name of the Cuckoo filter" + "name": "keys", + "type": "RedisVariadicArgument", + "description": "" }, { - "name": "item", - "type": "RedisValue", - "description": "The item to check" + "name": "timeout", + "type": "number", + "description": "" } ], "returns": { - "type": "Task", - "description": "true if item may exist" + "type": "Any", + "description": "" } } ], - "php": [ + "ioredis": [ { - "signature": "cfexists(string $key, $item)", + "signature": "bzpopmin(...args: [, ...keys: RedisKey[], timeout: number | string, callback: Callback<[key: string, member: string, score: string] | null>, ])", "params": [ { - "name": "$key", - "type": "string", - "description": "The name of the Cuckoo filter" - }, + "name": "...args", + "type": "[, ...keys", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "bzpopmin(...args: [, keys: RedisKey[], timeout: number | string, callback: Callback<[key: string, member: string, score: string] | null>, ])", + "params": [ { - "name": "$item", - "type": "mixed", - "description": "The item to check" + "name": "...args", + "type": "[, keys", + "description": "" } ], "returns": { - "type": "mixed", - "description": "Result of the operation" + "type": "Any", + "description": "" } - } - ] - } - }, - "CF.INFO": { - "api_calls": { - "redis_py": [ + }, { - "signature": "info(key)", + "signature": "bzpopmin(...args: [...keys: RedisKey[], timeout: number | string])", "params": [ { - "name": "key", - "type": "str", - "description": "The name of the Cuckoo filter" + "name": "...args", + "type": "[...keys", + "description": "" } ], "returns": { - "type": "dict", - "description": "Filter information (size, buckets, items, etc.)" + "type": "Any", + "description": "" } - } - ], - "jedis": [ + }, { - "signature": "Map cfInfo(String key)", + "signature": "bzpopmin(...args: [keys: RedisKey[], timeout: number | string])", "params": [ { - "name": "key", - "type": "String", - "description": "The name of the Cuckoo filter" + "name": "...args", + "type": "[keys", + "description": "" } ], "returns": { - "type": "Map", - "description": "Filter information" + "type": "Any", + "description": "" } } ], - "go-redis": [ + "redis_rs_sync": [ { - "signature": "CFInfo(ctx context.Context, key string) *CFInfoCmd", + "signature": "bzpopmin(key: K, timeout: f64)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" + "name": "key", + "type": "K", + "description": "" }, { - "name": "key", - "type": "string", - "description": "The name of the Cuckoo filter" + "name": "timeout", + "type": "f64", + "description": "" } ], "returns": { - "type": "*CFInfoCmd", - "description": "CFInfo command result" + "type": "(Option<(String, String, f64)>)", + "description": "" } } ], - "node_redis": [ + "redis_rs_async": [ { - "signature": "CF.INFO(key: RedisArgument)", + "signature": "bzpopmin(key: K, timeout: f64)", "params": [ { "name": "key", - "type": "RedisArgument", - "description": "The name of the Cuckoo filter" + "type": "K", + "description": "" + }, + { + "name": "timeout", + "type": "f64", + "description": "" } ], "returns": { - "type": "CfInfoReply", - "description": "Filter information object" + "type": "(Option<(String, String, f64)>)", + "description": "" } } ], "nredisstack_sync": [ { - "signature": "CuckooInformation Info(RedisKey key)", + "signature": "BZPopMin(RedisKey[] keys, double timeout)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The name of the Cuckoo filter" + "name": "keys", + "type": "RedisKey[]", + "description": "" + }, + { + "name": "timeout", + "type": "double", + "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." } ], "returns": { - "type": "CuckooInformation", - "description": "Filter information" + "type": "Tuple?", + "description": "A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires." } - } - ], - "nredisstack_async": [ + }, { - "signature": "async Task InfoAsync(RedisKey key)", + "signature": "BZPopMin(RedisKey key, double timeout)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The name of the Cuckoo filter" + "description": "The key to check." + }, + { + "name": "timeout", + "type": "double", + "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." } ], "returns": { - "type": "Task", - "description": "Filter information" + "type": "Tuple?", + "description": "A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires." } - } - ], - "php": [ + }, { - "signature": "cfinfo(string $key)", + "signature": "BZPopMin(db, [key], timeout)", "params": [ { - "name": "$key", - "type": "string", - "description": "The name of the Cuckoo filter" + "name": "db", + "type": "Any", + "description": "The IDatabase class where this extension method is applied." + }, + { + "name": "[key]", + "type": "Any", + "description": "" + }, + { + "name": "timeout", + "type": "Any", + "description": "Server-side timeout for the wait. A value of 0 means to wait indefinitely." } ], "returns": { - "type": "array", - "description": "Filter information" + "type": "return", + "description": "A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires." } } - ] - } - }, - "CF.INSERT": { - "api_calls": { - "redis_py": [ + ], + "php": [ { - "signature": "insert(key, items, capacity=None, nocreate=None)", + "signature": "bzpopmin(array $keys, int $timeout)", "params": [ { - "name": "key", - "type": "str", - "description": "The name of the Cuckoo filter" - }, - { - "name": "items", - "type": "list", - "description": "Items to add" + "name": "$keys", + "type": "array", + "description": "" }, { - "name": "capacity", + "name": "$timeout", "type": "int", - "description": "Optional capacity for filter creation" + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "bzpopmin(*args)", + "params": [ + { + "name": "*args", + "type": "Array", + "description": "one or multiple keys of the sorted sets" }, { - "name": "nocreate", - "type": "bool", - "description": "If True, don't create filter" + "name": "timeout", + "type": "Integer", + "description": "the maximum number of seconds to block" } ], "returns": { - "type": "list", - "description": "List of booleans for each item" + "type": "Array", + "description": "a tuple of key, member and score" } } - ], - "jedis": [ + ] + } + }, + "CF.ADD": { + "api_calls": { + "redis_py": [ { - "signature": "List cfInsert(String key, String... items)", + "signature": "add(key, item)", "params": [ { "name": "key", - "type": "String", + "type": "str", "description": "The name of the Cuckoo filter" }, { - "name": "items", - "type": "String...", - "description": "Items to add" + "name": "item", + "type": "str", + "description": "The item to add" } ], "returns": { - "type": "List", - "description": "List of booleans for each item" + "type": "bool", + "description": "True on success" } - }, + } + ], + "jedis": [ { - "signature": "List cfInsert(String key, CFInsertParams insertParams, String... items)", + "signature": "boolean cfAdd(String key, String item)", "params": [ { "name": "key", @@ -18282,25 +18766,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "insertParams", - "type": "CFInsertParams", - "description": "Insert parameters (capacity, nocreate)" - }, - { - "name": "items", - "type": "String...", - "description": "Items to add" + "name": "item", + "type": "String", + "description": "The item to add" } ], "returns": { - "type": "List", - "description": "List of booleans for each item" + "type": "boolean", + "description": "true on success" } } ], "go-redis": [ { - "signature": "CFInsert(ctx context.Context, key string, options *CFInsertOptions, elements ...interface{}) *BoolSliceCmd", + "signature": "CFAdd(ctx context.Context, key string, element interface{}) *BoolCmd", "params": [ { "name": "ctx", @@ -18313,25 +18792,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "options", - "type": "*CFInsertOptions", - "description": "Insert options (Capacity, NoCreate)" - }, - { - "name": "elements", - "type": "...interface{}", - "description": "Items to add" + "name": "element", + "type": "interface{}", + "description": "The item to add" } ], "returns": { - "type": "*BoolSliceCmd", - "description": "Boolean slice command result" + "type": "*BoolCmd", + "description": "Boolean command result" } } ], "node_redis": [ { - "signature": "CF.INSERT(key: RedisArgument, items: RedisVariadicArgument, options?: CfInsertOptions)", + "signature": "CF.ADD(key: RedisArgument, item: RedisArgument)", "params": [ { "name": "key", @@ -18339,25 +18813,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "items", - "type": "RedisVariadicArgument", - "description": "Items to add" - }, - { - "name": "options", - "type": "CfInsertOptions", - "description": "Optional: CAPACITY, NOCREATE" + "name": "item", + "type": "RedisArgument", + "description": "The item to add" } ], "returns": { - "type": "boolean[]", - "description": "Array of booleans for each item" + "type": "boolean", + "description": "true on success" } } ], "nredisstack_sync": [ { - "signature": "bool[] Insert(RedisKey key, RedisValue[] items, int? capacity = null, bool nocreate = false)", + "signature": "bool Add(RedisKey key, RedisValue item)", "params": [ { "name": "key", @@ -18365,30 +18834,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "items", - "type": "RedisValue[]", - "description": "Items to add" - }, - { - "name": "capacity", - "type": "int?", - "description": "Optional capacity for filter creation" - }, - { - "name": "nocreate", - "type": "bool", - "description": "If true, don't create filter" + "name": "item", + "type": "RedisValue", + "description": "The item to add" } ], "returns": { - "type": "bool[]", - "description": "Array of booleans for each item" + "type": "bool", + "description": "true on success" } } ], "nredisstack_async": [ { - "signature": "async Task InsertAsync(RedisKey key, RedisValue[] items, int? capacity = null, bool nocreate = false)", + "signature": "async Task AddAsync(RedisKey key, RedisValue item)", "params": [ { "name": "key", @@ -18396,65 +18855,45 @@ "description": "The name of the Cuckoo filter" }, { - "name": "items", - "type": "RedisValue[]", - "description": "Items to add" - }, - { - "name": "capacity", - "type": "int?", - "description": "Optional capacity for filter creation" - }, - { - "name": "nocreate", - "type": "bool", - "description": "If true, don't create filter" + "name": "item", + "type": "RedisValue", + "description": "The item to add" } ], "returns": { - "type": "Task", - "description": "Array of booleans for each item" + "type": "Task", + "description": "true on success" } } ], "php": [ { - "signature": "cfinsert(string $key, int $capacity = -1, bool $noCreate = false, string ...$item)", + "signature": "cfadd(string $key, $item)", "params": [ { "name": "$key", "type": "string", "description": "The name of the Cuckoo filter" }, - { - "name": "$capacity", - "type": "int", - "description": "Optional capacity (-1 for default)" - }, - { - "name": "$noCreate", - "type": "bool", - "description": "If true, don't create filter" - }, { "name": "$item", - "type": "string...", - "description": "Items to add" + "type": "mixed", + "description": "The item to add" } ], "returns": { - "type": "array", - "description": "Array of booleans for each item" + "type": "mixed", + "description": "Result of the operation" } } ] } }, - "CF.INSERTNX": { + "CF.ADDNX": { "api_calls": { "redis_py": [ { - "signature": "insertnx(key, items, capacity=None, nocreate=None)", + "signature": "addnx(key, item)", "params": [ { "name": "key", @@ -18462,30 +18901,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "items", - "type": "list", - "description": "Items to add" - }, - { - "name": "capacity", - "type": "int", - "description": "Optional capacity for filter creation" - }, - { - "name": "nocreate", - "type": "bool", - "description": "If True, don't create filter" + "name": "item", + "type": "str", + "description": "The item to add" } ], "returns": { - "type": "list", - "description": "List of booleans (True if added, False if exists)" + "type": "bool", + "description": "True if added, False if already exists" } } ], "jedis": [ { - "signature": "List cfInsertNx(String key, String... items)", + "signature": "boolean cfAddNx(String key, String item)", "params": [ { "name": "key", @@ -18493,44 +18922,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "items", - "type": "String...", - "description": "Items to add" - } - ], - "returns": { - "type": "List", - "description": "List of booleans" - } - }, - { - "signature": "List cfInsertNx(String key, CFInsertParams insertParams, String... items)", - "params": [ - { - "name": "key", + "name": "item", "type": "String", - "description": "The name of the Cuckoo filter" - }, - { - "name": "insertParams", - "type": "CFInsertParams", - "description": "Insert parameters (capacity, nocreate)" - }, - { - "name": "items", - "type": "String...", - "description": "Items to add" + "description": "The item to add" } ], "returns": { - "type": "List", - "description": "List of booleans" + "type": "boolean", + "description": "true if added, false if already exists" } } ], "go-redis": [ { - "signature": "CFInsertNX(ctx context.Context, key string, options *CFInsertOptions, elements ...interface{}) *BoolSliceCmd", + "signature": "CFAddNX(ctx context.Context, key string, element interface{}) *BoolCmd", "params": [ { "name": "ctx", @@ -18543,25 +18948,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "options", - "type": "*CFInsertOptions", - "description": "Insert options (Capacity, NoCreate)" - }, - { - "name": "elements", - "type": "...interface{}", - "description": "Items to add" + "name": "element", + "type": "interface{}", + "description": "The item to add" } ], "returns": { - "type": "*BoolSliceCmd", - "description": "Boolean slice command result" + "type": "*BoolCmd", + "description": "Boolean command result" } } ], "node_redis": [ { - "signature": "CF.INSERTNX(key: RedisArgument, items: RedisVariadicArgument, options?: CfInsertOptions)", + "signature": "CF.ADDNX(key: RedisArgument, item: RedisArgument)", "params": [ { "name": "key", @@ -18569,25 +18969,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "items", - "type": "RedisVariadicArgument", - "description": "Items to add" - }, - { - "name": "options", - "type": "CfInsertOptions", - "description": "Optional: CAPACITY, NOCREATE" + "name": "item", + "type": "RedisArgument", + "description": "The item to add" } ], "returns": { - "type": "boolean[]", - "description": "Array of booleans" + "type": "boolean", + "description": "true if added, false if already exists" } } ], "nredisstack_sync": [ { - "signature": "bool[] InsertNX(RedisKey key, RedisValue[] items, int? capacity = null, bool nocreate = false)", + "signature": "bool AddNX(RedisKey key, RedisValue item)", "params": [ { "name": "key", @@ -18595,30 +18990,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "items", - "type": "RedisValue[]", - "description": "Items to add" - }, - { - "name": "capacity", - "type": "int?", - "description": "Optional capacity for filter creation" - }, - { - "name": "nocreate", - "type": "bool", - "description": "If true, don't create filter" + "name": "item", + "type": "RedisValue", + "description": "The item to add" } ], "returns": { - "type": "bool[]", - "description": "Array of booleans" + "type": "bool", + "description": "true if added, false if already exists" } } ], "nredisstack_async": [ { - "signature": "async Task InsertNXAsync(RedisKey key, RedisValue[] items, int? capacity = null, bool nocreate = false)", + "signature": "async Task AddNXAsync(RedisKey key, RedisValue item)", "params": [ { "name": "key", @@ -18626,65 +19011,45 @@ "description": "The name of the Cuckoo filter" }, { - "name": "items", - "type": "RedisValue[]", - "description": "Items to add" - }, - { - "name": "capacity", - "type": "int?", - "description": "Optional capacity for filter creation" - }, - { - "name": "nocreate", - "type": "bool", - "description": "If true, don't create filter" + "name": "item", + "type": "RedisValue", + "description": "The item to add" } ], "returns": { - "type": "Task", - "description": "Array of booleans" + "type": "Task", + "description": "true if added, false if already exists" } } ], "php": [ { - "signature": "cfinsertnx(string $key, int $capacity = -1, bool $noCreate = false, string ...$item)", + "signature": "cfaddnx(string $key, $item)", "params": [ { "name": "$key", "type": "string", "description": "The name of the Cuckoo filter" }, - { - "name": "$capacity", - "type": "int", - "description": "Optional capacity (-1 for default)" - }, - { - "name": "$noCreate", - "type": "bool", - "description": "If true, don't create filter" - }, { "name": "$item", - "type": "string...", - "description": "Items to add" + "type": "mixed", + "description": "The item to add" } ], "returns": { - "type": "array", - "description": "Array of booleans" + "type": "mixed", + "description": "Result of the operation" } } ] } }, - "CF.LOADCHUNK": { + "CF.COUNT": { "api_calls": { "redis_py": [ { - "signature": "loadchunk(key, iter, data)", + "signature": "count(key, item)", "params": [ { "name": "key", @@ -18692,25 +19057,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "iter", - "type": "int", - "description": "Iterator from SCANDUMP" - }, - { - "name": "data", - "type": "bytes", - "description": "Data from SCANDUMP" + "name": "item", + "type": "str", + "description": "The item to count" } ], "returns": { - "type": "str", - "description": "OK on success" + "type": "int", + "description": "Number of times the item exists in the filter" } } ], "jedis": [ { - "signature": "String cfLoadChunk(String key, long iterator, byte[] data)", + "signature": "long cfCount(String key, String item)", "params": [ { "name": "key", @@ -18718,25 +19078,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "iterator", - "type": "long", - "description": "Iterator from SCANDUMP" - }, - { - "name": "data", - "type": "byte[]", - "description": "Data from SCANDUMP" + "name": "item", + "type": "String", + "description": "The item to count" } ], "returns": { - "type": "String", - "description": "OK on success" + "type": "long", + "description": "Number of times the item exists" } } ], "go-redis": [ { - "signature": "CFLoadChunk(ctx context.Context, key string, iterator int64, data interface{}) *StatusCmd", + "signature": "CFCount(ctx context.Context, key string, element interface{}) *IntCmd", "params": [ { "name": "ctx", @@ -18749,25 +19104,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "iterator", - "type": "int64", - "description": "Iterator from SCANDUMP" - }, - { - "name": "data", + "name": "element", "type": "interface{}", - "description": "Data from SCANDUMP" + "description": "The item to count" } ], "returns": { - "type": "*StatusCmd", - "description": "Status command result" + "type": "*IntCmd", + "description": "Integer command result" } } ], "node_redis": [ { - "signature": "CF.LOADCHUNK(key: RedisArgument, iterator: number, data: RedisArgument)", + "signature": "CF.COUNT(key: RedisArgument, item: RedisArgument)", "params": [ { "name": "key", @@ -18775,25 +19125,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "iterator", - "type": "number", - "description": "Iterator from SCANDUMP" - }, - { - "name": "data", + "name": "item", "type": "RedisArgument", - "description": "Data from SCANDUMP" + "description": "The item to count" } ], "returns": { - "type": "SimpleStringReply<'OK'>", - "description": "OK on success" + "type": "number", + "description": "Number of times the item exists" } } ], "nredisstack_sync": [ { - "signature": "bool LoadChunk(RedisKey key, long iterator, Byte[] data)", + "signature": "long Count(RedisKey key, RedisValue item)", "params": [ { "name": "key", @@ -18801,25 +19146,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "iterator", - "type": "long", - "description": "Iterator from SCANDUMP" - }, - { - "name": "data", - "type": "Byte[]", - "description": "Data from SCANDUMP" + "name": "item", + "type": "RedisValue", + "description": "The item to count" } ], "returns": { - "type": "bool", - "description": "true on success" + "type": "long", + "description": "Number of times the item exists" } } ], "nredisstack_async": [ { - "signature": "async Task LoadChunkAsync(RedisKey key, long iterator, Byte[] data)", + "signature": "async Task CountAsync(RedisKey key, RedisValue item)", "params": [ { "name": "key", @@ -18827,25 +19167,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "iterator", - "type": "long", - "description": "Iterator from SCANDUMP" - }, - { - "name": "data", - "type": "Byte[]", - "description": "Data from SCANDUMP" + "name": "item", + "type": "RedisValue", + "description": "The item to count" } ], "returns": { - "type": "Task", - "description": "true on success" + "type": "Task", + "description": "Number of times the item exists" } } ], "php": [ { - "signature": "cfloadchunk(string $key, int $iterator, $data)", + "signature": "cfcount(string $key, $item)", "params": [ { "name": "$key", @@ -18853,29 +19188,24 @@ "description": "The name of the Cuckoo filter" }, { - "name": "$iterator", - "type": "int", - "description": "Iterator from SCANDUMP" - }, - { - "name": "$data", + "name": "$item", "type": "mixed", - "description": "Data from SCANDUMP" + "description": "The item to count" } ], "returns": { - "type": "Status", - "description": "OK on success" + "type": "int", + "description": "Number of times the item exists" } } ] } }, - "CF.MEXISTS": { + "CF.DEL": { "api_calls": { "redis_py": [ { - "signature": "mexists(key, *items)", + "signature": "delete(key, item)", "params": [ { "name": "key", @@ -18883,20 +19213,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "*items", + "name": "item", "type": "str", - "description": "Items to check" + "description": "The item to delete" } ], "returns": { - "type": "list", - "description": "List of booleans for each item" + "type": "bool", + "description": "True if deleted, False if not found" } } ], "jedis": [ { - "signature": "List cfMExists(String key, String... items)", + "signature": "boolean cfDel(String key, String item)", "params": [ { "name": "key", @@ -18904,20 +19234,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "items", - "type": "String...", - "description": "Items to check" + "name": "item", + "type": "String", + "description": "The item to delete" } ], "returns": { - "type": "List", - "description": "List of booleans" + "type": "boolean", + "description": "true if deleted, false if not found" } } ], "go-redis": [ { - "signature": "CFMExists(ctx context.Context, key string, elements ...interface{}) *BoolSliceCmd", + "signature": "CFDel(ctx context.Context, key string, element interface{}) *BoolCmd", "params": [ { "name": "ctx", @@ -18930,20 +19260,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "elements", - "type": "...interface{}", - "description": "Items to check" + "name": "element", + "type": "interface{}", + "description": "The item to delete" } ], "returns": { - "type": "*BoolSliceCmd", - "description": "Boolean slice command result" + "type": "*BoolCmd", + "description": "Boolean command result" } } ], "node_redis": [ { - "signature": "CF.MEXISTS(key: RedisArgument, items: RedisVariadicArgument)", + "signature": "CF.DEL(key: RedisArgument, item: RedisArgument)", "params": [ { "name": "key", @@ -18951,20 +19281,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "items", - "type": "RedisVariadicArgument", - "description": "Items to check" + "name": "item", + "type": "RedisArgument", + "description": "The item to delete" } ], "returns": { - "type": "boolean[]", - "description": "Array of booleans" + "type": "boolean", + "description": "true if deleted, false if not found" } } ], "nredisstack_sync": [ { - "signature": "bool[] MExists(RedisKey key, params RedisValue[] items)", + "signature": "bool Del(RedisKey key, RedisValue item)", "params": [ { "name": "key", @@ -18972,20 +19302,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "items", - "type": "RedisValue[]", - "description": "Items to check" + "name": "item", + "type": "RedisValue", + "description": "The item to delete" } ], "returns": { - "type": "bool[]", - "description": "Array of booleans" + "type": "bool", + "description": "true if deleted, false if not found" } } ], "nredisstack_async": [ { - "signature": "async Task MExistsAsync(RedisKey key, params RedisValue[] items)", + "signature": "async Task DelAsync(RedisKey key, RedisValue item)", "params": [ { "name": "key", @@ -18993,20 +19323,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "items", - "type": "RedisValue[]", - "description": "Items to check" + "name": "item", + "type": "RedisValue", + "description": "The item to delete" } ], "returns": { - "type": "Task", - "description": "Array of booleans" + "type": "Task", + "description": "true if deleted, false if not found" } } ], "php": [ { - "signature": "cfmexists(string $key, ...$item)", + "signature": "cfdel(string $key, $item)", "params": [ { "name": "$key", @@ -19015,23 +19345,23 @@ }, { "name": "$item", - "type": "...", - "description": "Items to check" + "type": "mixed", + "description": "The item to delete" } ], "returns": { - "type": "int", + "type": "mixed", "description": "Result of the operation" } } ] } }, - "CF.RESERVE": { + "CF.EXISTS": { "api_calls": { "redis_py": [ { - "signature": "create(key, capacity, expansion=None, bucket_size=None, max_iterations=None)", + "signature": "exists(key, item)", "params": [ { "name": "key", @@ -19039,69 +19369,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "capacity", - "type": "int", - "description": "Number of entries intended to be added" - }, - { - "name": "expansion", - "type": "int", - "description": "Optional expansion rate" - }, - { - "name": "bucket_size", - "type": "int", - "description": "Optional bucket size" - }, - { - "name": "max_iterations", - "type": "int", - "description": "Optional max iterations" - } - ], - "returns": { - "type": "str", - "description": "OK on success" - } - }, - { - "signature": "reserve(key, capacity, expansion=None, bucket_size=None, max_iterations=None)", - "params": [ - { - "name": "key", + "name": "item", "type": "str", - "description": "The name of the Cuckoo filter" - }, - { - "name": "capacity", - "type": "int", - "description": "Number of entries intended to be added" - }, - { - "name": "expansion", - "type": "int", - "description": "Optional expansion rate" - }, - { - "name": "bucket_size", - "type": "int", - "description": "Optional bucket size" - }, - { - "name": "max_iterations", - "type": "int", - "description": "Optional max iterations" + "description": "The item to check" } ], "returns": { - "type": "str", - "description": "OK on success (alias for create)" + "type": "bool", + "description": "True if item may exist, False if certainly doesn't" } } ], "jedis": [ { - "signature": "String cfReserve(String key, long capacity)", + "signature": "boolean cfExists(String key, String item)", "params": [ { "name": "key", @@ -19109,68 +19390,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "capacity", - "type": "long", - "description": "Initial capacity" - } - ], - "returns": { - "type": "String", - "description": "OK on success" - } - }, - { - "signature": "String cfReserve(String key, long capacity, CFReserveParams reserveParams)", - "params": [ - { - "name": "key", + "name": "item", "type": "String", - "description": "The name of the Cuckoo filter" - }, - { - "name": "capacity", - "type": "long", - "description": "Initial capacity" - }, - { - "name": "reserveParams", - "type": "CFReserveParams", - "description": "Reserve parameters (bucketSize, maxIterations, expansion)" + "description": "The item to check" } ], "returns": { - "type": "String", - "description": "OK on success" + "type": "boolean", + "description": "true if item may exist" } } ], "go-redis": [ { - "signature": "CFReserve(ctx context.Context, key string, capacity int64) *StatusCmd", - "params": [ - { - "name": "ctx", - "type": "context.Context", - "description": "Context" - }, - { - "name": "key", - "type": "string", - "description": "The name of the Cuckoo filter" - }, - { - "name": "capacity", - "type": "int64", - "description": "Initial capacity" - } - ], - "returns": { - "type": "*StatusCmd", - "description": "Status command result" - } - }, - { - "signature": "CFReserveWithArgs(ctx context.Context, key string, options *CFReserveOptions) *StatusCmd", + "signature": "CFExists(ctx context.Context, key string, element interface{}) *BoolCmd", "params": [ { "name": "ctx", @@ -19183,20 +19416,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "options", - "type": "*CFReserveOptions", - "description": "Reserve options (Capacity, BucketSize, MaxIterations, Expansion)" + "name": "element", + "type": "interface{}", + "description": "The item to check" } ], "returns": { - "type": "*StatusCmd", - "description": "Status command result" + "type": "*BoolCmd", + "description": "Boolean command result" } } ], "node_redis": [ { - "signature": "CF.RESERVE(key: RedisArgument, capacity: number, options?: CfReserveOptions)", + "signature": "CF.EXISTS(key: RedisArgument, item: RedisArgument)", "params": [ { "name": "key", @@ -19204,25 +19437,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "capacity", - "type": "number", - "description": "Initial capacity" - }, - { - "name": "options", - "type": "CfReserveOptions", - "description": "Optional: BUCKETSIZE, MAXITERATIONS, EXPANSION" + "name": "item", + "type": "RedisArgument", + "description": "The item to check" } ], "returns": { - "type": "SimpleStringReply<'OK'>", - "description": "OK on success" + "type": "boolean", + "description": "true if item may exist" } } ], "nredisstack_sync": [ { - "signature": "bool Reserve(RedisKey key, long capacity, long? bucketSize = null, int? maxIterations = null, int? expansion = null)", + "signature": "bool Exists(RedisKey key, RedisValue item)", "params": [ { "name": "key", @@ -19230,35 +19458,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "capacity", - "type": "long", - "description": "Initial capacity" - }, - { - "name": "bucketSize", - "type": "long?", - "description": "Optional bucket size" - }, - { - "name": "maxIterations", - "type": "int?", - "description": "Optional max iterations" - }, - { - "name": "expansion", - "type": "int?", - "description": "Optional expansion rate" + "name": "item", + "type": "RedisValue", + "description": "The item to check" } ], "returns": { "type": "bool", - "description": "true on success" + "description": "true if item may exist" } } ], "nredisstack_async": [ { - "signature": "async Task ReserveAsync(RedisKey key, long capacity, long? bucketSize = null, int? maxIterations = null, int? expansion = null)", + "signature": "async Task ExistsAsync(RedisKey key, RedisValue item)", "params": [ { "name": "key", @@ -19266,35 +19479,20 @@ "description": "The name of the Cuckoo filter" }, { - "name": "capacity", - "type": "long", - "description": "Initial capacity" - }, - { - "name": "bucketSize", - "type": "long?", - "description": "Optional bucket size" - }, - { - "name": "maxIterations", - "type": "int?", - "description": "Optional max iterations" - }, - { - "name": "expansion", - "type": "int?", - "description": "Optional expansion rate" + "name": "item", + "type": "RedisValue", + "description": "The item to check" } ], "returns": { "type": "Task", - "description": "true on success" + "description": "true if item may exist" } } ], "php": [ { - "signature": "cfreserve(string $key, int $capacity, int $bucketSize = -1, int $maxIterations = -1, int $expansion = -1)", + "signature": "cfexists(string $key, $item)", "params": [ { "name": "$key", @@ -19302,81 +19500,56 @@ "description": "The name of the Cuckoo filter" }, { - "name": "$capacity", - "type": "int", - "description": "Initial capacity" - }, - { - "name": "$bucketSize", - "type": "int", - "description": "Optional bucket size (-1 for default)" - }, - { - "name": "$maxIterations", - "type": "int", - "description": "Optional max iterations (-1 for default)" - }, - { - "name": "$expansion", - "type": "int", - "description": "Optional expansion rate (-1 for default)" + "name": "$item", + "type": "mixed", + "description": "The item to check" } ], "returns": { - "type": "Status", - "description": "OK on success" + "type": "mixed", + "description": "Result of the operation" } } ] } }, - "CF.SCANDUMP": { + "CF.INFO": { "api_calls": { "redis_py": [ { - "signature": "scandump(key, iter)", + "signature": "info(key)", "params": [ { "name": "key", "type": "str", "description": "The name of the Cuckoo filter" - }, - { - "name": "iter", - "type": "int", - "description": "Iterator value (start with 0)" } ], "returns": { - "type": "tuple", - "description": "Tuple of (iterator, data) - continue until iterator is 0" + "type": "dict", + "description": "Filter information (size, buckets, items, etc.)" } } ], "jedis": [ { - "signature": "Map.Entry cfScanDump(String key, long iterator)", + "signature": "Map cfInfo(String key)", "params": [ { "name": "key", "type": "String", "description": "The name of the Cuckoo filter" - }, - { - "name": "iterator", - "type": "long", - "description": "Iterator value (start with 0)" } ], "returns": { - "type": "Map.Entry", - "description": "Pair of next iterator and current data" + "type": "Map", + "description": "Filter information" } } ], "go-redis": [ { - "signature": "CFScanDump(ctx context.Context, key string, iterator int64) *ScanDumpCmd", + "signature": "CFInfo(ctx context.Context, key string) *CFInfoCmd", "params": [ { "name": "ctx", @@ -19387,1068 +19560,1355 @@ "name": "key", "type": "string", "description": "The name of the Cuckoo filter" - }, - { - "name": "iterator", - "type": "int64", - "description": "Iterator value (start with 0)" } ], "returns": { - "type": "*ScanDumpCmd", - "description": "ScanDump command result with Iter and Data" + "type": "*CFInfoCmd", + "description": "CFInfo command result" } } ], "node_redis": [ { - "signature": "CF.SCANDUMP(key: RedisArgument, iterator: number)", + "signature": "CF.INFO(key: RedisArgument)", "params": [ { "name": "key", "type": "RedisArgument", "description": "The name of the Cuckoo filter" - }, - { - "name": "iterator", - "type": "number", - "description": "Iterator value (start with 0)" } ], "returns": { - "type": "{ iterator: number, chunk: BlobStringReply }", - "description": "Object with iterator and chunk" + "type": "CfInfoReply", + "description": "Filter information object" } } ], "nredisstack_sync": [ { - "signature": "Tuple ScanDump(RedisKey key, long iterator)", + "signature": "CuckooInformation Info(RedisKey key)", "params": [ { "name": "key", "type": "RedisKey", "description": "The name of the Cuckoo filter" - }, - { - "name": "iterator", - "type": "long", - "description": "Iterator value (start with 0)" } ], "returns": { - "type": "Tuple", - "description": "Tuple of iterator and data" + "type": "CuckooInformation", + "description": "Filter information" } } ], "nredisstack_async": [ { - "signature": "async Task> ScanDumpAsync(RedisKey key, long iterator)", + "signature": "async Task InfoAsync(RedisKey key)", "params": [ { "name": "key", "type": "RedisKey", "description": "The name of the Cuckoo filter" - }, - { - "name": "iterator", - "type": "long", - "description": "Iterator value (start with 0)" } ], "returns": { - "type": "Task>", - "description": "Tuple of iterator and data" + "type": "Task", + "description": "Filter information" } } ], "php": [ { - "signature": "cfscandump(string $key, int $iterator)", + "signature": "cfinfo(string $key)", "params": [ { "name": "$key", "type": "string", "description": "The name of the Cuckoo filter" - }, - { - "name": "$iterator", - "type": "int", - "description": "Iterator value (start with 0)" } ], "returns": { "type": "array", - "description": "Array with iterator and data" + "description": "Filter information" } } ] } }, - "CLIENT CACHING": { + "CF.INSERT": { "api_calls": { "redis_py": [ { - "signature": "client_caching(enabled: bool, **kwargs)", + "signature": "insert(key, items, capacity=None, nocreate=None)", "params": [ { - "name": "enabled", - "type": "bool", - "description": "" + "name": "key", + "type": "str", + "description": "The name of the Cuckoo filter" }, { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "items", + "type": "list", + "description": "Items to add" + }, + { + "name": "capacity", + "type": "int", + "description": "Optional capacity for filter creation" + }, + { + "name": "nocreate", + "type": "bool", + "description": "If True, don't create filter" } ], "returns": { - "type": "str", - "description": "" + "type": "list", + "description": "List of booleans for each item" } } ], "jedis": [ { - "signature": "String clientCaching(boolean enabled)", + "signature": "List cfInsert(String key, String... items)", "params": [ { - "name": "enabled", - "type": "boolean", - "description": "" + "name": "key", + "type": "String", + "description": "The name of the Cuckoo filter" + }, + { + "name": "items", + "type": "String...", + "description": "Items to add" } ], "returns": { - "type": "String", - "description": "" + "type": "List", + "description": "List of booleans for each item" } - } - ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [ + }, { - "signature": "String clientCaching(boolean enabled)", + "signature": "List cfInsert(String key, CFInsertParams insertParams, String... items)", "params": [ { - "name": "enabled", - "type": "boolean", - "description": "" + "name": "key", + "type": "String", + "description": "The name of the Cuckoo filter" + }, + { + "name": "insertParams", + "type": "CFInsertParams", + "description": "Insert parameters (capacity, nocreate)" + }, + { + "name": "items", + "type": "String...", + "description": "Items to add" } ], "returns": { - "type": "String", - "description": "" + "type": "List", + "description": "List of booleans for each item" } } ], - "lettuce_async": [ + "go-redis": [ { - "signature": "RedisFuture clientCaching(boolean enabled)", + "signature": "CFInsert(ctx context.Context, key string, options *CFInsertOptions, elements ...interface{}) *BoolSliceCmd", "params": [ { - "name": "enabled", - "type": "boolean", - "description": "" + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "key", + "type": "string", + "description": "The name of the Cuckoo filter" + }, + { + "name": "options", + "type": "*CFInsertOptions", + "description": "Insert options (Capacity, NoCreate)" + }, + { + "name": "elements", + "type": "...interface{}", + "description": "Items to add" } ], "returns": { - "type": "RedisFuture", - "description": "" + "type": "*BoolSliceCmd", + "description": "Boolean slice command result" } } ], - "lettuce_reactive": [ + "node_redis": [ { - "signature": "Mono clientCaching(boolean enabled)", + "signature": "CF.INSERT(key: RedisArgument, items: RedisVariadicArgument, options?: CfInsertOptions)", "params": [ { - "name": "enabled", - "type": "boolean", - "description": "" + "name": "key", + "type": "RedisArgument", + "description": "The name of the Cuckoo filter" + }, + { + "name": "items", + "type": "RedisVariadicArgument", + "description": "Items to add" + }, + { + "name": "options", + "type": "CfInsertOptions", + "description": "Optional: CAPACITY, NOCREATE" } ], "returns": { - "type": "Mono", - "description": "" + "type": "boolean[]", + "description": "Array of booleans for each item" } } ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + "nredisstack_sync": [ { - "signature": "client(string $subcommand, ...$args)", + "signature": "bool[] Insert(RedisKey key, RedisValue[] items, int? capacity = null, bool nocreate = false)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" + "name": "key", + "type": "RedisKey", + "description": "The name of the Cuckoo filter" }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "items", + "type": "RedisValue[]", + "description": "Items to add" + }, + { + "name": "capacity", + "type": "int?", + "description": "Optional capacity for filter creation" + }, + { + "name": "nocreate", + "type": "bool", + "description": "If true, don't create filter" } ], "returns": { - "type": "string", - "description": "" + "type": "bool[]", + "description": "Array of booleans for each item" } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLIENT GETNAME": { - "api_calls": { - "redis_py": [ + "nredisstack_async": [ { - "signature": "client_getname(**kwargs)", + "signature": "async Task InsertAsync(RedisKey key, RedisValue[] items, int? capacity = null, bool nocreate = false)", "params": [ { - "name": "**kwargs", - "type": "Any", - "description": "" - } - ], - "returns": { - "type": "str | None", - "description": "" - } - } - ], - "jedis": [ - { - "signature": "String clientGetname()", - "params": [], - "returns": { - "type": "String", - "description": "" - } - } - ], - "go-redis": [ - { - "signature": "ClientGetName(ctx context.Context) *StringCmd", - "params": [ + "name": "key", + "type": "RedisKey", + "description": "The name of the Cuckoo filter" + }, { - "name": "ctx", - "type": "context.Context", - "description": "Context" + "name": "items", + "type": "RedisValue[]", + "description": "Items to add" + }, + { + "name": "capacity", + "type": "int?", + "description": "Optional capacity for filter creation" + }, + { + "name": "nocreate", + "type": "bool", + "description": "If true, don't create filter" } ], "returns": { - "type": "*StringCmd", - "description": "" - } - } - ], - "node_redis": [ - { - "signature": "clientGetName()", - "params": [], - "returns": { - "type": "BlobStringReply | NullReply", - "description": "" - } - } - ], - "lettuce_sync": [ - { - "signature": "String clientGetname()", - "params": [], - "returns": { - "type": "String", - "description": "" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture clientGetname()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "" - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono clientGetname()", - "params": [], - "returns": { - "type": "Mono", - "description": "" + "type": "Task", + "description": "Array of booleans for each item" } } ], - "nredisstack_sync": [], - "nredisstack_async": [], "php": [ { - "signature": "client(string $subcommand, ...$args)", + "signature": "cfinsert(string $key, int $capacity = -1, bool $noCreate = false, string ...$item)", "params": [ { - "name": "$subcommand", + "name": "$key", "type": "string", - "description": "" + "description": "The name of the Cuckoo filter" }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "$capacity", + "type": "int", + "description": "Optional capacity (-1 for default)" + }, + { + "name": "$noCreate", + "type": "bool", + "description": "If true, don't create filter" + }, + { + "name": "$item", + "type": "string...", + "description": "Items to add" } ], "returns": { - "type": "string|null", - "description": "" + "type": "array", + "description": "Array of booleans for each item" } } - ], - "redis_rs_sync": [], - "redis_rs_async": [] + ] } }, - "CLIENT GETREDIR": { + "CF.INSERTNX": { "api_calls": { "redis_py": [ { - "signature": "client_getredir(**kwargs)", + "signature": "insertnx(key, items, capacity=None, nocreate=None)", "params": [ { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "key", + "type": "str", + "description": "The name of the Cuckoo filter" + }, + { + "name": "items", + "type": "list", + "description": "Items to add" + }, + { + "name": "capacity", + "type": "int", + "description": "Optional capacity for filter creation" + }, + { + "name": "nocreate", + "type": "bool", + "description": "If True, don't create filter" } ], "returns": { - "type": "int", - "description": "" + "type": "list", + "description": "List of booleans (True if added, False if exists)" } } ], "jedis": [ { - "signature": "long clientGetredir()", - "params": [], - "returns": { - "type": "long", - "description": "" - } - } - ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [ - { - "signature": "Long clientGetredir()", - "params": [], - "returns": { - "type": "Long", - "description": "" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture clientGetredir()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "" - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono clientGetredir()", - "params": [], - "returns": { - "type": "Mono", - "description": "" - } - } - ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ - { - "signature": "client(string $subcommand, ...$args)", + "signature": "List cfInsertNx(String key, String... items)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" + "name": "key", + "type": "String", + "description": "The name of the Cuckoo filter" }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "items", + "type": "String...", + "description": "Items to add" } ], "returns": { - "type": "int", - "description": "" + "type": "List", + "description": "List of booleans" } - } - ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLIENT HELP": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLIENT ID": { - "api_calls": { - "redis_py": [ + }, { - "signature": "client_id(**kwargs)", + "signature": "List cfInsertNx(String key, CFInsertParams insertParams, String... items)", "params": [ { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "key", + "type": "String", + "description": "The name of the Cuckoo filter" + }, + { + "name": "insertParams", + "type": "CFInsertParams", + "description": "Insert parameters (capacity, nocreate)" + }, + { + "name": "items", + "type": "String...", + "description": "Items to add" } ], "returns": { - "type": "int", - "description": "" - } - } - ], - "jedis": [ - { - "signature": "long clientId()", - "params": [], - "returns": { - "type": "long", - "description": "" + "type": "List", + "description": "List of booleans" } } ], "go-redis": [ { - "signature": "ClientID(ctx context.Context) *IntCmd", + "signature": "CFInsertNX(ctx context.Context, key string, options *CFInsertOptions, elements ...interface{}) *BoolSliceCmd", "params": [ { "name": "ctx", "type": "context.Context", "description": "Context" + }, + { + "name": "key", + "type": "string", + "description": "The name of the Cuckoo filter" + }, + { + "name": "options", + "type": "*CFInsertOptions", + "description": "Insert options (Capacity, NoCreate)" + }, + { + "name": "elements", + "type": "...interface{}", + "description": "Items to add" } ], "returns": { - "type": "*IntCmd", - "description": "" + "type": "*BoolSliceCmd", + "description": "Boolean slice command result" } } ], - "node_redis": [], - "lettuce_sync": [ + "node_redis": [ { - "signature": "Long clientId()", - "params": [], + "signature": "CF.INSERTNX(key: RedisArgument, items: RedisVariadicArgument, options?: CfInsertOptions)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "The name of the Cuckoo filter" + }, + { + "name": "items", + "type": "RedisVariadicArgument", + "description": "Items to add" + }, + { + "name": "options", + "type": "CfInsertOptions", + "description": "Optional: CAPACITY, NOCREATE" + } + ], "returns": { - "type": "Long", - "description": "" + "type": "boolean[]", + "description": "Array of booleans" } } ], - "lettuce_async": [ + "nredisstack_sync": [ { - "signature": "RedisFuture clientId()", - "params": [], + "signature": "bool[] InsertNX(RedisKey key, RedisValue[] items, int? capacity = null, bool nocreate = false)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The name of the Cuckoo filter" + }, + { + "name": "items", + "type": "RedisValue[]", + "description": "Items to add" + }, + { + "name": "capacity", + "type": "int?", + "description": "Optional capacity for filter creation" + }, + { + "name": "nocreate", + "type": "bool", + "description": "If true, don't create filter" + } + ], "returns": { - "type": "RedisFuture", - "description": "" + "type": "bool[]", + "description": "Array of booleans" } } ], - "lettuce_reactive": [ + "nredisstack_async": [ { - "signature": "Mono clientId()", - "params": [], + "signature": "async Task InsertNXAsync(RedisKey key, RedisValue[] items, int? capacity = null, bool nocreate = false)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The name of the Cuckoo filter" + }, + { + "name": "items", + "type": "RedisValue[]", + "description": "Items to add" + }, + { + "name": "capacity", + "type": "int?", + "description": "Optional capacity for filter creation" + }, + { + "name": "nocreate", + "type": "bool", + "description": "If true, don't create filter" + } + ], "returns": { - "type": "Mono", - "description": "" + "type": "Task", + "description": "Array of booleans" } } ], - "nredisstack_sync": [], - "nredisstack_async": [], "php": [ { - "signature": "client(string $subcommand, ...$args)", + "signature": "cfinsertnx(string $key, int $capacity = -1, bool $noCreate = false, string ...$item)", "params": [ { - "name": "$subcommand", + "name": "$key", "type": "string", - "description": "" + "description": "The name of the Cuckoo filter" }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "$capacity", + "type": "int", + "description": "Optional capacity (-1 for default)" + }, + { + "name": "$noCreate", + "type": "bool", + "description": "If true, don't create filter" + }, + { + "name": "$item", + "type": "string...", + "description": "Items to add" } ], "returns": { - "type": "int", - "description": "" + "type": "array", + "description": "Array of booleans" } } - ], - "redis_rs_sync": [], - "redis_rs_async": [] + ] } }, - "CLIENT INFO": { + "CF.LOADCHUNK": { "api_calls": { "redis_py": [ { - "signature": "client_info(**kwargs)", + "signature": "loadchunk(key, iter, data)", "params": [ { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "key", + "type": "str", + "description": "The name of the Cuckoo filter" + }, + { + "name": "iter", + "type": "int", + "description": "Iterator from SCANDUMP" + }, + { + "name": "data", + "type": "bytes", + "description": "Data from SCANDUMP" } ], "returns": { - "type": "dict", - "description": "" + "type": "str", + "description": "OK on success" } } ], "jedis": [ { - "signature": "String clientInfo()", - "params": [], + "signature": "String cfLoadChunk(String key, long iterator, byte[] data)", + "params": [ + { + "name": "key", + "type": "String", + "description": "The name of the Cuckoo filter" + }, + { + "name": "iterator", + "type": "long", + "description": "Iterator from SCANDUMP" + }, + { + "name": "data", + "type": "byte[]", + "description": "Data from SCANDUMP" + } + ], "returns": { "type": "String", - "description": "" + "description": "OK on success" } } ], "go-redis": [ { - "signature": "ClientInfo(ctx context.Context) *ClientInfoCmd", + "signature": "CFLoadChunk(ctx context.Context, key string, iterator int64, data interface{}) *StatusCmd", "params": [ { "name": "ctx", "type": "context.Context", "description": "Context" + }, + { + "name": "key", + "type": "string", + "description": "The name of the Cuckoo filter" + }, + { + "name": "iterator", + "type": "int64", + "description": "Iterator from SCANDUMP" + }, + { + "name": "data", + "type": "interface{}", + "description": "Data from SCANDUMP" } ], "returns": { - "type": "*ClientInfoCmd", - "description": "" + "type": "*StatusCmd", + "description": "Status command result" } } ], "node_redis": [ { - "signature": "clientInfo()", - "params": [], + "signature": "CF.LOADCHUNK(key: RedisArgument, iterator: number, data: RedisArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "The name of the Cuckoo filter" + }, + { + "name": "iterator", + "type": "number", + "description": "Iterator from SCANDUMP" + }, + { + "name": "data", + "type": "RedisArgument", + "description": "Data from SCANDUMP" + } + ], "returns": { - "type": "ClientInfoReply", - "description": "" + "type": "SimpleStringReply<'OK'>", + "description": "OK on success" } } ], - "lettuce_sync": [ + "nredisstack_sync": [ { - "signature": "String clientInfo()", - "params": [], + "signature": "bool LoadChunk(RedisKey key, long iterator, Byte[] data)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The name of the Cuckoo filter" + }, + { + "name": "iterator", + "type": "long", + "description": "Iterator from SCANDUMP" + }, + { + "name": "data", + "type": "Byte[]", + "description": "Data from SCANDUMP" + } + ], "returns": { - "type": "String", - "description": "" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture clientInfo()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "" + "type": "bool", + "description": "true on success" } } ], - "lettuce_reactive": [ + "nredisstack_async": [ { - "signature": "Mono clientInfo()", - "params": [], + "signature": "async Task LoadChunkAsync(RedisKey key, long iterator, Byte[] data)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The name of the Cuckoo filter" + }, + { + "name": "iterator", + "type": "long", + "description": "Iterator from SCANDUMP" + }, + { + "name": "data", + "type": "Byte[]", + "description": "Data from SCANDUMP" + } + ], "returns": { - "type": "Mono", - "description": "" + "type": "Task", + "description": "true on success" } } ], - "nredisstack_sync": [], - "nredisstack_async": [], "php": [ { - "signature": "client(string $subcommand, ...$args)", + "signature": "cfloadchunk(string $key, int $iterator, $data)", "params": [ { - "name": "$subcommand", + "name": "$key", "type": "string", - "description": "" + "description": "The name of the Cuckoo filter" }, { - "name": "$args", + "name": "$iterator", + "type": "int", + "description": "Iterator from SCANDUMP" + }, + { + "name": "$data", "type": "mixed", - "description": "" + "description": "Data from SCANDUMP" } ], "returns": { - "type": "string", - "description": "" + "type": "Status", + "description": "OK on success" } } - ], - "redis_rs_sync": [], - "redis_rs_async": [] + ] } }, - "CLIENT KILL": { + "CF.MEXISTS": { "api_calls": { "redis_py": [ { - "signature": "client_kill(address: str, **kwargs)", + "signature": "mexists(key, *items)", "params": [ { - "name": "address", + "name": "key", "type": "str", - "description": "" + "description": "The name of the Cuckoo filter" }, { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "*items", + "type": "str", + "description": "Items to check" } ], "returns": { - "type": "int", - "description": "" + "type": "list", + "description": "List of booleans for each item" } - }, + } + ], + "jedis": [ { - "signature": "client_kill_filter(_id: int | None = None, _type: str | None = None, addr: str | None = None, skipme: bool | None = None, laddr: str | None = None, user: str | None = None, **kwargs)", + "signature": "List cfMExists(String key, String... items)", "params": [ { - "name": "_id", - "type": "int | None", - "description": "" - }, - { - "name": "_type", - "type": "str | None", - "description": "" - }, - { - "name": "addr", - "type": "str | None", - "description": "" - }, - { - "name": "skipme", - "type": "bool | None", - "description": "" - }, - { - "name": "laddr", - "type": "str | None", - "description": "" - }, - { - "name": "user", - "type": "str | None", - "description": "" + "name": "key", + "type": "String", + "description": "The name of the Cuckoo filter" }, { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "items", + "type": "String...", + "description": "Items to check" } ], "returns": { - "type": "int", - "description": "" + "type": "List", + "description": "List of booleans" } } ], - "jedis": [ + "go-redis": [ { - "signature": "long clientKill(String ipPort)", + "signature": "CFMExists(ctx context.Context, key string, elements ...interface{}) *BoolSliceCmd", "params": [ { - "name": "ipPort", - "type": "String", - "description": "" + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "key", + "type": "string", + "description": "The name of the Cuckoo filter" + }, + { + "name": "elements", + "type": "...interface{}", + "description": "Items to check" } ], "returns": { - "type": "long", - "description": "" + "type": "*BoolSliceCmd", + "description": "Boolean slice command result" } - }, + } + ], + "node_redis": [ { - "signature": "long clientKill(ClientKillParams params)", + "signature": "CF.MEXISTS(key: RedisArgument, items: RedisVariadicArgument)", "params": [ { - "name": "params", - "type": "ClientKillParams", - "description": "" + "name": "key", + "type": "RedisArgument", + "description": "The name of the Cuckoo filter" + }, + { + "name": "items", + "type": "RedisVariadicArgument", + "description": "Items to check" } ], "returns": { - "type": "long", - "description": "" + "type": "boolean[]", + "description": "Array of booleans" } } ], - "go-redis": [ + "nredisstack_sync": [ { - "signature": "ClientKill(ctx context.Context, ipPort string) *StatusCmd", + "signature": "bool[] MExists(RedisKey key, params RedisValue[] items)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" + "name": "key", + "type": "RedisKey", + "description": "The name of the Cuckoo filter" }, { - "name": "ipPort", - "type": "string", - "description": "" + "name": "items", + "type": "RedisValue[]", + "description": "Items to check" } ], "returns": { - "type": "*StatusCmd", - "description": "" + "type": "bool[]", + "description": "Array of booleans" } - }, + } + ], + "nredisstack_async": [ { - "signature": "ClientKillByFilter(ctx context.Context, keys ...string) *IntCmd", + "signature": "async Task MExistsAsync(RedisKey key, params RedisValue[] items)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" + "name": "key", + "type": "RedisKey", + "description": "The name of the Cuckoo filter" }, { - "name": "keys", - "type": "...string", - "description": "" + "name": "items", + "type": "RedisValue[]", + "description": "Items to check" } ], "returns": { - "type": "*IntCmd", - "description": "" + "type": "Task", + "description": "Array of booleans" } } ], - "node_redis": [ + "php": [ { - "signature": "clientKill(filters: ClientKillFilter | Array)", + "signature": "cfmexists(string $key, ...$item)", "params": [ { - "name": "filters", - "type": "ClientKillFilter | Array", - "description": "One or more filters to match client connections to kill" + "name": "$key", + "type": "string", + "description": "The name of the Cuckoo filter" + }, + { + "name": "$item", + "type": "...", + "description": "Items to check" } ], "returns": { - "type": "NumberReply", - "description": "" + "type": "int", + "description": "Result of the operation" } } - ], - "lettuce_sync": [ + ] + } + }, + "CF.RESERVE": { + "api_calls": { + "redis_py": [ { - "signature": "String clientKill(String addr)", + "signature": "create(key, capacity, expansion=None, bucket_size=None, max_iterations=None)", "params": [ { - "name": "addr", - "type": "String", - "description": "" + "name": "key", + "type": "str", + "description": "The name of the Cuckoo filter" + }, + { + "name": "capacity", + "type": "int", + "description": "Number of entries intended to be added" + }, + { + "name": "expansion", + "type": "int", + "description": "Optional expansion rate" + }, + { + "name": "bucket_size", + "type": "int", + "description": "Optional bucket size" + }, + { + "name": "max_iterations", + "type": "int", + "description": "Optional max iterations" } ], "returns": { - "type": "String", - "description": "" + "type": "str", + "description": "OK on success" } }, { - "signature": "Long clientKill(KillArgs killArgs)", + "signature": "reserve(key, capacity, expansion=None, bucket_size=None, max_iterations=None)", "params": [ { - "name": "killArgs", - "type": "KillArgs", - "description": "" + "name": "key", + "type": "str", + "description": "The name of the Cuckoo filter" + }, + { + "name": "capacity", + "type": "int", + "description": "Number of entries intended to be added" + }, + { + "name": "expansion", + "type": "int", + "description": "Optional expansion rate" + }, + { + "name": "bucket_size", + "type": "int", + "description": "Optional bucket size" + }, + { + "name": "max_iterations", + "type": "int", + "description": "Optional max iterations" } ], "returns": { - "type": "Long", - "description": "" + "type": "str", + "description": "OK on success (alias for create)" } } ], - "lettuce_async": [ + "jedis": [ { - "signature": "RedisFuture clientKill(String addr)", + "signature": "String cfReserve(String key, long capacity)", "params": [ { - "name": "addr", + "name": "key", "type": "String", - "description": "" + "description": "The name of the Cuckoo filter" + }, + { + "name": "capacity", + "type": "long", + "description": "Initial capacity" } ], "returns": { - "type": "RedisFuture", - "description": "" + "type": "String", + "description": "OK on success" } }, { - "signature": "RedisFuture clientKill(KillArgs killArgs)", + "signature": "String cfReserve(String key, long capacity, CFReserveParams reserveParams)", "params": [ { - "name": "killArgs", - "type": "KillArgs", - "description": "" + "name": "key", + "type": "String", + "description": "The name of the Cuckoo filter" + }, + { + "name": "capacity", + "type": "long", + "description": "Initial capacity" + }, + { + "name": "reserveParams", + "type": "CFReserveParams", + "description": "Reserve parameters (bucketSize, maxIterations, expansion)" } ], "returns": { - "type": "RedisFuture", - "description": "" + "type": "String", + "description": "OK on success" } } ], - "lettuce_reactive": [ + "go-redis": [ { - "signature": "Mono clientKill(String addr)", + "signature": "CFReserve(ctx context.Context, key string, capacity int64) *StatusCmd", "params": [ { - "name": "addr", - "type": "String", - "description": "" + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "key", + "type": "string", + "description": "The name of the Cuckoo filter" + }, + { + "name": "capacity", + "type": "int64", + "description": "Initial capacity" } ], "returns": { - "type": "Mono", - "description": "" + "type": "*StatusCmd", + "description": "Status command result" } }, { - "signature": "Mono clientKill(KillArgs killArgs)", + "signature": "CFReserveWithArgs(ctx context.Context, key string, options *CFReserveOptions) *StatusCmd", "params": [ { - "name": "killArgs", - "type": "KillArgs", - "description": "" + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "key", + "type": "string", + "description": "The name of the Cuckoo filter" + }, + { + "name": "options", + "type": "*CFReserveOptions", + "description": "Reserve options (Capacity, BucketSize, MaxIterations, Expansion)" } ], "returns": { - "type": "Mono", - "description": "" + "type": "*StatusCmd", + "description": "Status command result" } } ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + "node_redis": [ { - "signature": "client(string $subcommand, ...$args)", + "signature": "CF.RESERVE(key: RedisArgument, capacity: number, options?: CfReserveOptions)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" + "name": "key", + "type": "RedisArgument", + "description": "The name of the Cuckoo filter" }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "capacity", + "type": "number", + "description": "Initial capacity" + }, + { + "name": "options", + "type": "CfReserveOptions", + "description": "Optional: BUCKETSIZE, MAXITERATIONS, EXPANSION" } ], "returns": { - "type": "int|string", - "description": "" + "type": "SimpleStringReply<'OK'>", + "description": "OK on success" } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLIENT LIST": { - "api_calls": { - "redis_py": [ + "nredisstack_sync": [ { - "signature": "client_list(_type: str | None = None, client_id: list[int] | None = None, **kwargs)", + "signature": "bool Reserve(RedisKey key, long capacity, long? bucketSize = null, int? maxIterations = null, int? expansion = null)", "params": [ { - "name": "_type", - "type": "str | None", - "description": "" + "name": "key", + "type": "RedisKey", + "description": "The name of the Cuckoo filter" }, { - "name": "client_id", - "type": "list[int] | None", - "description": "" + "name": "capacity", + "type": "long", + "description": "Initial capacity" }, { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "bucketSize", + "type": "long?", + "description": "Optional bucket size" + }, + { + "name": "maxIterations", + "type": "int?", + "description": "Optional max iterations" + }, + { + "name": "expansion", + "type": "int?", + "description": "Optional expansion rate" } ], "returns": { - "type": "str", - "description": "" + "type": "bool", + "description": "true on success" } } ], - "jedis": [ - { - "signature": "String clientList()", - "params": [], - "returns": { - "type": "String", - "description": "" - } - }, + "nredisstack_async": [ { - "signature": "String clientList(long... clientIds)", + "signature": "async Task ReserveAsync(RedisKey key, long capacity, long? bucketSize = null, int? maxIterations = null, int? expansion = null)", "params": [ { - "name": "clientIds", - "type": "long...", - "description": "" + "name": "key", + "type": "RedisKey", + "description": "The name of the Cuckoo filter" + }, + { + "name": "capacity", + "type": "long", + "description": "Initial capacity" + }, + { + "name": "bucketSize", + "type": "long?", + "description": "Optional bucket size" + }, + { + "name": "maxIterations", + "type": "int?", + "description": "Optional max iterations" + }, + { + "name": "expansion", + "type": "int?", + "description": "Optional expansion rate" } ], "returns": { - "type": "String", - "description": "" + "type": "Task", + "description": "true on success" } } ], - "go-redis": [ + "php": [ { - "signature": "ClientList(ctx context.Context) *StringCmd", + "signature": "cfreserve(string $key, int $capacity, int $bucketSize = -1, int $maxIterations = -1, int $expansion = -1)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" - } + "name": "$key", + "type": "string", + "description": "The name of the Cuckoo filter" + }, + { + "name": "$capacity", + "type": "int", + "description": "Initial capacity" + }, + { + "name": "$bucketSize", + "type": "int", + "description": "Optional bucket size (-1 for default)" + }, + { + "name": "$maxIterations", + "type": "int", + "description": "Optional max iterations (-1 for default)" + }, + { + "name": "$expansion", + "type": "int", + "description": "Optional expansion rate (-1 for default)" + } ], "returns": { - "type": "*StringCmd", - "description": "" + "type": "Status", + "description": "OK on success" + } + } + ] + } + }, + "CF.SCANDUMP": { + "api_calls": { + "redis_py": [ + { + "signature": "scandump(key, iter)", + "params": [ + { + "name": "key", + "type": "str", + "description": "The name of the Cuckoo filter" + }, + { + "name": "iter", + "type": "int", + "description": "Iterator value (start with 0)" + } + ], + "returns": { + "type": "tuple", + "description": "Tuple of (iterator, data) - continue until iterator is 0" } } ], - "node_redis": [ + "jedis": [ { - "signature": "clientList(filter?: ListFilter)", + "signature": "Map.Entry cfScanDump(String key, long iterator)", "params": [ { - "name": "filter", - "type": "ListFilter", - "description": "Optional filter to return only specific client types or IDs" + "name": "key", + "type": "String", + "description": "The name of the Cuckoo filter" + }, + { + "name": "iterator", + "type": "long", + "description": "Iterator value (start with 0)" } ], "returns": { - "type": "Array", - "description": "" + "type": "Map.Entry", + "description": "Pair of next iterator and current data" } } ], - "lettuce_sync": [ + "go-redis": [ { - "signature": "String clientList()", - "params": [], + "signature": "CFScanDump(ctx context.Context, key string, iterator int64) *ScanDumpCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "key", + "type": "string", + "description": "The name of the Cuckoo filter" + }, + { + "name": "iterator", + "type": "int64", + "description": "Iterator value (start with 0)" + } + ], "returns": { - "type": "String", - "description": "" + "type": "*ScanDumpCmd", + "description": "ScanDump command result with Iter and Data" } } ], - "lettuce_async": [ + "node_redis": [ { - "signature": "RedisFuture clientList()", - "params": [], + "signature": "CF.SCANDUMP(key: RedisArgument, iterator: number)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "The name of the Cuckoo filter" + }, + { + "name": "iterator", + "type": "number", + "description": "Iterator value (start with 0)" + } + ], "returns": { - "type": "RedisFuture", - "description": "" + "type": "{ iterator: number, chunk: BlobStringReply }", + "description": "Object with iterator and chunk" } } ], - "lettuce_reactive": [ + "nredisstack_sync": [ { - "signature": "Mono clientList()", - "params": [], + "signature": "Tuple ScanDump(RedisKey key, long iterator)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The name of the Cuckoo filter" + }, + { + "name": "iterator", + "type": "long", + "description": "Iterator value (start with 0)" + } + ], "returns": { - "type": "Mono", - "description": "" + "type": "Tuple", + "description": "Tuple of iterator and data" + } + } + ], + "nredisstack_async": [ + { + "signature": "async Task> ScanDumpAsync(RedisKey key, long iterator)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The name of the Cuckoo filter" + }, + { + "name": "iterator", + "type": "long", + "description": "Iterator value (start with 0)" + } + ], + "returns": { + "type": "Task>", + "description": "Tuple of iterator and data" } } ], - "nredisstack_sync": [], - "nredisstack_async": [], "php": [ { - "signature": "client(string $subcommand, ...$args)", + "signature": "cfscandump(string $key, int $iterator)", "params": [ { - "name": "$subcommand", + "name": "$key", "type": "string", - "description": "" + "description": "The name of the Cuckoo filter" }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "$iterator", + "type": "int", + "description": "Iterator value (start with 0)" } ], "returns": { - "type": "string", - "description": "" + "type": "array", + "description": "Array with iterator and data" } } - ], - "redis_rs_sync": [], - "redis_rs_async": [] + ] } }, - "CLIENT NO-EVICT": { + "CLIENT CACHING": { "api_calls": { "redis_py": [ { - "signature": "client_no_evict(mode: str, **kwargs)", + "signature": "client_caching(enabled: bool, **kwargs)", "params": [ { - "name": "mode", - "type": "str", + "name": "enabled", + "type": "bool", "description": "" }, { @@ -20465,10 +20925,10 @@ ], "jedis": [ { - "signature": "String clientNoEvict(boolean on)", + "signature": "String clientCaching(boolean enabled)", "params": [ { - "name": "on", + "name": "enabled", "type": "boolean", "description": "" } @@ -20481,80 +20941,54 @@ ], "go-redis": [], "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + "lettuce_sync": [ { - "signature": "client(string $subcommand, ...$args)", + "signature": "String clientCaching(boolean enabled)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" - }, - { - "name": "$args", - "type": "mixed", + "name": "enabled", + "type": "boolean", "description": "" } ], "returns": { - "type": "string", + "type": "String", "description": "" } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLIENT NO-TOUCH": { - "api_calls": { - "redis_py": [ + "lettuce_async": [ { - "signature": "client_no_touch(mode: str, **kwargs)", + "signature": "RedisFuture clientCaching(boolean enabled)", "params": [ { - "name": "mode", - "type": "str", - "description": "" - }, - { - "name": "**kwargs", - "type": "Any", + "name": "enabled", + "type": "boolean", "description": "" } ], "returns": { - "type": "str", + "type": "RedisFuture", "description": "" } } ], - "jedis": [ + "lettuce_reactive": [ { - "signature": "String clientNoTouch(boolean on)", + "signature": "Mono clientCaching(boolean enabled)", "params": [ { - "name": "on", + "name": "enabled", "type": "boolean", "description": "" } ], "returns": { - "type": "String", + "type": "Mono", "description": "" } } ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], "nredisstack_sync": [], "nredisstack_async": [], "php": [ @@ -20582,22 +21016,12 @@ "redis_rs_async": [] } }, - "CLIENT PAUSE": { + "CLIENT GETNAME": { "api_calls": { "redis_py": [ { - "signature": "client_pause(timeout: int, all: bool = True, **kwargs)", + "signature": "client_getname(**kwargs)", "params": [ - { - "name": "timeout", - "type": "int", - "description": "" - }, - { - "name": "all", - "type": "bool", - "description": "" - }, { "name": "**kwargs", "type": "Any", @@ -20605,21 +21029,15 @@ } ], "returns": { - "type": "str", + "type": "str | None", "description": "" } } ], "jedis": [ { - "signature": "String clientPause(long timeout)", - "params": [ - { - "name": "timeout", - "type": "long", - "description": "" - } - ], + "signature": "String clientGetname()", + "params": [], "returns": { "type": "String", "description": "" @@ -20628,36 +21046,34 @@ ], "go-redis": [ { - "signature": "ClientPause(ctx context.Context, dur time.Duration) *BoolCmd", + "signature": "ClientGetName(ctx context.Context) *StringCmd", "params": [ { "name": "ctx", "type": "context.Context", "description": "Context" - }, - { - "name": "dur", - "type": "time.Duration", - "description": "" } ], "returns": { - "type": "*BoolCmd", + "type": "*StringCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "clientGetName()", + "params": [], + "returns": { + "type": "BlobStringReply | NullReply", "description": "" } } ], - "node_redis": [], "lettuce_sync": [ { - "signature": "String clientPause(long timeout)", - "params": [ - { - "name": "timeout", - "type": "long", - "description": "" - } - ], + "signature": "String clientGetname()", + "params": [], "returns": { "type": "String", "description": "" @@ -20666,14 +21082,8 @@ ], "lettuce_async": [ { - "signature": "RedisFuture clientPause(long timeout)", - "params": [ - { - "name": "timeout", - "type": "long", - "description": "" - } - ], + "signature": "RedisFuture clientGetname()", + "params": [], "returns": { "type": "RedisFuture", "description": "" @@ -20682,14 +21092,8 @@ ], "lettuce_reactive": [ { - "signature": "Mono clientPause(long timeout)", - "params": [ - { - "name": "timeout", - "type": "long", - "description": "" - } - ], + "signature": "Mono clientGetname()", + "params": [], "returns": { "type": "Mono", "description": "" @@ -20714,7 +21118,7 @@ } ], "returns": { - "type": "string", + "type": "string|null", "description": "" } } @@ -20723,17 +21127,12 @@ "redis_rs_async": [] } }, - "CLIENT REPLY": { + "CLIENT GETREDIR": { "api_calls": { "redis_py": [ { - "signature": "client_reply(reply: str, **kwargs)", + "signature": "client_getredir(**kwargs)", "params": [ - { - "name": "reply", - "type": "str", - "description": "" - }, { "name": "**kwargs", "type": "Any", @@ -20741,32 +21140,53 @@ } ], "returns": { - "type": "str", + "type": "int", "description": "" } } ], "jedis": [ { - "signature": "String clientReply(ClientReplyType replyType)", - "params": [ - { - "name": "replyType", - "type": "ClientReplyType", - "description": "" - } - ], + "signature": "long clientGetredir()", + "params": [], "returns": { - "type": "String", + "type": "long", "description": "" } } ], "go-redis": [], "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "Long clientGetredir()", + "params": [], + "returns": { + "type": "Long", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture clientGetredir()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono clientGetredir()", + "params": [], + "returns": { + "type": "Mono", + "description": "" + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], "php": [ @@ -20785,7 +21205,7 @@ } ], "returns": { - "type": "string", + "type": "int", "description": "" } } @@ -20794,22 +21214,28 @@ "redis_rs_async": [] } }, - "CLIENT SETINFO": { + "CLIENT HELP": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLIENT ID": { "api_calls": { "redis_py": [ { - "signature": "client_setinfo(attr: str, value: str, **kwargs)", + "signature": "client_id(**kwargs)", "params": [ - { - "name": "attr", - "type": "str", - "description": "Attribute name" - }, - { - "name": "value", - "type": "str", - "description": "Attribute value" - }, { "name": "**kwargs", "type": "Any", @@ -20817,137 +21243,117 @@ } ], "returns": { - "type": "ResponseT", + "type": "int", "description": "" } } ], "jedis": [ { - "signature": "String clientSetInfo(ClientAttributeOption attr, String value)", + "signature": "long clientId()", + "params": [], + "returns": { + "type": "long", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ClientID(ctx context.Context) *IntCmd", "params": [ { - "name": "attr", - "type": "ClientAttributeOption", - "description": "Attribute option" - }, - { - "name": "value", - "type": "String", - "description": "Attribute value" + "name": "ctx", + "type": "context.Context", + "description": "Context" } ], "returns": { - "type": "String", - "description": "OK" + "type": "*IntCmd", + "description": "" } } ], - "go-redis": [], "node_redis": [], "lettuce_sync": [ { - "signature": "String clientSetinfo(String key, String value)", - "params": [ - { - "name": "key", - "type": "String", - "description": "The key" - }, - { - "name": "value", - "type": "String", - "description": "The value" - } - ], + "signature": "Long clientId()", + "params": [], "returns": { - "type": "String", - "description": "OK" + "type": "Long", + "description": "" } } ], "lettuce_async": [ { - "signature": "RedisFuture clientSetinfo(String key, String value)", - "params": [ - { - "name": "key", - "type": "String", - "description": "The key" - }, - { - "name": "value", - "type": "String", - "description": "The value" - } - ], + "signature": "RedisFuture clientId()", + "params": [], "returns": { - "type": "RedisFuture", - "description": "OK" + "type": "RedisFuture", + "description": "" } } ], "lettuce_reactive": [ { - "signature": "Mono clientSetinfo(String key, String value)", - "params": [ - { - "name": "key", - "type": "String", - "description": "The key" - }, - { - "name": "value", - "type": "String", - "description": "The value" - } - ], + "signature": "Mono clientId()", + "params": [], "returns": { - "type": "Mono", - "description": "OK" + "type": "Mono", + "description": "" } } ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLIENT SETNAME": { - "api_calls": { - "redis_py": [ + "php": [ { - "signature": "client_setname(name: str, **kwargs)", + "signature": "client(string $subcommand, ...$args)", "params": [ { - "name": "name", - "type": "str", + "name": "$subcommand", + "type": "string", "description": "" }, { - "name": "**kwargs", - "type": "Any", + "name": "$args", + "type": "mixed", "description": "" } ], "returns": { - "type": "str", + "type": "int", "description": "" } } ], - "jedis": [ + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLIENT INFO": { + "api_calls": { + "redis_py": [ { - "signature": "String clientSetname(String name)", + "signature": "client_info(**kwargs)", "params": [ { - "name": "name", - "type": "String", + "name": "**kwargs", + "type": "Any", "description": "" } ], + "returns": { + "type": "dict", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String clientInfo()", + "params": [], "returns": { "type": "String", "description": "" @@ -20956,51 +21362,34 @@ ], "go-redis": [ { - "signature": "ClientSetName(ctx context.Context, name string) *BoolCmd", + "signature": "ClientInfo(ctx context.Context) *ClientInfoCmd", "params": [ { "name": "ctx", "type": "context.Context", "description": "Context" - }, - { - "name": "name", - "type": "string", - "description": "" } ], "returns": { - "type": "*BoolCmd", + "type": "*ClientInfoCmd", "description": "" } } ], "node_redis": [ { - "signature": "clientSetName(name: RedisArgument)", - "params": [ - { - "name": "name", - "type": "RedisArgument", - "description": "The name to assign to the connection" - } - ], + "signature": "clientInfo()", + "params": [], "returns": { - "type": "SimpleStringReply<'OK'>", + "type": "ClientInfoReply", "description": "" } } ], "lettuce_sync": [ { - "signature": "String clientSetname(String name)", - "params": [ - { - "name": "name", - "type": "String", - "description": "" - } - ], + "signature": "String clientInfo()", + "params": [], "returns": { "type": "String", "description": "" @@ -21009,14 +21398,8 @@ ], "lettuce_async": [ { - "signature": "RedisFuture clientSetname(String name)", - "params": [ - { - "name": "name", - "type": "String", - "description": "" - } - ], + "signature": "RedisFuture clientInfo()", + "params": [], "returns": { "type": "RedisFuture", "description": "" @@ -21025,14 +21408,8 @@ ], "lettuce_reactive": [ { - "signature": "Mono clientSetname(String name)", - "params": [ - { - "name": "name", - "type": "String", - "description": "" - } - ], + "signature": "Mono clientInfo()", + "params": [], "returns": { "type": "Mono", "description": "" @@ -21066,45 +21443,59 @@ "redis_rs_async": [] } }, - "CLIENT TRACKING": { + "CLIENT KILL": { "api_calls": { "redis_py": [ { - "signature": "client_tracking(on: bool = True, client_id: int | None = None, prefix: list | None = None, bcast: bool = False, optin: bool = False, optout: bool = False, noloop: bool = False, **kwargs)", + "signature": "client_kill(address: str, **kwargs)", "params": [ { - "name": "on", - "type": "bool", + "name": "address", + "type": "str", "description": "" }, { - "name": "client_id", + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + }, + { + "signature": "client_kill_filter(_id: int | None = None, _type: str | None = None, addr: str | None = None, skipme: bool | None = None, laddr: str | None = None, user: str | None = None, **kwargs)", + "params": [ + { + "name": "_id", "type": "int | None", "description": "" }, { - "name": "prefix", - "type": "list | None", + "name": "_type", + "type": "str | None", "description": "" }, { - "name": "bcast", - "type": "bool", + "name": "addr", + "type": "str | None", "description": "" }, { - "name": "optin", - "type": "bool", + "name": "skipme", + "type": "bool | None", "description": "" }, { - "name": "optout", - "type": "bool", + "name": "laddr", + "type": "str | None", "description": "" }, { - "name": "noloop", - "type": "bool", + "name": "user", + "type": "str | None", "description": "" }, { @@ -21114,351 +21505,230 @@ } ], "returns": { - "type": "str", + "type": "int", "description": "" } } ], "jedis": [ { - "signature": "String clientTracking(TrackingParams params)", + "signature": "long clientKill(String ipPort)", "params": [ { - "name": "params", - "type": "TrackingParams", + "name": "ipPort", + "type": "String", "description": "" } ], "returns": { - "type": "String", + "type": "long", "description": "" } - } - ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [ + }, { - "signature": "String clientTracking(TrackingArgs args)", + "signature": "long clientKill(ClientKillParams params)", "params": [ { - "name": "args", - "type": "TrackingArgs", + "name": "params", + "type": "ClientKillParams", "description": "" } ], "returns": { - "type": "String", + "type": "long", "description": "" } } ], - "lettuce_async": [ + "go-redis": [ { - "signature": "RedisFuture clientTracking(TrackingArgs args)", + "signature": "ClientKill(ctx context.Context, ipPort string) *StatusCmd", "params": [ { - "name": "args", - "type": "TrackingArgs", - "description": "" - } - ], - "returns": { - "type": "RedisFuture", - "description": "" - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono clientTracking(TrackingArgs args)", - "params": [ + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, { - "name": "args", - "type": "TrackingArgs", + "name": "ipPort", + "type": "string", "description": "" } ], "returns": { - "type": "Mono", + "type": "*StatusCmd", "description": "" } - } - ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + }, { - "signature": "client(string $subcommand, ...$args)", + "signature": "ClientKillByFilter(ctx context.Context, keys ...string) *IntCmd", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" + "name": "ctx", + "type": "context.Context", + "description": "Context" }, { - "name": "$args", - "type": "mixed", + "name": "keys", + "type": "...string", "description": "" } ], "returns": { - "type": "string", + "type": "*IntCmd", "description": "" } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLIENT TRACKINGINFO": { - "api_calls": { - "redis_py": [ + "node_redis": [ { - "signature": "client_trackinginfo(**kwargs)", + "signature": "clientKill(filters: ClientKillFilter | Array)", "params": [ { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "filters", + "type": "ClientKillFilter | Array", + "description": "One or more filters to match client connections to kill" } ], "returns": { - "type": "ResponseT", + "type": "NumberReply", "description": "" } } ], - "jedis": [ - { - "signature": "TrackingInfo clientTrackingInfo()", - "params": [], - "returns": { - "type": "TrackingInfo", - "description": "Tracking information" - } - } - ], - "go-redis": [], - "node_redis": [], "lettuce_sync": [ { - "signature": "TrackingInfo clientTrackinginfo()", - "params": [], - "returns": { - "type": "TrackingInfo", - "description": "Tracking information" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture clientTrackinginfo()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "Tracking information" - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono clientTrackinginfo()", - "params": [], - "returns": { - "type": "Mono", - "description": "Tracking information" - } - } - ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLIENT UNBLOCK": { - "api_calls": { - "redis_py": [ - { - "signature": "client_unblock(client_id: int, error: bool = False, **kwargs)", + "signature": "String clientKill(String addr)", "params": [ { - "name": "client_id", - "type": "int", - "description": "The client ID" - }, - { - "name": "error", - "type": "bool", - "description": "Whether to unblock with error" - }, - { - "name": "**kwargs", - "type": "Any", + "name": "addr", + "type": "String", "description": "" } ], "returns": { - "type": "ResponseT", + "type": "String", "description": "" } - } - ], - "jedis": [ - { - "signature": "long clientUnblock(final long clientId)", - "params": [ - { - "name": "clientId", - "type": "long", - "description": "The client ID" - } - ], - "returns": { - "type": "long", - "description": "Number of unblocked connections" - } }, { - "signature": "long clientUnblock(final long clientId, final UnblockType unblockType)", + "signature": "Long clientKill(KillArgs killArgs)", "params": [ { - "name": "clientId", - "type": "long", - "description": "The client ID" - }, - { - "name": "unblockType", - "type": "UnblockType", - "description": "Unblock type" + "name": "killArgs", + "type": "KillArgs", + "description": "" } ], "returns": { - "type": "long", - "description": "Number of unblocked connections" + "type": "Long", + "description": "" } } ], - "go-redis": [ + "lettuce_async": [ { - "signature": "ClientUnblock(ctx context.Context, id int64) *IntCmd", + "signature": "RedisFuture clientKill(String addr)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" - }, - { - "name": "id", - "type": "int64", - "description": "Client ID to unblock" + "name": "addr", + "type": "String", + "description": "" } ], "returns": { - "type": "*IntCmd", + "type": "RedisFuture", "description": "" } }, { - "signature": "ClientUnblockWithError(ctx context.Context, id int64) *IntCmd", + "signature": "RedisFuture clientKill(KillArgs killArgs)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" - }, - { - "name": "id", - "type": "int64", - "description": "Client ID to unblock with error" + "name": "killArgs", + "type": "KillArgs", + "description": "" } ], "returns": { - "type": "*IntCmd", + "type": "RedisFuture", "description": "" } } ], - "node_redis": [], - "lettuce_sync": [ + "lettuce_reactive": [ { - "signature": "Long clientUnblock(long id, UnblockType type)", + "signature": "Mono clientKill(String addr)", "params": [ { - "name": "id", - "type": "long", - "description": "The client ID" - }, - { - "name": "type", - "type": "UnblockType", - "description": "Unblock type" + "name": "addr", + "type": "String", + "description": "" } ], "returns": { - "type": "Long", - "description": "Number of unblocked connections" + "type": "Mono", + "description": "" } - } - ], - "lettuce_async": [ + }, { - "signature": "RedisFuture clientUnblock(long id, UnblockType type)", + "signature": "Mono clientKill(KillArgs killArgs)", "params": [ { - "name": "id", - "type": "long", - "description": "The client ID" - }, - { - "name": "type", - "type": "UnblockType", - "description": "Unblock type" + "name": "killArgs", + "type": "KillArgs", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Number of unblocked connections" + "type": "Mono", + "description": "" } } ], - "lettuce_reactive": [ + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ { - "signature": "Mono clientUnblock(long id, UnblockType type)", + "signature": "client(string $subcommand, ...$args)", "params": [ { - "name": "id", - "type": "long", - "description": "The client ID" + "name": "$subcommand", + "type": "string", + "description": "" }, { - "name": "type", - "type": "UnblockType", - "description": "Unblock type" + "name": "$args", + "type": "mixed", + "description": "" } ], "returns": { - "type": "Mono", - "description": "Number of unblocked connections" + "type": "int|string", + "description": "" } } ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], "redis_rs_sync": [], "redis_rs_async": [] } }, - "CLIENT UNPAUSE": { + "CLIENT LIST": { "api_calls": { "redis_py": [ { - "signature": "client_unpause(**kwargs)", + "signature": "client_list(_type: str | None = None, client_id: list[int] | None = None, **kwargs)", "params": [ + { + "name": "_type", + "type": "str | None", + "description": "" + }, + { + "name": "client_id", + "type": "list[int] | None", + "description": "" + }, { "name": "**kwargs", "type": "Any", @@ -21473,17 +21743,31 @@ ], "jedis": [ { - "signature": "String clientUnpause()", + "signature": "String clientList()", "params": [], "returns": { "type": "String", "description": "" } + }, + { + "signature": "String clientList(long... clientIds)", + "params": [ + { + "name": "clientIds", + "type": "long...", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "" + } } ], "go-redis": [ { - "signature": "ClientUnpause(ctx context.Context) *BoolCmd", + "signature": "ClientList(ctx context.Context) *StringCmd", "params": [ { "name": "ctx", @@ -21492,15 +21776,30 @@ } ], "returns": { - "type": "*BoolCmd", + "type": "*StringCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "clientList(filter?: ListFilter)", + "params": [ + { + "name": "filter", + "type": "ListFilter", + "description": "Optional filter to return only specific client types or IDs" + } + ], + "returns": { + "type": "Array", "description": "" } } ], - "node_redis": [], "lettuce_sync": [ { - "signature": "String clientUnpause()", + "signature": "String clientList()", "params": [], "returns": { "type": "String", @@ -21510,7 +21809,7 @@ ], "lettuce_async": [ { - "signature": "RedisFuture clientUnpause()", + "signature": "RedisFuture clientList()", "params": [], "returns": { "type": "RedisFuture", @@ -21520,7 +21819,7 @@ ], "lettuce_reactive": [ { - "signature": "Mono clientUnpause()", + "signature": "Mono clientList()", "params": [], "returns": { "type": "Mono", @@ -21555,179 +21854,209 @@ "redis_rs_async": [] } }, - "CLIENT": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLUSTER ADDSLOTS": { + "CLIENT NO-EVICT": { "api_calls": { - "redis_py": [], - "jedis": [ + "redis_py": [ { - "signature": "String clusterAddSlots(final int... slots)", + "signature": "client_no_evict(mode: str, **kwargs)", "params": [ { - "name": "slots", - "type": "int...", + "name": "mode", + "type": "str", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", "description": "" } ], "returns": { - "type": "String", - "description": "OK" + "type": "str", + "description": "" } } ], - "go-redis": [ + "jedis": [ { - "signature": "ClusterAddSlots(ctx context.Context, slots ...int)", + "signature": "String clientNoEvict(boolean on)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" - }, - { - "name": "slots", - "type": "...int", + "name": "on", + "type": "boolean", "description": "" } ], "returns": { - "type": "*StatusCmd", + "type": "String", "description": "" } } ], - "node_redis": [ + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ { - "signature": "parseCommand(parser: CommandParser, slots: number | Array)", + "signature": "client(string $subcommand, ...$args)", "params": [ { - "name": "parser", - "type": "CommandParser", - "description": "The Redis command parser" + "name": "$subcommand", + "type": "string", + "description": "" }, { - "name": "slots", - "type": "number | Array", - "description": "One or more hash slots to be assigned" + "name": "$args", + "type": "mixed", + "description": "" } ], "returns": { - "type": "SimpleStringReply<'OK'>", + "type": "string", "description": "" } } ], - "lettuce_sync": [ + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLIENT NO-TOUCH": { + "api_calls": { + "redis_py": [ { - "signature": "String clusterAddSlots(int... slots)", + "signature": "client_no_touch(mode: str, **kwargs)", "params": [ { - "name": "slots", - "type": "int...", - "description": "One or more hash slots to be assigned" + "name": "mode", + "type": "str", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" } ], "returns": { - "type": "String", - "description": "OK" + "type": "str", + "description": "" } } ], - "lettuce_async": [ + "jedis": [ { - "signature": "RedisFuture clusterAddSlots(int... slots)", + "signature": "String clientNoTouch(boolean on)", "params": [ { - "name": "slots", - "type": "int...", - "description": "One or more hash slots to be assigned" + "name": "on", + "type": "boolean", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "OK" + "type": "String", + "description": "" } } ], - "lettuce_reactive": [ + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ { - "signature": "Mono clusterAddSlots(int... slots)", + "signature": "client(string $subcommand, ...$args)", "params": [ { - "name": "slots", - "type": "int...", - "description": "One or more hash slots to be assigned" + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" } ], "returns": { - "type": "Mono", - "description": "OK" + "type": "string", + "description": "" } } ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], "redis_rs_sync": [], "redis_rs_async": [] } }, - "CLUSTER ADDSLOTSRANGE": { + "CLIENT PAUSE": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "client_pause(timeout: int, all: bool = True, **kwargs)", + "params": [ + { + "name": "timeout", + "type": "int", + "description": "" + }, + { + "name": "all", + "type": "bool", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "str", + "description": "" + } + } + ], "jedis": [ { - "signature": "String clusterAddSlotsRange(int... ranges)", + "signature": "String clientPause(long timeout)", "params": [ { - "name": "ranges", - "type": "int...", + "name": "timeout", + "type": "long", "description": "" } ], "returns": { "type": "String", - "description": "OK" + "description": "" } } ], "go-redis": [ { - "signature": "ClusterAddSlotsRange(ctx context.Context, min, max int)", + "signature": "ClientPause(ctx context.Context, dur time.Duration) *BoolCmd", "params": [ { "name": "ctx", "type": "context.Context", - "description": "" - }, - { - "name": "min", - "type": "Any", - "description": "" + "description": "Context" }, { - "name": "max", - "type": "int", + "name": "dur", + "type": "time.Duration", "description": "" } ], "returns": { - "type": "*StatusCmd", + "type": "*BoolCmd", "description": "" } } @@ -21735,214 +22064,261 @@ "node_redis": [], "lettuce_sync": [ { - "signature": "String clusterAddSlotsRange(Range... ranges)", + "signature": "String clientPause(long timeout)", "params": [ { - "name": "ranges", - "type": "Range...", - "description": "One or more slot ranges" + "name": "timeout", + "type": "long", + "description": "" } ], "returns": { "type": "String", - "description": "OK" + "description": "" } } ], "lettuce_async": [ { - "signature": "RedisFuture clusterAddSlotsRange(Range... ranges)", + "signature": "RedisFuture clientPause(long timeout)", "params": [ { - "name": "ranges", - "type": "Range...", - "description": "One or more slot ranges" + "name": "timeout", + "type": "long", + "description": "" } ], "returns": { "type": "RedisFuture", - "description": "OK" + "description": "" } } ], "lettuce_reactive": [ { - "signature": "Mono clusterAddSlotsRange(Range... ranges)", + "signature": "Mono clientPause(long timeout)", "params": [ { - "name": "ranges", - "type": "Range...", - "description": "One or more slot ranges" + "name": "timeout", + "type": "long", + "description": "" } ], "returns": { "type": "Mono", - "description": "OK" + "description": "" } } ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLUSTER BUMPEPOCH": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [ + "php": [ { - "signature": "String clusterBumpepoch()", - "params": [], + "signature": "client(string $subcommand, ...$args)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" + } + ], "returns": { - "type": "String", - "description": "BUMPED or STILL" + "type": "string", + "description": "" } } ], - "lettuce_async": [ + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLIENT REPLY": { + "api_calls": { + "redis_py": [ { - "signature": "RedisFuture clusterBumpepoch()", - "params": [], + "signature": "client_reply(reply: str, **kwargs)", + "params": [ + { + "name": "reply", + "type": "str", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], "returns": { - "type": "RedisFuture", - "description": "BUMPED or STILL" + "type": "str", + "description": "" } } ], - "lettuce_reactive": [ + "jedis": [ { - "signature": "Mono clusterBumpepoch()", - "params": [], + "signature": "String clientReply(ClientReplyType replyType)", + "params": [ + { + "name": "replyType", + "type": "ClientReplyType", + "description": "" + } + ], "returns": { - "type": "Mono", - "description": "BUMPED or STILL" + "type": "String", + "description": "" } } ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLUSTER COUNT-FAILURE-REPORTS": { - "api_calls": { - "redis_py": [], - "jedis": [], "go-redis": [], "node_redis": [], - "lettuce_sync": [ + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ { - "signature": "Long clusterCountFailureReports(String nodeId)", + "signature": "client(string $subcommand, ...$args)", "params": [ { - "name": "nodeId", - "type": "String", - "description": "The node ID" + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" } ], "returns": { - "type": "Long", - "description": "Number of failure reports" + "type": "string", + "description": "" } } ], - "lettuce_async": [ + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLIENT SETINFO": { + "api_calls": { + "redis_py": [ { - "signature": "RedisFuture clusterCountFailureReports(String nodeId)", + "signature": "client_setinfo(attr: str, value: str, **kwargs)", "params": [ { - "name": "nodeId", - "type": "String", - "description": "The node ID" + "name": "attr", + "type": "str", + "description": "Attribute name" + }, + { + "name": "value", + "type": "str", + "description": "Attribute value" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Number of failure reports" + "type": "ResponseT", + "description": "" } } ], - "lettuce_reactive": [ + "jedis": [ { - "signature": "Mono clusterCountFailureReports(String nodeId)", + "signature": "String clientSetInfo(ClientAttributeOption attr, String value)", "params": [ { - "name": "nodeId", + "name": "attr", + "type": "ClientAttributeOption", + "description": "Attribute option" + }, + { + "name": "value", "type": "String", - "description": "The node ID" + "description": "Attribute value" } ], "returns": { - "type": "Mono", - "description": "Number of failure reports" + "type": "String", + "description": "OK" } } ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLUSTER COUNTKEYSINSLOT": { - "api_calls": { - "redis_py": [], - "jedis": [], "go-redis": [], "node_redis": [], "lettuce_sync": [ { - "signature": "Long clusterCountKeysInSlot(int slot)", + "signature": "String clientSetinfo(String key, String value)", "params": [ { - "name": "slot", - "type": "int", - "description": "The hash slot" + "name": "key", + "type": "String", + "description": "The key" + }, + { + "name": "value", + "type": "String", + "description": "The value" } ], "returns": { - "type": "Long", - "description": "Number of keys in the slot" + "type": "String", + "description": "OK" } } ], "lettuce_async": [ { - "signature": "RedisFuture clusterCountKeysInSlot(int slot)", + "signature": "RedisFuture clientSetinfo(String key, String value)", "params": [ { - "name": "slot", - "type": "int", - "description": "The hash slot" + "name": "key", + "type": "String", + "description": "The key" + }, + { + "name": "value", + "type": "String", + "description": "The value" } ], "returns": { - "type": "RedisFuture", - "description": "Number of keys in the slot" + "type": "RedisFuture", + "description": "OK" } } ], "lettuce_reactive": [ { - "signature": "Mono clusterCountKeysInSlot(int slot)", + "signature": "Mono clientSetinfo(String key, String value)", "params": [ { - "name": "slot", - "type": "int", - "description": "The hash slot" + "name": "key", + "type": "String", + "description": "The key" + }, + { + "name": "value", + "type": "String", + "description": "The value" } ], "returns": { - "type": "Mono", - "description": "Number of keys in the slot" + "type": "Mono", + "description": "OK" } } ], @@ -21953,242 +22329,469 @@ "redis_rs_async": [] } }, - "CLUSTER DELSLOTS": { + "CLIENT SETNAME": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "client_setname(name: str, **kwargs)", + "params": [ + { + "name": "name", + "type": "str", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "str", + "description": "" + } + } + ], "jedis": [ { - "signature": "String clusterDelSlots(final int... slots)", + "signature": "String clientSetname(String name)", "params": [ { - "name": "slots", - "type": "int...", + "name": "name", + "type": "String", "description": "" } ], "returns": { "type": "String", - "description": "OK" + "description": "" } } ], "go-redis": [ { - "signature": "ClusterDelSlots(ctx context.Context, slots ...int)", + "signature": "ClientSetName(ctx context.Context, name string) *BoolCmd", "params": [ { "name": "ctx", "type": "context.Context", - "description": "" + "description": "Context" }, { - "name": "slots", - "type": "...int", + "name": "name", + "type": "string", "description": "" } ], "returns": { - "type": "*StatusCmd", + "type": "*BoolCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "clientSetName(name: RedisArgument)", + "params": [ + { + "name": "name", + "type": "RedisArgument", + "description": "The name to assign to the connection" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", "description": "" } } ], - "node_redis": [], "lettuce_sync": [ { - "signature": "String clusterDelSlots(int... slots)", + "signature": "String clientSetname(String name)", "params": [ { - "name": "slots", - "type": "int...", - "description": "One or more hash slots to be removed" + "name": "name", + "type": "String", + "description": "" } ], "returns": { "type": "String", - "description": "OK" + "description": "" } } ], "lettuce_async": [ { - "signature": "RedisFuture clusterDelSlots(int... slots)", + "signature": "RedisFuture clientSetname(String name)", "params": [ { - "name": "slots", - "type": "int...", - "description": "One or more hash slots to be removed" + "name": "name", + "type": "String", + "description": "" } ], "returns": { "type": "RedisFuture", - "description": "OK" + "description": "" } } ], "lettuce_reactive": [ { - "signature": "Mono clusterDelSlots(int... slots)", + "signature": "Mono clientSetname(String name)", "params": [ { - "name": "slots", - "type": "int...", - "description": "One or more hash slots to be removed" + "name": "name", + "type": "String", + "description": "" } ], "returns": { "type": "Mono", - "description": "OK" + "description": "" } } ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLUSTER DELSLOTSRANGE": { - "api_calls": { - "redis_py": [], - "jedis": [ + "php": [ { - "signature": "String clusterDelSlotsRange(int... ranges)", + "signature": "client(string $subcommand, ...$args)", "params": [ { - "name": "ranges", - "type": "int...", + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", "description": "" } ], "returns": { - "type": "String", - "description": "OK" + "type": "string", + "description": "" } } ], - "go-redis": [ + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLIENT TRACKING": { + "api_calls": { + "redis_py": [ { - "signature": "ClusterDelSlotsRange(ctx context.Context, min, max int)", + "signature": "client_tracking(on: bool = True, client_id: int | None = None, prefix: list | None = None, bcast: bool = False, optin: bool = False, optout: bool = False, noloop: bool = False, **kwargs)", "params": [ { - "name": "ctx", - "type": "context.Context", + "name": "on", + "type": "bool", "description": "" }, { - "name": "min", - "type": "Any", + "name": "client_id", + "type": "int | None", "description": "" }, { - "name": "max", - "type": "int", + "name": "prefix", + "type": "list | None", + "description": "" + }, + { + "name": "bcast", + "type": "bool", + "description": "" + }, + { + "name": "optin", + "type": "bool", + "description": "" + }, + { + "name": "optout", + "type": "bool", + "description": "" + }, + { + "name": "noloop", + "type": "bool", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", "description": "" } ], "returns": { - "type": "*StatusCmd", + "type": "str", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String clientTracking(TrackingParams params)", + "params": [ + { + "name": "params", + "type": "TrackingParams", + "description": "" + } + ], + "returns": { + "type": "String", "description": "" } } ], + "go-redis": [], "node_redis": [], "lettuce_sync": [ { - "signature": "String clusterDelSlotsRange(Range... ranges)", + "signature": "String clientTracking(TrackingArgs args)", "params": [ { - "name": "ranges", - "type": "Range...", - "description": "One or more slot ranges" + "name": "args", + "type": "TrackingArgs", + "description": "" } ], "returns": { "type": "String", - "description": "OK" + "description": "" } } ], "lettuce_async": [ { - "signature": "RedisFuture clusterDelSlotsRange(Range... ranges)", + "signature": "RedisFuture clientTracking(TrackingArgs args)", "params": [ { - "name": "ranges", - "type": "Range...", - "description": "One or more slot ranges" + "name": "args", + "type": "TrackingArgs", + "description": "" } ], "returns": { "type": "RedisFuture", - "description": "OK" + "description": "" } } ], "lettuce_reactive": [ { - "signature": "Mono clusterDelSlotsRange(Range... ranges)", + "signature": "Mono clientTracking(TrackingArgs args)", "params": [ { - "name": "ranges", - "type": "Range...", - "description": "One or more slot ranges" + "name": "args", + "type": "TrackingArgs", + "description": "" } ], "returns": { "type": "Mono", - "description": "OK" + "description": "" } } ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], + "php": [ + { + "signature": "client(string $subcommand, ...$args)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "string", + "description": "" + } + } + ], "redis_rs_sync": [], "redis_rs_async": [] } }, - "CLUSTER FAILOVER": { + "CLIENT TRACKINGINFO": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "client_trackinginfo(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "ResponseT", + "description": "" + } + } + ], "jedis": [ { - "signature": "String clusterFailover()", + "signature": "TrackingInfo clientTrackingInfo()", "params": [], "returns": { - "type": "String", - "description": "OK" + "type": "TrackingInfo", + "description": "Tracking information" } - }, + } + ], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [ { - "signature": "String clusterFailover(ClusterFailoverOption failoverOption)", + "signature": "TrackingInfo clientTrackinginfo()", + "params": [], + "returns": { + "type": "TrackingInfo", + "description": "Tracking information" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture clientTrackinginfo()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "Tracking information" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono clientTrackinginfo()", + "params": [], + "returns": { + "type": "Mono", + "description": "Tracking information" + } + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLIENT UNBLOCK": { + "api_calls": { + "redis_py": [ + { + "signature": "client_unblock(client_id: int, error: bool = False, **kwargs)", "params": [ { - "name": "failoverOption", - "type": "ClusterFailoverOption", + "name": "client_id", + "type": "int", + "description": "The client ID" + }, + { + "name": "error", + "type": "bool", + "description": "Whether to unblock with error" + }, + { + "name": "**kwargs", + "type": "Any", "description": "" } ], "returns": { - "type": "String", - "description": "OK" + "type": "ResponseT", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "long clientUnblock(final long clientId)", + "params": [ + { + "name": "clientId", + "type": "long", + "description": "The client ID" + } + ], + "returns": { + "type": "long", + "description": "Number of unblocked connections" + } + }, + { + "signature": "long clientUnblock(final long clientId, final UnblockType unblockType)", + "params": [ + { + "name": "clientId", + "type": "long", + "description": "The client ID" + }, + { + "name": "unblockType", + "type": "UnblockType", + "description": "Unblock type" + } + ], + "returns": { + "type": "long", + "description": "Number of unblocked connections" } } ], "go-redis": [ { - "signature": "ClusterFailover(ctx context.Context)", + "signature": "ClientUnblock(ctx context.Context, id int64) *IntCmd", "params": [ { "name": "ctx", "type": "context.Context", - "description": "" + "description": "Context" + }, + { + "name": "id", + "type": "int64", + "description": "Client ID to unblock" } ], "returns": { - "type": "*StatusCmd", + "type": "*IntCmd", + "description": "" + } + }, + { + "signature": "ClientUnblockWithError(ctx context.Context, id int64) *IntCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "id", + "type": "int64", + "description": "Client ID to unblock with error" + } + ], + "returns": { + "type": "*IntCmd", "description": "" } } @@ -22196,49 +22799,64 @@ "node_redis": [], "lettuce_sync": [ { - "signature": "String clusterFailover(boolean force)", + "signature": "Long clientUnblock(long id, UnblockType type)", "params": [ { - "name": "force", - "type": "boolean", - "description": "Force failover" + "name": "id", + "type": "long", + "description": "The client ID" + }, + { + "name": "type", + "type": "UnblockType", + "description": "Unblock type" } ], "returns": { - "type": "String", - "description": "OK" + "type": "Long", + "description": "Number of unblocked connections" } } ], "lettuce_async": [ { - "signature": "RedisFuture clusterFailover(boolean force)", + "signature": "RedisFuture clientUnblock(long id, UnblockType type)", "params": [ { - "name": "force", - "type": "boolean", - "description": "Force failover" + "name": "id", + "type": "long", + "description": "The client ID" + }, + { + "name": "type", + "type": "UnblockType", + "description": "Unblock type" } ], "returns": { - "type": "RedisFuture", - "description": "OK" + "type": "RedisFuture", + "description": "Number of unblocked connections" } } ], "lettuce_reactive": [ { - "signature": "Mono clusterFailover(boolean force)", + "signature": "Mono clientUnblock(long id, UnblockType type)", "params": [ { - "name": "force", - "type": "boolean", - "description": "Force failover" + "name": "id", + "type": "long", + "description": "The client ID" + }, + { + "name": "type", + "type": "UnblockType", + "description": "Unblock type" } ], "returns": { - "type": "Mono", - "description": "OK" + "type": "Mono", + "description": "Number of unblocked connections" } } ], @@ -22249,42 +22867,117 @@ "redis_rs_async": [] } }, - "CLUSTER FLUSHSLOTS": { + "CLIENT UNPAUSE": { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], + "redis_py": [ + { + "signature": "client_unpause(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "str", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String clientUnpause()", + "params": [], + "returns": { + "type": "String", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ClientUnpause(ctx context.Context) *BoolCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*BoolCmd", + "description": "" + } + } + ], "node_redis": [], "lettuce_sync": [ { - "signature": "String clusterFlushslots()", + "signature": "String clientUnpause()", "params": [], "returns": { "type": "String", - "description": "OK" + "description": "" } } ], "lettuce_async": [ { - "signature": "RedisFuture clusterFlushslots()", + "signature": "RedisFuture clientUnpause()", "params": [], "returns": { "type": "RedisFuture", - "description": "OK" + "description": "" } } ], "lettuce_reactive": [ { - "signature": "Mono clusterFlushslots()", + "signature": "Mono clientUnpause()", "params": [], "returns": { "type": "Mono", - "description": "OK" + "description": "" + } + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "client(string $subcommand, ...$args)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "string", + "description": "" } } ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLIENT": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], "nredisstack_sync": [], "nredisstack_async": [], "php": [], @@ -22292,16 +22985,16 @@ "redis_rs_async": [] } }, - "CLUSTER FORGET": { + "CLUSTER ADDSLOTS": { "api_calls": { "redis_py": [], "jedis": [ { - "signature": "String clusterForget(final String nodeId)", + "signature": "String clusterAddSlots(final int... slots)", "params": [ { - "name": "nodeId", - "type": "String", + "name": "slots", + "type": "int...", "description": "" } ], @@ -22313,7 +23006,7 @@ ], "go-redis": [ { - "signature": "ClusterForget(ctx context.Context, nodeID string)", + "signature": "ClusterAddSlots(ctx context.Context, slots ...int)", "params": [ { "name": "ctx", @@ -22321,8 +23014,8 @@ "description": "" }, { - "name": "nodeID", - "type": "string", + "name": "slots", + "type": "...int", "description": "" } ], @@ -22334,7 +23027,7 @@ ], "node_redis": [ { - "signature": "parseCommand(parser: CommandParser, nodeId: RedisArgument)", + "signature": "parseCommand(parser: CommandParser, slots: number | Array)", "params": [ { "name": "parser", @@ -22342,9 +23035,9 @@ "description": "The Redis command parser" }, { - "name": "nodeId", - "type": "RedisArgument", - "description": "The ID of the node to remove" + "name": "slots", + "type": "number | Array", + "description": "One or more hash slots to be assigned" } ], "returns": { @@ -22355,12 +23048,12 @@ ], "lettuce_sync": [ { - "signature": "String clusterForget(String nodeId)", + "signature": "String clusterAddSlots(int... slots)", "params": [ { - "name": "nodeId", - "type": "String", - "description": "The ID of the node to remove" + "name": "slots", + "type": "int...", + "description": "One or more hash slots to be assigned" } ], "returns": { @@ -22371,12 +23064,12 @@ ], "lettuce_async": [ { - "signature": "RedisFuture clusterForget(String nodeId)", + "signature": "RedisFuture clusterAddSlots(int... slots)", "params": [ { - "name": "nodeId", - "type": "String", - "description": "The ID of the node to remove" + "name": "slots", + "type": "int...", + "description": "One or more hash slots to be assigned" } ], "returns": { @@ -22387,12 +23080,12 @@ ], "lettuce_reactive": [ { - "signature": "Mono clusterForget(String nodeId)", + "signature": "Mono clusterAddSlots(int... slots)", "params": [ { - "name": "nodeId", - "type": "String", - "description": "The ID of the node to remove" + "name": "slots", + "type": "int...", + "description": "One or more hash slots to be assigned" } ], "returns": { @@ -22408,33 +23101,28 @@ "redis_rs_async": [] } }, - "CLUSTER GETKEYSINSLOT": { + "CLUSTER ADDSLOTSRANGE": { "api_calls": { "redis_py": [], "jedis": [ { - "signature": "List clusterGetKeysInSlot(final int slot, final int count)", + "signature": "String clusterAddSlotsRange(int... ranges)", "params": [ { - "name": "slot", - "type": "int", - "description": "" - }, - { - "name": "count", - "type": "int", + "name": "ranges", + "type": "int...", "description": "" } ], "returns": { - "type": "List", + "type": "String", "description": "OK" } } ], "go-redis": [ { - "signature": "ClusterGetKeysInSlot(ctx context.Context, slot int, count int)", + "signature": "ClusterAddSlotsRange(ctx context.Context, min, max int)", "params": [ { "name": "ctx", @@ -22442,108 +23130,68 @@ "description": "" }, { - "name": "slot", - "type": "int", + "name": "min", + "type": "Any", "description": "" }, { - "name": "count", + "name": "max", "type": "int", "description": "" } ], "returns": { - "type": "*StringSliceCmd", + "type": "*StatusCmd", "description": "" } } ], - "node_redis": [ + "node_redis": [], + "lettuce_sync": [ { - "signature": "parseCommand(parser: CommandParser, slot: number, count: number)", + "signature": "String clusterAddSlotsRange(Range... ranges)", "params": [ { - "name": "parser", - "type": "CommandParser", - "description": "The Redis command parser" - }, - { - "name": "slot", - "type": "number", - "description": "The hash slot to get keys from" - }, - { - "name": "count", - "type": "number", - "description": "Maximum number of keys to return" - } - ], - "returns": { - "type": "ArrayReply", - "description": "" - } - } - ], - "lettuce_sync": [ - { - "signature": "List clusterGetKeysInSlot(int slot, int count)", - "params": [ - { - "name": "slot", - "type": "int", - "description": "The hash slot to get keys from" - }, - { - "name": "count", - "type": "int", - "description": "Maximum number of keys to return" + "name": "ranges", + "type": "Range...", + "description": "One or more slot ranges" } ], "returns": { - "type": "List", - "description": "List of keys in the slot" + "type": "String", + "description": "OK" } } ], "lettuce_async": [ { - "signature": "RedisFuture> clusterGetKeysInSlot(int slot, int count)", + "signature": "RedisFuture clusterAddSlotsRange(Range... ranges)", "params": [ { - "name": "slot", - "type": "int", - "description": "The hash slot to get keys from" - }, - { - "name": "count", - "type": "int", - "description": "Maximum number of keys to return" + "name": "ranges", + "type": "Range...", + "description": "One or more slot ranges" } ], "returns": { - "type": "RedisFuture>", - "description": "List of keys in the slot" + "type": "RedisFuture", + "description": "OK" } } ], "lettuce_reactive": [ { - "signature": "Flux clusterGetKeysInSlot(int slot, int count)", + "signature": "Mono clusterAddSlotsRange(Range... ranges)", "params": [ { - "name": "slot", - "type": "int", - "description": "The hash slot to get keys from" - }, - { - "name": "count", - "type": "int", - "description": "Maximum number of keys to return" + "name": "ranges", + "type": "Range...", + "description": "One or more slot ranges" } ], "returns": { - "type": "Flux", - "description": "List of keys in the slot" + "type": "Mono", + "description": "OK" } } ], @@ -22554,94 +23202,39 @@ "redis_rs_async": [] } }, - "CLUSTER HELP": { + "CLUSTER BUMPEPOCH": { "api_calls": { "redis_py": [], "jedis": [], "go-redis": [], "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLUSTER INFO": { - "api_calls": { - "redis_py": [], - "jedis": [ - { - "signature": "String clusterInfo()", - "params": [], - "returns": { - "type": "String", - "description": "OK" - } - } - ], - "go-redis": [ - { - "signature": "ClusterInfo(ctx context.Context)", - "params": [ - { - "name": "ctx", - "type": "context.Context", - "description": "" - } - ], - "returns": { - "type": "*StringCmd", - "description": "" - } - } - ], - "node_redis": [ - { - "signature": "parseCommand(parser: CommandParser)", - "params": [ - { - "name": "parser", - "type": "CommandParser", - "description": "The Redis command parser" - } - ], - "returns": { - "type": "VerbatimStringReply", - "description": "" - } - } - ], "lettuce_sync": [ { - "signature": "String clusterInfo()", + "signature": "String clusterBumpepoch()", "params": [], "returns": { "type": "String", - "description": "Cluster information" + "description": "BUMPED or STILL" } } ], "lettuce_async": [ { - "signature": "RedisFuture clusterInfo()", + "signature": "RedisFuture clusterBumpepoch()", "params": [], "returns": { "type": "RedisFuture", - "description": "Cluster information" + "description": "BUMPED or STILL" } } ], "lettuce_reactive": [ { - "signature": "Mono clusterInfo()", + "signature": "Mono clusterBumpepoch()", "params": [], "returns": { "type": "Mono", - "description": "Cluster information" + "description": "BUMPED or STILL" } } ], @@ -22652,112 +23245,118 @@ "redis_rs_async": [] } }, - "CLUSTER KEYSLOT": { + "CLUSTER COUNT-FAILURE-REPORTS": { "api_calls": { "redis_py": [], - "jedis": [ + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [ { - "signature": "long clusterKeySlot(final String key)", + "signature": "Long clusterCountFailureReports(String nodeId)", "params": [ { - "name": "key", + "name": "nodeId", "type": "String", - "description": "" + "description": "The node ID" } ], "returns": { - "type": "long", - "description": "OK" + "type": "Long", + "description": "Number of failure reports" } } ], - "go-redis": [ + "lettuce_async": [ { - "signature": "ClusterKeySlot(ctx context.Context, key string)", + "signature": "RedisFuture clusterCountFailureReports(String nodeId)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" - }, - { - "name": "key", - "type": "string", - "description": "" + "name": "nodeId", + "type": "String", + "description": "The node ID" } ], "returns": { - "type": "*IntCmd", - "description": "" + "type": "RedisFuture", + "description": "Number of failure reports" } } ], - "node_redis": [ + "lettuce_reactive": [ { - "signature": "parseCommand(parser: CommandParser, key: RedisArgument)", + "signature": "Mono clusterCountFailureReports(String nodeId)", "params": [ { - "name": "parser", - "type": "CommandParser", - "description": "The Redis command parser" - }, - { - "name": "key", - "type": "RedisArgument", - "description": "The key to get the hash slot for" + "name": "nodeId", + "type": "String", + "description": "The node ID" } ], "returns": { - "type": "NumberReply", - "description": "" + "type": "Mono", + "description": "Number of failure reports" } } ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLUSTER COUNTKEYSINSLOT": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], "lettuce_sync": [ { - "signature": "Long clusterKeyslot(K key)", + "signature": "Long clusterCountKeysInSlot(int slot)", "params": [ { - "name": "key", - "type": "K", - "description": "The key to get the hash slot for" + "name": "slot", + "type": "int", + "description": "The hash slot" } ], "returns": { "type": "Long", - "description": "The hash slot number" + "description": "Number of keys in the slot" } } ], "lettuce_async": [ { - "signature": "RedisFuture clusterKeyslot(K key)", + "signature": "RedisFuture clusterCountKeysInSlot(int slot)", "params": [ { - "name": "key", - "type": "K", - "description": "The key to get the hash slot for" + "name": "slot", + "type": "int", + "description": "The hash slot" } ], "returns": { "type": "RedisFuture", - "description": "The hash slot number" + "description": "Number of keys in the slot" } } ], "lettuce_reactive": [ { - "signature": "Mono clusterKeyslot(K key)", + "signature": "Mono clusterCountKeysInSlot(int slot)", "params": [ { - "name": "key", - "type": "K", - "description": "The key to get the hash slot for" + "name": "slot", + "type": "int", + "description": "The hash slot" } ], "returns": { "type": "Mono", - "description": "The hash slot number" + "description": "Number of keys in the slot" } } ], @@ -22768,39 +23367,92 @@ "redis_rs_async": [] } }, - "CLUSTER LINKS": { + "CLUSTER DELSLOTS": { "api_calls": { "redis_py": [], - "jedis": [], - "go-redis": [], + "jedis": [ + { + "signature": "String clusterDelSlots(final int... slots)", + "params": [ + { + "name": "slots", + "type": "int...", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "OK" + } + } + ], + "go-redis": [ + { + "signature": "ClusterDelSlots(ctx context.Context, slots ...int)", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "slots", + "type": "...int", + "description": "" + } + ], + "returns": { + "type": "*StatusCmd", + "description": "" + } + } + ], "node_redis": [], "lettuce_sync": [ { - "signature": "List clusterLinks()", - "params": [], + "signature": "String clusterDelSlots(int... slots)", + "params": [ + { + "name": "slots", + "type": "int...", + "description": "One or more hash slots to be removed" + } + ], "returns": { - "type": "List", - "description": "Cluster links information" + "type": "String", + "description": "OK" } } ], "lettuce_async": [ { - "signature": "RedisFuture> clusterLinks()", - "params": [], + "signature": "RedisFuture clusterDelSlots(int... slots)", + "params": [ + { + "name": "slots", + "type": "int...", + "description": "One or more hash slots to be removed" + } + ], "returns": { - "type": "RedisFuture>", - "description": "Cluster links information" + "type": "RedisFuture", + "description": "OK" } } ], "lettuce_reactive": [ { - "signature": "Mono> clusterLinks()", - "params": [], + "signature": "Mono clusterDelSlots(int... slots)", + "params": [ + { + "name": "slots", + "type": "int...", + "description": "One or more hash slots to be removed" + } + ], "returns": { - "type": "Mono>", - "description": "Cluster links information" + "type": "Mono", + "description": "OK" } } ], @@ -22811,21 +23463,16 @@ "redis_rs_async": [] } }, - "CLUSTER MEET": { + "CLUSTER DELSLOTSRANGE": { "api_calls": { "redis_py": [], "jedis": [ { - "signature": "String clusterMeet(final String ip, final int port)", + "signature": "String clusterDelSlotsRange(int... ranges)", "params": [ { - "name": "ip", - "type": "String", - "description": "" - }, - { - "name": "port", - "type": "int", + "name": "ranges", + "type": "int...", "description": "" } ], @@ -22837,7 +23484,7 @@ ], "go-redis": [ { - "signature": "ClusterMeet(ctx context.Context, host, port string)", + "signature": "ClusterDelSlotsRange(ctx context.Context, min, max int)", "params": [ { "name": "ctx", @@ -22845,13 +23492,13 @@ "description": "" }, { - "name": "host", + "name": "min", "type": "Any", "description": "" }, { - "name": "port", - "type": "string", + "name": "max", + "type": "int", "description": "" } ], @@ -22861,45 +23508,15 @@ } } ], - "node_redis": [ - { - "signature": "parseCommand(parser: CommandParser, host: string, port: number)", - "params": [ - { - "name": "parser", - "type": "CommandParser", - "description": "The Redis command parser" - }, - { - "name": "host", - "type": "string", - "description": "Host name or IP address of the node" - }, - { - "name": "port", - "type": "number", - "description": "TCP port of the node" - } - ], - "returns": { - "type": "SimpleStringReply<'OK'>", - "description": "" - } - } - ], + "node_redis": [], "lettuce_sync": [ { - "signature": "String clusterMeet(String ip, int port)", + "signature": "String clusterDelSlotsRange(Range... ranges)", "params": [ { - "name": "ip", - "type": "String", - "description": "Host name or IP address of the node" - }, - { - "name": "port", - "type": "int", - "description": "TCP port of the node" + "name": "ranges", + "type": "Range...", + "description": "One or more slot ranges" } ], "returns": { @@ -22910,17 +23527,12 @@ ], "lettuce_async": [ { - "signature": "RedisFuture clusterMeet(String ip, int port)", + "signature": "RedisFuture clusterDelSlotsRange(Range... ranges)", "params": [ { - "name": "ip", - "type": "String", - "description": "Host name or IP address of the node" - }, - { - "name": "port", - "type": "int", - "description": "TCP port of the node" + "name": "ranges", + "type": "Range...", + "description": "One or more slot ranges" } ], "returns": { @@ -22931,17 +23543,12 @@ ], "lettuce_reactive": [ { - "signature": "Mono clusterMeet(String ip, int port)", + "signature": "Mono clusterDelSlotsRange(Range... ranges)", "params": [ { - "name": "ip", - "type": "String", - "description": "Host name or IP address of the node" - }, - { - "name": "port", - "type": "int", - "description": "TCP port of the node" + "name": "ranges", + "type": "Range...", + "description": "One or more slot ranges" } ], "returns": { @@ -22957,38 +23564,36 @@ "redis_rs_async": [] } }, - "CLUSTER MIGRATION": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLUSTER MYID": { + "CLUSTER FAILOVER": { "api_calls": { "redis_py": [], "jedis": [ { - "signature": "String clusterMyId()", + "signature": "String clusterFailover()", "params": [], "returns": { "type": "String", "description": "OK" } + }, + { + "signature": "String clusterFailover(ClusterFailoverOption failoverOption)", + "params": [ + { + "name": "failoverOption", + "type": "ClusterFailoverOption", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "OK" + } } ], "go-redis": [ { - "signature": "ClusterMyID(ctx context.Context)", + "signature": "ClusterFailover(ctx context.Context)", "params": [ { "name": "ctx", @@ -22997,7 +23602,7 @@ } ], "returns": { - "type": "*StringCmd", + "type": "*StatusCmd", "description": "" } } @@ -23005,31 +23610,49 @@ "node_redis": [], "lettuce_sync": [ { - "signature": "String clusterMyId()", - "params": [], + "signature": "String clusterFailover(boolean force)", + "params": [ + { + "name": "force", + "type": "boolean", + "description": "Force failover" + } + ], "returns": { "type": "String", - "description": "The node ID" + "description": "OK" } } ], "lettuce_async": [ { - "signature": "RedisFuture clusterMyId()", - "params": [], + "signature": "RedisFuture clusterFailover(boolean force)", + "params": [ + { + "name": "force", + "type": "boolean", + "description": "Force failover" + } + ], "returns": { "type": "RedisFuture", - "description": "The node ID" + "description": "OK" } } ], "lettuce_reactive": [ { - "signature": "Mono clusterMyId()", - "params": [], + "signature": "Mono clusterFailover(boolean force)", + "params": [ + { + "name": "force", + "type": "boolean", + "description": "Force failover" + } + ], "returns": { "type": "Mono", - "description": "The node ID" + "description": "OK" } } ], @@ -23040,7 +23663,7 @@ "redis_rs_async": [] } }, - "CLUSTER MYSHARDID": { + "CLUSTER FLUSHSLOTS": { "api_calls": { "redis_py": [], "jedis": [], @@ -23048,31 +23671,31 @@ "node_redis": [], "lettuce_sync": [ { - "signature": "String clusterMyShardId()", + "signature": "String clusterFlushslots()", "params": [], "returns": { "type": "String", - "description": "The shard ID" + "description": "OK" } } ], "lettuce_async": [ { - "signature": "RedisFuture clusterMyShardId()", + "signature": "RedisFuture clusterFlushslots()", "params": [], "returns": { "type": "RedisFuture", - "description": "The shard ID" + "description": "OK" } } ], "lettuce_reactive": [ { - "signature": "Mono clusterMyShardId()", + "signature": "Mono clusterFlushslots()", "params": [], "returns": { "type": "Mono", - "description": "The shard ID" + "description": "OK" } } ], @@ -23083,13 +23706,19 @@ "redis_rs_async": [] } }, - "CLUSTER NODES": { + "CLUSTER FORGET": { "api_calls": { "redis_py": [], "jedis": [ { - "signature": "String clusterNodes()", - "params": [], + "signature": "String clusterForget(final String nodeId)", + "params": [ + { + "name": "nodeId", + "type": "String", + "description": "" + } + ], "returns": { "type": "String", "description": "OK" @@ -23098,124 +23727,91 @@ ], "go-redis": [ { - "signature": "ClusterNodes(ctx context.Context)", + "signature": "ClusterForget(ctx context.Context, nodeID string)", "params": [ { "name": "ctx", "type": "context.Context", "description": "" - } - ], + }, + { + "name": "nodeID", + "type": "string", + "description": "" + } + ], "returns": { - "type": "*StringCmd", + "type": "*StatusCmd", "description": "" } } ], "node_redis": [ { - "signature": "parseCommand(parser: CommandParser)", + "signature": "parseCommand(parser: CommandParser, nodeId: RedisArgument)", "params": [ { "name": "parser", "type": "CommandParser", "description": "The Redis command parser" + }, + { + "name": "nodeId", + "type": "RedisArgument", + "description": "The ID of the node to remove" } ], "returns": { - "type": "VerbatimStringReply", + "type": "SimpleStringReply<'OK'>", "description": "" } } ], "lettuce_sync": [ { - "signature": "String clusterNodes()", - "params": [], - "returns": { - "type": "String", - "description": "Cluster nodes information" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture clusterNodes()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "Cluster nodes information" - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono clusterNodes()", - "params": [], - "returns": { - "type": "Mono", - "description": "Cluster nodes information" - } - } - ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLUSTER REPLICAS": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [ - { - "signature": "String clusterReplicas(String nodeId)", + "signature": "String clusterForget(String nodeId)", "params": [ { "name": "nodeId", "type": "String", - "description": "The node ID" + "description": "The ID of the node to remove" } ], "returns": { "type": "String", - "description": "Replica nodes information" + "description": "OK" } } ], "lettuce_async": [ { - "signature": "RedisFuture clusterReplicas(String nodeId)", + "signature": "RedisFuture clusterForget(String nodeId)", "params": [ { "name": "nodeId", "type": "String", - "description": "The node ID" + "description": "The ID of the node to remove" } ], "returns": { "type": "RedisFuture", - "description": "Replica nodes information" + "description": "OK" } } ], "lettuce_reactive": [ { - "signature": "Mono clusterReplicas(String nodeId)", + "signature": "Mono clusterForget(String nodeId)", "params": [ { "name": "nodeId", "type": "String", - "description": "The node ID" + "description": "The ID of the node to remove" } ], "returns": { "type": "Mono", - "description": "Replica nodes information" + "description": "OK" } } ], @@ -23226,28 +23822,33 @@ "redis_rs_async": [] } }, - "CLUSTER REPLICATE": { + "CLUSTER GETKEYSINSLOT": { "api_calls": { "redis_py": [], "jedis": [ { - "signature": "String clusterReplicate(final String nodeId)", + "signature": "List clusterGetKeysInSlot(final int slot, final int count)", "params": [ { - "name": "nodeId", - "type": "String", + "name": "slot", + "type": "int", + "description": "" + }, + { + "name": "count", + "type": "int", "description": "" } ], "returns": { - "type": "String", + "type": "List", "description": "OK" } } ], "go-redis": [ { - "signature": "ClusterReplicate(ctx context.Context, nodeID string)", + "signature": "ClusterGetKeysInSlot(ctx context.Context, slot int, count int)", "params": [ { "name": "ctx", @@ -23255,20 +23856,25 @@ "description": "" }, { - "name": "nodeID", - "type": "string", + "name": "slot", + "type": "int", + "description": "" + }, + { + "name": "count", + "type": "int", "description": "" } ], "returns": { - "type": "*StatusCmd", + "type": "*StringSliceCmd", "description": "" } } ], "node_redis": [ { - "signature": "parseCommand(parser: CommandParser, nodeId: RedisArgument)", + "signature": "parseCommand(parser: CommandParser, slot: number, count: number)", "params": [ { "name": "parser", @@ -23276,62 +23882,82 @@ "description": "The Redis command parser" }, { - "name": "nodeId", - "type": "RedisArgument", - "description": "Node ID of the primary node to replicate" + "name": "slot", + "type": "number", + "description": "The hash slot to get keys from" + }, + { + "name": "count", + "type": "number", + "description": "Maximum number of keys to return" } ], "returns": { - "type": "SimpleStringReply", + "type": "ArrayReply", "description": "" } } ], "lettuce_sync": [ { - "signature": "String clusterReplicate(String nodeId)", + "signature": "List clusterGetKeysInSlot(int slot, int count)", "params": [ { - "name": "nodeId", - "type": "String", - "description": "Node ID of the primary node to replicate" + "name": "slot", + "type": "int", + "description": "The hash slot to get keys from" + }, + { + "name": "count", + "type": "int", + "description": "Maximum number of keys to return" } ], "returns": { - "type": "String", - "description": "OK" + "type": "List", + "description": "List of keys in the slot" } } ], "lettuce_async": [ { - "signature": "RedisFuture clusterReplicate(String nodeId)", + "signature": "RedisFuture> clusterGetKeysInSlot(int slot, int count)", "params": [ { - "name": "nodeId", - "type": "String", - "description": "Node ID of the primary node to replicate" + "name": "slot", + "type": "int", + "description": "The hash slot to get keys from" + }, + { + "name": "count", + "type": "int", + "description": "Maximum number of keys to return" } ], "returns": { - "type": "RedisFuture", - "description": "OK" + "type": "RedisFuture>", + "description": "List of keys in the slot" } } ], "lettuce_reactive": [ { - "signature": "Mono clusterReplicate(String nodeId)", + "signature": "Flux clusterGetKeysInSlot(int slot, int count)", "params": [ { - "name": "nodeId", - "type": "String", - "description": "Node ID of the primary node to replicate" + "name": "slot", + "type": "int", + "description": "The hash slot to get keys from" + }, + { + "name": "count", + "type": "int", + "description": "Maximum number of keys to return" } ], "returns": { - "type": "Mono", - "description": "OK" + "type": "Flux", + "description": "List of keys in the slot" } } ], @@ -23342,36 +23968,38 @@ "redis_rs_async": [] } }, - "CLUSTER RESET": { + "CLUSTER HELP": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLUSTER INFO": { "api_calls": { "redis_py": [], "jedis": [ { - "signature": "String clusterReset()", + "signature": "String clusterInfo()", "params": [], "returns": { "type": "String", "description": "OK" } - }, - { - "signature": "String clusterReset(final ClusterResetType resetType)", - "params": [ - { - "name": "resetType", - "type": "ClusterResetType", - "description": "" - } - ], - "returns": { - "type": "String", - "description": "OK" - } } ], "go-redis": [ { - "signature": "ClusterResetSoft(ctx context.Context)", + "signature": "ClusterInfo(ctx context.Context)", "params": [ { "name": "ctx", @@ -23380,71 +24008,54 @@ } ], "returns": { - "type": "*StatusCmd", + "type": "*StringCmd", "description": "" } - }, + } + ], + "node_redis": [ { - "signature": "ClusterResetHard(ctx context.Context)", + "signature": "parseCommand(parser: CommandParser)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" + "name": "parser", + "type": "CommandParser", + "description": "The Redis command parser" } ], "returns": { - "type": "*StatusCmd", + "type": "VerbatimStringReply", "description": "" } } ], - "node_redis": [], "lettuce_sync": [ { - "signature": "String clusterReset(boolean hard)", - "params": [ - { - "name": "hard", - "type": "boolean", - "description": "Hard reset if true, soft reset if false" - } - ], + "signature": "String clusterInfo()", + "params": [], "returns": { "type": "String", - "description": "OK" + "description": "Cluster information" } } ], "lettuce_async": [ { - "signature": "RedisFuture clusterReset(boolean hard)", - "params": [ - { - "name": "hard", - "type": "boolean", - "description": "Hard reset if true, soft reset if false" - } - ], + "signature": "RedisFuture clusterInfo()", + "params": [], "returns": { "type": "RedisFuture", - "description": "OK" + "description": "Cluster information" } } ], "lettuce_reactive": [ { - "signature": "Mono clusterReset(boolean hard)", - "params": [ - { - "name": "hard", - "type": "boolean", - "description": "Hard reset if true, soft reset if false" - } - ], + "signature": "Mono clusterInfo()", + "params": [], "returns": { "type": "Mono", - "description": "OK" + "description": "Cluster information" } } ], @@ -23455,63 +24066,112 @@ "redis_rs_async": [] } }, - "CLUSTER SAVECONFIG": { + "CLUSTER KEYSLOT": { "api_calls": { "redis_py": [], "jedis": [ { - "signature": "String clusterSaveConfig()", - "params": [], + "signature": "long clusterKeySlot(final String key)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + } + ], "returns": { - "type": "String", + "type": "long", "description": "OK" } } ], "go-redis": [ { - "signature": "ClusterSaveConfig(ctx context.Context)", + "signature": "ClusterKeySlot(ctx context.Context, key string)", "params": [ { "name": "ctx", "type": "context.Context", "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" } ], "returns": { - "type": "*StatusCmd", + "type": "*IntCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "parseCommand(parser: CommandParser, key: RedisArgument)", + "params": [ + { + "name": "parser", + "type": "CommandParser", + "description": "The Redis command parser" + }, + { + "name": "key", + "type": "RedisArgument", + "description": "The key to get the hash slot for" + } + ], + "returns": { + "type": "NumberReply", "description": "" } } ], - "node_redis": [], "lettuce_sync": [ { - "signature": "String clusterSaveconfig()", - "params": [], + "signature": "Long clusterKeyslot(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "The key to get the hash slot for" + } + ], "returns": { - "type": "String", - "description": "OK" + "type": "Long", + "description": "The hash slot number" } } ], "lettuce_async": [ { - "signature": "RedisFuture clusterSaveconfig()", - "params": [], + "signature": "RedisFuture clusterKeyslot(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "The key to get the hash slot for" + } + ], "returns": { - "type": "RedisFuture", - "description": "OK" + "type": "RedisFuture", + "description": "The hash slot number" } } ], "lettuce_reactive": [ { - "signature": "Mono clusterSaveconfig()", - "params": [], + "signature": "Mono clusterKeyslot(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "The key to get the hash slot for" + } + ], "returns": { - "type": "Mono", - "description": "OK" + "type": "Mono", + "description": "The hash slot number" } } ], @@ -23522,7 +24182,7 @@ "redis_rs_async": [] } }, - "CLUSTER SET-CONFIG-EPOCH": { + "CLUSTER LINKS": { "api_calls": { "redis_py": [], "jedis": [], @@ -23530,49 +24190,31 @@ "node_redis": [], "lettuce_sync": [ { - "signature": "String clusterSetConfigEpoch(long configEpoch)", - "params": [ - { - "name": "configEpoch", - "type": "long", - "description": "The config epoch value" - } - ], + "signature": "List clusterLinks()", + "params": [], "returns": { - "type": "String", - "description": "OK" + "type": "List", + "description": "Cluster links information" } } ], "lettuce_async": [ { - "signature": "RedisFuture clusterSetConfigEpoch(long configEpoch)", - "params": [ - { - "name": "configEpoch", - "type": "long", - "description": "The config epoch value" - } - ], + "signature": "RedisFuture> clusterLinks()", + "params": [], "returns": { - "type": "RedisFuture", - "description": "OK" + "type": "RedisFuture>", + "description": "Cluster links information" } } ], "lettuce_reactive": [ { - "signature": "Mono clusterSetConfigEpoch(long configEpoch)", - "params": [ - { - "name": "configEpoch", - "type": "long", - "description": "The config epoch value" - } - ], + "signature": "Mono> clusterLinks()", + "params": [], "returns": { - "type": "Mono", - "description": "OK" + "type": "Mono>", + "description": "Cluster links information" } } ], @@ -23583,77 +24225,95 @@ "redis_rs_async": [] } }, - "CLUSTER SETSLOT": { + "CLUSTER MEET": { "api_calls": { "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [ + "jedis": [ { - "signature": "String clusterSetSlotImporting(int slot, String nodeId)", + "signature": "String clusterMeet(final String ip, final int port)", "params": [ { - "name": "slot", - "type": "int", - "description": "The hash slot" + "name": "ip", + "type": "String", + "description": "" }, { - "name": "nodeId", - "type": "String", - "description": "The node ID" + "name": "port", + "type": "int", + "description": "" } ], "returns": { "type": "String", "description": "OK" } - }, + } + ], + "go-redis": [ { - "signature": "String clusterSetSlotMigrating(int slot, String nodeId)", + "signature": "ClusterMeet(ctx context.Context, host, port string)", "params": [ { - "name": "slot", - "type": "int", - "description": "The hash slot" + "name": "ctx", + "type": "context.Context", + "description": "" }, { - "name": "nodeId", - "type": "String", - "description": "The node ID" + "name": "host", + "type": "Any", + "description": "" + }, + { + "name": "port", + "type": "string", + "description": "" } ], "returns": { - "type": "String", - "description": "OK" + "type": "*StatusCmd", + "description": "" } - }, + } + ], + "node_redis": [ { - "signature": "String clusterSetSlotNode(int slot, String nodeId)", + "signature": "parseCommand(parser: CommandParser, host: string, port: number)", "params": [ { - "name": "slot", - "type": "int", - "description": "The hash slot" + "name": "parser", + "type": "CommandParser", + "description": "The Redis command parser" }, { - "name": "nodeId", - "type": "String", - "description": "The node ID" + "name": "host", + "type": "string", + "description": "Host name or IP address of the node" + }, + { + "name": "port", + "type": "number", + "description": "TCP port of the node" } ], "returns": { - "type": "String", - "description": "OK" + "type": "SimpleStringReply<'OK'>", + "description": "" } - }, + } + ], + "lettuce_sync": [ { - "signature": "String clusterSetSlotStable(int slot)", + "signature": "String clusterMeet(String ip, int port)", "params": [ { - "name": "slot", + "name": "ip", + "type": "String", + "description": "Host name or IP address of the node" + }, + { + "name": "port", "type": "int", - "description": "The hash slot" + "description": "TCP port of the node" } ], "returns": { @@ -23664,147 +24324,126 @@ ], "lettuce_async": [ { - "signature": "RedisFuture clusterSetSlotImporting(int slot, String nodeId)", + "signature": "RedisFuture clusterMeet(String ip, int port)", "params": [ { - "name": "slot", - "type": "int", - "description": "The hash slot" + "name": "ip", + "type": "String", + "description": "Host name or IP address of the node" }, { - "name": "nodeId", - "type": "String", - "description": "The node ID" + "name": "port", + "type": "int", + "description": "TCP port of the node" } ], "returns": { "type": "RedisFuture", "description": "OK" } - }, + } + ], + "lettuce_reactive": [ { - "signature": "RedisFuture clusterSetSlotMigrating(int slot, String nodeId)", + "signature": "Mono clusterMeet(String ip, int port)", "params": [ { - "name": "slot", - "type": "int", - "description": "The hash slot" + "name": "ip", + "type": "String", + "description": "Host name or IP address of the node" }, { - "name": "nodeId", - "type": "String", - "description": "The node ID" - } - ], - "returns": { - "type": "RedisFuture", - "description": "OK" - } - }, - { - "signature": "RedisFuture clusterSetSlotNode(int slot, String nodeId)", - "params": [ - { - "name": "slot", + "name": "port", "type": "int", - "description": "The hash slot" - }, - { - "name": "nodeId", - "type": "String", - "description": "The node ID" + "description": "TCP port of the node" } ], "returns": { - "type": "RedisFuture", + "type": "Mono", "description": "OK" } - }, + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLUSTER MIGRATION": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLUSTER MYID": { + "api_calls": { + "redis_py": [], + "jedis": [ { - "signature": "RedisFuture clusterSetSlotStable(int slot)", - "params": [ - { - "name": "slot", - "type": "int", - "description": "The hash slot" - } - ], + "signature": "String clusterMyId()", + "params": [], "returns": { - "type": "RedisFuture", + "type": "String", "description": "OK" } } ], - "lettuce_reactive": [ + "go-redis": [ { - "signature": "Mono clusterSetSlotImporting(int slot, String nodeId)", + "signature": "ClusterMyID(ctx context.Context)", "params": [ { - "name": "slot", - "type": "int", - "description": "The hash slot" - }, - { - "name": "nodeId", - "type": "String", - "description": "The node ID" + "name": "ctx", + "type": "context.Context", + "description": "" } ], "returns": { - "type": "Mono", - "description": "OK" + "type": "*StringCmd", + "description": "" } - }, + } + ], + "node_redis": [], + "lettuce_sync": [ { - "signature": "Mono clusterSetSlotMigrating(int slot, String nodeId)", - "params": [ - { - "name": "slot", - "type": "int", - "description": "The hash slot" - }, - { - "name": "nodeId", - "type": "String", - "description": "The node ID" - } - ], + "signature": "String clusterMyId()", + "params": [], "returns": { - "type": "Mono", - "description": "OK" + "type": "String", + "description": "The node ID" } - }, + } + ], + "lettuce_async": [ { - "signature": "Mono clusterSetSlotNode(int slot, String nodeId)", - "params": [ - { - "name": "slot", - "type": "int", - "description": "The hash slot" - }, - { - "name": "nodeId", - "type": "String", - "description": "The node ID" - } - ], + "signature": "RedisFuture clusterMyId()", + "params": [], "returns": { - "type": "Mono", - "description": "OK" + "type": "RedisFuture", + "description": "The node ID" } - }, + } + ], + "lettuce_reactive": [ { - "signature": "Mono clusterSetSlotStable(int slot)", - "params": [ - { - "name": "slot", - "type": "int", - "description": "The hash slot" - } - ], + "signature": "Mono clusterMyId()", + "params": [], "returns": { "type": "Mono", - "description": "OK" + "description": "The node ID" } } ], @@ -23815,7 +24454,7 @@ "redis_rs_async": [] } }, - "CLUSTER SHARDS": { + "CLUSTER MYSHARDID": { "api_calls": { "redis_py": [], "jedis": [], @@ -23823,31 +24462,31 @@ "node_redis": [], "lettuce_sync": [ { - "signature": "List clusterShards()", + "signature": "String clusterMyShardId()", "params": [], "returns": { - "type": "List", - "description": "Cluster shards information" + "type": "String", + "description": "The shard ID" } } ], "lettuce_async": [ { - "signature": "RedisFuture> clusterShards()", + "signature": "RedisFuture clusterMyShardId()", "params": [], "returns": { - "type": "RedisFuture>", - "description": "Cluster shards information" + "type": "RedisFuture", + "description": "The shard ID" } } ], "lettuce_reactive": [ { - "signature": "Mono> clusterShards()", + "signature": "Mono clusterMyShardId()", "params": [], "returns": { - "type": "Mono>", - "description": "Cluster shards information" + "type": "Mono", + "description": "The shard ID" } } ], @@ -23858,71 +24497,78 @@ "redis_rs_async": [] } }, - "CLUSTER SLAVES": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLUSTER SLOT-STATS": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLUSTER SLOTS": { + "CLUSTER NODES": { "api_calls": { "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], + "jedis": [ + { + "signature": "String clusterNodes()", + "params": [], + "returns": { + "type": "String", + "description": "OK" + } + } + ], + "go-redis": [ + { + "signature": "ClusterNodes(ctx context.Context)", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + } + ], + "returns": { + "type": "*StringCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "parseCommand(parser: CommandParser)", + "params": [ + { + "name": "parser", + "type": "CommandParser", + "description": "The Redis command parser" + } + ], + "returns": { + "type": "VerbatimStringReply", + "description": "" + } + } + ], "lettuce_sync": [ { - "signature": "List clusterSlots()", + "signature": "String clusterNodes()", "params": [], "returns": { - "type": "List", - "description": "Cluster slots information" + "type": "String", + "description": "Cluster nodes information" } } ], "lettuce_async": [ { - "signature": "RedisFuture> clusterSlots()", + "signature": "RedisFuture clusterNodes()", "params": [], "returns": { - "type": "RedisFuture>", - "description": "Cluster slots information" + "type": "RedisFuture", + "description": "Cluster nodes information" } } ], "lettuce_reactive": [ { - "signature": "Mono> clusterSlots()", + "signature": "Mono clusterNodes()", "params": [], "returns": { - "type": "Mono>", - "description": "Cluster slots information" + "type": "Mono", + "description": "Cluster nodes information" } } ], @@ -23933,961 +24579,1054 @@ "redis_rs_async": [] } }, - "CLUSTER SYNCSLOTS": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLUSTER": { + "CLUSTER REPLICAS": { "api_calls": { "redis_py": [], "jedis": [], "go-redis": [], "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CMS.INCRBY": { - "api_calls": { - "redis_py": [ + "lettuce_sync": [ { - "signature": "incrby(key, items, increments)", + "signature": "String clusterReplicas(String nodeId)", "params": [ { - "name": "key", - "type": "str" - }, - { - "name": "items", - "type": "List", - "description": "Items to increment" - }, - { - "name": "increments", - "type": "List", - "description": "Increment values for each item" + "name": "nodeId", + "type": "String", + "description": "The node ID" } ], "returns": { - "type": "List[int]", - "description": "Count of each item after increment" + "type": "String", + "description": "Replica nodes information" } } ], - "jedis": [ + "lettuce_async": [ { - "signature": "cmsIncrBy(String key, String item, long increment)", + "signature": "RedisFuture clusterReplicas(String nodeId)", "params": [ { - "name": "key", - "type": "String" - }, - { - "name": "item", - "type": "String" - }, - { - "name": "increment", - "type": "long" + "name": "nodeId", + "type": "String", + "description": "The node ID" } ], "returns": { - "type": "long", - "description": "Count for item after increment" + "type": "RedisFuture", + "description": "Replica nodes information" } - }, + } + ], + "lettuce_reactive": [ { - "signature": "cmsIncrBy(String key, Map itemIncrements)", + "signature": "Mono clusterReplicas(String nodeId)", "params": [ { - "name": "key", - "type": "String" - }, + "name": "nodeId", + "type": "String", + "description": "The node ID" + } + ], + "returns": { + "type": "Mono", + "description": "Replica nodes information" + } + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLUSTER REPLICATE": { + "api_calls": { + "redis_py": [], + "jedis": [ + { + "signature": "String clusterReplicate(final String nodeId)", + "params": [ { - "name": "itemIncrements", - "type": "Map" + "name": "nodeId", + "type": "String", + "description": "" } ], "returns": { - "type": "List", - "description": "Count of each item after increment" + "type": "String", + "description": "OK" } } ], "go-redis": [ { - "signature": "CMSIncrBy(ctx context.Context, key string, elements ...interface{}) *IntSliceCmd", + "signature": "ClusterReplicate(ctx context.Context, nodeID string)", "params": [ { "name": "ctx", - "type": "context.Context" - }, - { - "name": "key", - "type": "string" + "type": "context.Context", + "description": "" }, { - "name": "elements", - "type": "...interface{}", - "description": "Alternating items and increments" + "name": "nodeID", + "type": "string", + "description": "" } ], "returns": { - "type": "*IntSliceCmd", - "description": "Counts after increment" + "type": "*StatusCmd", + "description": "" } } ], "node_redis": [ { - "signature": "CMS.INCRBY(key, items)", + "signature": "parseCommand(parser: CommandParser, nodeId: RedisArgument)", "params": [ { - "name": "key", - "type": "RedisArgument" + "name": "parser", + "type": "CommandParser", + "description": "The Redis command parser" }, { - "name": "items", - "type": "BfIncrByItem | Array", - "description": "{ item, incrementBy }" + "name": "nodeId", + "type": "RedisArgument", + "description": "Node ID of the primary node to replicate" } ], "returns": { - "type": "ArrayReply", - "description": "Counts after increment" + "type": "SimpleStringReply", + "description": "" } } ], - "nredisstack_sync": [ + "lettuce_sync": [ { - "signature": "IncrBy(RedisKey key, RedisValue item, long increment)", + "signature": "String clusterReplicate(String nodeId)", "params": [ { - "name": "key", - "type": "RedisKey" - }, - { - "name": "item", - "type": "RedisValue" - }, - { - "name": "increment", - "type": "long" + "name": "nodeId", + "type": "String", + "description": "Node ID of the primary node to replicate" } ], "returns": { - "type": "long", - "description": "Count after increment" + "type": "String", + "description": "OK" } - }, + } + ], + "lettuce_async": [ { - "signature": "IncrBy(RedisKey key, Tuple[] itemIncrements)", + "signature": "RedisFuture clusterReplicate(String nodeId)", "params": [ { - "name": "key", - "type": "RedisKey" - }, - { - "name": "itemIncrements", - "type": "Tuple[]" + "name": "nodeId", + "type": "String", + "description": "Node ID of the primary node to replicate" } ], "returns": { - "type": "long[]", - "description": "Counts after increment" + "type": "RedisFuture", + "description": "OK" } } ], - "nredisstack_async": [ + "lettuce_reactive": [ { - "signature": "IncrByAsync(RedisKey key, RedisValue item, long increment)", + "signature": "Mono clusterReplicate(String nodeId)", "params": [ { - "name": "key", - "type": "RedisKey" - }, - { - "name": "item", - "type": "RedisValue" - }, - { - "name": "increment", - "type": "long" + "name": "nodeId", + "type": "String", + "description": "Node ID of the primary node to replicate" } ], "returns": { - "type": "Task", - "description": "Count after increment" + "type": "Mono", + "description": "OK" + } + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLUSTER RESET": { + "api_calls": { + "redis_py": [], + "jedis": [ + { + "signature": "String clusterReset()", + "params": [], + "returns": { + "type": "String", + "description": "OK" } }, { - "signature": "IncrByAsync(RedisKey key, Tuple[] itemIncrements)", + "signature": "String clusterReset(final ClusterResetType resetType)", "params": [ { - "name": "key", - "type": "RedisKey" - }, - { - "name": "itemIncrements", - "type": "Tuple[]" + "name": "resetType", + "type": "ClusterResetType", + "description": "" } ], "returns": { - "type": "Task", - "description": "Counts after increment" + "type": "String", + "description": "OK" } } ], - "php": [ + "go-redis": [ { - "signature": "cmsincrby($key, ...$itemsAndIncrements)", + "signature": "ClusterResetSoft(ctx context.Context)", "params": [ { - "name": "key", - "type": "string" - }, - { - "name": "itemsAndIncrements", - "type": "mixed...", - "description": "Alternating items and increments" + "name": "ctx", + "type": "context.Context", + "description": "" } ], "returns": { - "type": "array", - "description": "Counts after increment" + "type": "*StatusCmd", + "description": "" } - } - ] - } - }, - "CMS.INFO": { - "api_calls": { - "redis_py": [ + }, { - "signature": "info(key)", + "signature": "ClusterResetHard(ctx context.Context)", "params": [ { - "name": "key", - "type": "str" + "name": "ctx", + "type": "context.Context", + "description": "" } ], "returns": { - "type": "dict", - "description": "Width, depth, and total count" + "type": "*StatusCmd", + "description": "" } } ], - "jedis": [ + "node_redis": [], + "lettuce_sync": [ { - "signature": "cmsInfo(String key)", + "signature": "String clusterReset(boolean hard)", "params": [ { - "name": "key", - "type": "String" + "name": "hard", + "type": "boolean", + "description": "Hard reset if true, soft reset if false" } ], "returns": { - "type": "Map", - "description": "Width, depth, and total count" + "type": "String", + "description": "OK" } } ], - "go-redis": [ + "lettuce_async": [ { - "signature": "CMSInfo(ctx context.Context, key string) *CMSInfoCmd", + "signature": "RedisFuture clusterReset(boolean hard)", "params": [ { - "name": "ctx", - "type": "context.Context" - }, - { - "name": "key", - "type": "string" + "name": "hard", + "type": "boolean", + "description": "Hard reset if true, soft reset if false" } ], "returns": { - "type": "*CMSInfoCmd", - "description": "CMSInfo with width, depth, count" + "type": "RedisFuture", + "description": "OK" } } ], - "node_redis": [ + "lettuce_reactive": [ { - "signature": "CMS.INFO(key)", + "signature": "Mono clusterReset(boolean hard)", "params": [ { - "name": "key", - "type": "RedisArgument" + "name": "hard", + "type": "boolean", + "description": "Hard reset if true, soft reset if false" } ], "returns": { - "type": "CmsInfoReply", - "description": "{ width, depth, count }" + "type": "Mono", + "description": "OK" } } ], - "nredisstack_sync": [ + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLUSTER SAVECONFIG": { + "api_calls": { + "redis_py": [], + "jedis": [ { - "signature": "Info(RedisKey key)", - "params": [ - { - "name": "key", - "type": "RedisKey" - } - ], + "signature": "String clusterSaveConfig()", + "params": [], "returns": { - "type": "CmsInformation", - "description": "Sketch information" + "type": "String", + "description": "OK" } } ], - "nredisstack_async": [ + "go-redis": [ { - "signature": "InfoAsync(RedisKey key)", + "signature": "ClusterSaveConfig(ctx context.Context)", "params": [ { - "name": "key", - "type": "RedisKey" + "name": "ctx", + "type": "context.Context", + "description": "" } ], "returns": { - "type": "Task", - "description": "Sketch information" + "type": "*StatusCmd", + "description": "" } } ], - "php": [ + "node_redis": [], + "lettuce_sync": [ { - "signature": "cmsinfo($key)", - "params": [ - { - "name": "key", - "type": "string" - } - ], + "signature": "String clusterSaveconfig()", + "params": [], "returns": { - "type": "array", - "description": "Sketch information" + "type": "String", + "description": "OK" } } - ] + ], + "lettuce_async": [ + { + "signature": "RedisFuture clusterSaveconfig()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "OK" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono clusterSaveconfig()", + "params": [], + "returns": { + "type": "Mono", + "description": "OK" + } + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] } }, - "CMS.INITBYDIM": { + "CLUSTER SET-CONFIG-EPOCH": { "api_calls": { - "redis_py": [ + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [ { - "signature": "initbydim(key, width, depth)", + "signature": "String clusterSetConfigEpoch(long configEpoch)", "params": [ { - "name": "key", - "type": "str" - }, - { - "name": "width", - "type": "int", - "description": "Number of counters in each array" - }, - { - "name": "depth", - "type": "int", - "description": "Number of counter-arrays" + "name": "configEpoch", + "type": "long", + "description": "The config epoch value" } ], "returns": { - "type": "bool", - "description": "True if created successfully" + "type": "String", + "description": "OK" } } ], - "jedis": [ + "lettuce_async": [ { - "signature": "cmsInitByDim(String key, long width, long depth)", + "signature": "RedisFuture clusterSetConfigEpoch(long configEpoch)", "params": [ { - "name": "key", - "type": "String" - }, - { - "name": "width", - "type": "long" - }, - { - "name": "depth", - "type": "long" + "name": "configEpoch", + "type": "long", + "description": "The config epoch value" } ], "returns": { - "type": "String", + "type": "RedisFuture", "description": "OK" } } ], - "go-redis": [ + "lettuce_reactive": [ { - "signature": "CMSInitByDim(ctx context.Context, key string, width, depth int64) *StatusCmd", + "signature": "Mono clusterSetConfigEpoch(long configEpoch)", "params": [ { - "name": "ctx", - "type": "context.Context" - }, - { - "name": "key", - "type": "string" - }, - { - "name": "width", - "type": "int64" - }, - { - "name": "depth", - "type": "int64" + "name": "configEpoch", + "type": "long", + "description": "The config epoch value" } ], "returns": { - "type": "*StatusCmd", - "description": "Status command result" + "type": "Mono", + "description": "OK" } } ], - "node_redis": [ + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLUSTER SETSLOT": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [ { - "signature": "CMS.INITBYDIM(key, width, depth)", + "signature": "String clusterSetSlotImporting(int slot, String nodeId)", "params": [ { - "name": "key", - "type": "RedisArgument" - }, - { - "name": "width", - "type": "number", - "description": "Number of counters in each array" + "name": "slot", + "type": "int", + "description": "The hash slot" }, { - "name": "depth", - "type": "number", - "description": "Number of counter arrays" + "name": "nodeId", + "type": "String", + "description": "The node ID" } ], "returns": { - "type": "SimpleStringReply<'OK'>", - "description": "OK on success" + "type": "String", + "description": "OK" } - } - ], - "nredisstack_sync": [ + }, { - "signature": "InitByDim(RedisKey key, long width, long depth)", + "signature": "String clusterSetSlotMigrating(int slot, String nodeId)", "params": [ { - "name": "key", - "type": "RedisKey" - }, - { - "name": "width", - "type": "long" + "name": "slot", + "type": "int", + "description": "The hash slot" }, { - "name": "depth", - "type": "long" + "name": "nodeId", + "type": "String", + "description": "The node ID" } ], "returns": { - "type": "bool", - "description": "True if created successfully" + "type": "String", + "description": "OK" } - } - ], - "nredisstack_async": [ + }, { - "signature": "InitByDimAsync(RedisKey key, long width, long depth)", + "signature": "String clusterSetSlotNode(int slot, String nodeId)", "params": [ { - "name": "key", - "type": "RedisKey" - }, - { - "name": "width", - "type": "long" + "name": "slot", + "type": "int", + "description": "The hash slot" }, { - "name": "depth", - "type": "long" + "name": "nodeId", + "type": "String", + "description": "The node ID" } ], "returns": { - "type": "Task", - "description": "True if created successfully" + "type": "String", + "description": "OK" } - } - ], - "php": [ + }, { - "signature": "cmsinitbydim($key, $width, $depth)", + "signature": "String clusterSetSlotStable(int slot)", "params": [ { - "name": "key", - "type": "string" - }, - { - "name": "width", - "type": "int" - }, - { - "name": "depth", - "type": "int" + "name": "slot", + "type": "int", + "description": "The hash slot" } ], "returns": { - "type": "string", + "type": "String", "description": "OK" } } - ] - } - }, - "CMS.INITBYPROB": { - "api_calls": { - "redis_py": [ + ], + "lettuce_async": [ { - "signature": "initbyprob(key, error, probability)", + "signature": "RedisFuture clusterSetSlotImporting(int slot, String nodeId)", "params": [ { - "name": "key", - "type": "str" - }, - { - "name": "error", - "type": "float", - "description": "Estimate size of error as percent of total" + "name": "slot", + "type": "int", + "description": "The hash slot" }, { - "name": "probability", - "type": "float", - "description": "Desired probability for inflated count" + "name": "nodeId", + "type": "String", + "description": "The node ID" } ], "returns": { - "type": "bool", - "description": "True if created successfully" + "type": "RedisFuture", + "description": "OK" } - } - ], - "jedis": [ + }, { - "signature": "cmsInitByProb(String key, double error, double probability)", + "signature": "RedisFuture clusterSetSlotMigrating(int slot, String nodeId)", "params": [ { - "name": "key", - "type": "String" - }, - { - "name": "error", - "type": "double" + "name": "slot", + "type": "int", + "description": "The hash slot" }, { - "name": "probability", - "type": "double" + "name": "nodeId", + "type": "String", + "description": "The node ID" } ], "returns": { - "type": "String", + "type": "RedisFuture", "description": "OK" } - } - ], - "go-redis": [ + }, { - "signature": "CMSInitByProb(ctx context.Context, key string, errorRate, probability float64) *StatusCmd", + "signature": "RedisFuture clusterSetSlotNode(int slot, String nodeId)", "params": [ { - "name": "ctx", - "type": "context.Context" - }, - { - "name": "key", - "type": "string" - }, - { - "name": "errorRate", - "type": "float64" + "name": "slot", + "type": "int", + "description": "The hash slot" }, { - "name": "probability", - "type": "float64" + "name": "nodeId", + "type": "String", + "description": "The node ID" } ], "returns": { - "type": "*StatusCmd", - "description": "Status command result" + "type": "RedisFuture", + "description": "OK" } - } - ], - "node_redis": [ + }, { - "signature": "CMS.INITBYPROB(key, error, probability)", + "signature": "RedisFuture clusterSetSlotStable(int slot)", "params": [ { - "name": "key", - "type": "RedisArgument" - }, - { - "name": "error", - "type": "number", - "description": "Error rate as decimal between 0 and 1" - }, - { - "name": "probability", - "type": "number", - "description": "Probability for inflated count" + "name": "slot", + "type": "int", + "description": "The hash slot" } ], "returns": { - "type": "SimpleStringReply<'OK'>", - "description": "OK on success" + "type": "RedisFuture", + "description": "OK" } } ], - "nredisstack_sync": [ + "lettuce_reactive": [ { - "signature": "InitByProb(RedisKey key, double error, double probability)", + "signature": "Mono clusterSetSlotImporting(int slot, String nodeId)", "params": [ { - "name": "key", - "type": "RedisKey" - }, - { - "name": "error", - "type": "double" + "name": "slot", + "type": "int", + "description": "The hash slot" }, { - "name": "probability", - "type": "double" + "name": "nodeId", + "type": "String", + "description": "The node ID" } ], "returns": { - "type": "bool", - "description": "True if created successfully" + "type": "Mono", + "description": "OK" } - } - ], - "nredisstack_async": [ + }, { - "signature": "InitByProbAsync(RedisKey key, double error, double probability)", + "signature": "Mono clusterSetSlotMigrating(int slot, String nodeId)", "params": [ { - "name": "key", - "type": "RedisKey" - }, - { - "name": "error", - "type": "double" + "name": "slot", + "type": "int", + "description": "The hash slot" }, { - "name": "probability", - "type": "double" + "name": "nodeId", + "type": "String", + "description": "The node ID" } ], "returns": { - "type": "Task", - "description": "True if created successfully" + "type": "Mono", + "description": "OK" } - } - ], - "php": [ + }, { - "signature": "cmsinitbyprob($key, $error, $probability)", + "signature": "Mono clusterSetSlotNode(int slot, String nodeId)", "params": [ { - "name": "key", - "type": "string" - }, - { - "name": "error", - "type": "float" + "name": "slot", + "type": "int", + "description": "The hash slot" }, { - "name": "probability", - "type": "float" + "name": "nodeId", + "type": "String", + "description": "The node ID" } ], "returns": { - "type": "string", + "type": "Mono", + "description": "OK" + } + }, + { + "signature": "Mono clusterSetSlotStable(int slot)", + "params": [ + { + "name": "slot", + "type": "int", + "description": "The hash slot" + } + ], + "returns": { + "type": "Mono", "description": "OK" } } - ] + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] } }, - "CMS.MERGE": { + "CLUSTER SHARDS": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [ + { + "signature": "List clusterShards()", + "params": [], + "returns": { + "type": "List", + "description": "Cluster shards information" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> clusterShards()", + "params": [], + "returns": { + "type": "RedisFuture>", + "description": "Cluster shards information" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> clusterShards()", + "params": [], + "returns": { + "type": "Mono>", + "description": "Cluster shards information" + } + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLUSTER SLAVES": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLUSTER SLOT-STATS": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLUSTER SLOTS": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [ + { + "signature": "List clusterSlots()", + "params": [], + "returns": { + "type": "List", + "description": "Cluster slots information" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> clusterSlots()", + "params": [], + "returns": { + "type": "RedisFuture>", + "description": "Cluster slots information" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> clusterSlots()", + "params": [], + "returns": { + "type": "Mono>", + "description": "Cluster slots information" + } + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLUSTER SYNCSLOTS": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CLUSTER": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CMS.INCRBY": { "api_calls": { "redis_py": [ { - "signature": "merge(destKey, numKeys, srcKeys, weights=[])", + "signature": "incrby(key, items, increments)", "params": [ { - "name": "destKey", + "name": "key", "type": "str" }, { - "name": "numKeys", - "type": "int" - }, - { - "name": "srcKeys", + "name": "items", "type": "List", - "description": "Source sketch keys" + "description": "Items to increment" }, { - "name": "weights", + "name": "increments", "type": "List", - "description": "Optional weights for each source" + "description": "Increment values for each item" } ], "returns": { - "type": "bool", - "description": "True if merged successfully" + "type": "List[int]", + "description": "Count of each item after increment" } } ], "jedis": [ { - "signature": "cmsMerge(String destKey, String... keys)", + "signature": "cmsIncrBy(String key, String item, long increment)", "params": [ { - "name": "destKey", + "name": "key", "type": "String" }, { - "name": "keys", - "type": "String..." + "name": "item", + "type": "String" + }, + { + "name": "increment", + "type": "long" } ], "returns": { - "type": "String", - "description": "OK" + "type": "long", + "description": "Count for item after increment" } }, { - "signature": "cmsMerge(String destKey, Map keysAndWeights)", + "signature": "cmsIncrBy(String key, Map itemIncrements)", "params": [ { - "name": "destKey", + "name": "key", "type": "String" }, { - "name": "keysAndWeights", + "name": "itemIncrements", "type": "Map" } ], "returns": { - "type": "String", - "description": "OK" + "type": "List", + "description": "Count of each item after increment" } } ], "go-redis": [ { - "signature": "CMSMerge(ctx context.Context, destKey string, sourceKeys ...string) *StatusCmd", - "params": [ - { - "name": "ctx", - "type": "context.Context" - }, - { - "name": "destKey", - "type": "string" - }, - { - "name": "sourceKeys", - "type": "...string" - } - ], - "returns": { - "type": "*StatusCmd", - "description": "Status command result" - } - }, - { - "signature": "CMSMergeWithWeight(ctx context.Context, destKey string, sourceKeys map[string]int64) *StatusCmd", + "signature": "CMSIncrBy(ctx context.Context, key string, elements ...interface{}) *IntSliceCmd", "params": [ { "name": "ctx", "type": "context.Context" }, { - "name": "destKey", + "name": "key", "type": "string" }, { - "name": "sourceKeys", - "type": "map[string]int64" + "name": "elements", + "type": "...interface{}", + "description": "Alternating items and increments" } ], "returns": { - "type": "*StatusCmd", - "description": "Status command result" + "type": "*IntSliceCmd", + "description": "Counts after increment" } } ], "node_redis": [ { - "signature": "CMS.MERGE(destination, source)", + "signature": "CMS.INCRBY(key, items)", "params": [ { - "name": "destination", + "name": "key", "type": "RedisArgument" }, { - "name": "source", - "type": "BfMergeSketches", - "description": "Array of sketch names or sketches with weights" + "name": "items", + "type": "BfIncrByItem | Array", + "description": "{ item, incrementBy }" } ], "returns": { - "type": "SimpleStringReply<'OK'>", - "description": "OK on success" + "type": "ArrayReply", + "description": "Counts after increment" } } ], "nredisstack_sync": [ { - "signature": "Merge(RedisValue destination, long numKeys, RedisValue[] source, long[]? weight = null)", + "signature": "IncrBy(RedisKey key, RedisValue item, long increment)", "params": [ { - "name": "destination", + "name": "key", + "type": "RedisKey" + }, + { + "name": "item", "type": "RedisValue" }, { - "name": "numKeys", + "name": "increment", "type": "long" - }, + } + ], + "returns": { + "type": "long", + "description": "Count after increment" + } + }, + { + "signature": "IncrBy(RedisKey key, Tuple[] itemIncrements)", + "params": [ { - "name": "source", - "type": "RedisValue[]" + "name": "key", + "type": "RedisKey" }, { - "name": "weight", - "type": "long[]?", - "description": "Optional weights" + "name": "itemIncrements", + "type": "Tuple[]" } ], "returns": { - "type": "bool", - "description": "True if merged successfully" + "type": "long[]", + "description": "Counts after increment" } } ], "nredisstack_async": [ { - "signature": "MergeAsync(RedisValue destination, long numKeys, RedisValue[] source, long[]? weight = null)", + "signature": "IncrByAsync(RedisKey key, RedisValue item, long increment)", "params": [ { - "name": "destination", + "name": "key", + "type": "RedisKey" + }, + { + "name": "item", "type": "RedisValue" }, { - "name": "numKeys", + "name": "increment", "type": "long" - }, + } + ], + "returns": { + "type": "Task", + "description": "Count after increment" + } + }, + { + "signature": "IncrByAsync(RedisKey key, Tuple[] itemIncrements)", + "params": [ { - "name": "source", - "type": "RedisValue[]" + "name": "key", + "type": "RedisKey" }, { - "name": "weight", - "type": "long[]?", - "description": "Optional weights" + "name": "itemIncrements", + "type": "Tuple[]" } ], "returns": { - "type": "Task", - "description": "True if merged successfully" + "type": "Task", + "description": "Counts after increment" } } ], "php": [ { - "signature": "cmsmerge($destKey, ...$sourceKeys)", + "signature": "cmsincrby($key, ...$itemsAndIncrements)", "params": [ { - "name": "destKey", + "name": "key", "type": "string" }, { - "name": "sourceKeys", - "type": "string..." + "name": "itemsAndIncrements", + "type": "mixed...", + "description": "Alternating items and increments" } ], "returns": { - "type": "string", - "description": "OK" + "type": "array", + "description": "Counts after increment" } } ] } }, - "CMS.QUERY": { + "CMS.INFO": { "api_calls": { "redis_py": [ { - "signature": "query(key, *items)", + "signature": "info(key)", "params": [ { "name": "key", "type": "str" - }, - { - "name": "items", - "type": "*args" } ], "returns": { - "type": "List[int]", - "description": "Estimated count for each item" + "type": "dict", + "description": "Width, depth, and total count" } } ], "jedis": [ { - "signature": "cmsQuery(String key, String... items)", + "signature": "cmsInfo(String key)", "params": [ { "name": "key", "type": "String" - }, - { - "name": "items", - "type": "String..." } ], "returns": { - "type": "List", - "description": "Count for one or more items" + "type": "Map", + "description": "Width, depth, and total count" } } ], "go-redis": [ { - "signature": "CMSQuery(ctx context.Context, key string, elements ...interface{}) *IntSliceCmd", + "signature": "CMSInfo(ctx context.Context, key string) *CMSInfoCmd", "params": [ { "name": "ctx", @@ -24896,776 +25635,776 @@ { "name": "key", "type": "string" - }, - { - "name": "elements", - "type": "...interface{}" } ], "returns": { - "type": "*IntSliceCmd", - "description": "Estimated counts" + "type": "*CMSInfoCmd", + "description": "CMSInfo with width, depth, count" } } ], "node_redis": [ { - "signature": "CMS.QUERY(key, items)", + "signature": "CMS.INFO(key)", "params": [ { "name": "key", "type": "RedisArgument" - }, - { - "name": "items", - "type": "RedisVariadicArgument" } ], "returns": { - "type": "ArrayReply", - "description": "Counts for each item" + "type": "CmsInfoReply", + "description": "{ width, depth, count }" } } ], "nredisstack_sync": [ { - "signature": "Query(RedisKey key, params RedisValue[] items)", + "signature": "Info(RedisKey key)", "params": [ { "name": "key", "type": "RedisKey" - }, - { - "name": "items", - "type": "params RedisValue[]" } ], "returns": { - "type": "long[]", - "description": "Estimated counts" + "type": "CmsInformation", + "description": "Sketch information" } } ], "nredisstack_async": [ { - "signature": "QueryAsync(RedisKey key, params RedisValue[] items)", + "signature": "InfoAsync(RedisKey key)", "params": [ { "name": "key", "type": "RedisKey" - }, - { - "name": "items", - "type": "params RedisValue[]" } ], "returns": { - "type": "Task", - "description": "Estimated counts" + "type": "Task", + "description": "Sketch information" } } ], "php": [ { - "signature": "cmsquery($key, ...$items)", + "signature": "cmsinfo($key)", "params": [ { "name": "key", "type": "string" - }, - { - "name": "items", - "type": "string..." } ], "returns": { "type": "array", - "description": "Estimated counts" + "description": "Sketch information" } } ] } }, - "COMMAND COUNT": { + "CMS.INITBYDIM": { "api_calls": { "redis_py": [ { - "signature": "command_count(**kwargs)", + "signature": "initbydim(key, width, depth)", "params": [ { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "key", + "type": "str" + }, + { + "name": "width", + "type": "int", + "description": "Number of counters in each array" + }, + { + "name": "depth", + "type": "int", + "description": "Number of counter-arrays" } ], "returns": { - "type": "int", - "description": "" + "type": "bool", + "description": "True if created successfully" } } ], "jedis": [ { - "signature": "Long commandCount()", - "params": [], + "signature": "cmsInitByDim(String key, long width, long depth)", + "params": [ + { + "name": "key", + "type": "String" + }, + { + "name": "width", + "type": "long" + }, + { + "name": "depth", + "type": "long" + } + ], "returns": { - "type": "Long", - "description": "" + "type": "String", + "description": "OK" } } ], "go-redis": [ { - "signature": "CommandCount(ctx context.Context) *IntCmd", + "signature": "CMSInitByDim(ctx context.Context, key string, width, depth int64) *StatusCmd", "params": [ { "name": "ctx", - "type": "context.Context", - "description": "Context" + "type": "context.Context" + }, + { + "name": "key", + "type": "string" + }, + { + "name": "width", + "type": "int64" + }, + { + "name": "depth", + "type": "int64" } ], "returns": { - "type": "*IntCmd", - "description": "" + "type": "*StatusCmd", + "description": "Status command result" } } ], "node_redis": [ { - "signature": "commandCount()", - "params": [], + "signature": "CMS.INITBYDIM(key, width, depth)", + "params": [ + { + "name": "key", + "type": "RedisArgument" + }, + { + "name": "width", + "type": "number", + "description": "Number of counters in each array" + }, + { + "name": "depth", + "type": "number", + "description": "Number of counter arrays" + } + ], "returns": { - "type": "NumberReply", - "description": "" + "type": "SimpleStringReply<'OK'>", + "description": "OK on success" } } ], - "lettuce_sync": [ + "nredisstack_sync": [ { - "signature": "Long commandCount()", - "params": [], - "returns": { - "type": "Long", - "description": "" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture commandCount()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "" - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono commandCount()", - "params": [], - "returns": { - "type": "Mono", - "description": "" - } - } - ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ - { - "signature": "command(string $subcommand, ...$args)", + "signature": "InitByDim(RedisKey key, long width, long depth)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" + "name": "key", + "type": "RedisKey" }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "width", + "type": "long" + }, + { + "name": "depth", + "type": "long" } ], "returns": { - "type": "int", - "description": "" + "type": "bool", + "description": "True if created successfully" } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "COMMAND DOCS": { - "api_calls": { - "redis_py": [ + "nredisstack_async": [ { - "signature": "command_docs(*commands, **kwargs)", + "signature": "InitByDimAsync(RedisKey key, long width, long depth)", "params": [ { - "name": "*commands", - "type": "str", - "description": "" + "name": "key", + "type": "RedisKey" }, { - "name": "**kwargs", - "type": "Any", - "description": "" - } - ], - "returns": { - "type": "dict", - "description": "" - } - } - ], - "jedis": [ - { - "signature": "Map commandDocs(String... commands)", - "params": [ + "name": "width", + "type": "long" + }, { - "name": "commands", - "type": "String...", - "description": "" + "name": "depth", + "type": "long" } ], "returns": { - "type": "Map", - "description": "" + "type": "Task", + "description": "True if created successfully" } } ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], "php": [ { - "signature": "command(string $subcommand, ...$args)", + "signature": "cmsinitbydim($key, $width, $depth)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" + "name": "key", + "type": "string" }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "width", + "type": "int" + }, + { + "name": "depth", + "type": "int" } ], "returns": { - "type": "array", - "description": "" + "type": "string", + "description": "OK" } } - ], - "redis_rs_sync": [], - "redis_rs_async": [] + ] } }, - "COMMAND GETKEYS": { + "CMS.INITBYPROB": { "api_calls": { "redis_py": [ { - "signature": "command_getkeys(command: str, *args, **kwargs)", + "signature": "initbyprob(key, error, probability)", "params": [ { - "name": "command", - "type": "str", - "description": "" + "name": "key", + "type": "str" }, { - "name": "*args", - "type": "Any", - "description": "" + "name": "error", + "type": "float", + "description": "Estimate size of error as percent of total" }, { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "probability", + "type": "float", + "description": "Desired probability for inflated count" } ], "returns": { - "type": "list", - "description": "" + "type": "bool", + "description": "True if created successfully" } } ], "jedis": [ { - "signature": "List commandGetKeys(String... args)", + "signature": "cmsInitByProb(String key, double error, double probability)", "params": [ { - "name": "args", - "type": "String...", - "description": "" + "name": "key", + "type": "String" + }, + { + "name": "error", + "type": "double" + }, + { + "name": "probability", + "type": "double" } ], "returns": { - "type": "List", - "description": "" + "type": "String", + "description": "OK" } } ], "go-redis": [ { - "signature": "CommandGetKeys(ctx context.Context, commands ...interface{}) *StringSliceCmd", + "signature": "CMSInitByProb(ctx context.Context, key string, errorRate, probability float64) *StatusCmd", "params": [ { "name": "ctx", - "type": "context.Context", - "description": "Context" + "type": "context.Context" }, { - "name": "commands", - "type": "...interface{}", - "description": "" + "name": "key", + "type": "string" + }, + { + "name": "errorRate", + "type": "float64" + }, + { + "name": "probability", + "type": "float64" } ], "returns": { - "type": "*StringSliceCmd", - "description": "" + "type": "*StatusCmd", + "description": "Status command result" } } ], - "node_redis": [], - "lettuce_sync": [ + "node_redis": [ { - "signature": "List commandGetkeys(String... args)", + "signature": "CMS.INITBYPROB(key, error, probability)", "params": [ { - "name": "args", - "type": "String...", - "description": "" + "name": "key", + "type": "RedisArgument" + }, + { + "name": "error", + "type": "number", + "description": "Error rate as decimal between 0 and 1" + }, + { + "name": "probability", + "type": "number", + "description": "Probability for inflated count" } ], "returns": { - "type": "List", - "description": "" + "type": "SimpleStringReply<'OK'>", + "description": "OK on success" } } ], - "lettuce_async": [ + "nredisstack_sync": [ { - "signature": "RedisFuture> commandGetkeys(String... args)", + "signature": "InitByProb(RedisKey key, double error, double probability)", "params": [ { - "name": "args", - "type": "String...", - "description": "" + "name": "key", + "type": "RedisKey" + }, + { + "name": "error", + "type": "double" + }, + { + "name": "probability", + "type": "double" } ], "returns": { - "type": "RedisFuture>", - "description": "" + "type": "bool", + "description": "True if created successfully" } } ], - "lettuce_reactive": [ + "nredisstack_async": [ { - "signature": "Flux commandGetkeys(String... args)", + "signature": "InitByProbAsync(RedisKey key, double error, double probability)", "params": [ { - "name": "args", - "type": "String...", - "description": "" + "name": "key", + "type": "RedisKey" + }, + { + "name": "error", + "type": "double" + }, + { + "name": "probability", + "type": "double" } ], "returns": { - "type": "Flux", - "description": "" + "type": "Task", + "description": "True if created successfully" } } ], - "nredisstack_sync": [], - "nredisstack_async": [], "php": [ { - "signature": "command(string $subcommand, ...$args)", + "signature": "cmsinitbyprob($key, $error, $probability)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" + "name": "key", + "type": "string" }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "error", + "type": "float" + }, + { + "name": "probability", + "type": "float" } ], "returns": { - "type": "array", - "description": "" + "type": "string", + "description": "OK" } } - ], - "redis_rs_sync": [], - "redis_rs_async": [] + ] } }, - "COMMAND GETKEYSANDFLAGS": { + "CMS.MERGE": { "api_calls": { "redis_py": [ { - "signature": "command_getkeysandflags(command: str, *args, **kwargs)", + "signature": "merge(destKey, numKeys, srcKeys, weights=[])", "params": [ { - "name": "command", - "type": "str", - "description": "" + "name": "destKey", + "type": "str" }, { - "name": "*args", - "type": "Any", - "description": "" + "name": "numKeys", + "type": "int" }, { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "srcKeys", + "type": "List", + "description": "Source sketch keys" + }, + { + "name": "weights", + "type": "List", + "description": "Optional weights for each source" } ], "returns": { - "type": "list", - "description": "" + "type": "bool", + "description": "True if merged successfully" } } ], "jedis": [ { - "signature": "List commandGetKeysAndFlags(String... args)", + "signature": "cmsMerge(String destKey, String... keys)", "params": [ { - "name": "args", - "type": "String...", - "description": "" + "name": "destKey", + "type": "String" + }, + { + "name": "keys", + "type": "String..." } ], "returns": { - "type": "List", - "description": "" + "type": "String", + "description": "OK" } - } - ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + }, { - "signature": "command(string $subcommand, ...$args)", + "signature": "cmsMerge(String destKey, Map keysAndWeights)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" + "name": "destKey", + "type": "String" }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "keysAndWeights", + "type": "Map" } ], "returns": { - "type": "array", - "description": "" + "type": "String", + "description": "OK" } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "COMMAND HELP": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + "go-redis": [ { - "signature": "command(string $subcommand, ...$args)", + "signature": "CMSMerge(ctx context.Context, destKey string, sourceKeys ...string) *StatusCmd", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" + "name": "ctx", + "type": "context.Context" }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "destKey", + "type": "string" + }, + { + "name": "sourceKeys", + "type": "...string" } ], "returns": { - "type": "array", - "description": "" + "type": "*StatusCmd", + "description": "Status command result" } - } - ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "COMMAND INFO": { - "api_calls": { - "redis_py": [ + }, { - "signature": "command_info(*args, **kwargs)", + "signature": "CMSMergeWithWeight(ctx context.Context, destKey string, sourceKeys map[string]int64) *StatusCmd", "params": [ { - "name": "*args", - "type": "str", - "description": "" + "name": "ctx", + "type": "context.Context" }, { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "destKey", + "type": "string" + }, + { + "name": "sourceKeys", + "type": "map[string]int64" } ], "returns": { - "type": "Any", - "description": "" + "type": "*StatusCmd", + "description": "Status command result" } } ], - "jedis": [ + "node_redis": [ { - "signature": "List commandInfo(String... commands)", + "signature": "CMS.MERGE(destination, source)", "params": [ { - "name": "commands", - "type": "String...", - "description": "" + "name": "destination", + "type": "RedisArgument" + }, + { + "name": "source", + "type": "BfMergeSketches", + "description": "Array of sketch names or sketches with weights" } ], "returns": { - "type": "List", - "description": "" + "type": "SimpleStringReply<'OK'>", + "description": "OK on success" } } ], - "go-redis": [ + "nredisstack_sync": [ { - "signature": "CommandInfo(ctx context.Context, commands ...string) *CommandsInfoCmd", + "signature": "Merge(RedisValue destination, long numKeys, RedisValue[] source, long[]? weight = null)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" + "name": "destination", + "type": "RedisValue" }, { - "name": "commands", - "type": "...string", - "description": "" + "name": "numKeys", + "type": "long" + }, + { + "name": "source", + "type": "RedisValue[]" + }, + { + "name": "weight", + "type": "long[]?", + "description": "Optional weights" } ], "returns": { - "type": "*CommandsInfoCmd", - "description": "" + "type": "bool", + "description": "True if merged successfully" } } ], - "node_redis": [ + "nredisstack_async": [ { - "signature": "commandInfo(commands: Array)", + "signature": "MergeAsync(RedisValue destination, long numKeys, RedisValue[] source, long[]? weight = null)", "params": [ { - "name": "commands", - "type": "Array", - "description": "Array of command names to get information about" + "name": "destination", + "type": "RedisValue" + }, + { + "name": "numKeys", + "type": "long" + }, + { + "name": "source", + "type": "RedisValue[]" + }, + { + "name": "weight", + "type": "long[]?", + "description": "Optional weights" } ], "returns": { - "type": "Array", - "description": "" + "type": "Task", + "description": "True if merged successfully" } } ], - "lettuce_sync": [ + "php": [ { - "signature": "List commandInfo(String... commands)", + "signature": "cmsmerge($destKey, ...$sourceKeys)", "params": [ { - "name": "commands", - "type": "String...", - "description": "" + "name": "destKey", + "type": "string" + }, + { + "name": "sourceKeys", + "type": "string..." } ], "returns": { - "type": "List", - "description": "" + "type": "string", + "description": "OK" } } - ], - "lettuce_async": [ - { - "signature": "RedisFuture> commandInfo(String... commands)", - "params": [ + ] + } + }, + "CMS.QUERY": { + "api_calls": { + "redis_py": [ + { + "signature": "query(key, *items)", + "params": [ { - "name": "commands", - "type": "String...", - "description": "" + "name": "key", + "type": "str" + }, + { + "name": "items", + "type": "*args" } ], "returns": { - "type": "RedisFuture>", - "description": "" + "type": "List[int]", + "description": "Estimated count for each item" } } ], - "lettuce_reactive": [ + "jedis": [ { - "signature": "Flux commandInfo(String... commands)", + "signature": "cmsQuery(String key, String... items)", "params": [ { - "name": "commands", - "type": "String...", - "description": "" + "name": "key", + "type": "String" + }, + { + "name": "items", + "type": "String..." } ], "returns": { - "type": "Flux", - "description": "" + "type": "List", + "description": "Count for one or more items" } } ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + "go-redis": [ { - "signature": "command(string $subcommand, ...$args)", + "signature": "CMSQuery(ctx context.Context, key string, elements ...interface{}) *IntSliceCmd", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" + "name": "ctx", + "type": "context.Context" }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "key", + "type": "string" + }, + { + "name": "elements", + "type": "...interface{}" } ], "returns": { - "type": "array", - "description": "" + "type": "*IntSliceCmd", + "description": "Estimated counts" } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "COMMAND LIST": { - "api_calls": { - "redis_py": [ + "node_redis": [ { - "signature": "command_list(module: str | None = None, category: str | None = None, pattern: str | None = None, **kwargs)", + "signature": "CMS.QUERY(key, items)", "params": [ { - "name": "module", - "type": "str | None", - "description": "" - }, - { - "name": "category", - "type": "str | None", - "description": "" - }, - { - "name": "pattern", - "type": "str | None", - "description": "" + "name": "key", + "type": "RedisArgument" }, { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "items", + "type": "RedisVariadicArgument" } ], "returns": { - "type": "list", - "description": "" + "type": "ArrayReply", + "description": "Counts for each item" } } ], - "jedis": [ + "nredisstack_sync": [ { - "signature": "List commandList()", - "params": [], + "signature": "Query(RedisKey key, params RedisValue[] items)", + "params": [ + { + "name": "key", + "type": "RedisKey" + }, + { + "name": "items", + "type": "params RedisValue[]" + } + ], "returns": { - "type": "List", - "description": "" + "type": "long[]", + "description": "Estimated counts" } - }, + } + ], + "nredisstack_async": [ { - "signature": "List commandList(CommandListFilterBy filterBy)", + "signature": "QueryAsync(RedisKey key, params RedisValue[] items)", "params": [ { - "name": "filterBy", - "type": "CommandListFilterBy", - "description": "" + "name": "key", + "type": "RedisKey" + }, + { + "name": "items", + "type": "params RedisValue[]" } ], "returns": { - "type": "List", - "description": "" + "type": "Task", + "description": "Estimated counts" } } ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], "php": [ { - "signature": "command(string $subcommand, ...$args)", + "signature": "cmsquery($key, ...$items)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" + "name": "key", + "type": "string" }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "items", + "type": "string..." } ], "returns": { "type": "array", - "description": "" + "description": "Estimated counts" } } - ], - "redis_rs_sync": [], - "redis_rs_async": [] + ] } }, - "COMMAND": { + "COMMAND COUNT": { "api_calls": { "redis_py": [ { - "signature": "command(**kwargs)", + "signature": "command_count(**kwargs)", "params": [ { "name": "**kwargs", @@ -25674,24 +26413,24 @@ } ], "returns": { - "type": "Any", + "type": "int", "description": "" } } ], "jedis": [ { - "signature": "List command()", + "signature": "Long commandCount()", "params": [], "returns": { - "type": "List", + "type": "Long", "description": "" } } ], "go-redis": [ { - "signature": "Command(ctx context.Context) *CommandsInfoCmd", + "signature": "CommandCount(ctx context.Context) *IntCmd", "params": [ { "name": "ctx", @@ -25700,47 +26439,47 @@ } ], "returns": { - "type": "*CommandsInfoCmd", + "type": "*IntCmd", "description": "" } } ], "node_redis": [ { - "signature": "command()", + "signature": "commandCount()", "params": [], "returns": { - "type": "Array", + "type": "NumberReply", "description": "" } } ], "lettuce_sync": [ { - "signature": "List command()", + "signature": "Long commandCount()", "params": [], "returns": { - "type": "List", + "type": "Long", "description": "" } } ], "lettuce_async": [ { - "signature": "RedisFuture> command()", + "signature": "RedisFuture commandCount()", "params": [], "returns": { - "type": "RedisFuture>", + "type": "RedisFuture", "description": "" } } ], "lettuce_reactive": [ { - "signature": "Flux command()", + "signature": "Mono commandCount()", "params": [], "returns": { - "type": "Flux", + "type": "Mono", "description": "" } } @@ -25763,7 +26502,7 @@ } ], "returns": { - "type": "mixed", + "type": "int", "description": "" } } @@ -25772,20 +26511,15 @@ "redis_rs_async": [] } }, - "CONFIG GET": { + "COMMAND DOCS": { "api_calls": { "redis_py": [ { - "signature": "config_get(pattern: PatternT = \"*\", *args: PatternT, **kwargs)", + "signature": "command_docs(*commands, **kwargs)", "params": [ { - "name": "pattern", - "type": "PatternT", - "description": "Config pattern" - }, - { - "name": "*args", - "type": "PatternT", + "name": "*commands", + "type": "str", "description": "" }, { @@ -25795,173 +26529,254 @@ } ], "returns": { - "type": "ResponseT", + "type": "dict", "description": "" } } ], "jedis": [ { - "signature": "Map configGet(final String pattern)", + "signature": "Map commandDocs(String... commands)", "params": [ { - "name": "pattern", - "type": "String", - "description": "Config pattern" + "name": "commands", + "type": "String...", + "description": "" } ], "returns": { - "type": "Map", - "description": "Bulk reply" + "type": "Map", + "description": "" } - }, + } + ], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ { - "signature": "Map configGet(String... patterns)", + "signature": "command(string $subcommand, ...$args)", "params": [ { - "name": "patterns", - "type": "String...", - "description": "Config patterns" + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" } ], "returns": { - "type": "Map", - "description": "Bulk reply" + "type": "array", + "description": "" } } ], - "go-redis": [ + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "COMMAND GETKEYS": { + "api_calls": { + "redis_py": [ { - "signature": "ConfigGet(ctx context.Context, parameter string) *MapStringStringCmd", + "signature": "command_getkeys(command: str, *args, **kwargs)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" + "name": "command", + "type": "str", + "description": "" }, { - "name": "parameter", - "type": "string", - "description": "Config parameter" + "name": "*args", + "type": "Any", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" } ], "returns": { - "type": "*MapStringStringCmd", + "type": "list", "description": "" } } ], - "node_redis": [ + "jedis": [ { - "signature": "configGet(parameters: RedisVariadicArgument)", + "signature": "List commandGetKeys(String... args)", "params": [ { - "name": "parameters", - "type": "RedisVariadicArgument", - "description": "Pattern or specific configuration parameter names" + "name": "args", + "type": "String...", + "description": "" } ], "returns": { - "type": "Map", + "type": "List", "description": "" } } ], - "lettuce_sync": [ + "go-redis": [ { - "signature": "Map configGet(String parameter)", + "signature": "CommandGetKeys(ctx context.Context, commands ...interface{}) *StringSliceCmd", "params": [ { - "name": "parameter", - "type": "String", + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "commands", + "type": "...interface{}", "description": "" } ], "returns": { - "type": "Map", + "type": "*StringSliceCmd", "description": "" } - }, + } + ], + "node_redis": [], + "lettuce_sync": [ { - "signature": "Map configGet(String... parameters)", + "signature": "List commandGetkeys(String... args)", "params": [ { - "name": "parameters", + "name": "args", "type": "String...", "description": "" } ], "returns": { - "type": "Map", + "type": "List", "description": "" } } ], "lettuce_async": [ { - "signature": "RedisFuture> configGet(String parameter)", + "signature": "RedisFuture> commandGetkeys(String... args)", "params": [ { - "name": "parameter", - "type": "String", + "name": "args", + "type": "String...", "description": "" } ], "returns": { - "type": "RedisFuture>", + "type": "RedisFuture>", "description": "" } - }, + } + ], + "lettuce_reactive": [ { - "signature": "RedisFuture> configGet(String... parameters)", + "signature": "Flux commandGetkeys(String... args)", "params": [ { - "name": "parameters", + "name": "args", "type": "String...", "description": "" } ], "returns": { - "type": "RedisFuture>", + "type": "Flux", "description": "" } } ], - "lettuce_reactive": [ + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ { - "signature": "Mono> configGet(String parameter)", + "signature": "command(string $subcommand, ...$args)", "params": [ { - "name": "parameter", - "type": "String", + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", "description": "" } ], "returns": { - "type": "Mono>", + "type": "array", "description": "" } - }, + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "COMMAND GETKEYSANDFLAGS": { + "api_calls": { + "redis_py": [ { - "signature": "Mono> configGet(String... parameters)", + "signature": "command_getkeysandflags(command: str, *args, **kwargs)", "params": [ { - "name": "parameters", + "name": "command", + "type": "str", + "description": "" + }, + { + "name": "*args", + "type": "Any", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "list", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "List commandGetKeysAndFlags(String... args)", + "params": [ + { + "name": "args", "type": "String...", "description": "" } ], "returns": { - "type": "Mono>", + "type": "List", "description": "" } } ], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], "nredisstack_sync": [], "nredisstack_async": [], "php": [ { - "signature": "config($subcommand, $argument = null)", + "signature": "command(string $subcommand, ...$args)", "params": [ { "name": "$subcommand", @@ -25969,13 +26784,13 @@ "description": "" }, { - "name": "$argument", + "name": "$args", "type": "mixed", "description": "" } ], "returns": { - "type": "mixed", + "type": "array", "description": "" } } @@ -25984,7 +26799,7 @@ "redis_rs_async": [] } }, - "CONFIG HELP": { + "COMMAND HELP": { "api_calls": { "redis_py": [], "jedis": [], @@ -25997,7 +26812,7 @@ "nredisstack_async": [], "php": [ { - "signature": "config(string $subcommand, ...$args)", + "signature": "command(string $subcommand, ...$args)", "params": [ { "name": "$subcommand", @@ -26020,12 +26835,17 @@ "redis_rs_async": [] } }, - "CONFIG RESETSTAT": { + "COMMAND INFO": { "api_calls": { "redis_py": [ { - "signature": "config_resetstat(**kwargs)", + "signature": "command_info(*args, **kwargs)", "params": [ + { + "name": "*args", + "type": "str", + "description": "" + }, { "name": "**kwargs", "type": "Any", @@ -26033,73 +26853,108 @@ } ], "returns": { - "type": "ResponseT", + "type": "Any", "description": "" } } ], "jedis": [ { - "signature": "String configResetStat()", - "params": [], + "signature": "List commandInfo(String... commands)", + "params": [ + { + "name": "commands", + "type": "String...", + "description": "" + } + ], "returns": { - "type": "String", + "type": "List", "description": "" } } ], "go-redis": [ { - "signature": "ConfigResetStat(ctx context.Context) *StatusCmd", + "signature": "CommandInfo(ctx context.Context, commands ...string) *CommandsInfoCmd", "params": [ { "name": "ctx", "type": "context.Context", "description": "Context" + }, + { + "name": "commands", + "type": "...string", + "description": "" } ], "returns": { - "type": "*StatusCmd", + "type": "*CommandsInfoCmd", "description": "" } } ], "node_redis": [ { - "signature": "configResetStat()", - "params": [], + "signature": "commandInfo(commands: Array)", + "params": [ + { + "name": "commands", + "type": "Array", + "description": "Array of command names to get information about" + } + ], "returns": { - "type": "SimpleStringReply", + "type": "Array", "description": "" } } ], "lettuce_sync": [ { - "signature": "String configResetstat()", - "params": [], + "signature": "List commandInfo(String... commands)", + "params": [ + { + "name": "commands", + "type": "String...", + "description": "" + } + ], "returns": { - "type": "String", + "type": "List", "description": "" } } ], "lettuce_async": [ { - "signature": "RedisFuture configResetstat()", - "params": [], + "signature": "RedisFuture> commandInfo(String... commands)", + "params": [ + { + "name": "commands", + "type": "String...", + "description": "" + } + ], "returns": { - "type": "RedisFuture", + "type": "RedisFuture>", "description": "" } } ], "lettuce_reactive": [ { - "signature": "Mono configResetstat()", - "params": [], + "signature": "Flux commandInfo(String... commands)", + "params": [ + { + "name": "commands", + "type": "String...", + "description": "" + } + ], "returns": { - "type": "Mono", + "type": "Flux", "description": "" } } @@ -26108,7 +26963,7 @@ "nredisstack_async": [], "php": [ { - "signature": "config($subcommand, $argument = null)", + "signature": "command(string $subcommand, ...$args)", "params": [ { "name": "$subcommand", @@ -26116,13 +26971,13 @@ "description": "" }, { - "name": "$argument", + "name": "$args", "type": "mixed", "description": "" } ], "returns": { - "type": "mixed", + "type": "array", "description": "" } } @@ -26131,12 +26986,27 @@ "redis_rs_async": [] } }, - "CONFIG REWRITE": { + "COMMAND LIST": { "api_calls": { "redis_py": [ { - "signature": "config_rewrite(**kwargs)", + "signature": "command_list(module: str | None = None, category: str | None = None, pattern: str | None = None, **kwargs)", "params": [ + { + "name": "module", + "type": "str | None", + "description": "" + }, + { + "name": "category", + "type": "str | None", + "description": "" + }, + { + "name": "pattern", + "type": "str | None", + "description": "" + }, { "name": "**kwargs", "type": "Any", @@ -26144,24 +27014,98 @@ } ], "returns": { - "type": "ResponseT", + "type": "list", "description": "" } } ], "jedis": [ { - "signature": "String configRewrite()", + "signature": "List commandList()", "params": [], "returns": { - "type": "String", - "description": "OK when the configuration was rewritten properly" + "type": "List", + "description": "" + } + }, + { + "signature": "List commandList(CommandListFilterBy filterBy)", + "params": [ + { + "name": "filterBy", + "type": "CommandListFilterBy", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + } + ], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "command(string $subcommand, ...$args)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "COMMAND": { + "api_calls": { + "redis_py": [ + { + "signature": "command(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "List command()", + "params": [], + "returns": { + "type": "List", + "description": "" } } ], "go-redis": [ { - "signature": "ConfigRewrite(ctx context.Context) *StatusCmd", + "signature": "Command(ctx context.Context) *CommandsInfoCmd", "params": [ { "name": "ctx", @@ -26170,47 +27114,47 @@ } ], "returns": { - "type": "*StatusCmd", + "type": "*CommandsInfoCmd", "description": "" } } ], "node_redis": [ { - "signature": "configRewrite()", + "signature": "command()", "params": [], "returns": { - "type": "SimpleStringReply", + "type": "Array", "description": "" } } ], "lettuce_sync": [ { - "signature": "String configRewrite()", + "signature": "List command()", "params": [], "returns": { - "type": "String", + "type": "List", "description": "" } } ], "lettuce_async": [ { - "signature": "RedisFuture configRewrite()", + "signature": "RedisFuture> command()", "params": [], "returns": { - "type": "RedisFuture", + "type": "RedisFuture>", "description": "" } } ], "lettuce_reactive": [ { - "signature": "Mono configRewrite()", + "signature": "Flux command()", "params": [], "returns": { - "type": "Mono", + "type": "Flux", "description": "" } } @@ -26219,7 +27163,7 @@ "nredisstack_async": [], "php": [ { - "signature": "config($subcommand, $argument = null)", + "signature": "command(string $subcommand, ...$args)", "params": [ { "name": "$subcommand", @@ -26227,7 +27171,7 @@ "description": "" }, { - "name": "$argument", + "name": "$args", "type": "mixed", "description": "" } @@ -26242,25 +27186,20 @@ "redis_rs_async": [] } }, - "CONFIG SET": { + "CONFIG GET": { "api_calls": { "redis_py": [ { - "signature": "config_set(name: KeyT, value: EncodableT, *args: Union[KeyT, EncodableT], **kwargs)", + "signature": "config_get(pattern: PatternT = \"*\", *args: PatternT, **kwargs)", "params": [ { - "name": "name", - "type": "KeyT", - "description": "Config name" - }, - { - "name": "value", - "type": "EncodableT", - "description": "Config value" + "name": "pattern", + "type": "PatternT", + "description": "Config pattern" }, { "name": "*args", - "type": "Union[KeyT, EncodableT]", + "type": "PatternT", "description": "" }, { @@ -26277,56 +27216,37 @@ ], "jedis": [ { - "signature": "String configSet(final String parameter, final String value)", + "signature": "Map configGet(final String pattern)", "params": [ { - "name": "parameter", - "type": "String", - "description": "Config parameter" - }, - { - "name": "value", + "name": "pattern", "type": "String", - "description": "Config value" + "description": "Config pattern" } ], "returns": { - "type": "String", - "description": "OK" + "type": "Map", + "description": "Bulk reply" } }, { - "signature": "String configSet(final String... parameterValues)", + "signature": "Map configGet(String... patterns)", "params": [ { - "name": "parameterValues", + "name": "patterns", "type": "String...", - "description": "Parameter-value pairs" - } - ], - "returns": { - "type": "String", - "description": "OK" - } - }, - { - "signature": "String configSet(Map parameterValues)", - "params": [ - { - "name": "parameterValues", - "type": "Map", - "description": "Parameter-value map" + "description": "Config patterns" } ], "returns": { - "type": "String", - "description": "OK" + "type": "Map", + "description": "Bulk reply" } } ], "go-redis": [ { - "signature": "ConfigSet(ctx context.Context, parameter, value string) *StatusCmd", + "signature": "ConfigGet(ctx context.Context, parameter string) *MapStringStringCmd", "params": [ { "name": "ctx", @@ -26337,155 +27257,116 @@ "name": "parameter", "type": "string", "description": "Config parameter" - }, - { - "name": "value", - "type": "string", - "description": "Config value" } ], "returns": { - "type": "*StatusCmd", + "type": "*MapStringStringCmd", "description": "" } } ], "node_redis": [ { - "signature": "configSet(parameter: RedisArgument, value: RedisArgument)", - "params": [ - { - "name": "parameter", - "type": "RedisArgument", - "description": "Configuration parameter name" - }, - { - "name": "value", - "type": "RedisArgument", - "description": "Value for the parameter" - } - ], - "returns": { - "type": "SimpleStringReply", - "description": "" - } - }, - { - "signature": "configSet(config: Record)", + "signature": "configGet(parameters: RedisVariadicArgument)", "params": [ { - "name": "config", - "type": "Record", - "description": "Configuration object with multiple parameters" + "name": "parameters", + "type": "RedisVariadicArgument", + "description": "Pattern or specific configuration parameter names" } ], "returns": { - "type": "SimpleStringReply", + "type": "Map", "description": "" } } ], "lettuce_sync": [ { - "signature": "String configSet(String parameter, String value)", + "signature": "Map configGet(String parameter)", "params": [ { "name": "parameter", "type": "String", "description": "" - }, - { - "name": "value", - "type": "String", - "description": "" } ], "returns": { - "type": "String", + "type": "Map", "description": "" } }, { - "signature": "String configSet(Map kvs)", + "signature": "Map configGet(String... parameters)", "params": [ { - "name": "kvs", - "type": "Map", + "name": "parameters", + "type": "String...", "description": "" } ], "returns": { - "type": "String", + "type": "Map", "description": "" } } ], "lettuce_async": [ { - "signature": "RedisFuture configSet(String parameter, String value)", + "signature": "RedisFuture> configGet(String parameter)", "params": [ { "name": "parameter", "type": "String", "description": "" - }, - { - "name": "value", - "type": "String", - "description": "" } ], "returns": { - "type": "RedisFuture", + "type": "RedisFuture>", "description": "" } }, { - "signature": "RedisFuture configSet(Map kvs)", + "signature": "RedisFuture> configGet(String... parameters)", "params": [ { - "name": "kvs", - "type": "Map", + "name": "parameters", + "type": "String...", "description": "" } ], "returns": { - "type": "RedisFuture", + "type": "RedisFuture>", "description": "" } } ], "lettuce_reactive": [ { - "signature": "Mono configSet(String parameter, String value)", + "signature": "Mono> configGet(String parameter)", "params": [ { "name": "parameter", "type": "String", "description": "" - }, - { - "name": "value", - "type": "String", - "description": "" } ], "returns": { - "type": "Mono", + "type": "Mono>", "description": "" } }, { - "signature": "Mono configSet(Map kvs)", + "signature": "Mono> configGet(String... parameters)", "params": [ { - "name": "kvs", - "type": "Map", + "name": "parameters", + "type": "String...", "description": "" } ], "returns": { - "type": "Mono", + "type": "Mono>", "description": "" } } @@ -26517,7 +27398,7 @@ "redis_rs_async": [] } }, - "CONFIG": { + "CONFIG HELP": { "api_calls": { "redis_py": [], "jedis": [], @@ -26544,7 +27425,7 @@ } ], "returns": { - "type": "mixed", + "type": "array", "description": "" } } @@ -26553,547 +27434,397 @@ "redis_rs_async": [] } }, - "COPY": { + "CONFIG RESETSTAT": { "api_calls": { "redis_py": [ { - "signature": "copy(source: str, destination: str, destination_db: Optional[int] = None, replace: bool = False)", + "signature": "config_resetstat(**kwargs)", "params": [ { - "name": "source", - "type": "str", - "description": "" - }, - { - "name": "destination", - "type": "str", - "description": "" - }, - { - "name": "destination_db", - "type": "Optional[int]", - "description": "" - }, - { - "name": "replace", - "type": "bool", + "name": "**kwargs", + "type": "Any", "description": "" } ], "returns": { - "type": "int", + "type": "ResponseT", "description": "" } } ], "jedis": [ { - "signature": "long copy(final byte[] srcKey, final byte[] dstKey, final boolean replace)", - "params": [ - { - "name": "srcKey", - "type": "byte[]", - "description": "" - }, - { - "name": "dstKey", - "type": "byte[]", - "description": "" - }, - { - "name": "replace", - "type": "boolean", - "description": "" - } - ], - "returns": { - "type": "long", - "description": "1 if source was copied. 0 if source was not copied." - } - }, - { - "signature": "long copy(final String srcKey, final String dstKey, final boolean replace)", - "params": [ - { - "name": "srcKey", - "type": "String", - "description": "" - }, - { - "name": "dstKey", - "type": "String", - "description": "" - }, - { - "name": "replace", - "type": "boolean", - "description": "" - } - ], + "signature": "String configResetStat()", + "params": [], "returns": { - "type": "long", - "description": "1 if source was copied. 0 if source was not copied." + "type": "String", + "description": "" } } ], "go-redis": [ { - "signature": "Copy(ctx context.Context, sourceKey string, destKey string, db int, replace bool)", + "signature": "ConfigResetStat(ctx context.Context) *StatusCmd", "params": [ { "name": "ctx", "type": "context.Context", - "description": "" - }, - { - "name": "sourceKey", - "type": "string", - "description": "" - }, - { - "name": "destKey", - "type": "string", - "description": "" - }, - { - "name": "db", - "type": "int", - "description": "" - }, - { - "name": "replace", - "type": "bool", - "description": "" + "description": "Context" } ], "returns": { - "type": "*IntCmd", + "type": "*StatusCmd", "description": "" } } ], "node_redis": [ { - "signature": "COPY(source: RedisArgument, destination: RedisArgument, options?: CopyOptions)", - "params": [ - { - "name": "source", - "type": "RedisArgument", - "description": "" - }, - { - "name": "destination", - "type": "RedisArgument", - "description": "" - }, - { - "name": "options?", - "type": "CopyOptions", - "description": "" - } - ], + "signature": "configResetStat()", + "params": [], "returns": { - "type": "Any", + "type": "SimpleStringReply", "description": "" } } ], "lettuce_sync": [ { - "signature": "Boolean copy(K source, K destination)", - "params": [ - { - "name": "source", - "type": "K", - "description": "the source key." - }, - { - "name": "destination", - "type": "K", - "description": "the destination key." - } - ], + "signature": "String configResetstat()", + "params": [], "returns": { - "type": "Boolean", - "description": "Boolean integer-reply specifically: true if source was copied. false if source was not copied." + "type": "String", + "description": "" } - }, + } + ], + "lettuce_async": [ { - "signature": "Boolean copy(K source, K destination, CopyArgs copyArgs)", - "params": [ - { - "name": "source", - "type": "K", - "description": "the source key." - }, - { - "name": "destination", - "type": "K", - "description": "the destination key." - }, - { - "name": "copyArgs", - "type": "CopyArgs", - "description": "the copy arguments." - } - ], + "signature": "RedisFuture configResetstat()", + "params": [], "returns": { - "type": "Boolean", - "description": "Boolean integer-reply specifically: true if source was copied. false if source was not copied." + "type": "RedisFuture", + "description": "" } } ], - "lettuce_async": [ + "lettuce_reactive": [ { - "signature": "RedisFuture copy(K source, K destination)", + "signature": "Mono configResetstat()", + "params": [], + "returns": { + "type": "Mono", + "description": "" + } + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "config($subcommand, $argument = null)", "params": [ { - "name": "source", - "type": "K", - "description": "the source key." + "name": "$subcommand", + "type": "string", + "description": "" }, { - "name": "destination", - "type": "K", - "description": "the destination key." + "name": "$argument", + "type": "mixed", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Boolean integer-reply specifically: true if source was copied. false if source was not copied." + "type": "mixed", + "description": "" } - }, + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CONFIG REWRITE": { + "api_calls": { + "redis_py": [ { - "signature": "RedisFuture copy(K source, K destination, CopyArgs copyArgs)", + "signature": "config_rewrite(**kwargs)", "params": [ { - "name": "source", - "type": "K", - "description": "the source key." - }, - { - "name": "destination", - "type": "K", - "description": "the destination key." - }, - { - "name": "copyArgs", - "type": "CopyArgs", - "description": "the copy arguments." + "name": "**kwargs", + "type": "Any", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Boolean integer-reply specifically: true if source was copied. false if source was not copied." + "type": "ResponseT", + "description": "" } } ], - "lettuce_reactive": [ + "jedis": [ { - "signature": "Mono copy(K source, K destination)", + "signature": "String configRewrite()", + "params": [], + "returns": { + "type": "String", + "description": "OK when the configuration was rewritten properly" + } + } + ], + "go-redis": [ + { + "signature": "ConfigRewrite(ctx context.Context) *StatusCmd", "params": [ { - "name": "source", - "type": "K", - "description": "the source key." - }, - { - "name": "destination", - "type": "K", - "description": "the destination key." + "name": "ctx", + "type": "context.Context", + "description": "Context" } ], "returns": { - "type": "Mono", - "description": "Boolean integer-reply specifically: true if source was copied. false if source was not copied." + "type": "*StatusCmd", + "description": "" } - }, + } + ], + "node_redis": [ { - "signature": "Mono copy(K source, K destination, CopyArgs copyArgs)", - "params": [ - { - "name": "source", - "type": "K", - "description": "the source key." - }, - { - "name": "destination", - "type": "K", - "description": "the destination key." - }, - { - "name": "copyArgs", - "type": "CopyArgs", - "description": "the copy arguments." - } - ], + "signature": "configRewrite()", + "params": [], "returns": { - "type": "Mono", - "description": "Boolean integer-reply specifically: true if source was copied. false if source was not copied." + "type": "SimpleStringReply", + "description": "" } } ], - "nredisstack_sync": [ + "lettuce_sync": [ { - "signature": "KeyCopy(RedisKey sourceKey, RedisKey destinationKey, int destinationDatabase = -1, bool replace = false, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "sourceKey", - "type": "RedisKey", - "description": "The source key." - }, - { - "name": "destinationKey", - "type": "RedisKey", - "description": "The destination key." - }, - { - "name": "destinationDatabase", - "type": "int", - "description": "The destination database." - }, - { - "name": "replace", - "type": "bool", - "description": "Whether to replace the destination key if it exists." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], + "signature": "String configRewrite()", + "params": [], "returns": { - "type": "bool", - "description": "true if source was copied. false if source was not copied." + "type": "String", + "description": "" } } ], - "nredisstack_async": [ + "lettuce_async": [ { - "signature": "KeyCopyAsync(RedisKey sourceKey, RedisKey destinationKey, int destinationDatabase = -1, bool replace = false, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture configRewrite()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono configRewrite()", + "params": [], + "returns": { + "type": "Mono", + "description": "" + } + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "config($subcommand, $argument = null)", "params": [ { - "name": "sourceKey", - "type": "RedisKey", - "description": "The source key." - }, - { - "name": "destinationKey", - "type": "RedisKey", - "description": "The destination key." - }, - { - "name": "destinationDatabase", - "type": "int", - "description": "The destination database." - }, - { - "name": "replace", - "type": "bool", - "description": "Whether to replace the destination key if it exists." + "name": "$subcommand", + "type": "string", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "$argument", + "type": "mixed", + "description": "" } ], "returns": { - "type": "Task", - "description": "true if source was copied. false if source was not copied." + "type": "mixed", + "description": "" } } ], - "php": [ + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "CONFIG SET": { + "api_calls": { + "redis_py": [ { - "signature": "copy(string $src, string $dst, array|null $options = null)", + "signature": "config_set(name: KeyT, value: EncodableT, *args: Union[KeyT, EncodableT], **kwargs)", "params": [ { - "name": "$src", - "type": "string", - "description": "" + "name": "name", + "type": "KeyT", + "description": "Config name" }, { - "name": "$dst", - "type": "string", + "name": "value", + "type": "EncodableT", + "description": "Config value" + }, + { + "name": "*args", + "type": "Union[KeyT, EncodableT]", "description": "" }, { - "name": "$options", - "type": "array|null", + "name": "**kwargs", + "type": "Any", "description": "" } ], "returns": { - "type": "bool", + "type": "ResponseT", "description": "" } } ], - "redis_rb": [ + "jedis": [ { - "signature": "copy(source, destination, db: nil, replace: false)", + "signature": "String configSet(final String parameter, final String value)", "params": [ { - "name": "source", + "name": "parameter", "type": "String", - "description": "" + "description": "Config parameter" }, { - "name": "destination", + "name": "value", "type": "String", - "description": "" - }, - { - "name": "db", - "type": "Integer", - "description": "" - }, - { - "name": "replace", - "type": "Boolean", - "description": "removes the destination key before copying value to it" + "description": "Config value" } ], "returns": { - "type": "Boolean", - "description": "whether the key was copied or not" + "type": "String", + "description": "OK" } - } - ] - } - }, - "DBSIZE": { - "api_calls": { - "redis_py": [ + }, { - "signature": "dbsize(**kwargs)", + "signature": "String configSet(final String... parameterValues)", "params": [ { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "parameterValues", + "type": "String...", + "description": "Parameter-value pairs" } ], "returns": { - "type": "ResponseT", - "description": "" + "type": "String", + "description": "OK" } - } - ], - "jedis": [ + }, { - "signature": "long dbSize()", - "params": [], + "signature": "String configSet(Map parameterValues)", + "params": [ + { + "name": "parameterValues", + "type": "Map", + "description": "Parameter-value map" + } + ], "returns": { - "type": "long", - "description": "The number of keys" + "type": "String", + "description": "OK" } } ], "go-redis": [ { - "signature": "DBSize(ctx context.Context) *IntCmd", + "signature": "ConfigSet(ctx context.Context, parameter, value string) *StatusCmd", "params": [ { "name": "ctx", "type": "context.Context", "description": "Context" + }, + { + "name": "parameter", + "type": "string", + "description": "Config parameter" + }, + { + "name": "value", + "type": "string", + "description": "Config value" } ], "returns": { - "type": "*IntCmd", + "type": "*StatusCmd", "description": "" } } ], "node_redis": [ { - "signature": "DBSIZE()", - "params": [], - "returns": { - "type": "NumberReply", - "description": "" - } - } - ], - "lettuce_sync": [ - { - "signature": "Long dbsize()", - "params": [], - "returns": { - "type": "Long", - "description": "" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture dbsize()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "" - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono dbsize()", - "params": [], + "signature": "configSet(parameter: RedisArgument, value: RedisArgument)", + "params": [ + { + "name": "parameter", + "type": "RedisArgument", + "description": "Configuration parameter name" + }, + { + "name": "value", + "type": "RedisArgument", + "description": "Value for the parameter" + } + ], "returns": { - "type": "Mono", + "type": "SimpleStringReply", "description": "" } - } - ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + }, { - "signature": "dbsize()", - "params": [], + "signature": "configSet(config: Record)", + "params": [ + { + "name": "config", + "type": "Record", + "description": "Configuration object with multiple parameters" + } + ], "returns": { - "type": "int", + "type": "SimpleStringReply", "description": "" } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "DEBUG": { - "api_calls": { - "redis_py": [ + "lettuce_sync": [ { - "signature": "debug_object(key: KeyT, **kwargs)", + "signature": "String configSet(String parameter, String value)", "params": [ { - "name": "key", - "type": "KeyT", + "name": "parameter", + "type": "String", "description": "" }, { - "name": "**kwargs", - "type": "Any", + "name": "value", + "type": "String", "description": "" } ], "returns": { - "type": "str", + "type": "String", "description": "" } - } - ], - "jedis": [ + }, { - "signature": "String debug(DebugParams params)", + "signature": "String configSet(Map kvs)", "params": [ { - "name": "params", - "type": "DebugParams", + "name": "kvs", + "type": "Map", "description": "" } ], @@ -27103,67 +27834,67 @@ } } ], - "go-redis": [ + "lettuce_async": [ { - "signature": "DebugObject(ctx context.Context, key string) *StringCmd", + "signature": "RedisFuture configSet(String parameter, String value)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" + "name": "parameter", + "type": "String", + "description": "" }, { - "name": "key", - "type": "string", + "name": "value", + "type": "String", "description": "" } ], "returns": { - "type": "*StringCmd", + "type": "RedisFuture", "description": "" } - } - ], - "node_redis": [], - "lettuce_sync": [ + }, { - "signature": "String debugObject(K key)", + "signature": "RedisFuture configSet(Map kvs)", "params": [ { - "name": "key", - "type": "K", + "name": "kvs", + "type": "Map", "description": "" } ], "returns": { - "type": "String", + "type": "RedisFuture", "description": "" } } ], - "lettuce_async": [ + "lettuce_reactive": [ { - "signature": "RedisFuture debugObject(K key)", + "signature": "Mono configSet(String parameter, String value)", "params": [ { - "name": "key", - "type": "K", + "name": "parameter", + "type": "String", + "description": "" + }, + { + "name": "value", + "type": "String", "description": "" } ], "returns": { - "type": "RedisFuture", + "type": "Mono", "description": "" } - } - ], - "lettuce_reactive": [ + }, { - "signature": "Mono debugObject(K key)", + "signature": "Mono configSet(Map kvs)", "params": [ { - "name": "key", - "type": "K", + "name": "kvs", + "type": "Map", "description": "" } ], @@ -27177,7 +27908,7 @@ "nredisstack_async": [], "php": [ { - "signature": "debug(string $subcommand, ...$args)", + "signature": "config($subcommand, $argument = null)", "params": [ { "name": "$subcommand", @@ -27185,13 +27916,13 @@ "description": "" }, { - "name": "$args", + "name": "$argument", "type": "mixed", "description": "" } ], "returns": { - "type": "string", + "type": "mixed", "description": "" } } @@ -27200,238 +27931,152 @@ "redis_rs_async": [] } }, - "DECR": { + "CONFIG": { "api_calls": { - "redis_py": [ + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ { - "signature": "decrby(name: KeyT, amount: int = 1)", + "signature": "config(string $subcommand, ...$args)", "params": [ { - "name": "name", - "type": "KeyT", + "name": "$subcommand", + "type": "string", "description": "" }, { - "name": "amount", - "type": "int = 1", + "name": "$args", + "type": "mixed", "description": "" } ], "returns": { - "type": "ResponseT", + "type": "mixed", "description": "" } } ], - "jedis": [ + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "COPY": { + "api_calls": { + "redis_py": [ { - "signature": "long decrBy(final byte[] key, final long decrement)", + "signature": "copy(source: str, destination: str, destination_db: Optional[int] = None, replace: bool = False)", "params": [ { - "name": "key", - "type": "byte[]", + "name": "source", + "type": "str", "description": "" }, { - "name": "decrement", - "type": "long", + "name": "destination", + "type": "str", + "description": "" + }, + { + "name": "destination_db", + "type": "Optional[int]", + "description": "" + }, + { + "name": "replace", + "type": "bool", "description": "" } ], "returns": { - "type": "long", - "description": "The value of key after the decrement" + "type": "int", + "description": "" } - }, + } + ], + "jedis": [ { - "signature": "long decr(final byte[] key)", + "signature": "long copy(final byte[] srcKey, final byte[] dstKey, final boolean replace)", "params": [ { - "name": "key", + "name": "srcKey", "type": "byte[]", "description": "" - } - ], - "returns": { - "type": "long", - "description": "The value of key after the decrement" - } - }, - { - "signature": "long decrBy(final String key, final long decrement)", - "params": [ + }, { - "name": "key", - "type": "String", + "name": "dstKey", + "type": "byte[]", "description": "" }, { - "name": "decrement", - "type": "long", + "name": "replace", + "type": "boolean", "description": "" } ], "returns": { "type": "long", - "description": "The value of key after the decrement" + "description": "1 if source was copied. 0 if source was not copied." } }, { - "signature": "long decr(final String key)", + "signature": "long copy(final String srcKey, final String dstKey, final boolean replace)", "params": [ { - "name": "key", + "name": "srcKey", + "type": "String", + "description": "" + }, + { + "name": "dstKey", "type": "String", "description": "" + }, + { + "name": "replace", + "type": "boolean", + "description": "" } ], "returns": { "type": "long", - "description": "The value of key after the decrement" + "description": "1 if source was copied. 0 if source was not copied." } } ], - "lettuce_sync": [ + "go-redis": [ { - "signature": "Long decr(K key)", + "signature": "Copy(ctx context.Context, sourceKey string, destKey string, db int, replace bool)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." - } - ], - "returns": { - "type": "Long", - "description": "Long integer-reply the value of key after the decrement." - } - }, - { - "signature": "Long decrby(K key, long amount)", - "params": [ + "name": "ctx", + "type": "context.Context", + "description": "" + }, { - "name": "key", - "type": "K", - "description": "the key." - }, - { - "name": "amount", - "type": "long", - "description": "the decrement type: long." - } - ], - "returns": { - "type": "Long", - "description": "Long integer-reply the value of key after the decrement." - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture decr(K key)", - "params": [ - { - "name": "key", - "type": "K", - "description": "the key." - } - ], - "returns": { - "type": "RedisFuture", - "description": "Long integer-reply the value of key after the decrement." - } - }, - { - "signature": "RedisFuture decrby(K key, long amount)", - "params": [ - { - "name": "key", - "type": "K", - "description": "the key." - }, - { - "name": "amount", - "type": "long", - "description": "the decrement type: long." - } - ], - "returns": { - "type": "RedisFuture", - "description": "Long integer-reply the value of key after the decrement." - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono decr(K key)", - "params": [ - { - "name": "key", - "type": "K", - "description": "the key." - } - ], - "returns": { - "type": "Mono", - "description": "Long integer-reply the value of key after the decrement." - } - }, - { - "signature": "Mono decrby(K key, long amount)", - "params": [ - { - "name": "key", - "type": "K", - "description": "the key." - }, - { - "name": "amount", - "type": "long", - "description": "the decrement type: long." - } - ], - "returns": { - "type": "Mono", - "description": "Long integer-reply the value of key after the decrement." - } - } - ], - "go-redis": [ - { - "signature": "Decr(ctx context.Context, key string)", - "params": [ - { - "name": "ctx", - "type": "context.Context", + "name": "sourceKey", + "type": "string", "description": "" }, { - "name": "key", + "name": "destKey", "type": "string", "description": "" - } - ], - "returns": { - "type": "*IntCmd", - "description": "" - } - }, - { - "signature": "DecrBy(ctx context.Context, key string, decrement int64)", - "params": [ - { - "name": "ctx", - "type": "context.Context", - "description": "" }, { - "name": "key", - "type": "string", + "name": "db", + "type": "int", "description": "" }, { - "name": "decrement", - "type": "int64", + "name": "replace", + "type": "bool", "description": "" } ], @@ -27443,30 +28088,21 @@ ], "node_redis": [ { - "signature": "DECR(key: RedisArgument)", + "signature": "COPY(source: RedisArgument, destination: RedisArgument, options?: CopyOptions)", "params": [ { - "name": "key", + "name": "source", "type": "RedisArgument", "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "DECRBY(key: RedisArgument, decrement: number)", - "params": [ + }, { - "name": "key", + "name": "destination", "type": "RedisArgument", "description": "" }, { - "name": "decrement", - "type": "number", + "name": "options?", + "type": "CopyOptions", "description": "" } ], @@ -27476,219 +28112,164 @@ } } ], - "ioredis": [ + "lettuce_sync": [ { - "signature": "decr(key: RedisKey, callback?: Callback): Result;, /**, * Decrement the integer value of a key by the given number, * - _group_: string, * - _complexity_: O(1), * - _since_: 1.0.0, */, decrby(, key: RedisKey, decrement: number | string, callback?: Callback)", + "signature": "Boolean copy(K source, K destination)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "callback?", - "type": "Callback)", - "description": "" - }, - { - "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "decrement", - "type": "number | string", - "description": "" + "name": "source", + "type": "K", + "description": "the source key." }, { - "name": "callback?", - "type": "Callback", - "description": "" + "name": "destination", + "type": "K", + "description": "the destination key." } ], "returns": { - "type": "Any", - "description": "" + "type": "Boolean", + "description": "Boolean integer-reply specifically: true if source was copied. false if source was not copied." } - } - ], - "redis_rs_sync": [ + }, { - "signature": "decr(key: K, delta: V)", + "signature": "Boolean copy(K source, K destination, CopyArgs copyArgs)", "params": [ { - "name": "key", + "name": "source", "type": "K", - "description": "" + "description": "the source key." }, { - "name": "delta", - "type": "V", - "description": "" - } - ], - "returns": { - "type": "(isize)", - "description": "" - } - } - ], - "redis_rs_async": [ - { - "signature": "decr(key: K, delta: V)", - "params": [ - { - "name": "key", + "name": "destination", "type": "K", - "description": "" + "description": "the destination key." }, { - "name": "delta", - "type": "V", - "description": "" + "name": "copyArgs", + "type": "CopyArgs", + "description": "the copy arguments." } ], "returns": { - "type": "(isize)", - "description": "" + "type": "Boolean", + "description": "Boolean integer-reply specifically: true if source was copied. false if source was not copied." } } ], - "nredisstack_sync": [ + "lettuce_async": [ { - "signature": "StringDecrement(RedisKey key, long value = 1, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture copy(K source, K destination)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The key of the string." - }, - { - "name": "value", - "type": "long", - "description": "The amount to decrement by (defaults to 1)." + "name": "source", + "type": "K", + "description": "the source key." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "destination", + "type": "K", + "description": "the destination key." } ], "returns": { - "type": "long", - "description": "The value of key after the decrement." + "type": "RedisFuture", + "description": "Boolean integer-reply specifically: true if source was copied. false if source was not copied." } }, { - "signature": "StringDecrement(RedisKey key, double value, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture copy(K source, K destination, CopyArgs copyArgs)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The key of the string." + "name": "source", + "type": "K", + "description": "the source key." }, { - "name": "value", - "type": "double", - "description": "The amount to decrement by (defaults to 1)." + "name": "destination", + "type": "K", + "description": "the destination key." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "copyArgs", + "type": "CopyArgs", + "description": "the copy arguments." } ], "returns": { - "type": "double", - "description": "The value of key after the decrement." + "type": "RedisFuture", + "description": "Boolean integer-reply specifically: true if source was copied. false if source was not copied." } - }, + } + ], + "lettuce_reactive": [ { - "signature": "StringDecrement(RedisKey key, long value = 1, CommandFlags flags = CommandFlags.None)", + "signature": "Mono copy(K source, K destination)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The key of the string." - }, - { - "name": "value", - "type": "long", - "description": "The amount to decrement by (defaults to 1)." + "name": "source", + "type": "K", + "description": "the source key." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "destination", + "type": "K", + "description": "the destination key." } ], "returns": { - "type": "long", - "description": "The value of key after the decrement." + "type": "Mono", + "description": "Boolean integer-reply specifically: true if source was copied. false if source was not copied." } }, { - "signature": "StringDecrement(RedisKey key, double value, CommandFlags flags = CommandFlags.None)", + "signature": "Mono copy(K source, K destination, CopyArgs copyArgs)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The key of the string." + "name": "source", + "type": "K", + "description": "the source key." }, { - "name": "value", - "type": "double", - "description": "The amount to decrement by (defaults to 1)." + "name": "destination", + "type": "K", + "description": "the destination key." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "copyArgs", + "type": "CopyArgs", + "description": "the copy arguments." } ], "returns": { - "type": "double", - "description": "The value of key after the decrement." + "type": "Mono", + "description": "Boolean integer-reply specifically: true if source was copied. false if source was not copied." } } ], - "nredisstack_async": [ + "nredisstack_sync": [ { - "signature": "StringDecrement(RedisKey key, long value = 1, CommandFlags flags = CommandFlags.None)", + "signature": "KeyCopy(RedisKey sourceKey, RedisKey destinationKey, int destinationDatabase = -1, bool replace = false, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", + "name": "sourceKey", "type": "RedisKey", - "description": "The key of the string." + "description": "The source key." }, { - "name": "value", - "type": "long", - "description": "The amount to decrement by (defaults to 1)." + "name": "destinationKey", + "type": "RedisKey", + "description": "The destination key." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "long", - "description": "The value of key after the decrement." - } - }, - { - "signature": "StringDecrement(RedisKey key, double value, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the string." + "name": "destinationDatabase", + "type": "int", + "description": "The destination database." }, { - "name": "value", - "type": "double", - "description": "The amount to decrement by (defaults to 1)." + "name": "replace", + "type": "bool", + "description": "Whether to replace the destination key if it exists." }, { "name": "flags", @@ -27697,46 +28278,34 @@ } ], "returns": { - "type": "double", - "description": "The value of key after the decrement." + "type": "bool", + "description": "true if source was copied. false if source was not copied." } - }, + } + ], + "nredisstack_async": [ { - "signature": "StringDecrement(RedisKey key, long value = 1, CommandFlags flags = CommandFlags.None)", + "signature": "KeyCopyAsync(RedisKey sourceKey, RedisKey destinationKey, int destinationDatabase = -1, bool replace = false, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", + "name": "sourceKey", "type": "RedisKey", - "description": "The key of the string." + "description": "The source key." }, { - "name": "value", - "type": "long", - "description": "The amount to decrement by (defaults to 1)." + "name": "destinationKey", + "type": "RedisKey", + "description": "The destination key." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "long", - "description": "The value of key after the decrement." - } - }, - { - "signature": "StringDecrement(RedisKey key, double value, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the string." + "name": "destinationDatabase", + "type": "int", + "description": "The destination database." }, { - "name": "value", - "type": "double", - "description": "The amount to decrement by (defaults to 1)." + "name": "replace", + "type": "bool", + "description": "Whether to replace the destination key if it exists." }, { "name": "flags", @@ -27745,78 +28314,79 @@ } ], "returns": { - "type": "double", - "description": "The value of key after the decrement." + "type": "Task", + "description": "true if source was copied. false if source was not copied." } } ], "php": [ { - "signature": "decr(string $key)", + "signature": "copy(string $src, string $dst, array|null $options = null)", "params": [ { - "name": "$key", + "name": "$src", "type": "string", "description": "" - } - ], - "returns": { - "type": "int", - "description": "" - } - }, - { - "signature": "decrby(string $key, int $decrement)", - "params": [ + }, { - "name": "$key", + "name": "$dst", "type": "string", "description": "" }, { - "name": "$decrement", - "type": "int", + "name": "$options", + "type": "array|null", "description": "" } ], "returns": { - "type": "int", + "type": "bool", "description": "" } } ], "redis_rb": [ { - "signature": "decr(key)", + "signature": "copy(source, destination, db: nil, replace: false)", "params": [ { - "name": "key", + "name": "source", + "type": "String", + "description": "" + }, + { + "name": "destination", "type": "String", "description": "" + }, + { + "name": "db", + "type": "Integer", + "description": "" + }, + { + "name": "replace", + "type": "Boolean", + "description": "removes the destination key before copying value to it" } ], "returns": { - "type": "Integer", - "description": "value after decrementing it" + "type": "Boolean", + "description": "whether the key was copied or not" } } ] } }, - "DECRBY": { + "DBSIZE": { "api_calls": { "redis_py": [ { - "signature": "decrby(name: KeyT, amount: int = 1)", + "signature": "dbsize(**kwargs)", "params": [ { - "name": "name", - "type": "KeyT", - "description": "" - }, - { - "name": "amount", - "type": "int = 1", + "name": "**kwargs", + "type": "Any", "description": "" } ], @@ -27828,51 +28398,292 @@ ], "jedis": [ { - "signature": "long decrBy(final byte[] key, final long decrement)", - "params": [ - { - "name": "key", - "type": "byte[]", - "description": "" - }, - { - "name": "decrement", - "type": "long", - "description": "" - } - ], + "signature": "long dbSize()", + "params": [], "returns": { "type": "long", - "description": "The value of key after the decrement" + "description": "The number of keys" } - }, + } + ], + "go-redis": [ { - "signature": "long decr(final byte[] key)", + "signature": "DBSize(ctx context.Context) *IntCmd", "params": [ { - "name": "key", - "type": "byte[]", - "description": "" + "name": "ctx", + "type": "context.Context", + "description": "Context" } ], "returns": { - "type": "long", - "description": "The value of key after the decrement" + "type": "*IntCmd", + "description": "" } - }, + } + ], + "node_redis": [ { - "signature": "long decrBy(final String key, final long decrement)", - "params": [ - { - "name": "key", - "type": "String", - "description": "" - }, - { - "name": "decrement", - "type": "long", - "description": "" - } + "signature": "DBSIZE()", + "params": [], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Long dbsize()", + "params": [], + "returns": { + "type": "Long", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture dbsize()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono dbsize()", + "params": [], + "returns": { + "type": "Mono", + "description": "" + } + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "dbsize()", + "params": [], + "returns": { + "type": "int", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "DEBUG": { + "api_calls": { + "redis_py": [ + { + "signature": "debug_object(key: KeyT, **kwargs)", + "params": [ + { + "name": "key", + "type": "KeyT", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "str", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String debug(DebugParams params)", + "params": [ + { + "name": "params", + "type": "DebugParams", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "DebugObject(ctx context.Context, key string) *StringCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "key", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "*StringCmd", + "description": "" + } + } + ], + "node_redis": [], + "lettuce_sync": [ + { + "signature": "String debugObject(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture debugObject(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "RedisFuture", + "description": "" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono debugObject(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "Mono", + "description": "" + } + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "debug(string $subcommand, ...$args)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "string", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "DECR": { + "api_calls": { + "redis_py": [ + { + "signature": "decrby(name: KeyT, amount: int = 1)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "amount", + "type": "int = 1", + "description": "" + } + ], + "returns": { + "type": "ResponseT", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "long decrBy(final byte[] key, final long decrement)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "decrement", + "type": "long", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "The value of key after the decrement" + } + }, + { + "signature": "long decr(final byte[] key)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "The value of key after the decrement" + } + }, + { + "signature": "long decrBy(final String key, final long decrement)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "decrement", + "type": "long", + "description": "" + } ], "returns": { "type": "long", @@ -28390,17 +29201,12 @@ ], "redis_rb": [ { - "signature": "decrby(key, decrement)", + "signature": "decr(key)", "params": [ { "name": "key", "type": "String", "description": "" - }, - { - "name": "decrement", - "type": "Integer", - "description": "" } ], "returns": { @@ -28411,41 +29217,51 @@ ] } }, - "DEL": { + "DECRBY": { "api_calls": { "redis_py": [ { - "signature": "delete(*names: KeyT)", + "signature": "decrby(name: KeyT, amount: int = 1)", "params": [ { - "name": "names", + "name": "name", "type": "KeyT", "description": "" + }, + { + "name": "amount", + "type": "int = 1", + "description": "" } ], "returns": { - "type": "int", + "type": "ResponseT", "description": "" } } ], "jedis": [ { - "signature": "long del(final byte[]... keys)", + "signature": "long decrBy(final byte[] key, final long decrement)", "params": [ { - "name": "keys", - "type": "byte[]...", + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "decrement", + "type": "long", "description": "" } ], "returns": { "type": "long", - "description": "An integer greater than 0 if one or more keys were removed, 0 if none of the specified keys existed" + "description": "The value of key after the decrement" } }, { - "signature": "long del(final byte[] key)", + "signature": "long decr(final byte[] key)", "params": [ { "name": "key", @@ -28455,25 +29271,30 @@ ], "returns": { "type": "long", - "description": "An integer greater than 0 if one or more keys were removed, 0 if none of the specified keys existed" + "description": "The value of key after the decrement" } }, { - "signature": "long del(final String... keys)", + "signature": "long decrBy(final String key, final long decrement)", "params": [ { - "name": "keys", - "type": "String...", + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "decrement", + "type": "long", "description": "" } ], "returns": { "type": "long", - "description": "An integer greater than 0 if one or more keys were removed, 0 if none of the specified keys existed" + "description": "The value of key after the decrement" } }, { - "signature": "long del(final String key)", + "signature": "long decr(final String key)", "params": [ { "name": "key", @@ -28483,384 +29304,374 @@ ], "returns": { "type": "long", - "description": "An integer greater than 0 if one or more keys were removed, 0 if none of the specified keys existed" + "description": "The value of key after the decrement" } } ], - "go-redis": [ + "lettuce_sync": [ { - "signature": "Del(ctx context.Context, keys ...string)", + "signature": "Long decr(K key)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" - }, - { - "name": "keys", - "type": "...string", - "description": "" + "name": "key", + "type": "K", + "description": "the key." } ], "returns": { - "type": "*IntCmd", - "description": "" + "type": "Long", + "description": "Long integer-reply the value of key after the decrement." } - } - ], - "node_redis": [ + }, { - "signature": "DEL(keys: RedisVariadicArgument)", + "signature": "Long decrby(K key, long amount)", "params": [ { - "name": "keys", - "type": "RedisVariadicArgument", - "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - } - ], - "lettuce_sync": [ - { - "signature": "Long del(K... keys)", - "params": [ + "name": "key", + "type": "K", + "description": "the key." + }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "amount", + "type": "long", + "description": "the decrement type: long." } ], "returns": { "type": "Long", - "description": "Long integer-reply The number of keys that were removed." + "description": "Long integer-reply the value of key after the decrement." } } ], "lettuce_async": [ { - "signature": "RedisFuture del(K... keys)", + "signature": "RedisFuture decr(K key)", "params": [ { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "key", + "type": "K", + "description": "the key." } ], "returns": { "type": "RedisFuture", - "description": "Long integer-reply The number of keys that were removed." + "description": "Long integer-reply the value of key after the decrement." } - } - ], - "lettuce_reactive": [ + }, { - "signature": "Mono del(K... keys)", + "signature": "RedisFuture decrby(K key, long amount)", "params": [ { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "amount", + "type": "long", + "description": "the decrement type: long." } ], "returns": { - "type": "Mono", - "description": "Long integer-reply The number of keys that were removed." + "type": "RedisFuture", + "description": "Long integer-reply the value of key after the decrement." } } ], - "nredisstack_sync": [ + "lettuce_reactive": [ { - "signature": "KeyDelete(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "Mono decr(K key)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "type": "K", + "description": "the key." } ], "returns": { - "type": "bool", - "description": "The number of keys that were removed." + "type": "Mono", + "description": "Long integer-reply the value of key after the decrement." } }, { - "signature": "KeyDelete(RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "signature": "Mono decrby(K key, long amount)", "params": [ { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys to delete." + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "amount", + "type": "long", + "description": "the decrement type: long." } ], "returns": { - "type": "long", - "description": "The number of keys that were removed." + "type": "Mono", + "description": "Long integer-reply the value of key after the decrement." } } ], - "nredisstack_async": [ + "go-redis": [ { - "signature": "KeyDeleteAsync(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "Decr(ctx context.Context, key string)", "params": [ { - "name": "key", - "type": "RedisKey", + "name": "ctx", + "type": "context.Context", "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "key", + "type": "string", + "description": "" } ], "returns": { - "type": "Task", - "description": "The number of keys that were removed." + "type": "*IntCmd", + "description": "" } }, { - "signature": "KeyDeleteAsync(RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "signature": "DecrBy(ctx context.Context, key string, decrement int64)", "params": [ { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys to delete." + "name": "ctx", + "type": "context.Context", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "Task", - "description": "The number of keys that were removed." - } - } - ], - "php": [ - { - "signature": "del(string[]|string $keyOrKeys, string ...$keys = null)", - "params": [ - { - "name": "$keyOrKeys", - "type": "string[]|string", + "name": "key", + "type": "string", "description": "" }, { - "name": "$keys", - "type": "string ...", + "name": "decrement", + "type": "int64", "description": "" } ], "returns": { - "type": "int", + "type": "*IntCmd", "description": "" } } ], - "redis_rb": [ + "node_redis": [ { - "signature": "del(*keys)", + "signature": "DECR(key: RedisArgument)", "params": [ { - "name": "*keys", - "type": "String, Array", + "name": "key", + "type": "RedisArgument", "description": "" } ], "returns": { - "type": "Integer", - "description": "number of keys that were deleted" + "type": "Any", + "description": "" } - } - ] - } - }, - "DELEX": { - "api_calls": { - "redis_py": [ + }, { - "signature": "delex(, name: KeyT,, ifeq: Optional[Union[bytes, str]] = None,, ifne: Optional[Union[bytes, str]] = None,, ifdeq: Optional[str] = None,, ifdne: Optional[str] = None,)", + "signature": "DECRBY(key: RedisArgument, decrement: number)", "params": [ { - "name": "name", - "type": "KeyT", + "name": "key", + "type": "RedisArgument", "description": "" }, { - "name": "ifeq", - "type": "Optional[Union[bytes, str]] = None", + "name": "decrement", + "type": "number", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "ioredis": [ + { + "signature": "decr(key: RedisKey, callback?: Callback): Result;, /**, * Decrement the integer value of a key by the given number, * - _group_: string, * - _complexity_: O(1), * - _since_: 1.0.0, */, decrby(, key: RedisKey, decrement: number | string, callback?: Callback)", + "params": [ + { + "name": "key", + "type": "RedisKey", "description": "" }, { - "name": "ifne", - "type": "Optional[Union[bytes, str]] = None", + "name": "callback?", + "type": "Callback)", "description": "" }, { - "name": "ifdeq", - "type": "Optional[str] = None", + "name": "key", + "type": "RedisKey", "description": "" }, { - "name": "ifdne", - "type": "Optional[str] = None", + "name": "decrement", + "type": "number | string", + "description": "" + }, + { + "name": "callback?", + "type": "Callback", "description": "" } ], "returns": { - "type": "int", + "type": "Any", "description": "" } } ], - "jedis": [ + "redis_rs_sync": [ { - "signature": "long delex(final byte[] key, final CompareCondition condition)", + "signature": "decr(key: K, delta: V)", "params": [ { "name": "key", - "type": "byte[]", + "type": "K", "description": "" }, { - "name": "condition", - "type": "CompareCondition", + "name": "delta", + "type": "V", "description": "" } ], "returns": { - "type": "long", + "type": "(isize)", "description": "" } - }, + } + ], + "redis_rs_async": [ { - "signature": "long delex(final String key, final CompareCondition condition)", + "signature": "decr(key: K, delta: V)", "params": [ { "name": "key", - "type": "String", + "type": "K", "description": "" }, { - "name": "condition", - "type": "CompareCondition", + "name": "delta", + "type": "V", "description": "" } ], "returns": { - "type": "long", + "type": "(isize)", "description": "" } } ], - "lettuce_sync": [ + "nredisstack_sync": [ { - "signature": "Long delex(K key, CompareCondition compareCondition)", + "signature": "StringDecrement(RedisKey key, long value = 1, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", - "type": "K", - "description": "the key." + "type": "RedisKey", + "description": "The key of the string." }, { - "name": "compareCondition", - "type": "CompareCondition", - "description": "the compare condition, must not be null." + "name": "value", + "type": "long", + "description": "The amount to decrement by (defaults to 1)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Long", - "description": "Long integer-reply the number of keys that were removed. @since 7.1" + "type": "long", + "description": "The value of key after the decrement." } - } - ], - "lettuce_async": [ + }, { - "signature": "RedisFuture delex(K key, CompareCondition compareCondition)", + "signature": "StringDecrement(RedisKey key, double value, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", - "type": "K", - "description": "the key." + "type": "RedisKey", + "description": "The key of the string." }, { - "name": "compareCondition", - "type": "CompareCondition", - "description": "the compare condition, must not be null." + "name": "value", + "type": "double", + "description": "The amount to decrement by (defaults to 1)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "RedisFuture", - "description": "Long integer-reply the number of keys that were removed. @since 7.1" + "type": "double", + "description": "The value of key after the decrement." } - } - ], - "lettuce_reactive": [ + }, { - "signature": "Mono delex(K key, CompareCondition compareCondition)", + "signature": "StringDecrement(RedisKey key, long value = 1, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", - "type": "K", - "description": "the key." + "type": "RedisKey", + "description": "The key of the string." }, { - "name": "compareCondition", - "type": "CompareCondition", - "description": "the compare condition, must not be null." + "name": "value", + "type": "long", + "description": "The amount to decrement by (defaults to 1)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Mono", - "description": "Long integer-reply the number of keys that were removed. @since 7.1" + "type": "long", + "description": "The value of key after the decrement." } - } - ], - "go-redis": [ + }, { - "signature": "DelExArgs(ctx context.Context, key string, a DelExArgs)", + "signature": "StringDecrement(RedisKey key, double value, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" + "name": "key", + "type": "RedisKey", + "description": "The key of the string." }, { - "name": "key", - "type": "string", - "description": "" + "name": "value", + "type": "double", + "description": "The amount to decrement by (defaults to 1)." }, { - "name": "a", - "type": "DelExArgs", - "description": "" + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "*IntCmd", - "description": "" + "type": "double", + "description": "The value of key after the decrement." } } ], - "nredisstack_sync": [ + "nredisstack_async": [ { - "signature": "StringDelete(RedisKey key, ValueCondition when, CommandFlags flags = CommandFlags.None)", + "signature": "StringDecrement(RedisKey key, long value = 1, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", @@ -28868,9 +29679,9 @@ "description": "The key of the string." }, { - "name": "when", - "type": "ValueCondition", - "description": "The condition to enforce." + "name": "value", + "type": "long", + "description": "The amount to decrement by (defaults to 1)." }, { "name": "flags", @@ -28879,14 +29690,12 @@ } ], "returns": { - "type": "bool", - "description": "" + "type": "long", + "description": "The value of key after the decrement." } - } - ], - "nredisstack_async": [ + }, { - "signature": "StringDelete(RedisKey key, ValueCondition when, CommandFlags flags = CommandFlags.None)", + "signature": "StringDecrement(RedisKey key, double value, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", @@ -28894,9 +29703,9 @@ "description": "The key of the string." }, { - "name": "when", - "type": "ValueCondition", - "description": "The condition to enforce." + "name": "value", + "type": "double", + "description": "The amount to decrement by (defaults to 1)." }, { "name": "flags", @@ -28905,171 +29714,196 @@ } ], "returns": { - "type": "bool", - "description": "" + "type": "double", + "description": "The value of key after the decrement." } - } - ], - "php": [ + }, { - "signature": "delex(string $key, string $flag, $flagValue)", + "signature": "StringDecrement(RedisKey key, long value = 1, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "$key", - "type": "string", - "description": "" + "name": "key", + "type": "RedisKey", + "description": "The key of the string." }, { - "name": "$flag", - "type": "string", - "description": "" + "name": "value", + "type": "long", + "description": "The amount to decrement by (defaults to 1)." }, { - "name": "$flagValue", - "type": "Any", - "description": "" + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "int", - "description": "" + "type": "long", + "description": "The value of key after the decrement." } - } - ], - "node_redis": [ + }, { - "signature": "DELEX(key: RedisArgument, options?: { condition: DelexCondition; matchValue: RedisArgument })", + "signature": "StringDecrement(RedisKey key, double value, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", - "type": "RedisArgument", - "description": "" + "type": "RedisKey", + "description": "The key of the string." }, { - "name": "options?", - "type": "{ condition: DelexCondition; matchValue: RedisArgument }", - "description": "" + "name": "value", + "type": "double", + "description": "The amount to decrement by (defaults to 1)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Any", - "description": "" + "type": "double", + "description": "The value of key after the decrement." } } ], - "redis_rs_sync": [ + "php": [ { - "signature": "del_ex(key: K, value_comparison: ValueComparison)", + "signature": "decr(string $key)", "params": [ { - "name": "key", - "type": "K", + "name": "$key", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + }, + { + "signature": "decrby(string $key, int $decrement)", + "params": [ + { + "name": "$key", + "type": "string", "description": "" }, { - "name": "value_comparison", - "type": "ValueComparison", + "name": "$decrement", + "type": "int", "description": "" } ], "returns": { - "type": "(usize)", + "type": "int", "description": "" } } ], - "redis_rs_async": [ + "redis_rb": [ { - "signature": "del_ex(key: K, value_comparison: ValueComparison)", + "signature": "decrby(key, decrement)", "params": [ { "name": "key", - "type": "K", + "type": "String", "description": "" }, { - "name": "value_comparison", - "type": "ValueComparison", + "name": "decrement", + "type": "Integer", "description": "" } ], "returns": { - "type": "(usize)", - "description": "" + "type": "Integer", + "description": "value after decrementing it" } } ] } }, - "DIGEST": { + "DEL": { "api_calls": { "redis_py": [ { - "signature": "digest(name: KeyT)", + "signature": "delete(*names: KeyT)", "params": [ { - "name": "name", + "name": "names", "type": "KeyT", "description": "" } ], "returns": { - "type": "Union[str, bytes, None]", - "description": "- None if the key does not exist - (bulk string) the XXH3 digest of the value as a hex string" + "type": "int", + "description": "" } } ], - "lettuce_sync": [ + "jedis": [ { - "signature": "String digestKey(K key)", + "signature": "long del(final byte[]... keys)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." + "name": "keys", + "type": "byte[]...", + "description": "" } ], "returns": { - "type": "String", - "description": "String bulk-string-reply the hex digest of the key's value, or null when key does not exist. @since 7.1" + "type": "long", + "description": "An integer greater than 0 if one or more keys were removed, 0 if none of the specified keys existed" } - } - ], - "lettuce_async": [ + }, { - "signature": "RedisFuture digestKey(K key)", + "signature": "long del(final byte[] key)", "params": [ { "name": "key", - "type": "K", - "description": "the key." + "type": "byte[]", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "String bulk-string-reply the hex digest of the key's value, or null when key does not exist. @since 7.1" + "type": "long", + "description": "An integer greater than 0 if one or more keys were removed, 0 if none of the specified keys existed" } - } - ], - "lettuce_reactive": [ + }, { - "signature": "Mono digestKey(K key)", + "signature": "long del(final String... keys)", + "params": [ + { + "name": "keys", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "An integer greater than 0 if one or more keys were removed, 0 if none of the specified keys existed" + } + }, + { + "signature": "long del(final String key)", "params": [ { "name": "key", - "type": "K", - "description": "the key." + "type": "String", + "description": "" } ], "returns": { - "type": "Mono", - "description": "String bulk-string-reply the hex digest of the key's value, or null when key does not exist. @since 7.1" + "type": "long", + "description": "An integer greater than 0 if one or more keys were removed, 0 if none of the specified keys existed" } } ], "go-redis": [ { - "signature": "Digest(ctx context.Context, key string)", + "signature": "Del(ctx context.Context, keys ...string)", "params": [ { "name": "ctx", @@ -29077,73 +29911,84 @@ "description": "" }, { - "name": "key", - "type": "string", + "name": "keys", + "type": "...string", "description": "" } ], "returns": { - "type": "*DigestCmd", + "type": "*IntCmd", "description": "" } } ], - "redis_rs_sync": [ + "node_redis": [ { - "signature": "digest(key: K)", + "signature": "DEL(keys: RedisVariadicArgument)", "params": [ { - "name": "key", - "type": "K", + "name": "keys", + "type": "RedisVariadicArgument", "description": "" } ], "returns": { - "type": "(Option)", + "type": "Any", "description": "" } } ], - "redis_rs_async": [ + "lettuce_sync": [ { - "signature": "digest(key: K)", + "signature": "Long del(K... keys)", "params": [ { - "name": "key", - "type": "K", - "description": "" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "(Option)", - "description": "" + "type": "Long", + "description": "Long integer-reply The number of keys that were removed." } } ], - "nredisstack_sync": [ + "lettuce_async": [ { - "signature": "StringDigest(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture del(K... keys)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" - }, + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Long integer-reply The number of keys that were removed." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono del(K... keys)", + "params": [ { - "name": "flags", - "type": "CommandFlags", - "description": "" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "ValueCondition?", - "description": "" + "type": "Mono", + "description": "Long integer-reply The number of keys that were removed." } } ], - "nredisstack_async": [ + "nredisstack_sync": [ { - "signature": "StringDigest(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "KeyDelete(RedisKey key, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", @@ -29153,220 +29998,293 @@ { "name": "flags", "type": "CommandFlags", - "description": "" + "description": "The flags to use for this operation." } ], "returns": { - "type": "ValueCondition?", - "description": "" + "type": "bool", + "description": "The number of keys that were removed." } - } - ], - "php": [ + }, { - "signature": "digest(string $key)", + "signature": "KeyDelete(RedisKey[] keys, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "$key", - "type": "string", - "description": "" + "name": "keys", + "type": "RedisKey[]", + "description": "The keys to delete." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "string", - "description": "" + "type": "long", + "description": "The number of keys that were removed." } } ], - "jedis": [ + "nredisstack_async": [ { - "signature": "String digestKey(String key)", + "signature": "KeyDeleteAsync(RedisKey key, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", - "type": "String", + "type": "RedisKey", "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "String", - "description": "Compute and return the 64-bit XXH3 digest hex of the string value stored at key. Returns null if key does not exist." + "type": "Task", + "description": "The number of keys that were removed." } }, { - "signature": "byte[] digestKey(byte[] key)", + "signature": "KeyDeleteAsync(RedisKey[] keys, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "byte[]", - "description": "" + "name": "keys", + "type": "RedisKey[]", + "description": "The keys to delete." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "byte[]", - "description": "Returns the 64-bit XXH3 digest hex (ASCII bytes) of the string value stored at key, or null if missing." + "type": "Task", + "description": "The number of keys that were removed." } } ], - "node_redis": [ + "php": [ { - "signature": "DIGEST(key: RedisArgument)", + "signature": "del(string[]|string $keyOrKeys, string ...$keys = null)", "params": [ { - "name": "key", - "type": "RedisArgument", + "name": "$keyOrKeys", + "type": "string[]|string", + "description": "" + }, + { + "name": "$keys", + "type": "string ...", "description": "" } ], "returns": { - "type": "Any", + "type": "int", "description": "" } } - ] - } - }, - "DUMP": { - "api_calls": { - "redis_py": [ + ], + "redis_rb": [ { - "signature": "dump(name: KeyT)", + "signature": "del(*keys)", "params": [ { - "name": "name", - "type": "KeyT", + "name": "*keys", + "type": "String, Array", "description": "" } ], "returns": { - "type": "bytes", - "description": "" + "type": "Integer", + "description": "number of keys that were deleted" } } - ], - "jedis": [ + ] + } + }, + "DELEX": { + "api_calls": { + "redis_py": [ { - "signature": "byte[] dump(final byte[] key)", + "signature": "delex(, name: KeyT,, ifeq: Optional[Union[bytes, str]] = None,, ifne: Optional[Union[bytes, str]] = None,, ifdeq: Optional[str] = None,, ifdne: Optional[str] = None,)", "params": [ { - "name": "key", - "type": "byte[]", + "name": "name", + "type": "KeyT", "description": "" - } - ], - "returns": { - "type": "byte[]", - "description": "the serialized value" - } - }, - { - "signature": "byte[] dump(final String key)", - "params": [ + }, { - "name": "key", - "type": "String", + "name": "ifeq", + "type": "Optional[Union[bytes, str]] = None", + "description": "" + }, + { + "name": "ifne", + "type": "Optional[Union[bytes, str]] = None", + "description": "" + }, + { + "name": "ifdeq", + "type": "Optional[str] = None", + "description": "" + }, + { + "name": "ifdne", + "type": "Optional[str] = None", "description": "" } ], "returns": { - "type": "byte[]", - "description": "the serialized value" + "type": "int", + "description": "" } } ], - "go-redis": [ + "jedis": [ { - "signature": "Dump(ctx context.Context, key string)", + "signature": "long delex(final byte[] key, final CompareCondition condition)", "params": [ { - "name": "ctx", - "type": "context.Context", + "name": "key", + "type": "byte[]", "description": "" }, { - "name": "key", - "type": "string", + "name": "condition", + "type": "CompareCondition", "description": "" } ], "returns": { - "type": "*StringCmd", + "type": "long", "description": "" } - } - ], - "node_redis": [ + }, { - "signature": "DUMP(key: RedisArgument)", + "signature": "long delex(final String key, final CompareCondition condition)", "params": [ { "name": "key", - "type": "RedisArgument", + "type": "String", + "description": "" + }, + { + "name": "condition", + "type": "CompareCondition", "description": "" } ], "returns": { - "type": "Any", + "type": "long", "description": "" } } ], "lettuce_sync": [ { - "signature": "byte[] dump(K key)", + "signature": "Long delex(K key, CompareCondition compareCondition)", "params": [ { "name": "key", "type": "K", "description": "the key." + }, + { + "name": "compareCondition", + "type": "CompareCondition", + "description": "the compare condition, must not be null." } ], "returns": { - "type": "byte[]", - "description": "byte[] bulk-string-reply the serialized value." + "type": "Long", + "description": "Long integer-reply the number of keys that were removed. @since 7.1" } } ], "lettuce_async": [ { - "signature": "RedisFuture dump(K key)", + "signature": "RedisFuture delex(K key, CompareCondition compareCondition)", "params": [ { "name": "key", "type": "K", "description": "the key." + }, + { + "name": "compareCondition", + "type": "CompareCondition", + "description": "the compare condition, must not be null." } ], "returns": { - "type": "RedisFuture", - "description": "byte[] bulk-string-reply the serialized value." + "type": "RedisFuture", + "description": "Long integer-reply the number of keys that were removed. @since 7.1" } } ], "lettuce_reactive": [ { - "signature": "Mono dump(K key)", + "signature": "Mono delex(K key, CompareCondition compareCondition)", "params": [ { "name": "key", "type": "K", "description": "the key." + }, + { + "name": "compareCondition", + "type": "CompareCondition", + "description": "the compare condition, must not be null." } ], "returns": { - "type": "Mono", - "description": "byte[] bulk-string-reply the serialized value." + "type": "Mono", + "description": "Long integer-reply the number of keys that were removed. @since 7.1" + } + } + ], + "go-redis": [ + { + "signature": "DelExArgs(ctx context.Context, key string, a DelExArgs)", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "a", + "type": "DelExArgs", + "description": "" + } + ], + "returns": { + "type": "*IntCmd", + "description": "" } } ], "nredisstack_sync": [ { - "signature": "KeyDump(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "StringDelete(RedisKey key, ValueCondition when, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key to dump." + "description": "The key of the string." + }, + { + "name": "when", + "type": "ValueCondition", + "description": "The condition to enforce." }, { "name": "flags", @@ -29375,19 +30293,24 @@ } ], "returns": { - "type": "byte[]", - "description": "The serialized value." + "type": "bool", + "description": "" } } ], "nredisstack_async": [ { - "signature": "KeyDumpAsync(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "StringDelete(RedisKey key, ValueCondition when, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key to dump." + "description": "The key of the string." + }, + { + "name": "when", + "type": "ValueCondition", + "description": "The condition to enforce." }, { "name": "flags", @@ -29396,179 +30319,271 @@ } ], "returns": { - "type": "Task", - "description": "The serialized value." + "type": "bool", + "description": "" } } ], "php": [ { - "signature": "dump(string $key)", + "signature": "delex(string $key, string $flag, $flagValue)", "params": [ { "name": "$key", "type": "string", "description": "" + }, + { + "name": "$flag", + "type": "string", + "description": "" + }, + { + "name": "$flagValue", + "type": "Any", + "description": "" } ], "returns": { - "type": "string", + "type": "int", "description": "" } } ], - "redis_rb": [ + "node_redis": [ { - "signature": "dump(key)", + "signature": "DELEX(key: RedisArgument, options?: { condition: DelexCondition; matchValue: RedisArgument })", "params": [ { "name": "key", - "type": "String", + "type": "RedisArgument", + "description": "" + }, + { + "name": "options?", + "type": "{ condition: DelexCondition; matchValue: RedisArgument }", "description": "" } ], "returns": { - "type": "String", - "description": "serialized_value" + "type": "Any", + "description": "" + } + } + ], + "redis_rs_sync": [ + { + "signature": "del_ex(key: K, value_comparison: ValueComparison)", + "params": [ + { + "name": "key", + "type": "K", + "description": "" + }, + { + "name": "value_comparison", + "type": "ValueComparison", + "description": "" + } + ], + "returns": { + "type": "(usize)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "del_ex(key: K, value_comparison: ValueComparison)", + "params": [ + { + "name": "key", + "type": "K", + "description": "" + }, + { + "name": "value_comparison", + "type": "ValueComparison", + "description": "" + } + ], + "returns": { + "type": "(usize)", + "description": "" } } ] } }, - "ECHO": { + "DIGEST": { "api_calls": { "redis_py": [ { - "signature": "echo(value: EncodableT, **kwargs)", + "signature": "digest(name: KeyT)", "params": [ { - "name": "value", - "type": "EncodableT", - "description": "The value to echo" - }, - { - "name": "**kwargs", - "type": "Any", + "name": "name", + "type": "KeyT", "description": "" } ], "returns": { - "type": "ResponseT", - "description": "" + "type": "Union[str, bytes, None]", + "description": "- None if the key does not exist - (bulk string) the XXH3 digest of the value as a hex string" } } ], - "jedis": [ + "lettuce_sync": [ { - "signature": "String echo(final String string)", + "signature": "String digestKey(K key)", "params": [ { - "name": "string", - "type": "String", - "description": "The string to echo" + "name": "key", + "type": "K", + "description": "the key." } ], "returns": { "type": "String", - "description": "The echoed string" + "description": "String bulk-string-reply the hex digest of the key's value, or null when key does not exist. @since 7.1" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture digestKey(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "RedisFuture", + "description": "String bulk-string-reply the hex digest of the key's value, or null when key does not exist. @since 7.1" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono digestKey(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "Mono", + "description": "String bulk-string-reply the hex digest of the key's value, or null when key does not exist. @since 7.1" } } ], "go-redis": [ { - "signature": "Echo(ctx context.Context, message interface{}) *StringCmd", + "signature": "Digest(ctx context.Context, key string)", "params": [ { "name": "ctx", "type": "context.Context", - "description": "Context" + "description": "" }, { - "name": "message", - "type": "interface{}", - "description": "The message to echo" + "name": "key", + "type": "string", + "description": "" } ], "returns": { - "type": "*StringCmd", + "type": "*DigestCmd", "description": "" } } ], - "node_redis": [ + "redis_rs_sync": [ { - "signature": "parseCommand(parser: CommandParser, message: RedisArgument)", + "signature": "digest(key: K)", "params": [ { - "name": "parser", - "type": "CommandParser", - "description": "The command parser" - }, + "name": "key", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(Option)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "digest(key: K)", + "params": [ { - "name": "message", - "type": "RedisArgument", - "description": "Message to echo back" + "name": "key", + "type": "K", + "description": "" } ], "returns": { - "type": "BlobStringReply", + "type": "(Option)", "description": "" } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], "nredisstack_sync": [ { - "signature": "RedisValue Echo(RedisValue message, CommandFlags flags = CommandFlags.None)", + "signature": "StringDigest(RedisKey key, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "message", - "type": "RedisValue", - "description": "The message to echo" + "name": "key", + "type": "RedisKey", + "description": "" }, { "name": "flags", "type": "CommandFlags", - "description": "Command flags" + "description": "" } ], "returns": { - "type": "RedisValue", + "type": "ValueCondition?", "description": "" } } ], "nredisstack_async": [ { - "signature": "Task EchoAsync(RedisValue message, CommandFlags flags = CommandFlags.None)", + "signature": "StringDigest(RedisKey key, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "message", - "type": "RedisValue", - "description": "The message to echo" + "name": "key", + "type": "RedisKey", + "description": "" }, { "name": "flags", "type": "CommandFlags", - "description": "Command flags" + "description": "" } ], "returns": { - "type": "Task", + "type": "ValueCondition?", "description": "" } } ], "php": [ { - "signature": "echo(string $message)", + "signature": "digest(string $key)", "params": [ { - "name": "$message", + "name": "$key", "type": "string", - "description": "The message to echo" + "description": "" } ], "returns": { @@ -29577,122 +30592,521 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "jedis": [ + { + "signature": "String digestKey(String key)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "Compute and return the 64-bit XXH3 digest hex of the string value stored at key. Returns null if key does not exist." + } + }, + { + "signature": "byte[] digestKey(byte[] key)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "byte[]", + "description": "Returns the 64-bit XXH3 digest hex (ASCII bytes) of the string value stored at key, or null if missing." + } + } + ], + "node_redis": [ + { + "signature": "DIGEST(key: RedisArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ] } }, - "EVAL": { + "DUMP": { "api_calls": { "redis_py": [ { - "signature": "eval(script: str, numkeys: int, *keys_and_args: Union[KeyT, EncodableT])", + "signature": "dump(name: KeyT)", "params": [ { - "name": "script", - "type": "str", - "description": "Lua script to execute" - }, - { - "name": "numkeys", - "type": "int", - "description": "Number of keys in the script" - }, - { - "name": "*keys_and_args", - "type": "Union[KeyT, EncodableT]", - "description": "Keys and arguments for the script" + "name": "name", + "type": "KeyT", + "description": "" } ], "returns": { - "type": "Union[Awaitable[str], str]", - "description": "Script execution result" + "type": "bytes", + "description": "" } } ], "jedis": [ { - "signature": "Object eval(final String script, final int keyCount, final String... params)", + "signature": "byte[] dump(final byte[] key)", "params": [ { - "name": "script", - "type": "String", - "description": "Lua script to execute" - }, - { - "name": "keyCount", - "type": "int", - "description": "Number of keys in the script" - }, - { - "name": "params", - "type": "String...", - "description": "Keys and arguments for the script" + "name": "key", + "type": "byte[]", + "description": "" } ], "returns": { - "type": "Object", - "description": "Script execution result" + "type": "byte[]", + "description": "the serialized value" } }, { - "signature": "Object eval(final String script, final List keys, final List args)", + "signature": "byte[] dump(final String key)", "params": [ { - "name": "script", + "name": "key", "type": "String", - "description": "Lua script to execute" - }, - { - "name": "keys", - "type": "List", - "description": "Keys for the script" - }, - { - "name": "args", - "type": "List", - "description": "Arguments for the script" + "description": "" } ], "returns": { - "type": "Object", - "description": "Script execution result" + "type": "byte[]", + "description": "the serialized value" } } ], "go-redis": [ { - "signature": "Eval(ctx context.Context, script string, keys []string, args ...interface{})", + "signature": "Dump(ctx context.Context, key string)", "params": [ { "name": "ctx", "type": "context.Context", - "description": "Context for the operation" + "description": "" }, { - "name": "script", + "name": "key", "type": "string", - "description": "Lua script to execute" - }, - { - "name": "keys", - "type": "[]string", - "description": "Keys for the script" - }, - { - "name": "args", - "type": "...interface{}", - "description": "Arguments for the script" + "description": "" } ], "returns": { - "type": "*Cmd", - "description": "Script execution result" + "type": "*StringCmd", + "description": "" } } ], "node_redis": [ { - "signature": "eval(script: RedisArgument, options?: EvalOptions)", + "signature": "DUMP(key: RedisArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "byte[] dump(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "byte[]", + "description": "byte[] bulk-string-reply the serialized value." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture dump(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "RedisFuture", + "description": "byte[] bulk-string-reply the serialized value." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono dump(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "Mono", + "description": "byte[] bulk-string-reply the serialized value." + } + } + ], + "nredisstack_sync": [ + { + "signature": "KeyDump(RedisKey key, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to dump." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "byte[]", + "description": "The serialized value." + } + } + ], + "nredisstack_async": [ + { + "signature": "KeyDumpAsync(RedisKey key, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to dump." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "Task", + "description": "The serialized value." + } + } + ], + "php": [ + { + "signature": "dump(string $key)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "string", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "dump(key)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "serialized_value" + } + } + ] + } + }, + "ECHO": { + "api_calls": { + "redis_py": [ + { + "signature": "echo(value: EncodableT, **kwargs)", + "params": [ + { + "name": "value", + "type": "EncodableT", + "description": "The value to echo" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "ResponseT", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String echo(final String string)", + "params": [ + { + "name": "string", + "type": "String", + "description": "The string to echo" + } + ], + "returns": { + "type": "String", + "description": "The echoed string" + } + } + ], + "go-redis": [ + { + "signature": "Echo(ctx context.Context, message interface{}) *StringCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "message", + "type": "interface{}", + "description": "The message to echo" + } + ], + "returns": { + "type": "*StringCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "parseCommand(parser: CommandParser, message: RedisArgument)", + "params": [ + { + "name": "parser", + "type": "CommandParser", + "description": "The command parser" + }, + { + "name": "message", + "type": "RedisArgument", + "description": "Message to echo back" + } + ], + "returns": { + "type": "BlobStringReply", + "description": "" + } + } + ], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [ + { + "signature": "RedisValue Echo(RedisValue message, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "message", + "type": "RedisValue", + "description": "The message to echo" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "Command flags" + } + ], + "returns": { + "type": "RedisValue", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task EchoAsync(RedisValue message, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "message", + "type": "RedisValue", + "description": "The message to echo" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "Command flags" + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], + "php": [ + { + "signature": "echo(string $message)", + "params": [ + { + "name": "$message", + "type": "string", + "description": "The message to echo" + } + ], + "returns": { + "type": "string", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "EVAL": { + "api_calls": { + "redis_py": [ + { + "signature": "eval(script: str, numkeys: int, *keys_and_args: Union[KeyT, EncodableT])", + "params": [ + { + "name": "script", + "type": "str", + "description": "Lua script to execute" + }, + { + "name": "numkeys", + "type": "int", + "description": "Number of keys in the script" + }, + { + "name": "*keys_and_args", + "type": "Union[KeyT, EncodableT]", + "description": "Keys and arguments for the script" + } + ], + "returns": { + "type": "Union[Awaitable[str], str]", + "description": "Script execution result" + } + } + ], + "jedis": [ + { + "signature": "Object eval(final String script, final int keyCount, final String... params)", + "params": [ + { + "name": "script", + "type": "String", + "description": "Lua script to execute" + }, + { + "name": "keyCount", + "type": "int", + "description": "Number of keys in the script" + }, + { + "name": "params", + "type": "String...", + "description": "Keys and arguments for the script" + } + ], + "returns": { + "type": "Object", + "description": "Script execution result" + } + }, + { + "signature": "Object eval(final String script, final List keys, final List args)", + "params": [ + { + "name": "script", + "type": "String", + "description": "Lua script to execute" + }, + { + "name": "keys", + "type": "List", + "description": "Keys for the script" + }, + { + "name": "args", + "type": "List", + "description": "Arguments for the script" + } + ], + "returns": { + "type": "Object", + "description": "Script execution result" + } + } + ], + "go-redis": [ + { + "signature": "Eval(ctx context.Context, script string, keys []string, args ...interface{})", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context for the operation" + }, + { + "name": "script", + "type": "string", + "description": "Lua script to execute" + }, + { + "name": "keys", + "type": "[]string", + "description": "Keys for the script" + }, + { + "name": "args", + "type": "...interface{}", + "description": "Arguments for the script" + } + ], + "returns": { + "type": "*Cmd", + "description": "Script execution result" + } + } + ], + "node_redis": [ + { + "signature": "eval(script: RedisArgument, options?: EvalOptions)", "params": [ { "name": "script", @@ -87217,121 +88631,5813 @@ } ], "returns": { - "type": "Task", - "description": "" + "type": "Task", + "description": "" + } + } + ], + "php": [ + { + "signature": "migrate(string $host, int $port, string|array $key, int $dstdb, int $timeout, bool $copy = false, bool $replace = false)", + "params": [ + { + "name": "$host", + "type": "string", + "description": "" + }, + { + "name": "$port", + "type": "int", + "description": "" + }, + { + "name": "$key", + "type": "string|array", + "description": "" + }, + { + "name": "$dstdb", + "type": "int", + "description": "" + }, + { + "name": "$timeout", + "type": "int", + "description": "" + }, + { + "name": "$copy", + "type": "bool", + "description": "" + }, + { + "name": "$replace", + "type": "bool", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "migrate(key, options)", + "params": [ + { + "name": "key", + "type": "String, Array", + "description": "" + }, + { + "name": "options", + "type": "Hash", + "description": "host, port, db, timeout, copy, replace" + } + ], + "returns": { + "type": "String", + "description": "\"OK\"" + } + } + ] + } + }, + "MODULE HELP": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "module(string $subcommand, ...$args)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "MODULE LIST": { + "api_calls": { + "redis_py": [ + { + "signature": "module_list(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "list", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "List moduleList()", + "params": [], + "returns": { + "type": "List", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ModuleList(ctx context.Context) *ModuleListCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*ModuleListCmd", + "description": "" + } + } + ], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "module(string $subcommand, ...$args)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "MODULE LOAD": { + "api_calls": { + "redis_py": [ + { + "signature": "module_load(path: str, *args, **kwargs)", + "params": [ + { + "name": "path", + "type": "str", + "description": "" + }, + { + "name": "*args", + "type": "str", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "str", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String moduleLoad(String path)", + "params": [ + { + "name": "path", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ModuleLoad(ctx context.Context, path string, args ...string) *StringCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "path", + "type": "string", + "description": "" + }, + { + "name": "args", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*StringCmd", + "description": "" + } + } + ], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "module(string $subcommand, ...$args)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "string", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "MODULE LOADEX": { + "api_calls": { + "redis_py": [ + { + "signature": "module_loadex(path: str, options: list | None = None, args: list | None = None, **kwargs)", + "params": [ + { + "name": "path", + "type": "str", + "description": "" + }, + { + "name": "options", + "type": "list | None", + "description": "" + }, + { + "name": "args", + "type": "list | None", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "str", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String moduleLoadex(String path, ModuleLoadExParams params)", + "params": [ + { + "name": "path", + "type": "String", + "description": "" + }, + { + "name": "params", + "type": "ModuleLoadExParams", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "" + } + } + ], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "module(string $subcommand, ...$args)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "string", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "MODULE UNLOAD": { + "api_calls": { + "redis_py": [ + { + "signature": "module_unload(name: str, **kwargs)", + "params": [ + { + "name": "name", + "type": "str", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "str", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String moduleUnload(String name)", + "params": [ + { + "name": "name", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ModuleUnload(ctx context.Context, name string) *StringCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "name", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "*StringCmd", + "description": "" + } + } + ], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "module(string $subcommand, ...$args)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "string", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "MODULE": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "module(string $subcommand, ...$args)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "mixed", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "MONITOR": { + "api_calls": { + "redis_py": [ + { + "signature": "monitor()", + "params": [], + "returns": { + "type": "Monitor", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "void monitor(JedisMonitor jedisMonitor)", + "params": [ + { + "name": "jedisMonitor", + "type": "JedisMonitor", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "monitor()", + "params": [], + "returns": { + "type": "void", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "MOVE": { + "api_calls": { + "redis_py": [ + { + "signature": "move(name: KeyT, db: int)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "db", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "long move(final byte[] key, final int dbIndex)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "dbIndex", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "1 if key was moved. 0 if key was not moved." + } + }, + { + "signature": "long move(final String key, final int dbIndex)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "dbIndex", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "1 if key was moved. 0 if key was not moved." + } + } + ], + "go-redis": [ + { + "signature": "Move(ctx context.Context, key string, db int)", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "db", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "*BoolCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "MOVE(key: RedisArgument, db: number)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "db", + "type": "number", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Boolean move(K key, int db)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "db", + "type": "int", + "description": "the database." + } + ], + "returns": { + "type": "Boolean", + "description": "Boolean integer-reply specifically: true if key was moved. false if key was not moved." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture move(K key, int db)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "db", + "type": "int", + "description": "the database." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Boolean integer-reply specifically: true if key was moved. false if key was not moved." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono move(K key, int db)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "db", + "type": "int", + "description": "the database." + } + ], + "returns": { + "type": "Mono", + "description": "Boolean integer-reply specifically: true if key was moved. false if key was not moved." + } + } + ], + "nredisstack_sync": [ + { + "signature": "KeyMove(RedisKey key, int database, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to move." + }, + { + "name": "database", + "type": "int", + "description": "The database to move to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "bool", + "description": "true if key was moved. false if key was not moved." + } + } + ], + "nredisstack_async": [ + { + "signature": "KeyMoveAsync(RedisKey key, int database, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to move." + }, + { + "name": "database", + "type": "int", + "description": "The database to move to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "Task", + "description": "true if key was moved. false if key was not moved." + } + } + ], + "php": [ + { + "signature": "move(string $key, int $index)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$index", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "move(key, db)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "db", + "type": "Integer", + "description": "" + } + ], + "returns": { + "type": "Boolean", + "description": "whether the key was moved or not" + } + } + ] + } + }, + "MSET": { + "api_calls": { + "redis_py": [ + { + "signature": "mset(mapping: Mapping[AnyKeyT, EncodableT])", + "params": [ + { + "name": "mapping", + "type": "Mapping[AnyKeyT, EncodableT]", + "description": "" + } + ], + "returns": { + "type": "ResponseT", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String mset(final byte[]... keysvalues)", + "params": [ + { + "name": "keysvalues", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "OK" + } + }, + { + "signature": "String mset(final String... keysvalues)", + "params": [ + { + "name": "keysvalues", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "OK" + } + } + ], + "lettuce_sync": [ + { + "signature": "String mset(Map map)", + "params": [ + { + "name": "map", + "type": "Map", + "description": "the map." + } + ], + "returns": { + "type": "String", + "description": "String simple-string-reply always OK since MSET can't fail." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture mset(Map map)", + "params": [ + { + "name": "map", + "type": "Map", + "description": "the map." + } + ], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply always OK since MSET can't fail." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono mset(Map map)", + "params": [ + { + "name": "map", + "type": "Map", + "description": "the map." + } + ], + "returns": { + "type": "Mono", + "description": "String simple-string-reply always OK since MSET can't fail." + } + } + ], + "go-redis": [ + { + "signature": "MSet(ctx context.Context, values ...interface{})", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "values", + "type": "...interface{}", + "description": "" + } + ], + "returns": { + "type": "*StatusCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "MSET(toSet: MSetArguments)", + "params": [ + { + "name": "toSet", + "type": "MSetArguments", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "ioredis": [ + { + "signature": "mset(object: object, callback?: Callback<\"OK\">): Result<\"OK\", Context>;, mset(, map: Map, callback?: Callback<\"OK\">)", + "params": [ + { + "name": "object", + "type": "object", + "description": "" + }, + { + "name": "callback?", + "type": "Callback<\"OK\">)", + "description": "" + }, + { + "name": "map", + "type": "Map", + "description": "" + }, + { + "name": "callback?", + "type": "Callback<\"OK\">", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "mset(...args: [, ...keyValues: (RedisKey | string | Buffer | number)[], callback: Callback<\"OK\">, ])", + "params": [ + { + "name": "...args", + "type": "[, ...keyValues", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "mset(...args: [...keyValues: (RedisKey | string | Buffer | number)[]])", + "params": [ + { + "name": "...args", + "type": "[...keyValues", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "redis_rs_sync": [ + { + "signature": "mset(items: &'a [(K, V)])", + "params": [ + { + "name": "items", + "type": "&'a [(K, V)]", + "description": "" + } + ], + "returns": { + "type": "(())", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "mset(items: &'a [(K, V)])", + "params": [ + { + "name": "items", + "type": "&'a [(K, V)]", + "description": "" + } + ], + "returns": { + "type": "(())", + "description": "" + } + } + ], + "php": [ + { + "signature": "mset(array $dictionary)", + "params": [ + { + "name": "$dictionary", + "type": "array", + "description": "" + } + ], + "returns": { + "type": "mixed", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "mset(*args)", + "params": [ + { + "name": "*args", + "type": "Array", + "description": "array of keys and values" + } + ], + "returns": { + "type": "String", + "description": "\"OK\"" + } + } + ] + } + }, + "MSETEX": { + "api_calls": { + "redis_py": [ + { + "signature": "msetex(, mapping: Mapping[AnyKeyT, EncodableT],, data_persist_option: Optional[DataPersistOptions] = None,, ex: Optional[ExpiryT] = None,, px: Optional[ExpiryT] = None,, exat: Optional[AbsExpiryT] = None,, pxat: Optional[AbsExpiryT] = None,, keepttl: bool = False,)", + "params": [ + { + "name": "mapping", + "type": "Mapping[AnyKeyT, EncodableT]", + "description": "" + }, + { + "name": "data_persist_option", + "type": "Optional[DataPersistOptions] = None", + "description": "" + }, + { + "name": "ex", + "type": "Optional[ExpiryT] = None", + "description": "" + }, + { + "name": "px", + "type": "Optional[ExpiryT] = None", + "description": "" + }, + { + "name": "exat", + "type": "Optional[AbsExpiryT] = None", + "description": "" + }, + { + "name": "pxat", + "type": "Optional[AbsExpiryT] = None", + "description": "" + }, + { + "name": "keepttl", + "type": "bool = False", + "description": "" + } + ], + "returns": { + "type": "Union[Awaitable[int], int]", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "boolean msetex(final MSetExParams params, final byte[]... keysvalues)", + "params": [ + { + "name": "params", + "type": "MSetExParams", + "description": "" + }, + { + "name": "keysvalues", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "boolean", + "description": "1 if the all the keys were set, 0 if no key was set (at least one key already existed)" + } + }, + { + "signature": "boolean msetex(final MSetExParams params, final String... keysvalues)", + "params": [ + { + "name": "params", + "type": "MSetExParams", + "description": "" + }, + { + "name": "keysvalues", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "boolean", + "description": "1 if the all the keys were set, 0 if no key was set (at least one key already existed)" + } + } + ], + "lettuce_sync": [ + { + "signature": "Boolean msetex(Map map, MSetExArgs args)", + "params": [ + { + "name": "map", + "type": "Map", + "description": "the map of keys and values." + }, + { + "name": "args", + "type": "MSetExArgs", + "description": "the MSetExArgs specifying NX/XX and expiration." + } + ], + "returns": { + "type": "Boolean", + "description": "Boolean from integer-reply: 1 if all keys were set, 0 otherwise. @since 7.1" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture msetex(Map map, MSetExArgs args)", + "params": [ + { + "name": "map", + "type": "Map", + "description": "the map of keys and values." + }, + { + "name": "args", + "type": "MSetExArgs", + "description": "the MSetExArgs specifying NX/XX and expiration." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Boolean from integer-reply: 1 if all keys were set, 0 otherwise. @since 7.1" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono msetex(Map map, MSetExArgs args)", + "params": [ + { + "name": "map", + "type": "Map", + "description": "the map of keys and values." + }, + { + "name": "args", + "type": "MSetExArgs", + "description": "the MSetExArgs specifying NX/XX and expiration." + } + ], + "returns": { + "type": "Mono", + "description": "Boolean from integer-reply: 1 if all keys were set, 0 otherwise. @since 7.1" + } + } + ], + "go-redis": [ + { + "signature": "MSetEX(ctx context.Context, args MSetEXArgs, values ...interface{})", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "args", + "type": "MSetEXArgs", + "description": "" + }, + { + "name": "values", + "type": "...interface{}", + "description": "" + } + ], + "returns": { + "type": "*IntCmd", + "description": "" + } + } + ], + "redis_rs_sync": [ + { + "signature": "mset_ex(items: &'a [(K, V)], options: MSetOptions)", + "params": [ + { + "name": "items", + "type": "&'a [(K, V)]", + "description": "" + }, + { + "name": "options", + "type": "MSetOptions", + "description": "" + } + ], + "returns": { + "type": "(bool)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "mset_ex(items: &'a [(K, V)], options: MSetOptions)", + "params": [ + { + "name": "items", + "type": "&'a [(K, V)]", + "description": "" + }, + { + "name": "options", + "type": "MSetOptions", + "description": "" + } + ], + "returns": { + "type": "(bool)", + "description": "" + } + } + ], + "php": [ + { + "signature": "msetex(array $dictionary, ?string $existModifier = null, ?string $expireResolution = null, ?int $expireTTL = null)", + "params": [ + { + "name": "$dictionary", + "type": "array", + "description": "" + }, + { + "name": "?string $existModifier = null", + "type": "Any", + "description": "" + }, + { + "name": "?string $expireResolution = null", + "type": "Any", + "description": "" + }, + { + "name": "?int $expireTTL = null", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ] + } + }, + "MSETNX": { + "api_calls": { + "redis_py": [ + { + "signature": "msetnx(mapping: Mapping[AnyKeyT, EncodableT])", + "params": [ + { + "name": "mapping", + "type": "Mapping[AnyKeyT, EncodableT]", + "description": "" + } + ], + "returns": { + "type": "ResponseT", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "long msetnx(final byte[]... keysvalues)", + "params": [ + { + "name": "keysvalues", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "1 if the all the keys were set, 0 if no key was set (at least one key already existed)" + } + }, + { + "signature": "long msetnx(final String... keysvalues)", + "params": [ + { + "name": "keysvalues", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "1 if the all the keys were set, 0 if no key was set (at least one key already existed)" + } + } + ], + "lettuce_sync": [ + { + "signature": "Boolean msetnx(Map map)", + "params": [ + { + "name": "map", + "type": "Map", + "description": "the map." + } + ], + "returns": { + "type": "Boolean", + "description": "Boolean integer-reply specifically: 1 if the all the keys were set. 0 if no key was set (at least one key already existed)." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture msetnx(Map map)", + "params": [ + { + "name": "map", + "type": "Map", + "description": "the map." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Boolean integer-reply specifically: 1 if the all the keys were set. 0 if no key was set (at least one key already existed)." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono msetnx(Map map)", + "params": [ + { + "name": "map", + "type": "Map", + "description": "the map." + } + ], + "returns": { + "type": "Mono", + "description": "Boolean integer-reply specifically: 1 if the all the keys were set. 0 if no key was set (at least one key already existed)." + } + } + ], + "go-redis": [ + { + "signature": "MSetNX(ctx context.Context, values ...interface{})", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "values", + "type": "...interface{}", + "description": "" + } + ], + "returns": { + "type": "*BoolCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "MSETNX(toSet: MSetArguments)", + "params": [ + { + "name": "toSet", + "type": "MSetArguments", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "ioredis": [ + { + "signature": "msetnx(object: object, callback?: Callback<\"OK\">): Result<\"OK\", Context>;, msetnx(, map: Map, callback?: Callback<\"OK\">)", + "params": [ + { + "name": "object", + "type": "object", + "description": "" + }, + { + "name": "callback?", + "type": "Callback<\"OK\">)", + "description": "" + }, + { + "name": "map", + "type": "Map", + "description": "" + }, + { + "name": "callback?", + "type": "Callback<\"OK\">", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "msetnx(...args: [, ...keyValues: (RedisKey | string | Buffer | number)[], callback: Callback, ])", + "params": [ + { + "name": "...args", + "type": "[, ...keyValues", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "msetnx(...args: [...keyValues: (RedisKey | string | Buffer | number)[]])", + "params": [ + { + "name": "...args", + "type": "[...keyValues", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "redis_rs_sync": [ + { + "signature": "mset_nx(items: &'a [(K, V)])", + "params": [ + { + "name": "items", + "type": "&'a [(K, V)]", + "description": "" + } + ], + "returns": { + "type": "(bool)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "mset_nx(items: &'a [(K, V)])", + "params": [ + { + "name": "items", + "type": "&'a [(K, V)]", + "description": "" + } + ], + "returns": { + "type": "(bool)", + "description": "" + } + } + ], + "php": [ + { + "signature": "msetnx(array $dictionary)", + "params": [ + { + "name": "$dictionary", + "type": "array", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "msetnx(*args)", + "params": [ + { + "name": "*args", + "type": "Array", + "description": "array of keys and values" + } + ], + "returns": { + "type": "Boolean", + "description": "whether or not all values were set" + } + } + ] + } + }, + "PERSIST": { + "api_calls": { + "redis_py": [ + { + "signature": "persist(name: KeyT)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "long persist(final byte[] key)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "1 if the timeout was removed, 0 if key does not exist or does not have an associated timeout" + } + }, + { + "signature": "long persist(final String key)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "1 if the timeout was removed, 0 if key does not exist or does not have an associated timeout" + } + } + ], + "go-redis": [ + { + "signature": "Persist(ctx context.Context, key string)", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "*BoolCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "PERSIST(key: RedisArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Boolean persist(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "Boolean", + "description": "Boolean integer-reply specifically: true if the timeout was removed. false if key does not exist or does not have an associated timeout." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture persist(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Boolean integer-reply specifically: true if the timeout was removed. false if key does not exist or does not have an associated timeout." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono persist(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "Mono", + "description": "Boolean integer-reply specifically: true if the timeout was removed. false if key does not exist or does not have an associated timeout." + } + } + ], + "nredisstack_sync": [ + { + "signature": "KeyPersist(RedisKey key, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to persist." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "bool", + "description": "true if the timeout was removed. false if key does not exist or does not have an associated timeout." + } + } + ], + "nredisstack_async": [ + { + "signature": "KeyPersistAsync(RedisKey key, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to persist." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "Task", + "description": "true if the timeout was removed. false if key does not exist or does not have an associated timeout." + } + } + ], + "php": [ + { + "signature": "persist(string $key)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "persist(key)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "Boolean", + "description": "whether the timeout was removed or not" + } + } + ] + } + }, + "PEXPIRE": { + "api_calls": { + "redis_py": [ + { + "signature": "pexpire(name: KeyT, time: ExpiryT, nx: bool = False, xx: bool = False, gt: bool = False, lt: bool = False)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "time", + "type": "ExpiryT", + "description": "" + }, + { + "name": "nx", + "type": "bool", + "description": "" + }, + { + "name": "xx", + "type": "bool", + "description": "" + }, + { + "name": "gt", + "type": "bool", + "description": "" + }, + { + "name": "lt", + "type": "bool", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "long pexpire(final byte[] key, final long milliseconds)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "milliseconds", + "type": "long", + "description": "time to expire" + } + ], + "returns": { + "type": "long", + "description": "1 if the timeout was set, 0 otherwise" + } + }, + { + "signature": "long pexpire(final byte[] key, final long milliseconds, final ExpiryOption expiryOption)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "milliseconds", + "type": "long", + "description": "time to expire" + }, + { + "name": "expiryOption", + "type": "ExpiryOption", + "description": "can be NX, XX, GT or LT" + } + ], + "returns": { + "type": "long", + "description": "1 if the timeout was set, 0 otherwise" + } + }, + { + "signature": "long pexpire(final String key, final long milliseconds)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "milliseconds", + "type": "long", + "description": "time to expire" + } + ], + "returns": { + "type": "long", + "description": "1 if the timeout was set, 0 otherwise" + } + }, + { + "signature": "long pexpire(final String key, final long milliseconds, final ExpiryOption expiryOption)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "milliseconds", + "type": "long", + "description": "time to expire" + }, + { + "name": "expiryOption", + "type": "ExpiryOption", + "description": "can be NX, XX, GT or LT" + } + ], + "returns": { + "type": "long", + "description": "1 if the timeout was set, 0 otherwise" + } + } + ], + "go-redis": [ + { + "signature": "PExpire(ctx context.Context, key string, expiration time.Duration)", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "expiration", + "type": "time.Duration", + "description": "" + } + ], + "returns": { + "type": "*BoolCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "PEXPIRE(key: RedisArgument, milliseconds: number, mode?: 'NX' | 'XX' | 'GT' | 'LT')", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "milliseconds", + "type": "number", + "description": "" + }, + { + "name": "mode?", + "type": "'NX' | 'XX' | 'GT' | 'LT'", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Boolean pexpire(K key, long milliseconds)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the milliseconds." + } + ], + "returns": { + "type": "Boolean", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + }, + { + "signature": "Boolean pexpire(K key, long milliseconds, ExpireArgs expireArgs)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the milliseconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the expiry arguments." + } + ], + "returns": { + "type": "Boolean", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + }, + { + "signature": "Boolean pexpire(K key, Duration milliseconds)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the milliseconds." + } + ], + "returns": { + "type": "Boolean", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + }, + { + "signature": "Boolean pexpire(K key, Duration milliseconds, ExpireArgs expireArgs)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the milliseconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the expiry arguments." + } + ], + "returns": { + "type": "Boolean", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture pexpire(K key, long milliseconds)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the milliseconds." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + }, + { + "signature": "RedisFuture pexpire(K key, long milliseconds, ExpireArgs expireArgs)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the milliseconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the expiry arguments." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + }, + { + "signature": "RedisFuture pexpire(K key, Duration milliseconds)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the milliseconds." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + }, + { + "signature": "RedisFuture pexpire(K key, Duration milliseconds, ExpireArgs expireArgs)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the milliseconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the expiry arguments." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono pexpire(K key, long milliseconds)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the milliseconds." + } + ], + "returns": { + "type": "Mono", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + }, + { + "signature": "Mono pexpire(K key, long milliseconds, ExpireArgs expireArgs)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the milliseconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the expiry arguments." + } + ], + "returns": { + "type": "Mono", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + }, + { + "signature": "Mono pexpire(K key, Duration milliseconds)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the milliseconds." + } + ], + "returns": { + "type": "Mono", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + }, + { + "signature": "Mono pexpire(K key, Duration milliseconds, ExpireArgs expireArgs)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the milliseconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the expiry arguments." + } + ], + "returns": { + "type": "Mono", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + } + ], + "nredisstack_sync": [ + { + "signature": "KeyExpire(RedisKey key, TimeSpan? expiry, ExpireWhen when = ExpireWhen.Always, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to set the expiration for." + }, + { + "name": "expiry", + "type": "TimeSpan?", + "description": "The timeout to set." + }, + { + "name": "when", + "type": "ExpireWhen", + "description": "In Redis 7+, we choose under which condition the expiration will be set using ExpireWhen." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "bool", + "description": "true if the timeout was set. false if key does not exist or the timeout could not be set." + } + } + ], + "nredisstack_async": [ + { + "signature": "KeyExpireAsync(RedisKey key, TimeSpan? expiry, ExpireWhen when = ExpireWhen.Always, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to set the expiration for." + }, + { + "name": "expiry", + "type": "TimeSpan?", + "description": "The timeout to set." + }, + { + "name": "when", + "type": "ExpireWhen", + "description": "In Redis 7+, we choose under which condition the expiration will be set using ExpireWhen." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "Task", + "description": "true if the timeout was set. false if key does not exist or the timeout could not be set." + } + } + ], + "php": [ + { + "signature": "pexpire(string $key, int $milliseconds, string $expireOption = '')", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$milliseconds", + "type": "int", + "description": "" + }, + { + "name": "$expireOption", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "pexpire(key, milliseconds, nx: nil, xx: nil, gt: nil, lt: nil)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "milliseconds", + "type": "Integer", + "description": "time to live" + }, + { + "name": "nx", + "type": "Boolean", + "description": "Set expiry only when the key has no expiry." + }, + { + "name": "xx", + "type": "Boolean", + "description": "Set expiry only when the key has an existing expiry." + }, + { + "name": "gt", + "type": "Boolean", + "description": "Set expiry only when the new expiry is greater than current one." + }, + { + "name": "lt", + "type": "Boolean", + "description": "Set expiry only when the new expiry is less than current one." + } + ], + "returns": { + "type": "Boolean", + "description": "whether the timeout was set or not" + } + } + ] + } + }, + "PEXPIREAT": { + "api_calls": { + "redis_py": [ + { + "signature": "pexpireat(name: KeyT, when: AbsExpiryT, nx: bool = False, xx: bool = False, gt: bool = False, lt: bool = False)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "when", + "type": "AbsExpiryT", + "description": "" + }, + { + "name": "nx", + "type": "bool", + "description": "" + }, + { + "name": "xx", + "type": "bool", + "description": "" + }, + { + "name": "gt", + "type": "bool", + "description": "" + }, + { + "name": "lt", + "type": "bool", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "long pexpireAt(final byte[] key, final long millisecondsTimestamp)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "millisecondsTimestamp", + "type": "long", + "description": "timestamp in milliseconds" + } + ], + "returns": { + "type": "long", + "description": "1 if the timeout was set, 0 otherwise" + } + }, + { + "signature": "long pexpireAt(final byte[] key, final long millisecondsTimestamp, final ExpiryOption expiryOption)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "millisecondsTimestamp", + "type": "long", + "description": "timestamp in milliseconds" + }, + { + "name": "expiryOption", + "type": "ExpiryOption", + "description": "can be NX, XX, GT or LT" + } + ], + "returns": { + "type": "long", + "description": "1 if the timeout was set, 0 otherwise" + } + }, + { + "signature": "long pexpireAt(final String key, final long millisecondsTimestamp)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "millisecondsTimestamp", + "type": "long", + "description": "timestamp in milliseconds" + } + ], + "returns": { + "type": "long", + "description": "1 if the timeout was set, 0 otherwise" + } + }, + { + "signature": "long pexpireAt(final String key, final long millisecondsTimestamp, final ExpiryOption expiryOption)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "millisecondsTimestamp", + "type": "long", + "description": "timestamp in milliseconds" + }, + { + "name": "expiryOption", + "type": "ExpiryOption", + "description": "can be NX, XX, GT or LT" + } + ], + "returns": { + "type": "long", + "description": "1 if the timeout was set, 0 otherwise" + } + } + ], + "go-redis": [ + { + "signature": "PExpireAt(ctx context.Context, key string, tm time.Time)", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "tm", + "type": "time.Time", + "description": "" + } + ], + "returns": { + "type": "*BoolCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "PEXPIREAT(key: RedisArgument, millisecondsTimestamp: number, mode?: 'NX' | 'XX' | 'GT' | 'LT')", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "millisecondsTimestamp", + "type": "number", + "description": "" + }, + { + "name": "mode?", + "type": "'NX' | 'XX' | 'GT' | 'LT'", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Boolean pexpireat(K key, long timestamp)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "timestamp", + "type": "long", + "description": "the milliseconds-timestamp." + } + ], + "returns": { + "type": "Boolean", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + }, + { + "signature": "Boolean pexpireat(K key, long timestamp, ExpireArgs expireArgs)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "timestamp", + "type": "long", + "description": "the milliseconds-timestamp." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the expiry arguments." + } + ], + "returns": { + "type": "Boolean", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + }, + { + "signature": "Boolean pexpireat(K key, Date timestamp)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the milliseconds-timestamp." + } + ], + "returns": { + "type": "Boolean", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + }, + { + "signature": "Boolean pexpireat(K key, Date timestamp, ExpireArgs expireArgs)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the milliseconds-timestamp." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the expiry arguments." + } + ], + "returns": { + "type": "Boolean", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture pexpireat(K key, long timestamp)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "timestamp", + "type": "long", + "description": "the milliseconds-timestamp." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + }, + { + "signature": "RedisFuture pexpireat(K key, long timestamp, ExpireArgs expireArgs)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "timestamp", + "type": "long", + "description": "the milliseconds-timestamp." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the expiry arguments." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono pexpireat(K key, long timestamp)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "timestamp", + "type": "long", + "description": "the milliseconds-timestamp." + } + ], + "returns": { + "type": "Mono", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + }, + { + "signature": "Mono pexpireat(K key, long timestamp, ExpireArgs expireArgs)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "timestamp", + "type": "long", + "description": "the milliseconds-timestamp." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the expiry arguments." + } + ], + "returns": { + "type": "Mono", + "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + } + } + ], + "nredisstack_sync": [ + { + "signature": "KeyExpire(RedisKey key, DateTime? expiry, ExpireWhen when = ExpireWhen.Always, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to set the expiration for." + }, + { + "name": "expiry", + "type": "DateTime?", + "description": "The exact date to expire at." + }, + { + "name": "when", + "type": "ExpireWhen", + "description": "In Redis 7+, we choose under which condition the expiration will be set using ExpireWhen." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "bool", + "description": "true if the timeout was set. false if key does not exist or the timeout could not be set." + } + } + ], + "nredisstack_async": [ + { + "signature": "KeyExpireAsync(RedisKey key, DateTime? expiry, ExpireWhen when = ExpireWhen.Always, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to set the expiration for." + }, + { + "name": "expiry", + "type": "DateTime?", + "description": "The exact date to expire at." + }, + { + "name": "when", + "type": "ExpireWhen", + "description": "In Redis 7+, we choose under which condition the expiration will be set using ExpireWhen." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "Task", + "description": "true if the timeout was set. false if key does not exist or the timeout could not be set." + } + } + ], + "php": [ + { + "signature": "pexpireAt(string $key, int $timestamp, string $expireOption = '')", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$timestamp", + "type": "int", + "description": "" + }, + { + "name": "$expireOption", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "pexpireat(key, ms_unix_time, nx: nil, xx: nil, gt: nil, lt: nil)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "ms_unix_time", + "type": "Integer", + "description": "expiry time specified as number of milliseconds from UNIX Epoch" + }, + { + "name": "nx", + "type": "Boolean", + "description": "Set expiry only when the key has no expiry." + }, + { + "name": "xx", + "type": "Boolean", + "description": "Set expiry only when the key has an existing expiry." + }, + { + "name": "gt", + "type": "Boolean", + "description": "Set expiry only when the new expiry is greater than current one." + }, + { + "name": "lt", + "type": "Boolean", + "description": "Set expiry only when the new expiry is less than current one." + } + ], + "returns": { + "type": "Boolean", + "description": "whether the timeout was set or not" + } + } + ] + } + }, + "PEXPIRETIME": { + "api_calls": { + "redis_py": [ + { + "signature": "pexpiretime(key: KeyT)", + "params": [ + { + "name": "key", + "type": "KeyT", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "long pexpireTime(final byte[] key)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "Expiration Unix timestamp in milliseconds, or a negative value in order to signal an error" + } + }, + { + "signature": "long pexpireTime(final String key)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "Expiration Unix timestamp in milliseconds, or a negative value in order to signal an error" + } + } + ], + "go-redis": [ + { + "signature": "PExpireTime(ctx context.Context, key string)", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "*DurationCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "PEXPIRETIME(key: RedisArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Long pexpiretime(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "Long", + "description": "Long integer-reply expiration Unix timestamp in milliseconds, or a negative value in order to signal an error." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture pexpiretime(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Long integer-reply expiration Unix timestamp in milliseconds, or a negative value in order to signal an error." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono pexpiretime(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "Mono", + "description": "Long integer-reply expiration Unix timestamp in milliseconds, or a negative value in order to signal an error." + } + } + ], + "nredisstack_sync": [ + { + "signature": "KeyExpireTime(RedisKey key, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to check." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "DateTime?", + "description": "The expiration time, or null if the key does not exist or has no associated expiration." + } + } + ], + "nredisstack_async": [ + { + "signature": "KeyExpireTimeAsync(RedisKey key, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to check." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "Task", + "description": "The expiration time, or null if the key does not exist or has no associated expiration." + } + } + ], + "php": [ + { + "signature": "pexpireTime(string $key)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "pexpiretime(key)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "Integer", + "description": "expiry time specified as number of milliseconds from UNIX Epoch" + } + } + ] + } + }, + "PFADD": { + "api_calls": { + "redis_py": [ + { + "signature": "pfadd(name: KeyT, *values: FieldT)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "The key of the HyperLogLog data structure" + }, + { + "name": "*values", + "type": "FieldT", + "description": "One or more elements to add" + } + ], + "returns": { + "type": "ResponseT", + "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + } + } + ], + "jedis": [ + { + "signature": "long pfadd(final byte[] key, final byte[]... elements)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "The key of the HyperLogLog" + }, + { + "name": "elements", + "type": "byte[]...", + "description": "One or more elements to add" + } + ], + "returns": { + "type": "long", + "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + } + }, + { + "signature": "long pfadd(final String key, final String... elements)", + "params": [ + { + "name": "key", + "type": "String", + "description": "The key of the HyperLogLog" + }, + { + "name": "elements", + "type": "String...", + "description": "One or more elements to add" + } + ], + "returns": { + "type": "long", + "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + } + } + ], + "lettuce_sync": [ + { + "signature": "Long pfadd(K key, V... values)", + "params": [ + { + "name": "key", + "type": "K", + "description": "The key" + }, + { + "name": "values", + "type": "V...", + "description": "The values to add" + } + ], + "returns": { + "type": "Long", + "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture pfadd(K key, V... values)", + "params": [ + { + "name": "key", + "type": "K", + "description": "The key" + }, + { + "name": "values", + "type": "V...", + "description": "The values to add" + } + ], + "returns": { + "type": "RedisFuture", + "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono pfadd(K key, V... values)", + "params": [ + { + "name": "key", + "type": "K", + "description": "The key" + }, + { + "name": "values", + "type": "V...", + "description": "The values to add" + } + ], + "returns": { + "type": "Mono", + "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + } + } + ], + "ioredis": [ + { + "signature": "pfadd(key: RedisKey, ...elements: (string | Buffer | number)[], callback?: Callback)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key of the HyperLogLog" + }, + { + "name": "...elements", + "type": "(string | Buffer | number)[]", + "description": "One or more elements to add" + }, + { + "name": "callback", + "type": "Callback", + "description": "Optional callback" + } + ], + "returns": { + "type": "Result", + "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + } + } + ], + "redis_rs_sync": [ + { + "signature": "pfadd(key: K, element: E)", + "params": [ + { + "name": "key", + "type": "K", + "description": "The key of the HyperLogLog" + }, + { + "name": "element", + "type": "E", + "description": "The element to add" + } + ], + "returns": { + "type": "bool", + "description": "true if at least 1 HyperLogLog internal register was altered" + } + } + ], + "redis_rs_async": [ + { + "signature": "pfadd(key: K, element: E)", + "params": [ + { + "name": "key", + "type": "K", + "description": "The key of the HyperLogLog" + }, + { + "name": "element", + "type": "E", + "description": "The element to add" + } + ], + "returns": { + "type": "bool", + "description": "true if at least 1 HyperLogLog internal register was altered" + } + } + ], + "nredisstack_sync": [ + { + "signature": "HyperLogLogAdd(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key of the HyperLogLog" + }, + { + "name": "value", + "type": "RedisValue", + "description": "The value to add" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation" + } + ], + "returns": { + "type": "bool", + "description": "true if at least 1 HyperLogLog internal register was altered, false otherwise" + } + }, + { + "signature": "HyperLogLogAdd(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key of the HyperLogLog" + }, + { + "name": "values", + "type": "RedisValue[]", + "description": "The values to add" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation" + } + ], + "returns": { + "type": "bool", + "description": "true if at least 1 HyperLogLog internal register was altered, false otherwise" + } + } + ], + "nredisstack_async": [ + { + "signature": "HyperLogLogAddAsync(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key of the HyperLogLog" + }, + { + "name": "value", + "type": "RedisValue", + "description": "The value to add" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation" + } + ], + "returns": { + "type": "Task", + "description": "true if at least 1 HyperLogLog internal register was altered, false otherwise" + } + }, + { + "signature": "HyperLogLogAddAsync(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key of the HyperLogLog" + }, + { + "name": "values", + "type": "RedisValue[]", + "description": "The values to add" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation" + } + ], + "returns": { + "type": "Task", + "description": "true if at least 1 HyperLogLog internal register was altered, false otherwise" + } + } + ], + "php": [ + { + "signature": "pfadd(string $key, array $elements)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "The key of the HyperLogLog" + }, + { + "name": "$elements", + "type": "array", + "description": "The elements to add" + } + ], + "returns": { + "type": "int", + "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + } + } + ], + "go-redis": [ + { + "signature": "PFAdd(ctx context.Context, key string, els ...interface{}) *IntCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context for the command" + }, + { + "name": "key", + "type": "string", + "description": "The key of the HyperLogLog" + }, + { + "name": "els", + "type": "...interface{}", + "description": "One or more elements to add" + } + ], + "returns": { + "type": "*IntCmd", + "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + } + } + ], + "node_redis": [ + { + "signature": "PFADD(key: RedisArgument, element?: RedisVariadicArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "The key of the HyperLogLog" + }, + { + "name": "element", + "type": "RedisVariadicArgument", + "description": "Optional elements to add" + } + ], + "returns": { + "type": "NumberReply", + "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + } + } + ], + "redis_rb": [ + { + "signature": "pfadd(key, member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "member", + "type": "String, Array", + "description": "one member, or array of members" + } + ], + "returns": { + "type": "Boolean", + "description": "true if at least 1 HyperLogLog internal register was altered" + } + } + ] + } + }, + "PFCOUNT": { + "api_calls": { + "redis_py": [ + { + "signature": "pfcount(*sources: KeyT)", + "params": [ + { + "name": "*sources", + "type": "KeyT", + "description": "One or more HyperLogLog keys" + } + ], + "returns": { + "type": "ResponseT", + "description": "The approximated number of unique elements observed via PFADD" + } + } + ], + "jedis": [ + { + "signature": "long pfcount(final byte[] key)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "The HyperLogLog key" + } + ], + "returns": { + "type": "long", + "description": "The approximated number of unique elements" + } + }, + { + "signature": "long pfcount(final byte[]... keys)", + "params": [ + { + "name": "keys", + "type": "byte[]...", + "description": "One or more HyperLogLog keys" + } + ], + "returns": { + "type": "long", + "description": "The approximated number of unique elements across all keys" + } + }, + { + "signature": "long pfcount(final String key)", + "params": [ + { + "name": "key", + "type": "String", + "description": "The HyperLogLog key" + } + ], + "returns": { + "type": "long", + "description": "The approximated number of unique elements" + } + }, + { + "signature": "long pfcount(final String... keys)", + "params": [ + { + "name": "keys", + "type": "String...", + "description": "One or more HyperLogLog keys" + } + ], + "returns": { + "type": "long", + "description": "The approximated number of unique elements across all keys" + } + } + ], + "lettuce_sync": [ + { + "signature": "Long pfcount(K... keys)", + "params": [ + { + "name": "keys", + "type": "K...", + "description": "The keys" + } + ], + "returns": { + "type": "Long", + "description": "The approximated number of unique elements observed via PFADD" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture pfcount(K... keys)", + "params": [ + { + "name": "keys", + "type": "K...", + "description": "The keys" + } + ], + "returns": { + "type": "RedisFuture", + "description": "The approximated number of unique elements observed via PFADD" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono pfcount(K... keys)", + "params": [ + { + "name": "keys", + "type": "K...", + "description": "The keys" + } + ], + "returns": { + "type": "Mono", + "description": "The approximated number of unique elements observed via PFADD" + } + } + ], + "ioredis": [ + { + "signature": "pfcount(...keys: RedisKey[], callback?: Callback)", + "params": [ + { + "name": "...keys", + "type": "RedisKey[]", + "description": "One or more HyperLogLog keys" + }, + { + "name": "callback", + "type": "Callback", + "description": "Optional callback" + } + ], + "returns": { + "type": "Result", + "description": "The approximated number of unique elements" + } + } + ], + "redis_rs_sync": [ + { + "signature": "pfcount(key: K)", + "params": [ + { + "name": "key", + "type": "K", + "description": "The HyperLogLog key" + } + ], + "returns": { + "type": "usize", + "description": "The approximated number of unique elements" + } + } + ], + "redis_rs_async": [ + { + "signature": "pfcount(key: K)", + "params": [ + { + "name": "key", + "type": "K", + "description": "The HyperLogLog key" + } + ], + "returns": { + "type": "usize", + "description": "The approximated number of unique elements" + } + } + ], + "nredisstack_sync": [ + { + "signature": "HyperLogLogLength(RedisKey key, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The HyperLogLog key" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation" + } + ], + "returns": { + "type": "long", + "description": "The approximated number of unique elements observed via HyperLogLogAdd" + } + }, + { + "signature": "HyperLogLogLength(RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the HyperLogLogs" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation" + } + ], + "returns": { + "type": "long", + "description": "The approximated number of unique elements observed via HyperLogLogAdd" + } + } + ], + "nredisstack_async": [ + { + "signature": "HyperLogLogLengthAsync(RedisKey key, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The HyperLogLog key" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation" + } + ], + "returns": { + "type": "Task", + "description": "The approximated number of unique elements observed via HyperLogLogAdd" + } + }, + { + "signature": "HyperLogLogLengthAsync(RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the HyperLogLogs" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation" + } + ], + "returns": { + "type": "Task", + "description": "The approximated number of unique elements observed via HyperLogLogAdd" + } + } + ], + "php": [ + { + "signature": "pfcount(string[]|string $keyOrKeys, string ...$keys = null)", + "params": [ + { + "name": "$keyOrKeys", + "type": "string[]|string", + "description": "One or more HyperLogLog keys" + }, + { + "name": "...$keys", + "type": "string", + "description": "Additional keys (optional)" + } + ], + "returns": { + "type": "int", + "description": "The approximated number of unique elements" + } + } + ], + "go-redis": [ + { + "signature": "PFCount(ctx context.Context, keys ...string) *IntCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context for the command" + }, + { + "name": "keys", + "type": "...string", + "description": "One or more HyperLogLog keys" + } + ], + "returns": { + "type": "*IntCmd", + "description": "The approximated number of unique elements" + } + } + ], + "node_redis": [ + { + "signature": "PFCOUNT(keys: RedisVariadicArgument)", + "params": [ + { + "name": "keys", + "type": "RedisVariadicArgument", + "description": "One or more keys of HyperLogLog structures to count" + } + ], + "returns": { + "type": "NumberReply", + "description": "The approximated number of unique elements" + } + } + ], + "redis_rb": [ + { + "signature": "pfcount(*keys)", + "params": [ + { + "name": "*keys", + "type": "String, Array", + "description": "" + } + ], + "returns": { + "type": "Integer", + "description": "" + } + } + ] + } + }, + "PFMERGE": { + "api_calls": { + "redis_py": [ + { + "signature": "pfmerge(dest: KeyT, *sources: KeyT)", + "params": [ + { + "name": "dest", + "type": "KeyT", + "description": "The destination key" + }, + { + "name": "*sources", + "type": "KeyT", + "description": "One or more source HyperLogLog keys" + } + ], + "returns": { + "type": "ResponseT", + "description": "OK" + } + } + ], + "jedis": [ + { + "signature": "String pfmerge(final byte[] destkey, final byte[]... sourcekeys)", + "params": [ + { + "name": "destkey", + "type": "byte[]", + "description": "The destination key" + }, + { + "name": "sourcekeys", + "type": "byte[]...", + "description": "One or more source keys" + } + ], + "returns": { + "type": "String", + "description": "OK" + } + }, + { + "signature": "String pfmerge(final String destkey, final String... sourcekeys)", + "params": [ + { + "name": "destkey", + "type": "String", + "description": "The destination key" + }, + { + "name": "sourcekeys", + "type": "String...", + "description": "One or more source keys" + } + ], + "returns": { + "type": "String", + "description": "OK" + } + } + ], + "lettuce_sync": [ + { + "signature": "String pfmerge(K destkey, K... sourcekeys)", + "params": [ + { + "name": "destkey", + "type": "K", + "description": "The destination key" + }, + { + "name": "sourcekeys", + "type": "K...", + "description": "The source keys" + } + ], + "returns": { + "type": "String", + "description": "OK" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture pfmerge(K destkey, K... sourcekeys)", + "params": [ + { + "name": "destkey", + "type": "K", + "description": "The destination key" + }, + { + "name": "sourcekeys", + "type": "K...", + "description": "The source keys" + } + ], + "returns": { + "type": "RedisFuture", + "description": "OK" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono pfmerge(K destkey, K... sourcekeys)", + "params": [ + { + "name": "destkey", + "type": "K", + "description": "The destination key" + }, + { + "name": "sourcekeys", + "type": "K...", + "description": "The source keys" + } + ], + "returns": { + "type": "Mono", + "description": "OK" + } + } + ], + "ioredis": [ + { + "signature": "pfmerge(destkey: RedisKey, ...sourcekeys: RedisKey[], callback?: Callback<'OK'>)", + "params": [ + { + "name": "destkey", + "type": "RedisKey", + "description": "The destination key" + }, + { + "name": "...sourcekeys", + "type": "RedisKey[]", + "description": "One or more source keys" + }, + { + "name": "callback", + "type": "Callback<'OK'>", + "description": "Optional callback" + } + ], + "returns": { + "type": "Result<'OK', Context>", + "description": "OK" + } + } + ], + "redis_rs_sync": [ + { + "signature": "pfmerge(dstkey: D, srckeys: S)", + "params": [ + { + "name": "dstkey", + "type": "D", + "description": "The destination key" + }, + { + "name": "srckeys", + "type": "S", + "description": "The source keys" + } + ], + "returns": { + "type": "()", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "pfmerge(dstkey: D, srckeys: S)", + "params": [ + { + "name": "dstkey", + "type": "D", + "description": "The destination key" + }, + { + "name": "srckeys", + "type": "S", + "description": "The source keys" + } + ], + "returns": { + "type": "()", + "description": "" + } + } + ], + "nredisstack_sync": [ + { + "signature": "HyperLogLogMerge(RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the merged HyperLogLog" + }, + { + "name": "first", + "type": "RedisKey", + "description": "First source key" + }, + { + "name": "second", + "type": "RedisKey", + "description": "Second source key" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation" + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "HyperLogLogMerge(RedisKey destination, RedisKey[] sourceKeys, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the merged HyperLogLog" + }, + { + "name": "sourceKeys", + "type": "RedisKey[]", + "description": "The keys of the HyperLogLogs to merge" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "HyperLogLogMergeAsync(RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the merged HyperLogLog" + }, + { + "name": "first", + "type": "RedisKey", + "description": "First source key" + }, + { + "name": "second", + "type": "RedisKey", + "description": "Second source key" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation" + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "HyperLogLogMergeAsync(RedisKey destination, RedisKey[] sourceKeys, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the merged HyperLogLog" + }, + { + "name": "sourceKeys", + "type": "RedisKey[]", + "description": "The keys of the HyperLogLogs to merge" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation" + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], + "php": [ + { + "signature": "pfmerge(string $destinationKey, array|string $sourceKeys)", + "params": [ + { + "name": "$destinationKey", + "type": "string", + "description": "The destination key" + }, + { + "name": "$sourceKeys", + "type": "array|string", + "description": "One or more source keys" + } + ], + "returns": { + "type": "mixed", + "description": "OK" + } + } + ], + "go-redis": [ + { + "signature": "PFMerge(ctx context.Context, dest string, keys ...string) *StatusCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context for the command" + }, + { + "name": "dest", + "type": "string", + "description": "The destination key" + }, + { + "name": "keys", + "type": "...string", + "description": "One or more source keys" + } + ], + "returns": { + "type": "*StatusCmd", + "description": "OK" + } + } + ], + "node_redis": [ + { + "signature": "PFMERGE(destination: RedisArgument, sources?: RedisVariadicArgument)", + "params": [ + { + "name": "destination", + "type": "RedisArgument", + "description": "The destination key to merge to" + }, + { + "name": "sources", + "type": "RedisVariadicArgument", + "description": "One or more source keys to merge from" + } + ], + "returns": { + "type": "SimpleStringReply", + "description": "OK" + } + } + ], + "redis_rb": [ + { + "signature": "pfmerge(dest_key, *source_key)", + "params": [ + { + "name": "dest_key", + "type": "String", + "description": "destination key" + }, + { + "name": "*source_key", + "type": "String, Array", + "description": "source key, or array of keys" + } + ], + "returns": { + "type": "Boolean", + "description": "" + } + } + ] + } + }, + "PING": { + "api_calls": { + "redis_py": [ + { + "signature": "ping(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "Union[Awaitable[bool], bool]", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String ping()", + "params": [], + "returns": { + "type": "String", + "description": "PONG" + } + }, + { + "signature": "String ping(final String message)", + "params": [ + { + "name": "message", + "type": "String", + "description": "The message to echo" + } + ], + "returns": { + "type": "String", + "description": "The message" + } + } + ], + "go-redis": [ + { + "signature": "Ping(ctx context.Context) *StatusCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*StatusCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "parseCommand(parser: CommandParser, message?: RedisArgument)", + "params": [ + { + "name": "parser", + "type": "CommandParser", + "description": "The command parser" + }, + { + "name": "message", + "type": "RedisArgument", + "description": "Optional message to be returned instead of PONG" + } + ], + "returns": { + "type": "SimpleStringReply | BlobStringReply", + "description": "" + } + } + ], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "ping(?string $message = null)", + "params": [ + { + "name": "$message", + "type": "?string", + "description": "Optional message" + } + ], + "returns": { + "type": "mixed", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "PSETEX": { + "api_calls": { + "redis_py": [ + { + "signature": "psetex(name: KeyT, time_ms: ExpiryT, value: EncodableT)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "time_ms", + "type": "ExpiryT", + "description": "" + }, + { + "name": "value", + "type": "EncodableT", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String psetex(final byte[] key, final long milliseconds, final byte[] value)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "milliseconds", + "type": "long", + "description": "" + }, + { + "name": "value", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "OK @deprecated Use Jedis#set(String, String, redis.clients.jedis.params.SetParams) with redis.clients.jedis.params.SetParams#px(long). Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 2.6.12." + } + }, + { + "signature": "String psetex(final String key, final long milliseconds, final String value)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "milliseconds", + "type": "long", + "description": "" + }, + { + "name": "value", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "OK @deprecated Use Jedis#set(String, String, redis.clients.jedis.params.SetParams) with redis.clients.jedis.params.SetParams#px(long). Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 2.6.12." + } + } + ], + "lettuce_sync": [ + { + "signature": "String psetex(K key, long milliseconds, V value)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the milliseconds type: long." + }, + { + "name": "value", + "type": "V", + "description": "the value." + } + ], + "returns": { + "type": "String", + "description": "String simple-string-reply." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture psetex(K key, long milliseconds, V value)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the milliseconds type: long." + }, + { + "name": "value", + "type": "V", + "description": "the value." + } + ], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono psetex(K key, long milliseconds, V value)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the milliseconds type: long." + }, + { + "name": "value", + "type": "V", + "description": "the value." + } + ], + "returns": { + "type": "Mono", + "description": "String simple-string-reply." + } + } + ], + "node_redis": [ + { + "signature": "PSETEX(key: RedisArgument, ms: number, value: RedisArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "ms", + "type": "number", + "description": "" + }, + { + "name": "value", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "ioredis": [ + { + "signature": "psetex(key: RedisKey, milliseconds: number | string, value: string | Buffer | number, callback?: Callback)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "" + }, + { + "name": "milliseconds", + "type": "number | string", + "description": "" + }, + { + "name": "value", + "type": "string | Buffer | number", + "description": "" + }, + { + "name": "callback?", + "type": "Callback", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "redis_rs_sync": [ + { + "signature": "pset_ex(key: K, value: V, milliseconds: u64)", + "params": [ + { + "name": "key", + "type": "K", + "description": "" + }, + { + "name": "value", + "type": "V", + "description": "" + }, + { + "name": "milliseconds", + "type": "u64", + "description": "" + } + ], + "returns": { + "type": "(())", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "pset_ex(key: K, value: V, milliseconds: u64)", + "params": [ + { + "name": "key", + "type": "K", + "description": "" + }, + { + "name": "value", + "type": "V", + "description": "" + }, + { + "name": "milliseconds", + "type": "u64", + "description": "" + } + ], + "returns": { + "type": "(())", + "description": "" + } + } + ], + "php": [ + { + "signature": "psetex(string $key, $milliseconds, $value)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$milliseconds", + "type": "Any", + "description": "" + }, + { + "name": "$value", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "Status", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "psetex(key, ttl, value)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "ttl", + "type": "Integer", + "description": "" + }, + { + "name": "value", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "\"OK\"" + } + } + ] + } + }, + "PSUBSCRIBE": { + "api_calls": { + "redis_py": [], + "jedis": [ + { + "signature": "void psubscribe(BinaryJedisPubSub jedisPubSub, final byte[]... patterns)", + "params": [ + { + "name": "jedisPubSub", + "type": "BinaryJedisPubSub", + "description": "Pub/sub listener object" + }, + { + "name": "patterns", + "type": "byte[]...", + "description": "Channel patterns to subscribe to" + } + ], + "returns": { + "type": "void", + "description": "Blocks until unsubscribed" + } + }, + { + "signature": "void psubscribe(final JedisPubSub jedisPubSub, final String... patterns)", + "params": [ + { + "name": "jedisPubSub", + "type": "JedisPubSub", + "description": "Pub/sub listener object" + }, + { + "name": "patterns", + "type": "String...", + "description": "Channel patterns to subscribe to" + } + ], + "returns": { + "type": "void", + "description": "Blocks until unsubscribed" + } + } + ], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "ioredis": [], + "redis_rs_sync": [], + "redis_rs_async": [], + "redisvl": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rb": [ + { + "signature": "psubscribe(*channels, &block)", + "params": [ + { + "name": "*channels", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "nil", + "description": "" + } + } + ] + } + }, + "PSYNC": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "PTTL": { + "api_calls": { + "redis_py": [ + { + "signature": "pttl(name: KeyT)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "long pttl(final byte[] key)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "TTL in milliseconds, or a negative value in order to signal an error" + } + }, + { + "signature": "long pttl(final String key)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "TTL in milliseconds, or a negative value in order to signal an error" + } + } + ], + "go-redis": [ + { + "signature": "PTTL(ctx context.Context, key string)", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "*DurationCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "PTTL(key: RedisArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Long pttl(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "Long", + "description": "Long integer-reply TTL in milliseconds, or a negative value in order to signal an error." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture pttl(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Long integer-reply TTL in milliseconds, or a negative value in order to signal an error." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono pttl(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "Mono", + "description": "Long integer-reply TTL in milliseconds, or a negative value in order to signal an error." + } + } + ], + "nredisstack_sync": [ + { + "signature": "KeyTimeToLive(RedisKey key, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to check." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "TimeSpan?", + "description": "The time to live, or null if the key does not exist or has no associated expiration." + } + } + ], + "nredisstack_async": [ + { + "signature": "KeyTimeToLiveAsync(RedisKey key, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to check." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "Task", + "description": "The time to live, or null if the key does not exist or has no associated expiration." + } + } + ], + "php": [ + { + "signature": "pttl(string $key)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "pttl(key)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "Integer", + "description": "remaining time to live in milliseconds" + } + } + ] + } + }, + "PUBLISH": { + "api_calls": { + "redis_py": [ + { + "signature": "publish(channel: ChannelT, message: EncodableT, **kwargs)", + "params": [ + { + "name": "channel", + "type": "ChannelT", + "description": "Channel to publish the message to" + }, + { + "name": "message", + "type": "EncodableT", + "description": "Message to publish" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "Additional keyword arguments" + } + ], + "returns": { + "type": "ResponseT", + "description": "Number of clients that received the message" + } + } + ], + "jedis": [ + { + "signature": "long publish(final byte[] channel, final byte[] message)", + "params": [ + { + "name": "channel", + "type": "byte[]", + "description": "Channel to publish the message to" + }, + { + "name": "message", + "type": "byte[]", + "description": "Message to publish" + } + ], + "returns": { + "type": "long", + "description": "Number of clients that received the message" + } + }, + { + "signature": "long publish(final String channel, final String message)", + "params": [ + { + "name": "channel", + "type": "String", + "description": "Channel to publish the message to" + }, + { + "name": "message", + "type": "String", + "description": "Message to publish" + } + ], + "returns": { + "type": "long", + "description": "Number of clients that received the message" + } + } + ], + "go-redis": [ + { + "signature": "Publish(ctx context.Context, channel string, message interface{})", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context for the operation" + }, + { + "name": "channel", + "type": "string", + "description": "Channel to publish the message to" + }, + { + "name": "message", + "type": "interface{}", + "description": "Message to publish" + } + ], + "returns": { + "type": "*IntCmd", + "description": "Number of clients that received the message" + } + } + ], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "ioredis": [], + "redis_rs_sync": [], + "redis_rs_async": [], + "redisvl": [], + "nredisstack_sync": [ + { + "signature": "long Publish(RedisChannel channel, RedisValue message, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to publish to" + }, + { + "name": "message", + "type": "RedisValue", + "description": "The message to send" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation" + } + ], + "returns": { + "type": "long", + "description": "The number of clients that received the message on the destination server" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task PublishAsync(RedisChannel channel, RedisValue message, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to publish to" + }, + { + "name": "message", + "type": "RedisValue", + "description": "The message to send" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation" + } + ], + "returns": { + "type": "Task", + "description": "The number of clients that received the message on the destination server" + } + } + ], + "php": [ + { + "signature": "publish($channel, $message)", + "params": [ + { + "name": "$channel", + "type": "string", + "description": "Channel to publish the message to" + }, + { + "name": "$message", + "type": "string", + "description": "Message to publish" + } + ], + "returns": { + "type": "int", + "description": "Number of clients that received the message" + } + } + ], + "redis_rb": [ + { + "signature": "publish(channel, message)", + "params": [ + { + "name": "channel", + "type": "String", + "description": "" + }, + { + "name": "message", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "Integer", + "description": "number of clients that received the message" + } + } + ] + } + }, + "PUBSUB CHANNELS": { + "api_calls": { + "redis_py": [ + { + "signature": "pubsub_channels(pattern: PatternT = \"*\", **kwargs)", + "params": [ + { + "name": "pattern", + "type": "PatternT", + "description": "Pattern to match channel names (default: \"*\")" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "Additional keyword arguments" + } + ], + "returns": { + "type": "ResponseT", + "description": "List of active channels matching the pattern" + } + } + ], + "jedis": [ + { + "signature": "List pubsubChannels()", + "params": [], + "returns": { + "type": "List", + "description": "List of all active channels" + } + }, + { + "signature": "List pubsubChannels(final String pattern)", + "params": [ + { + "name": "pattern", + "type": "String", + "description": "Pattern to match channel names" + } + ], + "returns": { + "type": "List", + "description": "List of active channels matching the pattern" + } + } + ], + "go-redis": [ + { + "signature": "PubSubChannels(ctx context.Context, pattern string)", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context for the operation" + }, + { + "name": "pattern", + "type": "string", + "description": "Pattern to match channel names" + } + ], + "returns": { + "type": "*StringSliceCmd", + "description": "List of active channels matching the pattern" + } + } + ], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "ioredis": [], + "redis_rs_sync": [], + "redis_rs_async": [], + "redisvl": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "pubsub($subcommand, $argument)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "PUBSUB subcommand (e.g., 'CHANNELS')" + }, + { + "name": "$argument", + "type": "mixed", + "description": "Pattern to match channel names" + } + ], + "returns": { + "type": "mixed", + "description": "List of active channels matching the pattern" + } + } + ] + } + }, + "PUBSUB HELP": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "ioredis": [], + "redis_rs_sync": [], + "redis_rs_async": [], + "redisvl": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [] + } + }, + "PUBSUB NUMPAT": { + "api_calls": { + "redis_py": [ + { + "signature": "pubsub_numpat(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "Additional keyword arguments" + } + ], + "returns": { + "type": "ResponseT", + "description": "Number of unique pattern subscriptions" + } + } + ], + "jedis": [ + { + "signature": "Long pubsubNumPat()", + "params": [], + "returns": { + "type": "Long", + "description": "Number of unique pattern subscriptions" + } + } + ], + "go-redis": [ + { + "signature": "PubSubNumPat(ctx context.Context)", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context for the operation" + } + ], + "returns": { + "type": "*IntCmd", + "description": "Number of unique pattern subscriptions" + } + } + ], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "ioredis": [], + "redis_rs_sync": [], + "redis_rs_async": [], + "redisvl": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "pubsub($subcommand, $argument)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "PUBSUB subcommand (e.g., 'NUMPAT')" + }, + { + "name": "$argument", + "type": "mixed", + "description": "Not used for NUMPAT" + } + ], + "returns": { + "type": "mixed", + "description": "Number of unique pattern subscriptions" + } + } + ] + } + }, + "PUBSUB NUMSUB": { + "api_calls": { + "redis_py": [ + { + "signature": "pubsub_numsub(*args: ChannelT, **kwargs)", + "params": [ + { + "name": "*args", + "type": "ChannelT", + "description": "Channel names to get subscriber counts for" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "Additional keyword arguments" + } + ], + "returns": { + "type": "ResponseT", + "description": "Map of channel names to subscriber counts" + } + } + ], + "jedis": [ + { + "signature": "Map pubsubNumSub(String... channels)", + "params": [ + { + "name": "channels", + "type": "String...", + "description": "Channel names to get subscriber counts for" + } + ], + "returns": { + "type": "Map", + "description": "Map of channel names to subscriber counts" + } + } + ], + "go-redis": [ + { + "signature": "PubSubNumSub(ctx context.Context, channels ...string)", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context for the operation" + }, + { + "name": "channels", + "type": "...string", + "description": "Channel names to get subscriber counts for" + } + ], + "returns": { + "type": "*MapStringIntCmd", + "description": "Map of channel names to subscriber counts" + } + } + ], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "ioredis": [], + "redis_rs_sync": [], + "redis_rs_async": [], + "redisvl": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "pubsub($subcommand, $argument)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "PUBSUB subcommand (e.g., 'NUMSUB')" + }, + { + "name": "$argument", + "type": "mixed", + "description": "Channel names to get subscriber counts for" + } + ], + "returns": { + "type": "mixed", + "description": "Map of channel names to subscriber counts" + } + } + ] + } + }, + "PUBSUB SHARDCHANNELS": { + "api_calls": { + "redis_py": [ + { + "signature": "pubsub_shardchannels(pattern: PatternT = \"*\", **kwargs)", + "params": [ + { + "name": "pattern", + "type": "PatternT", + "description": "Pattern to match shard channel names (default: \"*\")" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "Additional keyword arguments" + } + ], + "returns": { + "type": "ResponseT", + "description": "List of active shard channels matching the pattern" + } + } + ], + "jedis": [ + { + "signature": "List pubsubShardChannels()", + "params": [], + "returns": { + "type": "List", + "description": "List of all active shard channels" + } + }, + { + "signature": "List pubsubShardChannels(final String pattern)", + "params": [ + { + "name": "pattern", + "type": "String", + "description": "Pattern to match shard channel names" + } + ], + "returns": { + "type": "List", + "description": "List of active shard channels matching the pattern" + } + } + ], + "go-redis": [ + { + "signature": "PubSubShardChannels(ctx context.Context, pattern string)", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context for the operation" + }, + { + "name": "pattern", + "type": "string", + "description": "Pattern to match shard channel names" + } + ], + "returns": { + "type": "*StringSliceCmd", + "description": "List of active shard channels matching the pattern" + } + } + ], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "ioredis": [], + "redis_rs_sync": [], + "redis_rs_async": [], + "redisvl": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "pubsub($subcommand, $argument)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "PUBSUB subcommand (e.g., 'SHARDCHANNELS')" + }, + { + "name": "$argument", + "type": "mixed", + "description": "Pattern to match shard channel names" + } + ], + "returns": { + "type": "mixed", + "description": "List of active shard channels matching the pattern" + } + } + ] + } + }, + "PUBSUB SHARDNUMSUB": { + "api_calls": { + "redis_py": [ + { + "signature": "pubsub_shardnumsub(*args: ChannelT, **kwargs)", + "params": [ + { + "name": "*args", + "type": "ChannelT", + "description": "Shard channel names to get subscriber counts for" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "Additional keyword arguments" + } + ], + "returns": { + "type": "ResponseT", + "description": "Map of shard channel names to subscriber counts" + } + } + ], + "jedis": [ + { + "signature": "Map pubsubShardNumSub(String... channels)", + "params": [ + { + "name": "channels", + "type": "String...", + "description": "Shard channel names to get subscriber counts for" + } + ], + "returns": { + "type": "Map", + "description": "Map of shard channel names to subscriber counts" + } + } + ], + "go-redis": [ + { + "signature": "PubSubShardNumSub(ctx context.Context, channels ...string)", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context for the operation" + }, + { + "name": "channels", + "type": "...string", + "description": "Shard channel names to get subscriber counts for" + } + ], + "returns": { + "type": "*MapStringIntCmd", + "description": "Map of shard channel names to subscriber counts" + } + } + ], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "ioredis": [], + "redis_rs_sync": [], + "redis_rs_async": [], + "redisvl": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "pubsub($subcommand, $argument)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "PUBSUB subcommand (e.g., 'SHARDNUMSUB')" + }, + { + "name": "$argument", + "type": "mixed", + "description": "Shard channel names to get subscriber counts for" + } + ], + "returns": { + "type": "mixed", + "description": "Map of shard channel names to subscriber counts" + } + } + ] + } + }, + "PUNSUBSCRIBE": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "ioredis": [], + "redis_rs_sync": [], + "redis_rs_async": [], + "redisvl": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rb": [ + { + "signature": "punsubscribe(*channels)", + "params": [ + { + "name": "*channels", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "nil", + "description": "" + } + } + ] + } + }, + "QUIT": { + "api_calls": { + "redis_py": [ + { + "signature": "quit(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "ResponseT", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String quit()", + "params": [], + "returns": { + "type": "String", + "description": "OK" + } + } + ], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "RANDOMKEY": { + "api_calls": { + "redis_py": [ + { + "signature": "randomkey()", + "params": [], + "returns": { + "type": "str", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "byte[] randomBinaryKey()", + "params": [], + "returns": { + "type": "byte[]", + "description": "the random key, or null when the database is empty." + } + }, + { + "signature": "String randomKey()", + "params": [], + "returns": { + "type": "String", + "description": "the random key, or null when the database is empty." + } + } + ], + "go-redis": [ + { + "signature": "RandomKey(ctx context.Context)", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + } + ], + "returns": { + "type": "*StringCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "RANDOMKEY()", + "params": [], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "K randomkey()", + "params": [], + "returns": { + "type": "K", + "description": "K bulk-string-reply the random key, or null when the database is empty." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture randomkey()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "K bulk-string-reply the random key, or null when the database is empty." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono randomkey()", + "params": [], + "returns": { + "type": "Mono", + "description": "K bulk-string-reply the random key, or null when the database is empty." } } ], - "php": [ + "nredisstack_sync": [ { - "signature": "migrate(string $host, int $port, string|array $key, int $dstdb, int $timeout, bool $copy = false, bool $replace = false)", + "signature": "KeyRandom(CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "$host", - "type": "string", - "description": "" - }, - { - "name": "$port", - "type": "int", - "description": "" - }, - { - "name": "$key", - "type": "string|array", - "description": "" - }, - { - "name": "$dstdb", - "type": "int", - "description": "" - }, - { - "name": "$timeout", - "type": "int", - "description": "" - }, - { - "name": "$copy", - "type": "bool", - "description": "" - }, - { - "name": "$replace", - "type": "bool", - "description": "" + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "bool", - "description": "" + "type": "RedisKey", + "description": "The random key, or null when the database is empty." } } ], - "redis_rb": [ + "nredisstack_async": [ { - "signature": "migrate(key, options)", + "signature": "KeyRandomAsync(CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "String, Array", - "description": "" - }, - { - "name": "options", - "type": "Hash", - "description": "host, port, db, timeout, copy, replace" + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "String", - "description": "\"OK\"" + "type": "Task", + "description": "The random key, or null when the database is empty." } } - ] - } - }, - "MODULE HELP": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + ], "php": [ { - "signature": "module(string $subcommand, ...$args)", - "params": [ - { - "name": "$subcommand", - "type": "string", - "description": "" - }, - { - "name": "$args", - "type": "mixed", - "description": "" - } - ], + "signature": "randomKey()", + "params": [], "returns": { - "type": "array", + "type": "string", "description": "" } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rb": [ + { + "signature": "randomkey", + "params": [], + "returns": { + "type": "String", + "description": "" + } + } + ] } }, - "MODULE LIST": { + "READONLY": { "api_calls": { "redis_py": [ { - "signature": "module_list(**kwargs)", + "signature": "readonly(**kwargs)", "params": [ { "name": "**kwargs", @@ -87340,84 +94446,96 @@ } ], "returns": { - "type": "list", + "type": "ResponseT", "description": "" } } ], "jedis": [ { - "signature": "List moduleList()", + "signature": "String readonly()", "params": [], "returns": { - "type": "List", - "description": "" + "type": "String", + "description": "OK" } } ], "go-redis": [ { - "signature": "ModuleList(ctx context.Context) *ModuleListCmd", + "signature": "ReadOnly(ctx context.Context)", "params": [ { "name": "ctx", "type": "context.Context", - "description": "Context" + "description": "" } ], "returns": { - "type": "*ModuleListCmd", + "type": "*StatusCmd", "description": "" } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + "node_redis": [ { - "signature": "module(string $subcommand, ...$args)", + "signature": "parseCommand(parser: CommandParser)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" - }, - { - "name": "$args", - "type": "mixed", - "description": "" + "name": "parser", + "type": "CommandParser", + "description": "The command parser" } ], "returns": { - "type": "array", + "type": "SimpleStringReply", "description": "" } } ], + "lettuce_sync": [ + { + "signature": "String readOnly()", + "params": [], + "returns": { + "type": "String", + "description": "OK" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture readOnly()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "OK" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono readOnly()", + "params": [], + "returns": { + "type": "Mono", + "description": "OK" + } + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], "redis_rs_sync": [], "redis_rs_async": [] } }, - "MODULE LOAD": { + "READWRITE": { "api_calls": { "redis_py": [ { - "signature": "module_load(path: str, *args, **kwargs)", + "signature": "readwrite(**kwargs)", "params": [ - { - "name": "path", - "type": "str", - "description": "" - }, - { - "name": "*args", - "type": "str", - "description": "" - }, { "name": "**kwargs", "type": "Any", @@ -87425,108 +94543,104 @@ } ], "returns": { - "type": "str", + "type": "ResponseT", "description": "" } } ], "jedis": [ { - "signature": "String moduleLoad(String path)", - "params": [ - { - "name": "path", - "type": "String", - "description": "" - } - ], + "signature": "String readwrite()", + "params": [], "returns": { "type": "String", - "description": "" + "description": "OK" } } ], "go-redis": [ { - "signature": "ModuleLoad(ctx context.Context, path string, args ...string) *StringCmd", + "signature": "ReadWrite(ctx context.Context)", "params": [ { "name": "ctx", "type": "context.Context", - "description": "Context" - }, - { - "name": "path", - "type": "string", - "description": "" - }, - { - "name": "args", - "type": "...string", "description": "" } ], "returns": { - "type": "*StringCmd", + "type": "*StatusCmd", "description": "" } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + "node_redis": [ { - "signature": "module(string $subcommand, ...$args)", + "signature": "parseCommand(parser: CommandParser)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" - }, - { - "name": "$args", - "type": "mixed", - "description": "" + "name": "parser", + "type": "CommandParser", + "description": "The command parser" } ], "returns": { - "type": "string", + "type": "SimpleStringReply", "description": "" } } ], + "lettuce_sync": [ + { + "signature": "String readWrite()", + "params": [], + "returns": { + "type": "String", + "description": "OK" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture readWrite()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "OK" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono readWrite()", + "params": [], + "returns": { + "type": "Mono", + "description": "OK" + } + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], "redis_rs_sync": [], "redis_rs_async": [] } }, - "MODULE LOADEX": { + "RENAME": { "api_calls": { "redis_py": [ { - "signature": "module_loadex(path: str, options: list | None = None, args: list | None = None, **kwargs)", + "signature": "rename(src: KeyT, dst: KeyT)", "params": [ { - "name": "path", - "type": "str", - "description": "" - }, - { - "name": "options", - "type": "list | None", - "description": "" - }, - { - "name": "args", - "type": "list | None", + "name": "src", + "type": "KeyT", "description": "" }, { - "name": "**kwargs", - "type": "Any", + "name": "dst", + "type": "KeyT", "description": "" } ], @@ -87538,247 +94652,264 @@ ], "jedis": [ { - "signature": "String moduleLoadex(String path, ModuleLoadExParams params)", + "signature": "String rename(final byte[] oldkey, final byte[] newkey)", "params": [ { - "name": "path", + "name": "oldkey", + "type": "byte[]", + "description": "" + }, + { + "name": "newkey", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "Status code reply" + } + }, + { + "signature": "String rename(final String oldkey, final String newkey)", + "params": [ + { + "name": "oldkey", "type": "String", "description": "" }, { - "name": "params", - "type": "ModuleLoadExParams", + "name": "newkey", + "type": "String", "description": "" } ], "returns": { "type": "String", - "description": "" + "description": "Status code reply" } } ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + "go-redis": [ { - "signature": "module(string $subcommand, ...$args)", + "signature": "Rename(ctx context.Context, key, newkey string)", "params": [ { - "name": "$subcommand", + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", "type": "string", "description": "" }, { - "name": "$args", - "type": "mixed", + "name": "newkey", + "type": "string", "description": "" } ], "returns": { - "type": "string", + "type": "*StatusCmd", "description": "" } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "MODULE UNLOAD": { - "api_calls": { - "redis_py": [ + "node_redis": [ { - "signature": "module_unload(name: str, **kwargs)", + "signature": "RENAME(key: RedisArgument, newKey: RedisArgument)", "params": [ { - "name": "name", - "type": "str", + "name": "key", + "type": "RedisArgument", "description": "" }, { - "name": "**kwargs", - "type": "Any", + "name": "newKey", + "type": "RedisArgument", "description": "" } ], "returns": { - "type": "str", + "type": "Any", "description": "" } } ], - "jedis": [ + "lettuce_sync": [ { - "signature": "String moduleUnload(String name)", + "signature": "String rename(K key, K newKey)", "params": [ { - "name": "name", - "type": "String", - "description": "" + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "newKey", + "type": "K", + "description": "the newkey." } ], "returns": { "type": "String", - "description": "" + "description": "String simple-string-reply" } } ], - "go-redis": [ + "lettuce_async": [ { - "signature": "ModuleUnload(ctx context.Context, name string) *StringCmd", + "signature": "RedisFuture rename(K key, K newKey)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "name", - "type": "string", - "description": "" + "name": "newKey", + "type": "K", + "description": "the newkey." } ], "returns": { - "type": "*StringCmd", - "description": "" + "type": "RedisFuture", + "description": "String simple-string-reply" } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + "lettuce_reactive": [ { - "signature": "module(string $subcommand, ...$args)", + "signature": "Mono rename(K key, K newKey)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "newKey", + "type": "K", + "description": "the newkey." } ], "returns": { - "type": "string", - "description": "" + "type": "Mono", + "description": "String simple-string-reply" + } + } + ], + "nredisstack_sync": [ + { + "signature": "KeyRename(RedisKey key, RedisKey newKey, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to rename." + }, + { + "name": "newKey", + "type": "RedisKey", + "description": "The new key name." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "bool", + "description": "true if the key was renamed, false otherwise." + } + } + ], + "nredisstack_async": [ + { + "signature": "KeyRenameAsync(RedisKey key, RedisKey newKey, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key to rename." + }, + { + "name": "newKey", + "type": "RedisKey", + "description": "The new key name." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "Task", + "description": "true if the key was renamed, false otherwise." } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "MODULE": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], "php": [ { - "signature": "module(string $subcommand, ...$args)", + "signature": "rename(string $srcKey, string $dstKey)", "params": [ { - "name": "$subcommand", + "name": "$srcKey", "type": "string", "description": "" }, { - "name": "$args", - "type": "mixed", + "name": "$dstKey", + "type": "string", "description": "" } ], "returns": { - "type": "mixed", - "description": "" - } - } - ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "MONITOR": { - "api_calls": { - "redis_py": [ - { - "signature": "monitor()", - "params": [], - "returns": { - "type": "Monitor", + "type": "bool", "description": "" } } ], - "jedis": [ + "redis_rb": [ { - "signature": "void monitor(JedisMonitor jedisMonitor)", + "signature": "rename(old_name, new_name)", "params": [ { - "name": "jedisMonitor", - "type": "JedisMonitor", + "name": "old_name", + "type": "String", + "description": "" + }, + { + "name": "new_name", + "type": "String", "description": "" } ], "returns": { - "type": "void", - "description": "" - } - } - ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ - { - "signature": "monitor()", - "params": [], - "returns": { - "type": "void", - "description": "" + "type": "String", + "description": "\"OK\"" } } - ], - "redis_rs_sync": [], - "redis_rs_async": [] + ] } }, - "MOVE": { + "RENAMENX": { "api_calls": { "redis_py": [ { - "signature": "move(name: KeyT, db: int)", + "signature": "renamenx(src: KeyT, dst: KeyT)", "params": [ { - "name": "name", + "name": "src", "type": "KeyT", "description": "" }, { - "name": "db", - "type": "int", + "name": "dst", + "type": "KeyT", "description": "" } ], @@ -87790,47 +94921,47 @@ ], "jedis": [ { - "signature": "long move(final byte[] key, final int dbIndex)", + "signature": "long renamenx(final byte[] oldkey, final byte[] newkey)", "params": [ { - "name": "key", + "name": "oldkey", "type": "byte[]", "description": "" }, { - "name": "dbIndex", - "type": "int", + "name": "newkey", + "type": "byte[]", "description": "" } ], "returns": { "type": "long", - "description": "1 if key was moved. 0 if key was not moved." + "description": "1 if key was renamed to newkey, 0 if newkey already exists" } }, { - "signature": "long move(final String key, final int dbIndex)", + "signature": "long renamenx(final String oldkey, final String newkey)", "params": [ { - "name": "key", + "name": "oldkey", "type": "String", "description": "" }, { - "name": "dbIndex", - "type": "int", + "name": "newkey", + "type": "String", "description": "" } ], "returns": { "type": "long", - "description": "1 if key was moved. 0 if key was not moved." + "description": "1 if key was renamed to newkey, 0 if newkey already exists" } } ], "go-redis": [ { - "signature": "Move(ctx context.Context, key string, db int)", + "signature": "RenameNX(ctx context.Context, key, newkey string)", "params": [ { "name": "ctx", @@ -87843,8 +94974,8 @@ "description": "" }, { - "name": "db", - "type": "int", + "name": "newkey", + "type": "string", "description": "" } ], @@ -87856,7 +94987,7 @@ ], "node_redis": [ { - "signature": "MOVE(key: RedisArgument, db: number)", + "signature": "RENAMENX(key: RedisArgument, newKey: RedisArgument)", "params": [ { "name": "key", @@ -87864,8 +94995,8 @@ "description": "" }, { - "name": "db", - "type": "number", + "name": "newKey", + "type": "RedisArgument", "description": "" } ], @@ -87877,7 +95008,7 @@ ], "lettuce_sync": [ { - "signature": "Boolean move(K key, int db)", + "signature": "Boolean renamenx(K key, K newKey)", "params": [ { "name": "key", @@ -87885,20 +95016,20 @@ "description": "the key." }, { - "name": "db", - "type": "int", - "description": "the database." + "name": "newKey", + "type": "K", + "description": "the newkey." } ], "returns": { "type": "Boolean", - "description": "Boolean integer-reply specifically: true if key was moved. false if key was not moved." + "description": "Boolean integer-reply specifically: true if key was renamed to newkey. false if newkey already exists." } } ], "lettuce_async": [ { - "signature": "RedisFuture move(K key, int db)", + "signature": "RedisFuture renamenx(K key, K newKey)", "params": [ { "name": "key", @@ -87906,20 +95037,20 @@ "description": "the key." }, { - "name": "db", - "type": "int", - "description": "the database." + "name": "newKey", + "type": "K", + "description": "the newkey." } ], "returns": { "type": "RedisFuture", - "description": "Boolean integer-reply specifically: true if key was moved. false if key was not moved." + "description": "Boolean integer-reply specifically: true if key was renamed to newkey. false if newkey already exists." } } ], "lettuce_reactive": [ { - "signature": "Mono move(K key, int db)", + "signature": "Mono renamenx(K key, K newKey)", "params": [ { "name": "key", @@ -87927,30 +95058,35 @@ "description": "the key." }, { - "name": "db", - "type": "int", - "description": "the database." + "name": "newKey", + "type": "K", + "description": "the newkey." } ], "returns": { "type": "Mono", - "description": "Boolean integer-reply specifically: true if key was moved. false if key was not moved." + "description": "Boolean integer-reply specifically: true if key was renamed to newkey. false if newkey already exists." } } ], "nredisstack_sync": [ { - "signature": "KeyMove(RedisKey key, int database, CommandFlags flags = CommandFlags.None)", + "signature": "KeyRename(RedisKey key, RedisKey newKey, When when, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key to move." + "description": "The key to rename." }, { - "name": "database", - "type": "int", - "description": "The database to move to." + "name": "newKey", + "type": "RedisKey", + "description": "The new key name." + }, + { + "name": "when", + "type": "When", + "description": "Which condition to use for the rename (NotExists for RENAMENX)." }, { "name": "flags", @@ -87960,23 +95096,28 @@ ], "returns": { "type": "bool", - "description": "true if key was moved. false if key was not moved." + "description": "true if key was renamed to newkey. false if newkey already exists." } } ], "nredisstack_async": [ { - "signature": "KeyMoveAsync(RedisKey key, int database, CommandFlags flags = CommandFlags.None)", + "signature": "KeyRenameAsync(RedisKey key, RedisKey newKey, When when, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key to move." + "description": "The key to rename." }, { - "name": "database", - "type": "int", - "description": "The database to move to." + "name": "newKey", + "type": "RedisKey", + "description": "The new key name." + }, + { + "name": "when", + "type": "When", + "description": "Which condition to use for the rename (NotExists for RENAMENX)." }, { "name": "flags", @@ -87986,162 +95127,144 @@ ], "returns": { "type": "Task", - "description": "true if key was moved. false if key was not moved." + "description": "true if key was renamed to newkey. false if newkey already exists." } } ], "php": [ { - "signature": "move(string $key, int $index)", + "signature": "renameNx(string $srcKey, string $dstKey)", "params": [ { - "name": "$key", + "name": "$srcKey", "type": "string", "description": "" }, { - "name": "$index", - "type": "int", + "name": "$dstKey", + "type": "string", "description": "" } ], "returns": { - "type": "bool", + "type": "int", "description": "" } } ], "redis_rb": [ { - "signature": "move(key, db)", + "signature": "renamenx(old_name, new_name)", "params": [ { - "name": "key", + "name": "old_name", "type": "String", "description": "" }, { - "name": "db", - "type": "Integer", + "name": "new_name", + "type": "String", "description": "" } ], "returns": { "type": "Boolean", - "description": "whether the key was moved or not" + "description": "whether the key was renamed or not" } } ] } }, - "MSET": { + "REPLCONF": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "REPLICAOF": { "api_calls": { "redis_py": [ { - "signature": "mset(mapping: Mapping[AnyKeyT, EncodableT])", + "signature": "replicaof(host: str | None = None, port: int | str | None = None, **kwargs)", "params": [ { - "name": "mapping", - "type": "Mapping[AnyKeyT, EncodableT]", + "name": "host", + "type": "str | None", + "description": "" + }, + { + "name": "port", + "type": "int | str | None", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", "description": "" } ], "returns": { - "type": "ResponseT", + "type": "str", "description": "" } } ], "jedis": [ { - "signature": "String mset(final byte[]... keysvalues)", + "signature": "String replicaof(String host, int port)", "params": [ { - "name": "keysvalues", - "type": "byte[]...", + "name": "host", + "type": "String", "description": "" - } - ], - "returns": { - "type": "String", - "description": "OK" - } - }, - { - "signature": "String mset(final String... keysvalues)", - "params": [ + }, { - "name": "keysvalues", - "type": "String...", + "name": "port", + "type": "int", "description": "" } ], "returns": { "type": "String", - "description": "OK" + "description": "" } - } - ], - "lettuce_sync": [ + }, { - "signature": "String mset(Map map)", - "params": [ - { - "name": "map", - "type": "Map", - "description": "the map." - } - ], + "signature": "String replicaofNoOne()", + "params": [], "returns": { "type": "String", - "description": "String simple-string-reply always OK since MSET can't fail." - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture mset(Map map)", - "params": [ - { - "name": "map", - "type": "Map", - "description": "the map." - } - ], - "returns": { - "type": "RedisFuture", - "description": "String simple-string-reply always OK since MSET can't fail." - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono mset(Map map)", - "params": [ - { - "name": "map", - "type": "Map", - "description": "the map." - } - ], - "returns": { - "type": "Mono", - "description": "String simple-string-reply always OK since MSET can't fail." + "description": "" } } ], "go-redis": [ { - "signature": "MSet(ctx context.Context, values ...interface{})", + "signature": "ReplicaOf(ctx context.Context, host, port string) *StatusCmd", "params": [ { "name": "ctx", "type": "context.Context", + "description": "Context" + }, + { + "name": "host", + "type": "string", "description": "" }, { - "name": "values", - "type": "...interface{}", + "name": "port", + "type": "string", "description": "" } ], @@ -88151,301 +95274,356 @@ } } ], - "node_redis": [ + "node_redis": [], + "lettuce_sync": [ { - "signature": "MSET(toSet: MSetArguments)", + "signature": "String replicaof(String host, int port)", "params": [ { - "name": "toSet", - "type": "MSetArguments", + "name": "host", + "type": "String", + "description": "" + }, + { + "name": "port", + "type": "int", "description": "" } ], "returns": { - "type": "Any", + "type": "String", + "description": "" + } + }, + { + "signature": "String replicaofNoOne()", + "params": [], + "returns": { + "type": "String", "description": "" } } ], - "ioredis": [ + "lettuce_async": [ { - "signature": "mset(object: object, callback?: Callback<\"OK\">): Result<\"OK\", Context>;, mset(, map: Map, callback?: Callback<\"OK\">)", + "signature": "RedisFuture replicaof(String host, int port)", "params": [ { - "name": "object", - "type": "object", - "description": "" - }, - { - "name": "callback?", - "type": "Callback<\"OK\">)", - "description": "" - }, - { - "name": "map", - "type": "Map", + "name": "host", + "type": "String", "description": "" }, { - "name": "callback?", - "type": "Callback<\"OK\">", - "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "mset(...args: [, ...keyValues: (RedisKey | string | Buffer | number)[], callback: Callback<\"OK\">, ])", - "params": [ - { - "name": "...args", - "type": "[, ...keyValues", + "name": "port", + "type": "int", "description": "" } ], "returns": { - "type": "Any", + "type": "RedisFuture", "description": "" } }, { - "signature": "mset(...args: [...keyValues: (RedisKey | string | Buffer | number)[]])", - "params": [ - { - "name": "...args", - "type": "[...keyValues", - "description": "" - } - ], + "signature": "RedisFuture replicaofNoOne()", + "params": [], "returns": { - "type": "Any", + "type": "RedisFuture", "description": "" } } ], - "redis_rs_sync": [ + "lettuce_reactive": [ { - "signature": "mset(items: &'a [(K, V)])", + "signature": "Mono replicaof(String host, int port)", "params": [ { - "name": "items", - "type": "&'a [(K, V)]", + "name": "host", + "type": "String", + "description": "" + }, + { + "name": "port", + "type": "int", "description": "" } ], "returns": { - "type": "(())", + "type": "Mono", "description": "" } - } - ], - "redis_rs_async": [ + }, { - "signature": "mset(items: &'a [(K, V)])", - "params": [ - { - "name": "items", - "type": "&'a [(K, V)]", - "description": "" - } - ], + "signature": "Mono replicaofNoOne()", + "params": [], "returns": { - "type": "(())", + "type": "Mono", "description": "" } } ], + "nredisstack_sync": [], + "nredisstack_async": [], "php": [ { - "signature": "mset(array $dictionary)", + "signature": "replicaof(string $host, int $port)", "params": [ { - "name": "$dictionary", - "type": "array", + "name": "$host", + "type": "string", + "description": "" + }, + { + "name": "$port", + "type": "int", "description": "" } ], "returns": { - "type": "mixed", + "type": "string", "description": "" } } ], - "redis_rb": [ + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "RESET": { + "api_calls": { + "redis_py": [ { - "signature": "mset(*args)", + "signature": "reset(**kwargs)", "params": [ { - "name": "*args", - "type": "Array", - "description": "array of keys and values" + "name": "**kwargs", + "type": "Any", + "description": "" } ], "returns": { - "type": "String", - "description": "\"OK\"" + "type": "ResponseT", + "description": "" } } - ] + ], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] } }, - "MSETEX": { + "RESTORE-ASKING": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "RESTORE": { "api_calls": { "redis_py": [ { - "signature": "msetex(, mapping: Mapping[AnyKeyT, EncodableT],, data_persist_option: Optional[DataPersistOptions] = None,, ex: Optional[ExpiryT] = None,, px: Optional[ExpiryT] = None,, exat: Optional[AbsExpiryT] = None,, pxat: Optional[AbsExpiryT] = None,, keepttl: bool = False,)", + "signature": "restore(name: KeyT, ttl: int, value: bytes, replace: bool = False, absttl: bool = False, idletime: Optional[int] = None, frequency: Optional[int] = None)", "params": [ { - "name": "mapping", - "type": "Mapping[AnyKeyT, EncodableT]", + "name": "name", + "type": "KeyT", "description": "" }, { - "name": "data_persist_option", - "type": "Optional[DataPersistOptions] = None", + "name": "ttl", + "type": "int", "description": "" }, { - "name": "ex", - "type": "Optional[ExpiryT] = None", + "name": "value", + "type": "bytes", "description": "" }, { - "name": "px", - "type": "Optional[ExpiryT] = None", + "name": "replace", + "type": "bool", "description": "" }, { - "name": "exat", - "type": "Optional[AbsExpiryT] = None", + "name": "absttl", + "type": "bool", "description": "" }, { - "name": "pxat", - "type": "Optional[AbsExpiryT] = None", + "name": "idletime", + "type": "Optional[int]", "description": "" }, { - "name": "keepttl", - "type": "bool = False", + "name": "frequency", + "type": "Optional[int]", "description": "" } ], "returns": { - "type": "Union[Awaitable[int], int]", + "type": "str", "description": "" } } ], "jedis": [ { - "signature": "boolean msetex(final MSetExParams params, final byte[]... keysvalues)", + "signature": "String restore(final byte[] key, final long ttl, final byte[] serializedValue)", "params": [ { - "name": "params", - "type": "MSetExParams", + "name": "key", + "type": "byte[]", "description": "" }, { - "name": "keysvalues", - "type": "byte[]...", + "name": "ttl", + "type": "long", + "description": "time to live" + }, + { + "name": "serializedValue", + "type": "byte[]", "description": "" } ], "returns": { - "type": "boolean", - "description": "1 if the all the keys were set, 0 if no key was set (at least one key already existed)" + "type": "String", + "description": "Status code reply" } }, { - "signature": "boolean msetex(final MSetExParams params, final String... keysvalues)", + "signature": "String restore(final byte[] key, final long ttl, final byte[] serializedValue, final RestoreParams params)", "params": [ { - "name": "params", - "type": "MSetExParams", + "name": "key", + "type": "byte[]", "description": "" }, { - "name": "keysvalues", - "type": "String...", + "name": "ttl", + "type": "long", + "description": "time to live" + }, + { + "name": "serializedValue", + "type": "byte[]", + "description": "" + }, + { + "name": "params", + "type": "RestoreParams", "description": "" } ], "returns": { - "type": "boolean", - "description": "1 if the all the keys were set, 0 if no key was set (at least one key already existed)" + "type": "String", + "description": "Status code reply" } - } - ], - "lettuce_sync": [ + }, { - "signature": "Boolean msetex(Map map, MSetExArgs args)", + "signature": "String restore(final String key, final long ttl, final byte[] serializedValue)", "params": [ { - "name": "map", - "type": "Map", - "description": "the map of keys and values." + "name": "key", + "type": "String", + "description": "" }, { - "name": "args", - "type": "MSetExArgs", - "description": "the MSetExArgs specifying NX/XX and expiration." + "name": "ttl", + "type": "long", + "description": "time to live" + }, + { + "name": "serializedValue", + "type": "byte[]", + "description": "" } ], "returns": { - "type": "Boolean", - "description": "Boolean from integer-reply: 1 if all keys were set, 0 otherwise. @since 7.1" + "type": "String", + "description": "Status code reply" } - } - ], - "lettuce_async": [ + }, { - "signature": "RedisFuture msetex(Map map, MSetExArgs args)", + "signature": "String restore(final String key, final long ttl, final byte[] serializedValue, final RestoreParams params)", "params": [ { - "name": "map", - "type": "Map", - "description": "the map of keys and values." + "name": "key", + "type": "String", + "description": "" }, { - "name": "args", - "type": "MSetExArgs", - "description": "the MSetExArgs specifying NX/XX and expiration." + "name": "ttl", + "type": "long", + "description": "time to live" + }, + { + "name": "serializedValue", + "type": "byte[]", + "description": "" + }, + { + "name": "params", + "type": "RestoreParams", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Boolean from integer-reply: 1 if all keys were set, 0 otherwise. @since 7.1" + "type": "String", + "description": "Status code reply" } } ], - "lettuce_reactive": [ + "go-redis": [ { - "signature": "Mono msetex(Map map, MSetExArgs args)", + "signature": "Restore(ctx context.Context, key string, ttl time.Duration, value string)", "params": [ { - "name": "map", - "type": "Map", - "description": "the map of keys and values." + "name": "ctx", + "type": "context.Context", + "description": "" }, { - "name": "args", - "type": "MSetExArgs", - "description": "the MSetExArgs specifying NX/XX and expiration." + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "ttl", + "type": "time.Duration", + "description": "" + }, + { + "name": "value", + "type": "string", + "description": "" } ], "returns": { - "type": "Mono", - "description": "Boolean from integer-reply: 1 if all keys were set, 0 otherwise. @since 7.1" + "type": "*StatusCmd", + "description": "" } - } - ], - "go-redis": [ + }, { - "signature": "MSetEX(ctx context.Context, args MSetEXArgs, values ...interface{})", + "signature": "RestoreReplace(ctx context.Context, key string, ttl time.Duration, value string)", "params": [ { "name": "ctx", @@ -88453,252 +95631,400 @@ "description": "" }, { - "name": "args", - "type": "MSetEXArgs", + "name": "key", + "type": "string", "description": "" }, { - "name": "values", - "type": "...interface{}", + "name": "ttl", + "type": "time.Duration", + "description": "" + }, + { + "name": "value", + "type": "string", "description": "" } ], "returns": { - "type": "*IntCmd", + "type": "*StatusCmd", "description": "" } } ], - "redis_rs_sync": [ + "node_redis": [ { - "signature": "mset_ex(items: &'a [(K, V)], options: MSetOptions)", + "signature": "RESTORE(key: RedisArgument, ttl: number, serializedValue: RedisArgument, options?: RestoreOptions)", "params": [ { - "name": "items", - "type": "&'a [(K, V)]", + "name": "key", + "type": "RedisArgument", "description": "" }, { - "name": "options", - "type": "MSetOptions", + "name": "ttl", + "type": "number", + "description": "" + }, + { + "name": "serializedValue", + "type": "RedisArgument", + "description": "" + }, + { + "name": "options?", + "type": "RestoreOptions", "description": "" } ], "returns": { - "type": "(bool)", + "type": "Any", "description": "" } } ], - "redis_rs_async": [ + "lettuce_sync": [ { - "signature": "mset_ex(items: &'a [(K, V)], options: MSetOptions)", + "signature": "String restore(K key, byte[] value)", "params": [ { - "name": "items", - "type": "&'a [(K, V)]", - "description": "" + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "options", - "type": "MSetOptions", - "description": "" + "name": "value", + "type": "byte[]", + "description": "the value." } ], "returns": { - "type": "(bool)", - "description": "" + "type": "String", + "description": "String simple-string-reply The command returns OK on success." } - } - ], - "php": [ + }, { - "signature": "msetex(array $dictionary, ?string $existModifier = null, ?string $expireResolution = null, ?int $expireTTL = null)", + "signature": "String restore(K key, long ttl, byte[] value)", "params": [ { - "name": "$dictionary", - "type": "array", - "description": "" + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "?string $existModifier = null", - "type": "Any", - "description": "" + "name": "ttl", + "type": "long", + "description": "the ttl." }, { - "name": "?string $expireResolution = null", - "type": "Any", - "description": "" + "name": "value", + "type": "byte[]", + "description": "the value." + } + ], + "returns": { + "type": "String", + "description": "String simple-string-reply The command returns OK on success." + } + }, + { + "signature": "String restore(K key, byte[] value, RestoreArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "?int $expireTTL = null", - "type": "Any", - "description": "" + "name": "value", + "type": "byte[]", + "description": "the value." + }, + { + "name": "args", + "type": "RestoreArgs", + "description": "the restore arguments." } ], "returns": { - "type": "array", - "description": "" + "type": "String", + "description": "String simple-string-reply The command returns OK on success." } } - ] - } - }, - "MSETNX": { - "api_calls": { - "redis_py": [ + ], + "lettuce_async": [ { - "signature": "msetnx(mapping: Mapping[AnyKeyT, EncodableT])", + "signature": "RedisFuture restore(K key, byte[] value)", "params": [ { - "name": "mapping", - "type": "Mapping[AnyKeyT, EncodableT]", - "description": "" + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "value", + "type": "byte[]", + "description": "the value." } ], "returns": { - "type": "ResponseT", - "description": "" + "type": "RedisFuture", + "description": "String simple-string-reply The command returns OK on success." } - } - ], - "jedis": [ + }, { - "signature": "long msetnx(final byte[]... keysvalues)", + "signature": "RedisFuture restore(K key, long ttl, byte[] value)", "params": [ { - "name": "keysvalues", - "type": "byte[]...", - "description": "" + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "ttl", + "type": "long", + "description": "the ttl." + }, + { + "name": "value", + "type": "byte[]", + "description": "the value." } ], "returns": { - "type": "long", - "description": "1 if the all the keys were set, 0 if no key was set (at least one key already existed)" + "type": "RedisFuture", + "description": "String simple-string-reply The command returns OK on success." } }, { - "signature": "long msetnx(final String... keysvalues)", + "signature": "RedisFuture restore(K key, byte[] value, RestoreArgs args)", "params": [ { - "name": "keysvalues", - "type": "String...", - "description": "" + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "value", + "type": "byte[]", + "description": "the value." + }, + { + "name": "args", + "type": "RestoreArgs", + "description": "the restore arguments." } ], "returns": { - "type": "long", - "description": "1 if the all the keys were set, 0 if no key was set (at least one key already existed)" + "type": "RedisFuture", + "description": "String simple-string-reply The command returns OK on success." } } ], - "lettuce_sync": [ + "lettuce_reactive": [ { - "signature": "Boolean msetnx(Map map)", + "signature": "Mono restore(K key, byte[] value)", "params": [ { - "name": "map", - "type": "Map", - "description": "the map." + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "value", + "type": "byte[]", + "description": "the value." } ], "returns": { - "type": "Boolean", - "description": "Boolean integer-reply specifically: 1 if the all the keys were set. 0 if no key was set (at least one key already existed)." + "type": "Mono", + "description": "String simple-string-reply The command returns OK on success." } - } - ], - "lettuce_async": [ + }, { - "signature": "RedisFuture msetnx(Map map)", + "signature": "Mono restore(K key, long ttl, byte[] value)", "params": [ { - "name": "map", - "type": "Map", - "description": "the map." + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "ttl", + "type": "long", + "description": "the ttl." + }, + { + "name": "value", + "type": "byte[]", + "description": "the value." } ], "returns": { - "type": "RedisFuture", - "description": "Boolean integer-reply specifically: 1 if the all the keys were set. 0 if no key was set (at least one key already existed)." + "type": "Mono", + "description": "String simple-string-reply The command returns OK on success." + } + }, + { + "signature": "Mono restore(K key, byte[] value, RestoreArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "value", + "type": "byte[]", + "description": "the value." + }, + { + "name": "args", + "type": "RestoreArgs", + "description": "the restore arguments." + } + ], + "returns": { + "type": "Mono", + "description": "String simple-string-reply The command returns OK on success." } } ], - "lettuce_reactive": [ + "nredisstack_sync": [ { - "signature": "Mono msetnx(Map map)", + "signature": "KeyRestore(RedisKey key, byte[] value, TimeSpan? expiry = null, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "map", - "type": "Map", - "description": "the map." + "name": "key", + "type": "RedisKey", + "description": "The key to restore." + }, + { + "name": "value", + "type": "byte[]", + "description": "The serialized value to restore." + }, + { + "name": "expiry", + "type": "TimeSpan?", + "description": "The expiry to set." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Mono", - "description": "Boolean integer-reply specifically: 1 if the all the keys were set. 0 if no key was set (at least one key already existed)." + "type": "void", + "description": "" } } ], - "go-redis": [ + "nredisstack_async": [ { - "signature": "MSetNX(ctx context.Context, values ...interface{})", + "signature": "KeyRestoreAsync(RedisKey key, byte[] value, TimeSpan? expiry = null, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" + "name": "key", + "type": "RedisKey", + "description": "The key to restore." }, { - "name": "values", - "type": "...interface{}", - "description": "" + "name": "value", + "type": "byte[]", + "description": "The serialized value to restore." + }, + { + "name": "expiry", + "type": "TimeSpan?", + "description": "The expiry to set." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "*BoolCmd", + "type": "Task", "description": "" } } ], - "node_redis": [ + "php": [ { - "signature": "MSETNX(toSet: MSetArguments)", + "signature": "restore(string $key, int $ttl, string $value, array $options = null)", "params": [ { - "name": "toSet", - "type": "MSetArguments", + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$ttl", + "type": "int", + "description": "" + }, + { + "name": "$value", + "type": "string", + "description": "" + }, + { + "name": "$options", + "type": "array", "description": "" } ], "returns": { - "type": "Any", + "type": "bool", "description": "" } } ], - "ioredis": [ + "redis_rb": [ { - "signature": "msetnx(object: object, callback?: Callback<\"OK\">): Result<\"OK\", Context>;, msetnx(, map: Map, callback?: Callback<\"OK\">)", + "signature": "restore(key, ttl, serialized_value, replace: nil)", "params": [ { - "name": "object", - "type": "object", + "name": "key", + "type": "String", "description": "" }, { - "name": "callback?", - "type": "Callback<\"OK\">)", + "name": "ttl", + "type": "String", "description": "" }, { - "name": "map", - "type": "Map", + "name": "serialized_value", + "type": "String", "description": "" }, { - "name": "callback?", - "type": "Callback<\"OK\">", + "name": "replace", + "type": "Boolean", + "description": "if false, raises an error if key already exists" + } + ], + "returns": { + "type": "String", + "description": "\"OK\"" + } + } + ] + } + }, + "ROLE": { + "api_calls": { + "redis_py": [ + { + "signature": "role(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", "description": "" } ], @@ -88706,190 +96032,184 @@ "type": "Any", "description": "" } - }, + } + ], + "jedis": [ { - "signature": "msetnx(...args: [, ...keyValues: (RedisKey | string | Buffer | number)[], callback: Callback, ])", - "params": [ - { - "name": "...args", - "type": "[, ...keyValues", - "description": "" - } - ], + "signature": "List role()", + "params": [], "returns": { - "type": "Any", + "type": "List", "description": "" } - }, + } + ], + "go-redis": [ { - "signature": "msetnx(...args: [...keyValues: (RedisKey | string | Buffer | number)[]])", + "signature": "Role(ctx context.Context) *RoleCmd", "params": [ { - "name": "...args", - "type": "[...keyValues", - "description": "" + "name": "ctx", + "type": "context.Context", + "description": "Context" } ], "returns": { - "type": "Any", + "type": "*RoleCmd", "description": "" } } ], - "redis_rs_sync": [ + "node_redis": [ { - "signature": "mset_nx(items: &'a [(K, V)])", - "params": [ - { - "name": "items", - "type": "&'a [(K, V)]", - "description": "" - } - ], + "signature": "ROLE()", + "params": [], "returns": { - "type": "(bool)", + "type": "RoleReply", "description": "" } } ], - "redis_rs_async": [ + "lettuce_sync": [ { - "signature": "mset_nx(items: &'a [(K, V)])", - "params": [ - { - "name": "items", - "type": "&'a [(K, V)]", - "description": "" - } - ], + "signature": "List role()", + "params": [], "returns": { - "type": "(bool)", + "type": "List", "description": "" } } ], - "php": [ + "lettuce_async": [ { - "signature": "msetnx(array $dictionary)", - "params": [ - { - "name": "$dictionary", - "type": "array", - "description": "" - } - ], + "signature": "RedisFuture> role()", + "params": [], "returns": { - "type": "int", + "type": "RedisFuture>", "description": "" } } ], - "redis_rb": [ + "lettuce_reactive": [ { - "signature": "msetnx(*args)", - "params": [ - { - "name": "*args", - "type": "Array", - "description": "array of keys and values" - } - ], + "signature": "Mono> role()", + "params": [], "returns": { - "type": "Boolean", - "description": "whether or not all values were set" + "type": "Mono>", + "description": "" } } - ] + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "role()", + "params": [], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] } }, - "PERSIST": { + "RPOP": { "api_calls": { "redis_py": [ { - "signature": "persist(name: KeyT)", + "signature": "rpop(, name: KeyT,, count: Optional[int] = None,)", "params": [ { "name": "name", "type": "KeyT", "description": "" + }, + { + "name": "count", + "type": "Optional[int] = None", + "description": "" } ], "returns": { - "type": "int", + "type": "Union[Awaitable[Union[str, List, None]], Union[str, List, None]]", "description": "" } } ], "jedis": [ { - "signature": "long persist(final byte[] key)", + "signature": "String rpop(final String key)", "params": [ { "name": "key", - "type": "byte[]", + "type": "String", "description": "" } ], "returns": { - "type": "long", - "description": "1 if the timeout was removed, 0 if key does not exist or does not have an associated timeout" + "type": "String", + "description": "A list of count popped elements, or 'nil' when key does not exist." } }, { - "signature": "long persist(final String key)", + "signature": "List rpop(final String key, final int count)", "params": [ { "name": "key", "type": "String", "description": "" + }, + { + "name": "count", + "type": "int", + "description": "return up to count elements" } ], "returns": { - "type": "long", - "description": "1 if the timeout was removed, 0 if key does not exist or does not have an associated timeout" + "type": "List", + "description": "A list of count popped elements, or 'nil' when key does not exist." } - } - ], - "go-redis": [ + }, { - "signature": "Persist(ctx context.Context, key string)", + "signature": "String rpop(String key)", "params": [ - { - "name": "ctx", - "type": "context.Context", - "description": "" - }, { "name": "key", - "type": "string", + "type": "String", "description": "" } ], "returns": { - "type": "*BoolCmd", - "description": "" + "type": "String", + "description": "A list of count popped elements, or 'nil' when key does not exist." } - } - ], - "node_redis": [ + }, { - "signature": "PERSIST(key: RedisArgument)", + "signature": "List rpop(String key, int count)", "params": [ { "name": "key", - "type": "RedisArgument", + "type": "String", "description": "" + }, + { + "name": "count", + "type": "int", + "description": "return up to count elements" } ], "returns": { - "type": "Any", - "description": "" + "type": "List", + "description": "A list of count popped elements, or 'nil' when key does not exist." } } ], "lettuce_sync": [ { - "signature": "Boolean persist(K key)", + "signature": "V rpop(K key)", "params": [ { "name": "key", @@ -88898,30 +96218,33 @@ } ], "returns": { - "type": "Boolean", - "description": "Boolean integer-reply specifically: true if the timeout was removed. false if key does not exist or does not have an associated timeout." + "type": "V", + "description": "List<V> array-reply list of the last count elements, or null when key does not exist. @since 6.1" } - } - ], - "lettuce_async": [ + }, { - "signature": "RedisFuture persist(K key)", + "signature": "List rpop(K key, long count)", "params": [ { "name": "key", "type": "K", "description": "the key." + }, + { + "name": "count", + "type": "long", + "description": "the number of elements to return." } ], "returns": { - "type": "RedisFuture", - "description": "Boolean integer-reply specifically: true if the timeout was removed. false if key does not exist or does not have an associated timeout." + "type": "List", + "description": "List<V> array-reply list of the last count elements, or null when key does not exist. @since 6.1" } } ], - "lettuce_reactive": [ + "lettuce_async": [ { - "signature": "Mono persist(K key)", + "signature": "RedisFuture rpop(K key)", "params": [ { "name": "key", @@ -88930,670 +96253,702 @@ } ], "returns": { - "type": "Mono", - "description": "Boolean integer-reply specifically: true if the timeout was removed. false if key does not exist or does not have an associated timeout." + "type": "RedisFuture", + "description": "List<V> array-reply list of the last count elements, or null when key does not exist. @since 6.1" } - } - ], - "nredisstack_sync": [ + }, { - "signature": "KeyPersist(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture> rpop(K key, long count)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key to persist." + "type": "K", + "description": "the key." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "count", + "type": "long", + "description": "the number of elements to return." } ], "returns": { - "type": "bool", - "description": "true if the timeout was removed. false if key does not exist or does not have an associated timeout." + "type": "RedisFuture>", + "description": "List<V> array-reply list of the last count elements, or null when key does not exist. @since 6.1" } } ], - "nredisstack_async": [ + "lettuce_reactive": [ { - "signature": "KeyPersistAsync(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "Mono rpop(K key)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key to persist." + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "Mono", + "description": "V array-reply list of the last count elements, or null when key does not exist. @since 6.1" + } + }, + { + "signature": "Flux rpop(K key, long count)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "count", + "type": "long", + "description": "the number of elements to return." } ], "returns": { - "type": "Task", - "description": "true if the timeout was removed. false if key does not exist or does not have an associated timeout." + "type": "Flux", + "description": "V array-reply list of the last count elements, or null when key does not exist. @since 6.1" } } ], - "php": [ + "go-redis": [ { - "signature": "persist(string $key)", + "signature": "RPop(ctx context.Context, key string)", "params": [ { - "name": "$key", + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", "type": "string", "description": "" } ], "returns": { - "type": "int", + "type": "*StringCmd", "description": "" } } ], - "redis_rb": [ + "node_redis": [ { - "signature": "persist(key)", + "signature": "RPOP(key: RedisArgument)", "params": [ { "name": "key", - "type": "String", + "type": "RedisArgument", "description": "" } ], "returns": { - "type": "Boolean", - "description": "whether the timeout was removed or not" + "type": "Any", + "description": "" } } - ] - } - }, - "PEXPIRE": { - "api_calls": { - "redis_py": [ + ], + "ioredis": [ { - "signature": "pexpire(name: KeyT, time: ExpiryT, nx: bool = False, xx: bool = False, gt: bool = False, lt: bool = False)", + "signature": "rpop(key: RedisKey, count: number | string, callback?: Callback)", "params": [ { - "name": "name", - "type": "KeyT", + "name": "key", + "type": "RedisKey", "description": "" }, { - "name": "time", - "type": "ExpiryT", + "name": "count", + "type": "number | string", "description": "" }, { - "name": "nx", - "type": "bool", + "name": "callback?", + "type": "Callback", "description": "" - }, + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "redis_rs_sync": [ + { + "signature": "rpop(key: K, count: Option)", + "params": [ { - "name": "xx", - "type": "bool", + "name": "key", + "type": "K", "description": "" }, { - "name": "gt", - "type": "bool", + "name": "count", + "type": "Option)", + "params": [ + { + "name": "key", + "type": "K", "description": "" }, { - "name": "lt", - "type": "bool", + "name": "count", + "type": "Option pexpire(K key, long milliseconds)", + "signature": "rpop(string $key)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." - }, - { - "name": "milliseconds", - "type": "long", - "description": "the milliseconds." + "name": "$key", + "type": "string", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "string|null", + "description": "" } - }, + } + ], + "redis_rb": [ { - "signature": "RedisFuture pexpire(K key, long milliseconds, ExpireArgs expireArgs)", + "signature": "rpop(key, count = nil)", "params": [ { "name": "key", - "type": "K", - "description": "the key." + "type": "String", + "description": "" }, { - "name": "milliseconds", - "type": "long", - "description": "the milliseconds." + "name": "count", + "type": "Integer", + "description": "number of elements to remove" + } + ], + "returns": { + "type": "nil, String, Array", + "description": "the values of the last elements" + } + } + ] + } + }, + "RPOPLPUSH": { + "api_calls": { + "redis_py": [ + { + "signature": "rpoplpush(src: KeyT, dst: KeyT)", + "params": [ + { + "name": "src", + "type": "KeyT", + "description": "" }, { - "name": "expireArgs", - "type": "ExpireArgs", - "description": "the expiry arguments." + "name": "dst", + "type": "KeyT", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "Union[Awaitable[str], str]", + "description": "" } - }, + } + ], + "jedis": [ { - "signature": "RedisFuture pexpire(K key, Duration milliseconds)", + "signature": "String rpoplpush(final String srckey, final String dstkey)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." + "name": "srckey", + "type": "String", + "description": "" }, { - "name": "milliseconds", - "type": "Duration", - "description": "the milliseconds." + "name": "dstkey", + "type": "String", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "String", + "description": "Bulk reply @deprecated Use ListCommands#lmove(String, String, ListDirection, ListDirection) with ListDirection#RIGHT and ListDirection#LEFT. Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 6.2.0." } }, { - "signature": "RedisFuture pexpire(K key, Duration milliseconds, ExpireArgs expireArgs)", + "signature": "String rpoplpush(String srckey, String dstkey)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." - }, - { - "name": "milliseconds", - "type": "Duration", - "description": "the milliseconds." + "name": "srckey", + "type": "String", + "description": "" }, { - "name": "expireArgs", - "type": "ExpireArgs", - "description": "the expiry arguments." + "name": "dstkey", + "type": "String", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "String", + "description": "Bulk reply @deprecated Use ListCommands#lmove(String, String, ListDirection, ListDirection) with ListDirection#RIGHT and ListDirection#LEFT. Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 6.2.0." } } ], - "lettuce_reactive": [ + "lettuce_sync": [ { - "signature": "Mono pexpire(K key, long milliseconds)", + "signature": "V rpoplpush(K source, K destination)", "params": [ { - "name": "key", + "name": "source", "type": "K", - "description": "the key." + "description": "the source key." }, { - "name": "milliseconds", - "type": "long", - "description": "the milliseconds." + "name": "destination", + "type": "K", + "description": "the destination type: key." } ], "returns": { - "type": "Mono", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "V", + "description": "V bulk-string-reply the element being popped and pushed." } - }, + } + ], + "lettuce_async": [ { - "signature": "Mono pexpire(K key, long milliseconds, ExpireArgs expireArgs)", + "signature": "RedisFuture rpoplpush(K source, K destination)", "params": [ { - "name": "key", + "name": "source", "type": "K", - "description": "the key." - }, - { - "name": "milliseconds", - "type": "long", - "description": "the milliseconds." + "description": "the source key." }, { - "name": "expireArgs", - "type": "ExpireArgs", - "description": "the expiry arguments." + "name": "destination", + "type": "K", + "description": "the destination type: key." } ], "returns": { - "type": "Mono", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "RedisFuture", + "description": "V bulk-string-reply the element being popped and pushed." } - }, + } + ], + "lettuce_reactive": [ { - "signature": "Mono pexpire(K key, Duration milliseconds)", + "signature": "Mono rpoplpush(K source, K destination)", "params": [ { - "name": "key", + "name": "source", "type": "K", - "description": "the key." + "description": "the source key." }, { - "name": "milliseconds", - "type": "Duration", - "description": "the milliseconds." + "name": "destination", + "type": "K", + "description": "the destination type: key." } ], "returns": { - "type": "Mono", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "Mono", + "description": "V bulk-string-reply the element being popped and pushed." } - }, + } + ], + "go-redis": [ { - "signature": "Mono pexpire(K key, Duration milliseconds, ExpireArgs expireArgs)", + "signature": "RPopLPush(ctx context.Context, source, destination string)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." + "name": "ctx", + "type": "context.Context", + "description": "" }, { - "name": "milliseconds", - "type": "Duration", - "description": "the milliseconds." + "name": "source", + "type": "Any", + "description": "" }, { - "name": "expireArgs", - "type": "ExpireArgs", - "description": "the expiry arguments." + "name": "destination", + "type": "string", + "description": "" } ], "returns": { - "type": "Mono", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "*StringCmd", + "description": "" } } ], - "nredisstack_sync": [ + "ioredis": [ { - "signature": "KeyExpire(RedisKey key, TimeSpan? expiry, ExpireWhen when = ExpireWhen.Always, CommandFlags flags = CommandFlags.None)", + "signature": "rpoplpush(source: RedisKey, destination: RedisKey, callback?: Callback)", "params": [ { - "name": "key", + "name": "source", "type": "RedisKey", - "description": "The key to set the expiration for." - }, - { - "name": "expiry", - "type": "TimeSpan?", - "description": "The timeout to set." + "description": "" }, { - "name": "when", - "type": "ExpireWhen", - "description": "In Redis 7+, we choose under which condition the expiration will be set using ExpireWhen." + "name": "destination", + "type": "RedisKey", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "callback?", + "type": "Callback", + "description": "" } ], "returns": { - "type": "bool", - "description": "true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "Any", + "description": "" } } ], - "nredisstack_async": [ + "redis_rs_sync": [ { - "signature": "KeyExpireAsync(RedisKey key, TimeSpan? expiry, ExpireWhen when = ExpireWhen.Always, CommandFlags flags = CommandFlags.None)", + "signature": "rpoplpush(key: K, dstkey: D)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key to set the expiration for." + "type": "K", + "description": "" }, { - "name": "expiry", - "type": "TimeSpan?", - "description": "The timeout to set." - }, + "name": "dstkey", + "type": "D", + "description": "" + } + ], + "returns": { + "type": "(Option)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "rpoplpush(key: K, dstkey: D)", + "params": [ { - "name": "when", - "type": "ExpireWhen", - "description": "In Redis 7+, we choose under which condition the expiration will be set using ExpireWhen." + "name": "key", + "type": "K", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "dstkey", + "type": "D", + "description": "" } ], "returns": { - "type": "Task", - "description": "true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "(Option)", + "description": "" } } ], "php": [ { - "signature": "pexpire(string $key, int $milliseconds, string $expireOption = '')", + "signature": "rpoplpush(string $source, string $destination)", "params": [ { - "name": "$key", + "name": "$source", "type": "string", "description": "" }, { - "name": "$milliseconds", - "type": "int", - "description": "" - }, - { - "name": "$expireOption", + "name": "$destination", "type": "string", "description": "" } ], "returns": { - "type": "int", + "type": "string|null", "description": "" } } ], "redis_rb": [ { - "signature": "pexpire(key, milliseconds, nx: nil, xx: nil, gt: nil, lt: nil)", + "signature": "rpoplpush(source, destination)", "params": [ { - "name": "key", + "name": "source", "type": "String", - "description": "" - }, - { - "name": "milliseconds", - "type": "Integer", - "description": "time to live" - }, - { - "name": "nx", - "type": "Boolean", - "description": "Set expiry only when the key has no expiry." - }, - { - "name": "xx", - "type": "Boolean", - "description": "Set expiry only when the key has an existing expiry." - }, - { - "name": "gt", - "type": "Boolean", - "description": "Set expiry only when the new expiry is greater than current one." + "description": "source key" }, { - "name": "lt", - "type": "Boolean", - "description": "Set expiry only when the new expiry is less than current one." + "name": "destination", + "type": "String", + "description": "destination key" } ], "returns": { - "type": "Boolean", - "description": "whether the timeout was set or not" + "type": "nil, String", + "description": "the element, or nil when the source key does not exist" } } ] } }, - "PEXPIREAT": { + "RPUSH": { "api_calls": { "redis_py": [ { - "signature": "pexpireat(name: KeyT, when: AbsExpiryT, nx: bool = False, xx: bool = False, gt: bool = False, lt: bool = False)", + "signature": "rpush(name: KeyT, *values: FieldT)", "params": [ { "name": "name", @@ -89601,59 +96956,20 @@ "description": "" }, { - "name": "when", - "type": "AbsExpiryT", - "description": "" - }, - { - "name": "nx", - "type": "bool", - "description": "" - }, - { - "name": "xx", - "type": "bool", - "description": "" - }, - { - "name": "gt", - "type": "bool", - "description": "" - }, - { - "name": "lt", - "type": "bool", + "name": "*values", + "type": "FieldT", "description": "" } ], "returns": { - "type": "int", + "type": "Union[Awaitable[int], int]", "description": "" } } ], "jedis": [ { - "signature": "long pexpireAt(final byte[] key, final long millisecondsTimestamp)", - "params": [ - { - "name": "key", - "type": "byte[]", - "description": "" - }, - { - "name": "millisecondsTimestamp", - "type": "long", - "description": "timestamp in milliseconds" - } - ], - "returns": { - "type": "long", - "description": "1 if the timeout was set, 0 otherwise" - } - }, - { - "signature": "long pexpireAt(final byte[] key, final long millisecondsTimestamp, final ExpiryOption expiryOption)", + "signature": "long rpush(final byte[] key, final byte[]... strings)", "params": [ { "name": "key", @@ -89661,23 +96977,18 @@ "description": "" }, { - "name": "millisecondsTimestamp", - "type": "long", - "description": "timestamp in milliseconds" - }, - { - "name": "expiryOption", - "type": "ExpiryOption", - "description": "can be NX, XX, GT or LT" + "name": "strings", + "type": "byte[]...", + "description": "data to push" } ], "returns": { "type": "long", - "description": "1 if the timeout was set, 0 otherwise" + "description": "The number of elements inside the list after the push operation" } }, { - "signature": "long pexpireAt(final String key, final long millisecondsTimestamp)", + "signature": "long rpush(final String key, final String... strings)", "params": [ { "name": "key", @@ -89685,18 +96996,18 @@ "description": "" }, { - "name": "millisecondsTimestamp", - "type": "long", - "description": "timestamp in milliseconds" + "name": "strings", + "type": "String...", + "description": "data to push" } ], "returns": { "type": "long", - "description": "1 if the timeout was set, 0 otherwise" + "description": "The number of elements inside the list after the push operation" } }, { - "signature": "long pexpireAt(final String key, final long millisecondsTimestamp, final ExpiryOption expiryOption)", + "signature": "long rpush(String key, String... strings)", "params": [ { "name": "key", @@ -89704,77 +97015,20 @@ "description": "" }, { - "name": "millisecondsTimestamp", - "type": "long", - "description": "timestamp in milliseconds" - }, - { - "name": "expiryOption", - "type": "ExpiryOption", - "description": "can be NX, XX, GT or LT" + "name": "strings", + "type": "String...", + "description": "data to push" } ], "returns": { "type": "long", - "description": "1 if the timeout was set, 0 otherwise" - } - } - ], - "go-redis": [ - { - "signature": "PExpireAt(ctx context.Context, key string, tm time.Time)", - "params": [ - { - "name": "ctx", - "type": "context.Context", - "description": "" - }, - { - "name": "key", - "type": "string", - "description": "" - }, - { - "name": "tm", - "type": "time.Time", - "description": "" - } - ], - "returns": { - "type": "*BoolCmd", - "description": "" - } - } - ], - "node_redis": [ - { - "signature": "PEXPIREAT(key: RedisArgument, millisecondsTimestamp: number, mode?: 'NX' | 'XX' | 'GT' | 'LT')", - "params": [ - { - "name": "key", - "type": "RedisArgument", - "description": "" - }, - { - "name": "millisecondsTimestamp", - "type": "number", - "description": "" - }, - { - "name": "mode?", - "type": "'NX' | 'XX' | 'GT' | 'LT'", - "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" + "description": "The number of elements inside the list after the push operation" } } ], "lettuce_sync": [ { - "signature": "Boolean pexpireat(K key, long timestamp)", + "signature": "Long rpush(K key, V... values)", "params": [ { "name": "key", @@ -89782,18 +97036,20 @@ "description": "the key." }, { - "name": "timestamp", - "type": "long", - "description": "the milliseconds-timestamp." + "name": "values", + "type": "V...", + "description": "the value." } ], "returns": { - "type": "Boolean", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "Long", + "description": "Long integer-reply the length of the list after the push operation." } - }, + } + ], + "lettuce_async": [ { - "signature": "Boolean pexpireat(K key, long timestamp, ExpireArgs expireArgs)", + "signature": "RedisFuture rpush(K key, V... values)", "params": [ { "name": "key", @@ -89801,23 +97057,20 @@ "description": "the key." }, { - "name": "timestamp", - "type": "long", - "description": "the milliseconds-timestamp." - }, - { - "name": "expireArgs", - "type": "ExpireArgs", - "description": "the expiry arguments." + "name": "values", + "type": "V...", + "description": "the value." } ], "returns": { - "type": "Boolean", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "RedisFuture", + "description": "Long integer-reply the length of the list after the push operation." } - }, + } + ], + "lettuce_reactive": [ { - "signature": "Boolean pexpireat(K key, Date timestamp)", + "signature": "Mono rpush(K key, V... values)", "params": [ { "name": "key", @@ -89825,149 +97078,154 @@ "description": "the key." }, { - "name": "timestamp", - "type": "Date", - "description": "the milliseconds-timestamp." + "name": "values", + "type": "V...", + "description": "the value." } ], "returns": { - "type": "Boolean", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "Mono", + "description": "Long integer-reply the length of the list after the push operation." } - }, + } + ], + "go-redis": [ { - "signature": "Boolean pexpireat(K key, Date timestamp, ExpireArgs expireArgs)", + "signature": "RPush(ctx context.Context, key string, values ...interface{})", "params": [ { - "name": "key", - "type": "K", - "description": "the key." + "name": "ctx", + "type": "context.Context", + "description": "" }, { - "name": "timestamp", - "type": "Date", - "description": "the milliseconds-timestamp." + "name": "key", + "type": "string", + "description": "" }, { - "name": "expireArgs", - "type": "ExpireArgs", - "description": "the expiry arguments." + "name": "values", + "type": "...interface{}", + "description": "" } ], "returns": { - "type": "Boolean", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "*IntCmd", + "description": "" } } ], - "lettuce_async": [ + "node_redis": [ { - "signature": "RedisFuture pexpireat(K key, long timestamp)", + "signature": "RPUSH(key: RedisArgument, element: RedisVariadicArgument)", "params": [ { "name": "key", - "type": "K", - "description": "the key." + "type": "RedisArgument", + "description": "" }, { - "name": "timestamp", - "type": "long", - "description": "the milliseconds-timestamp." + "name": "element", + "type": "RedisVariadicArgument", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "Any", + "description": "" } - }, + } + ], + "ioredis": [ { - "signature": "RedisFuture pexpireat(K key, long timestamp, ExpireArgs expireArgs)", + "signature": "rpush(...args: [, key: RedisKey, ...elements: (string | Buffer | number)[], callback: Callback, ])", "params": [ { - "name": "key", - "type": "K", - "description": "the key." - }, - { - "name": "timestamp", - "type": "long", - "description": "the milliseconds-timestamp." - }, + "name": "...args", + "type": "[, key", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "rpush(...args: [key: RedisKey, ...elements: (string | Buffer | number)[]])", + "params": [ { - "name": "expireArgs", - "type": "ExpireArgs", - "description": "the expiry arguments." + "name": "...args", + "type": "[key", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "Any", + "description": "" } } ], - "lettuce_reactive": [ + "redis_rs_sync": [ { - "signature": "Mono pexpireat(K key, long timestamp)", + "signature": "rpush(key: K, value: V)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "" }, { - "name": "timestamp", - "type": "long", - "description": "the milliseconds-timestamp." + "name": "value", + "type": "V", + "description": "" } ], "returns": { - "type": "Mono", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "(usize)", + "description": "" } - }, + } + ], + "redis_rs_async": [ { - "signature": "Mono pexpireat(K key, long timestamp, ExpireArgs expireArgs)", + "signature": "rpush(key: K, value: V)", "params": [ { "name": "key", "type": "K", - "description": "the key." - }, - { - "name": "timestamp", - "type": "long", - "description": "the milliseconds-timestamp." + "description": "" }, { - "name": "expireArgs", - "type": "ExpireArgs", - "description": "the expiry arguments." + "name": "value", + "type": "V", + "description": "" } ], "returns": { - "type": "Mono", - "description": "Boolean integer-reply specifically: true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "(usize)", + "description": "" } } ], "nredisstack_sync": [ { - "signature": "KeyExpire(RedisKey key, DateTime? expiry, ExpireWhen when = ExpireWhen.Always, CommandFlags flags = CommandFlags.None)", + "signature": "ListRightPush(RedisKey key, RedisValue value, When when = When.Always, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key to set the expiration for." + "description": "The key of the list." }, { - "name": "expiry", - "type": "DateTime?", - "description": "The exact date to expire at." + "name": "value", + "type": "RedisValue", + "description": "" }, { "name": "when", - "type": "ExpireWhen", - "description": "In Redis 7+, we choose under which condition the expiration will be set using ExpireWhen." + "type": "When", + "description": "" }, { "name": "flags", @@ -89976,29 +97234,27 @@ } ], "returns": { - "type": "bool", - "description": "true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "long", + "description": "The length of the list after the push operation." } - } - ], - "nredisstack_async": [ + }, { - "signature": "KeyExpireAsync(RedisKey key, DateTime? expiry, ExpireWhen when = ExpireWhen.Always, CommandFlags flags = CommandFlags.None)", + "signature": "ListRightPush(RedisKey key, RedisValue[] values, When when = When.Always, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key to set the expiration for." + "description": "The key of the list." }, { - "name": "expiry", - "type": "DateTime?", - "description": "The exact date to expire at." + "name": "values", + "type": "RedisValue[]", + "description": "The values to add to the tail of the list." }, { "name": "when", - "type": "ExpireWhen", - "description": "In Redis 7+, we choose under which condition the expiration will be set using ExpireWhen." + "type": "When", + "description": "" }, { "name": "flags", @@ -90007,221 +97263,193 @@ } ], "returns": { - "type": "Task", - "description": "true if the timeout was set. false if key does not exist or the timeout could not be set." + "type": "long", + "description": "The length of the list after the push operation." } - } - ], - "php": [ + }, { - "signature": "pexpireAt(string $key, int $timestamp, string $expireOption = '')", + "signature": "ListRightPush(RedisKey key, RedisValue[] values, CommandFlags flags)", "params": [ { - "name": "$key", - "type": "string", - "description": "" + "name": "key", + "type": "RedisKey", + "description": "The key of the list." }, { - "name": "$timestamp", - "type": "int", - "description": "" + "name": "values", + "type": "RedisValue[]", + "description": "The values to add to the tail of the list." }, { - "name": "$expireOption", - "type": "string", - "description": "" + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "int", - "description": "" + "type": "long", + "description": "The length of the list after the push operation." } - } - ], - "redis_rb": [ + }, { - "signature": "pexpireat(key, ms_unix_time, nx: nil, xx: nil, gt: nil, lt: nil)", + "signature": "ListRightPush(RedisKey key, RedisValue value, When when = When.Always, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", - "type": "String", - "description": "" - }, - { - "name": "ms_unix_time", - "type": "Integer", - "description": "expiry time specified as number of milliseconds from UNIX Epoch" - }, - { - "name": "nx", - "type": "Boolean", - "description": "Set expiry only when the key has no expiry." + "type": "RedisKey", + "description": "The key of the list." }, { - "name": "xx", - "type": "Boolean", - "description": "Set expiry only when the key has an existing expiry." + "name": "value", + "type": "RedisValue", + "description": "" }, { - "name": "gt", - "type": "Boolean", - "description": "Set expiry only when the new expiry is greater than current one." + "name": "when", + "type": "When", + "description": "" }, { - "name": "lt", - "type": "Boolean", - "description": "Set expiry only when the new expiry is less than current one." + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Boolean", - "description": "whether the timeout was set or not" + "type": "long", + "description": "The length of the list after the push operation." } - } - ] - } - }, - "PEXPIRETIME": { - "api_calls": { - "redis_py": [ + }, { - "signature": "pexpiretime(key: KeyT)", + "signature": "ListRightPush(RedisKey key, RedisValue[] values, When when = When.Always, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", - "type": "KeyT", + "type": "RedisKey", + "description": "The key of the list." + }, + { + "name": "values", + "type": "RedisValue[]", + "description": "The values to add to the tail of the list." + }, + { + "name": "when", + "type": "When", "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "int", - "description": "" + "type": "long", + "description": "The length of the list after the push operation." } } ], - "jedis": [ + "nredisstack_async": [ { - "signature": "long pexpireTime(final byte[] key)", + "signature": "ListRightPush(RedisKey key, RedisValue value, When when = When.Always, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", - "type": "byte[]", + "type": "RedisKey", + "description": "The key of the list." + }, + { + "name": "value", + "type": "RedisValue", + "description": "" + }, + { + "name": "when", + "type": "When", "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { "type": "long", - "description": "Expiration Unix timestamp in milliseconds, or a negative value in order to signal an error" + "description": "The length of the list after the push operation." } }, { - "signature": "long pexpireTime(final String key)", + "signature": "ListRightPush(RedisKey key, RedisValue[] values, When when = When.Always, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", - "type": "String", - "description": "" - } - ], - "returns": { - "type": "long", - "description": "Expiration Unix timestamp in milliseconds, or a negative value in order to signal an error" - } - } - ], - "go-redis": [ - { - "signature": "PExpireTime(ctx context.Context, key string)", - "params": [ + "type": "RedisKey", + "description": "The key of the list." + }, { - "name": "ctx", - "type": "context.Context", - "description": "" + "name": "values", + "type": "RedisValue[]", + "description": "The values to add to the tail of the list." }, { - "name": "key", - "type": "string", + "name": "when", + "type": "When", "description": "" - } - ], - "returns": { - "type": "*DurationCmd", - "description": "" - } - } - ], - "node_redis": [ - { - "signature": "PEXPIRETIME(key: RedisArgument)", - "params": [ + }, { - "name": "key", - "type": "RedisArgument", - "description": "" + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Any", - "description": "" + "type": "long", + "description": "The length of the list after the push operation." } - } - ], - "lettuce_sync": [ + }, { - "signature": "Long pexpiretime(K key)", + "signature": "ListRightPush(RedisKey key, RedisValue[] values, CommandFlags flags)", "params": [ { "name": "key", - "type": "K", - "description": "the key." - } - ], - "returns": { - "type": "Long", - "description": "Long integer-reply expiration Unix timestamp in milliseconds, or a negative value in order to signal an error." - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture pexpiretime(K key)", - "params": [ + "type": "RedisKey", + "description": "The key of the list." + }, { - "name": "key", - "type": "K", - "description": "the key." - } - ], - "returns": { - "type": "RedisFuture", - "description": "Long integer-reply expiration Unix timestamp in milliseconds, or a negative value in order to signal an error." - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono pexpiretime(K key)", - "params": [ + "name": "values", + "type": "RedisValue[]", + "description": "The values to add to the tail of the list." + }, { - "name": "key", - "type": "K", - "description": "the key." + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Mono", - "description": "Long integer-reply expiration Unix timestamp in milliseconds, or a negative value in order to signal an error." + "type": "long", + "description": "The length of the list after the push operation." } - } - ], - "nredisstack_sync": [ + }, { - "signature": "KeyExpireTime(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "ListRightPush(RedisKey key, RedisValue value, When when = When.Always, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key to check." + "description": "The key of the list." + }, + { + "name": "value", + "type": "RedisValue", + "description": "" + }, + { + "name": "when", + "type": "When", + "description": "" }, { "name": "flags", @@ -90230,19 +97458,27 @@ } ], "returns": { - "type": "DateTime?", - "description": "The expiration time, or null if the key does not exist or has no associated expiration." + "type": "long", + "description": "The length of the list after the push operation." } - } - ], - "nredisstack_async": [ + }, { - "signature": "KeyExpireTimeAsync(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "ListRightPush(RedisKey key, RedisValue[] values, When when = When.Always, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key to check." + "description": "The key of the list." + }, + { + "name": "values", + "type": "RedisValue[]", + "description": "The values to add to the tail of the list." + }, + { + "name": "when", + "type": "When", + "description": "" }, { "name": "flags", @@ -90251,19 +97487,24 @@ } ], "returns": { - "type": "Task", - "description": "The expiration time, or null if the key does not exist or has no associated expiration." + "type": "long", + "description": "The length of the list after the push operation." } } ], "php": [ { - "signature": "pexpireTime(string $key)", + "signature": "rpush(string $key, array $values)", "params": [ { "name": "$key", "type": "string", "description": "" + }, + { + "name": "$values", + "type": "array", + "description": "" } ], "returns": { @@ -90274,1140 +97515,1422 @@ ], "redis_rb": [ { - "signature": "pexpiretime(key)", + "signature": "rpush(key, value)", "params": [ { "name": "key", "type": "String", "description": "" + }, + { + "name": "value", + "type": "String, Array", + "description": "string value, or array of string values to push" } ], "returns": { "type": "Integer", - "description": "expiry time specified as number of milliseconds from UNIX Epoch" + "description": "the length of the list after the push operation" } } ] } }, - "PFADD": { + "RPUSHX": { "api_calls": { "redis_py": [ { - "signature": "pfadd(name: KeyT, *values: FieldT)", + "signature": "rpushx(name: KeyT, *values: str)", "params": [ { "name": "name", "type": "KeyT", - "description": "The key of the HyperLogLog data structure" + "description": "" + }, + { + "name": "*values", + "type": "str", + "description": "" + } + ], + "returns": { + "type": "Union[Awaitable[int], int]", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "long rpushx(final byte[] key, final byte[]... strings)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" }, { - "name": "*values", - "type": "FieldT", - "description": "One or more elements to add" + "name": "strings", + "type": "byte[]...", + "description": "the strings to push" } ], "returns": { - "type": "ResponseT", - "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + "type": "long", + "description": "The length of the list after the push operation" } - } - ], - "jedis": [ + }, { - "signature": "long pfadd(final byte[] key, final byte[]... elements)", + "signature": "long rpushx(final String key, final String... strings)", "params": [ { "name": "key", - "type": "byte[]", - "description": "The key of the HyperLogLog" + "type": "String", + "description": "" }, { - "name": "elements", - "type": "byte[]...", - "description": "One or more elements to add" + "name": "strings", + "type": "String...", + "description": "the strings to push" } ], "returns": { "type": "long", - "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + "description": "The length of the list after the push operation" } }, { - "signature": "long pfadd(final String key, final String... elements)", + "signature": "long rpushx(String key, String... strings)", "params": [ { "name": "key", "type": "String", - "description": "The key of the HyperLogLog" + "description": "" }, { - "name": "elements", + "name": "strings", "type": "String...", - "description": "One or more elements to add" + "description": "the strings to push" } ], "returns": { "type": "long", - "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + "description": "The length of the list after the push operation" } } ], "lettuce_sync": [ { - "signature": "Long pfadd(K key, V... values)", + "signature": "Long rpushx(K key, V... values)", "params": [ { "name": "key", "type": "K", - "description": "The key" + "description": "the key." }, { "name": "values", "type": "V...", - "description": "The values to add" + "description": "the values." } ], "returns": { "type": "Long", - "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + "description": "Long integer-reply the length of the list after the push operation." } } ], "lettuce_async": [ { - "signature": "RedisFuture pfadd(K key, V... values)", + "signature": "RedisFuture rpushx(K key, V... values)", "params": [ { "name": "key", "type": "K", - "description": "The key" + "description": "the key." }, { "name": "values", "type": "V...", - "description": "The values to add" + "description": "the values." } ], "returns": { "type": "RedisFuture", - "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + "description": "Long integer-reply the length of the list after the push operation." } } ], "lettuce_reactive": [ { - "signature": "Mono pfadd(K key, V... values)", + "signature": "Mono rpushx(K key, V... values)", "params": [ { "name": "key", "type": "K", - "description": "The key" + "description": "the key." }, { "name": "values", "type": "V...", - "description": "The values to add" + "description": "the values." } ], "returns": { "type": "Mono", - "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + "description": "Long integer-reply the length of the list after the push operation." } } ], - "ioredis": [ + "go-redis": [ { - "signature": "pfadd(key: RedisKey, ...elements: (string | Buffer | number)[], callback?: Callback)", + "signature": "RPushX(ctx context.Context, key string, values ...interface{})", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The key of the HyperLogLog" + "name": "ctx", + "type": "context.Context", + "description": "" }, { - "name": "...elements", - "type": "(string | Buffer | number)[]", - "description": "One or more elements to add" + "name": "key", + "type": "string", + "description": "" }, { - "name": "callback", - "type": "Callback", - "description": "Optional callback" + "name": "values", + "type": "...interface{}", + "description": "" } ], "returns": { - "type": "Result", - "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + "type": "*IntCmd", + "description": "" + } + } + ], + "ioredis": [ + { + "signature": "rpushx(...args: [, key: RedisKey, ...elements: (string | Buffer | number)[], callback: Callback, ])", + "params": [ + { + "name": "...args", + "type": "[, key", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "rpushx(...args: [key: RedisKey, ...elements: (string | Buffer | number)[]])", + "params": [ + { + "name": "...args", + "type": "[key", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" } } ], "redis_rs_sync": [ { - "signature": "pfadd(key: K, element: E)", + "signature": "rpush_exists(key: K, value: V)", "params": [ { "name": "key", "type": "K", - "description": "The key of the HyperLogLog" + "description": "" }, { - "name": "element", - "type": "E", - "description": "The element to add" + "name": "value", + "type": "V", + "description": "" } ], "returns": { - "type": "bool", - "description": "true if at least 1 HyperLogLog internal register was altered" + "type": "(usize)", + "description": "" } } ], "redis_rs_async": [ { - "signature": "pfadd(key: K, element: E)", + "signature": "rpush_exists(key: K, value: V)", "params": [ { "name": "key", "type": "K", - "description": "The key of the HyperLogLog" + "description": "" }, { - "name": "element", - "type": "E", - "description": "The element to add" + "name": "value", + "type": "V", + "description": "" } ], "returns": { - "type": "bool", - "description": "true if at least 1 HyperLogLog internal register was altered" + "type": "(usize)", + "description": "" } } ], - "nredisstack_sync": [ + "php": [ { - "signature": "HyperLogLogAdd(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "rpushx(string $key, array $values)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The key of the HyperLogLog" - }, - { - "name": "value", - "type": "RedisValue", - "description": "The value to add" + "name": "$key", + "type": "string", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation" + "name": "$values", + "type": "array", + "description": "" } ], "returns": { - "type": "bool", - "description": "true if at least 1 HyperLogLog internal register was altered, false otherwise" + "type": "int", + "description": "" } - }, + } + ], + "redis_rb": [ { - "signature": "HyperLogLogAdd(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "signature": "rpushx(key, value)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the HyperLogLog" + "type": "String", + "description": "" }, { - "name": "values", - "type": "RedisValue[]", - "description": "The values to add" + "name": "value", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "Integer", + "description": "the length of the list after the push operation" + } + } + ] + } + }, + "SADD": { + "api_calls": { + "redis_py": [ + { + "signature": "sadd(name: KeyT, *values: FieldT)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation" + "name": "*values", + "type": "FieldT", + "description": "" } ], "returns": { - "type": "bool", - "description": "true if at least 1 HyperLogLog internal register was altered, false otherwise" + "type": "Union[Awaitable[int], int]", + "description": "" } } ], - "nredisstack_async": [ + "jedis": [ { - "signature": "HyperLogLogAddAsync(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "long sadd(final byte[] key, final byte[]... members)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the HyperLogLog" - }, - { - "name": "value", - "type": "RedisValue", - "description": "The value to add" + "type": "byte[]", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation" + "name": "members", + "type": "byte[]...", + "description": "" } ], "returns": { - "type": "Task", - "description": "true if at least 1 HyperLogLog internal register was altered, false otherwise" + "type": "long", + "description": "1 if the new element was added, 0 if the element was already a member of the set" } }, { - "signature": "HyperLogLogAddAsync(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "signature": "long sadd(final String key, final String... members)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the HyperLogLog" - }, - { - "name": "values", - "type": "RedisValue[]", - "description": "The values to add" + "type": "String", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation" + "name": "members", + "type": "String...", + "description": "" } ], "returns": { - "type": "Task", - "description": "true if at least 1 HyperLogLog internal register was altered, false otherwise" + "type": "long", + "description": "1 if the new element was added, 0 if the element was already a member of the set" } } ], - "php": [ + "lettuce_sync": [ { - "signature": "pfadd(string $key, array $elements)", + "signature": "Long sadd(K key, V... members)", "params": [ { - "name": "$key", - "type": "string", - "description": "The key of the HyperLogLog" + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "$elements", - "type": "array", - "description": "The elements to add" + "name": "members", + "type": "V...", + "description": "the member type: value." } ], "returns": { - "type": "int", - "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + "type": "Long", + "description": "Long integer-reply the number of elements that were added to the set, not including all the elements already present into the set." } } ], - "go-redis": [ + "lettuce_async": [ { - "signature": "PFAdd(ctx context.Context, key string, els ...interface{}) *IntCmd", + "signature": "RedisFuture sadd(K key, V... members)", "params": [ - { - "name": "ctx", - "type": "context.Context", - "description": "Context for the command" - }, { "name": "key", - "type": "string", - "description": "The key of the HyperLogLog" + "type": "K", + "description": "the key." }, { - "name": "els", - "type": "...interface{}", - "description": "One or more elements to add" + "name": "members", + "type": "V...", + "description": "the member type: value." } ], "returns": { - "type": "*IntCmd", - "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + "type": "RedisFuture", + "description": "Long integer-reply the number of elements that were added to the set, not including all the elements already present into the set." } } ], - "node_redis": [ + "lettuce_reactive": [ { - "signature": "PFADD(key: RedisArgument, element?: RedisVariadicArgument)", + "signature": "Mono sadd(K key, V... members)", "params": [ { "name": "key", - "type": "RedisArgument", - "description": "The key of the HyperLogLog" + "type": "K", + "description": "the key." }, { - "name": "element", - "type": "RedisVariadicArgument", - "description": "Optional elements to add" + "name": "members", + "type": "V...", + "description": "the member type: value." } ], "returns": { - "type": "NumberReply", - "description": "1 if at least 1 HyperLogLog internal register was altered, 0 otherwise" + "type": "Mono", + "description": "Long integer-reply the number of elements that were added to the set, not including all the elements already present into the set." } } ], - "redis_rb": [ + "go-redis": [ { - "signature": "pfadd(key, member)", + "signature": "SAdd(ctx context.Context, key string, members ...interface{})", "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, { "name": "key", - "type": "String", + "type": "string", "description": "" }, { - "name": "member", - "type": "String, Array", - "description": "one member, or array of members" + "name": "members", + "type": "...interface{}", + "description": "" } ], "returns": { - "type": "Boolean", - "description": "true if at least 1 HyperLogLog internal register was altered" + "type": "*IntCmd", + "description": "" } } - ] - } - }, - "PFCOUNT": { - "api_calls": { - "redis_py": [ + ], + "node_redis": [ { - "signature": "pfcount(*sources: KeyT)", + "signature": "SADD(key: RedisArgument, members: RedisVariadicArgument)", "params": [ { - "name": "*sources", - "type": "KeyT", - "description": "One or more HyperLogLog keys" + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" } ], "returns": { - "type": "ResponseT", - "description": "The approximated number of unique elements observed via PFADD" + "type": "Any", + "description": "" } } ], - "jedis": [ + "ioredis": [ { - "signature": "long pfcount(final byte[] key)", + "signature": "sadd(...args: [, key: RedisKey, ...members: (string | Buffer | number)[], callback: Callback, ])", "params": [ { - "name": "key", - "type": "byte[]", - "description": "The HyperLogLog key" + "name": "...args", + "type": "[, key", + "description": "" } ], "returns": { - "type": "long", - "description": "The approximated number of unique elements" + "type": "Any", + "description": "" } }, { - "signature": "long pfcount(final byte[]... keys)", + "signature": "sadd(...args: [, key: RedisKey, members: (string | Buffer | number)[], callback: Callback, ])", "params": [ { - "name": "keys", - "type": "byte[]...", - "description": "One or more HyperLogLog keys" + "name": "...args", + "type": "[, key", + "description": "" } ], "returns": { - "type": "long", - "description": "The approximated number of unique elements across all keys" + "type": "Any", + "description": "" } }, { - "signature": "long pfcount(final String key)", + "signature": "sadd(...args: [key: RedisKey, ...members: (string | Buffer | number)[]])", "params": [ { - "name": "key", - "type": "String", - "description": "The HyperLogLog key" + "name": "...args", + "type": "[key", + "description": "" } ], "returns": { - "type": "long", - "description": "The approximated number of unique elements" + "type": "Any", + "description": "" } }, { - "signature": "long pfcount(final String... keys)", + "signature": "sadd(...args: [key: RedisKey, members: (string | Buffer | number)[]])", "params": [ { - "name": "keys", - "type": "String...", - "description": "One or more HyperLogLog keys" + "name": "...args", + "type": "[key", + "description": "" } ], "returns": { - "type": "long", - "description": "The approximated number of unique elements across all keys" + "type": "Any", + "description": "" } } ], - "lettuce_sync": [ + "redis_rs_sync": [ { - "signature": "Long pfcount(K... keys)", + "signature": "sadd(key: K, member: M)", "params": [ { - "name": "keys", - "type": "K...", - "description": "The keys" + "name": "key", + "type": "K", + "description": "" + }, + { + "name": "member", + "type": "M", + "description": "" } ], "returns": { - "type": "Long", - "description": "The approximated number of unique elements observed via PFADD" + "type": "(usize)", + "description": "" } } ], - "lettuce_async": [ + "redis_rs_async": [ { - "signature": "RedisFuture pfcount(K... keys)", + "signature": "sadd(key: K, member: M)", "params": [ { - "name": "keys", - "type": "K...", - "description": "The keys" + "name": "key", + "type": "K", + "description": "" + }, + { + "name": "member", + "type": "M", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "The approximated number of unique elements observed via PFADD" + "type": "(usize)", + "description": "" } } ], - "lettuce_reactive": [ + "nredisstack_sync": [ { - "signature": "Mono pfcount(K... keys)", + "signature": "SetAdd(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "keys", - "type": "K...", - "description": "The keys" + "name": "key", + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "value", + "type": "RedisValue", + "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Mono", - "description": "The approximated number of unique elements observed via PFADD" + "type": "bool", + "description": "The number of elements that were added to the set, not including all the elements already present into the set." } - } - ], - "ioredis": [ + }, { - "signature": "pfcount(...keys: RedisKey[], callback?: Callback)", + "signature": "SetAdd(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "...keys", - "type": "RedisKey[]", - "description": "One or more HyperLogLog keys" + "name": "key", + "type": "RedisKey", + "description": "The key of the set." }, { - "name": "callback", - "type": "Callback", - "description": "Optional callback" + "name": "values", + "type": "RedisValue[]", + "description": "The values to add to the set." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Result", - "description": "The approximated number of unique elements" + "type": "long", + "description": "The number of elements that were added to the set, not including all the elements already present into the set." } - } - ], - "redis_rs_sync": [ + }, { - "signature": "pfcount(key: K)", + "signature": "SetAdd(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", - "type": "K", - "description": "The HyperLogLog key" + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "value", + "type": "RedisValue", + "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "usize", - "description": "The approximated number of unique elements" + "type": "bool", + "description": "The number of elements that were added to the set, not including all the elements already present into the set." } - } - ], - "redis_rs_async": [ + }, { - "signature": "pfcount(key: K)", + "signature": "SetAdd(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", - "type": "K", - "description": "The HyperLogLog key" + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "values", + "type": "RedisValue[]", + "description": "The values to add to the set." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "usize", - "description": "The approximated number of unique elements" + "type": "long", + "description": "The number of elements that were added to the set, not including all the elements already present into the set." } } ], - "nredisstack_sync": [ + "nredisstack_async": [ { - "signature": "HyperLogLogLength(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "SetAdd(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The HyperLogLog key" + "description": "The key of the set." + }, + { + "name": "value", + "type": "RedisValue", + "description": "" }, { "name": "flags", "type": "CommandFlags", - "description": "The flags to use for this operation" + "description": "The flags to use for this operation." } ], "returns": { - "type": "long", - "description": "The approximated number of unique elements observed via HyperLogLogAdd" + "type": "bool", + "description": "The number of elements that were added to the set, not including all the elements already present into the set." } }, { - "signature": "HyperLogLogLength(RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "signature": "SetAdd(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the HyperLogLogs" + "name": "key", + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "values", + "type": "RedisValue[]", + "description": "The values to add to the set." }, { "name": "flags", "type": "CommandFlags", - "description": "The flags to use for this operation" + "description": "The flags to use for this operation." } ], "returns": { "type": "long", - "description": "The approximated number of unique elements observed via HyperLogLogAdd" + "description": "The number of elements that were added to the set, not including all the elements already present into the set." } - } - ], - "nredisstack_async": [ + }, { - "signature": "HyperLogLogLengthAsync(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "SetAdd(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The HyperLogLog key" + "description": "The key of the set." + }, + { + "name": "value", + "type": "RedisValue", + "description": "" }, { "name": "flags", "type": "CommandFlags", - "description": "The flags to use for this operation" + "description": "The flags to use for this operation." } ], "returns": { - "type": "Task", - "description": "The approximated number of unique elements observed via HyperLogLogAdd" + "type": "bool", + "description": "The number of elements that were added to the set, not including all the elements already present into the set." } }, { - "signature": "HyperLogLogLengthAsync(RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "signature": "SetAdd(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the HyperLogLogs" + "name": "key", + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "values", + "type": "RedisValue[]", + "description": "The values to add to the set." }, { "name": "flags", "type": "CommandFlags", - "description": "The flags to use for this operation" + "description": "The flags to use for this operation." } ], "returns": { - "type": "Task", - "description": "The approximated number of unique elements observed via HyperLogLogAdd" + "type": "long", + "description": "The number of elements that were added to the set, not including all the elements already present into the set." } } ], "php": [ { - "signature": "pfcount(string[]|string $keyOrKeys, string ...$keys = null)", + "signature": "sadd(string $key, array $members)", "params": [ { - "name": "$keyOrKeys", - "type": "string[]|string", - "description": "One or more HyperLogLog keys" + "name": "$key", + "type": "string", + "description": "" }, { - "name": "...$keys", - "type": "string", - "description": "Additional keys (optional)" + "name": "$members", + "type": "array", + "description": "" } ], "returns": { "type": "int", - "description": "The approximated number of unique elements" + "description": "" } } ], - "go-redis": [ + "redis_rb": [ { - "signature": "PFCount(ctx context.Context, keys ...string) *IntCmd", + "signature": "sadd(key, *members)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context for the command" + "name": "key", + "type": "String", + "description": "" }, { - "name": "keys", - "type": "...string", - "description": "One or more HyperLogLog keys" + "name": "*members", + "type": "String, Array", + "description": "one member, or array of members" } ], "returns": { - "type": "*IntCmd", - "description": "The approximated number of unique elements" + "type": "Integer", + "description": "The number of members that were successfully added" + } + } + ] + } + }, + "SADDEX": { + "api_calls": { + "redis_py": [ + { + "signature": "saddex(name: KeyT, *members: FieldT, ex: ExpiryT | str | None = None, px: ExpiryT | str | None = None, exat: AbsExpiryT | None = None, pxat: AbsExpiryT | None = None, data_persist_option: SetDataPersistOptions | None = None, keepttl: bool = False)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", + "description": "" + }, + { + "name": "ex", + "type": "ExpiryT | str | None", + "description": "" + }, + { + "name": "px", + "type": "ExpiryT | str | None", + "description": "" + }, + { + "name": "exat", + "type": "AbsExpiryT | None", + "description": "" + }, + { + "name": "pxat", + "type": "AbsExpiryT | None", + "description": "" + }, + { + "name": "data_persist_option", + "type": "SetDataPersistOptions | None", + "description": "" + }, + { + "name": "keepttl", + "type": "bool", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" } } ], "node_redis": [ { - "signature": "PFCOUNT(keys: RedisVariadicArgument)", + "signature": "sAddEx(key: RedisArgument, members: RedisVariadicArgument, options?: SAddExOptions)", "params": [ { - "name": "keys", + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", "type": "RedisVariadicArgument", - "description": "One or more keys of HyperLogLog structures to count" + "description": "" + }, + { + "name": "options?", + "type": "SAddExOptions", + "description": "" } ], "returns": { - "type": "NumberReply", - "description": "The approximated number of unique elements" + "type": "NumberReply<0 | 1>", + "description": "" } } ], - "redis_rb": [ + "go-redis": [ { - "signature": "pfcount(*keys)", + "signature": "SAddEX(ctx context.Context, key string, members ...string) *IntCmd", "params": [ { - "name": "*keys", - "type": "String, Array", + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "members", + "type": "...string", "description": "" } ], "returns": { - "type": "Integer", + "type": "*IntCmd", "description": "" } - } - ] - } - }, - "PFMERGE": { - "api_calls": { - "redis_py": [ + }, { - "signature": "pfmerge(dest: KeyT, *sources: KeyT)", + "signature": "SAddEXWithArgs(ctx context.Context, key string, options *SAddEXOptions, members ...string) *IntCmd", "params": [ { - "name": "dest", - "type": "KeyT", - "description": "The destination key" + "name": "ctx", + "type": "context.Context", + "description": "" }, { - "name": "*sources", - "type": "KeyT", - "description": "One or more source HyperLogLog keys" + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "options", + "type": "*SAddEXOptions", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" } ], "returns": { - "type": "ResponseT", - "description": "OK" + "type": "*IntCmd", + "description": "" } } ], - "jedis": [ + "php": [ { - "signature": "String pfmerge(final byte[] destkey, final byte[]... sourcekeys)", + "signature": "saddex(string $key, array $members, string $condition = SADDEX::COND_NULL, string $ttlModifier = SADDEX::TTL_NULL, int|bool $ttlModifierValue = false)", "params": [ { - "name": "destkey", - "type": "byte[]", - "description": "The destination key" + "name": "$key", + "type": "string", + "description": "" }, { - "name": "sourcekeys", - "type": "byte[]...", - "description": "One or more source keys" + "name": "$members", + "type": "array", + "description": "" + }, + { + "name": "$condition", + "type": "string", + "description": "" + }, + { + "name": "$ttlModifier", + "type": "string", + "description": "" + }, + { + "name": "$ttlModifierValue", + "type": "int|bool", + "description": "" } ], "returns": { - "type": "String", - "description": "OK" + "type": "int", + "description": "" } - }, + } + ], + "redis_rb": [ { - "signature": "String pfmerge(final String destkey, final String... sourcekeys)", + "signature": "saddex(key, *members, mnx: nil, mxx: nil, ex: nil, px: nil, exat: nil, pxat: nil, keepttl: false)", "params": [ { - "name": "destkey", + "name": "key", "type": "String", - "description": "The destination key" + "description": "" }, { - "name": "sourcekeys", - "type": "String...", - "description": "One or more source keys" + "name": "*members", + "type": "Array", + "description": "" + }, + { + "name": "mnx", + "type": "Boolean", + "description": "" + }, + { + "name": "mxx", + "type": "Boolean", + "description": "" + }, + { + "name": "ex", + "type": "Integer", + "description": "" + }, + { + "name": "px", + "type": "Integer", + "description": "" + }, + { + "name": "exat", + "type": "Integer", + "description": "" + }, + { + "name": "pxat", + "type": "Integer", + "description": "" + }, + { + "name": "keepttl", + "type": "Boolean", + "description": "" } ], "returns": { - "type": "String", - "description": "OK" + "type": "Integer", + "description": "" } } ], "lettuce_sync": [ { - "signature": "String pfmerge(K destkey, K... sourcekeys)", + "signature": "Long saddex(K key, V... members)", "params": [ { - "name": "destkey", + "name": "key", "type": "K", - "description": "The destination key" + "description": "the key of the set, must not be null." }, { - "name": "sourcekeys", - "type": "K...", - "description": "The source keys" + "name": "members", + "type": "V...", + "description": "the members to add, must not be null or empty." } ], "returns": { - "type": "String", - "description": "OK" + "type": "Long", + "description": "1 if at least one member was added, updated or deleted; 0 if nothing changed." } - } - ], - "lettuce_async": [ + }, { - "signature": "RedisFuture pfmerge(K destkey, K... sourcekeys)", + "signature": "Long saddex(K key, V member)", "params": [ { - "name": "destkey", + "name": "key", "type": "K", - "description": "The destination key" + "description": "the key of the set, must not be null." }, { - "name": "sourcekeys", - "type": "K...", - "description": "The source keys" + "name": "member", + "type": "V", + "description": "the member to add." } ], "returns": { - "type": "RedisFuture", - "description": "OK" + "type": "Long", + "description": "1 if at least one member was added, updated or deleted; 0 if nothing changed." } - } - ], - "lettuce_reactive": [ + }, { - "signature": "Mono pfmerge(K destkey, K... sourcekeys)", + "signature": "Long saddex(K key, SAddExArgs sAddExArgs, V... members)", "params": [ { - "name": "destkey", + "name": "key", "type": "K", - "description": "The destination key" + "description": "the key of the set, must not be null." }, { - "name": "sourcekeys", - "type": "K...", - "description": "The source keys" + "name": "sAddExArgs", + "type": "SAddExArgs", + "description": "the command arguments, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to add, must not be null or empty." } ], "returns": { - "type": "Mono", - "description": "OK" + "type": "Long", + "description": "1 if at least one member was added, updated or deleted; 0 if the MNX or MXX condition was not met, or nothing changed." } - } - ], - "ioredis": [ + }, { - "signature": "pfmerge(destkey: RedisKey, ...sourcekeys: RedisKey[], callback?: Callback<'OK'>)", + "signature": "Long saddex(K key, SAddExArgs sAddExArgs, V member)", "params": [ { - "name": "destkey", - "type": "RedisKey", - "description": "The destination key" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "...sourcekeys", - "type": "RedisKey[]", - "description": "One or more source keys" + "name": "sAddExArgs", + "type": "SAddExArgs", + "description": "the command arguments, must not be null." }, { - "name": "callback", - "type": "Callback<'OK'>", - "description": "Optional callback" + "name": "member", + "type": "V", + "description": "the member to add." } ], "returns": { - "type": "Result<'OK', Context>", - "description": "OK" + "type": "Long", + "description": "1 if at least one member was added, updated or deleted; 0 if the MNX or MXX condition was not met, or nothing changed." } } ], - "redis_rs_sync": [ + "lettuce_async": [ { - "signature": "pfmerge(dstkey: D, srckeys: S)", + "signature": "RedisFuture saddex(K key, V... members)", "params": [ { - "name": "dstkey", - "type": "D", - "description": "The destination key" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "srckeys", - "type": "S", - "description": "The source keys" + "name": "members", + "type": "V...", + "description": "the members to add, must not be null or empty." } ], "returns": { - "type": "()", - "description": "" + "type": "RedisFuture", + "description": "1 if at least one member was added, updated or deleted; 0 if nothing changed." } - } - ], - "redis_rs_async": [ + }, { - "signature": "pfmerge(dstkey: D, srckeys: S)", + "signature": "RedisFuture saddex(K key, V member)", "params": [ { - "name": "dstkey", - "type": "D", - "description": "The destination key" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "srckeys", - "type": "S", - "description": "The source keys" + "name": "member", + "type": "V", + "description": "the member to add." } ], "returns": { - "type": "()", - "description": "" + "type": "RedisFuture", + "description": "1 if at least one member was added, updated or deleted; 0 if nothing changed." } - } - ], - "nredisstack_sync": [ + }, { - "signature": "HyperLogLogMerge(RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture saddex(K key, SAddExArgs sAddExArgs, V... members)", "params": [ { - "name": "destination", - "type": "RedisKey", - "description": "The key of the merged HyperLogLog" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "first", - "type": "RedisKey", - "description": "First source key" + "name": "sAddExArgs", + "type": "SAddExArgs", + "description": "the command arguments, must not be null." }, { - "name": "second", - "type": "RedisKey", - "description": "Second source key" + "name": "members", + "type": "V...", + "description": "the members to add, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture", + "description": "1 if at least one member was added, updated or deleted; 0 if the MNX or MXX condition was not met, or nothing changed." + } + }, + { + "signature": "RedisFuture saddex(K key, SAddExArgs sAddExArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation" + "name": "sAddExArgs", + "type": "SAddExArgs", + "description": "the command arguments, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to add." } ], "returns": { - "type": "void", - "description": "" + "type": "RedisFuture", + "description": "1 if at least one member was added, updated or deleted; 0 if the MNX or MXX condition was not met, or nothing changed." } - }, + } + ], + "lettuce_reactive": [ { - "signature": "HyperLogLogMerge(RedisKey destination, RedisKey[] sourceKeys, CommandFlags flags = CommandFlags.None)", + "signature": "Mono saddex(K key, V... members)", "params": [ { - "name": "destination", - "type": "RedisKey", - "description": "The key of the merged HyperLogLog" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "sourceKeys", - "type": "RedisKey[]", - "description": "The keys of the HyperLogLogs to merge" + "name": "members", + "type": "V...", + "description": "the members to add, must not be null or empty." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 1 if at least one member was added, updated or deleted; 0 if nothing changed." + } + }, + { + "signature": "Mono saddex(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation" + "name": "member", + "type": "V", + "description": "the member to add." } ], "returns": { - "type": "void", - "description": "" + "type": "Mono", + "description": "a Mono emitting 1 if at least one member was added, updated or deleted; 0 if nothing changed." } - } - ], - "nredisstack_async": [ + }, { - "signature": "HyperLogLogMergeAsync(RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "Mono saddex(K key, SAddExArgs sAddExArgs, V... members)", "params": [ { - "name": "destination", - "type": "RedisKey", - "description": "The key of the merged HyperLogLog" - }, - { - "name": "first", - "type": "RedisKey", - "description": "First source key" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "second", - "type": "RedisKey", - "description": "Second source key" + "name": "sAddExArgs", + "type": "SAddExArgs", + "description": "the command arguments, must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation" + "name": "members", + "type": "V...", + "description": "the members to add, must not be null or empty." } ], "returns": { - "type": "Task", - "description": "" + "type": "Mono", + "description": "a Mono emitting 1 if at least one member was added, updated or deleted; 0 if the MNX or MXX condition was not met, or nothing changed." } }, { - "signature": "HyperLogLogMergeAsync(RedisKey destination, RedisKey[] sourceKeys, CommandFlags flags = CommandFlags.None)", + "signature": "Mono saddex(K key, SAddExArgs sAddExArgs, V member)", "params": [ { - "name": "destination", - "type": "RedisKey", - "description": "The key of the merged HyperLogLog" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "sourceKeys", - "type": "RedisKey[]", - "description": "The keys of the HyperLogLogs to merge" + "name": "sAddExArgs", + "type": "SAddExArgs", + "description": "the command arguments, must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation" + "name": "member", + "type": "V", + "description": "the member to add." } ], "returns": { - "type": "Task", - "description": "" + "type": "Mono", + "description": "a Mono emitting 1 if at least one member was added, updated or deleted; 0 if the MNX or MXX condition was not met, or nothing changed." } } ], - "php": [ + "jedis": [ { - "signature": "pfmerge(string $destinationKey, array|string $sourceKeys)", + "signature": "long saddex(byte[] key, SAddExParams params, byte[]... members)", "params": [ { - "name": "$destinationKey", - "type": "string", - "description": "The destination key" + "name": "key", + "type": "byte[]", + "description": "" }, { - "name": "$sourceKeys", - "type": "array|string", - "description": "One or more source keys" + "name": "params", + "type": "SAddExParams", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" } ], "returns": { - "type": "mixed", - "description": "OK" + "type": "long", + "description": "" } - } - ], - "go-redis": [ + }, { - "signature": "PFMerge(ctx context.Context, dest string, keys ...string) *StatusCmd", + "signature": "long saddex(byte[] key, SAddExParams params, byte[] member)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context for the command" + "name": "key", + "type": "byte[]", + "description": "" }, { - "name": "dest", - "type": "string", - "description": "The destination key" + "name": "params", + "type": "SAddExParams", + "description": "" }, { - "name": "keys", - "type": "...string", - "description": "One or more source keys" + "name": "member", + "type": "byte[]", + "description": "" } ], "returns": { - "type": "*StatusCmd", - "description": "OK" + "type": "long", + "description": "" } - } - ], - "node_redis": [ + }, { - "signature": "PFMERGE(destination: RedisArgument, sources?: RedisVariadicArgument)", + "signature": "long saddex(String key, SAddExParams params, String... members)", "params": [ { - "name": "destination", - "type": "RedisArgument", - "description": "The destination key to merge to" + "name": "key", + "type": "String", + "description": "" }, { - "name": "sources", - "type": "RedisVariadicArgument", - "description": "One or more source keys to merge from" + "name": "params", + "type": "SAddExParams", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" } ], "returns": { - "type": "SimpleStringReply", - "description": "OK" + "type": "long", + "description": "" } - } - ], - "redis_rb": [ + }, { - "signature": "pfmerge(dest_key, *source_key)", + "signature": "long saddex(String key, SAddExParams params, String member)", "params": [ { - "name": "dest_key", + "name": "key", "type": "String", - "description": "destination key" + "description": "" }, { - "name": "*source_key", - "type": "String, Array", - "description": "source key, or array of keys" + "name": "params", + "type": "SAddExParams", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" } ], "returns": { - "type": "Boolean", + "type": "long", "description": "" } } ] } }, - "PING": { + "SAVE": { "api_calls": { "redis_py": [ { - "signature": "ping(**kwargs)", + "signature": "save(**kwargs)", "params": [ { "name": "**kwargs", @@ -91416,38 +98939,24 @@ } ], "returns": { - "type": "Union[Awaitable[bool], bool]", + "type": "ResponseT", "description": "" } } ], "jedis": [ { - "signature": "String ping()", + "signature": "String save()", "params": [], "returns": { "type": "String", - "description": "PONG" - } - }, - { - "signature": "String ping(final String message)", - "params": [ - { - "name": "message", - "type": "String", - "description": "The message to echo" - } - ], - "returns": { - "type": "String", - "description": "The message" + "description": "OK" } } ], "go-redis": [ { - "signature": "Ping(ctx context.Context) *StatusCmd", + "signature": "Save(ctx context.Context) *StatusCmd", "params": [ { "name": "ctx", @@ -91463,40 +98972,50 @@ ], "node_redis": [ { - "signature": "parseCommand(parser: CommandParser, message?: RedisArgument)", - "params": [ - { - "name": "parser", - "type": "CommandParser", - "description": "The command parser" - }, - { - "name": "message", - "type": "RedisArgument", - "description": "Optional message to be returned instead of PONG" - } - ], + "signature": "SAVE()", + "params": [], "returns": { - "type": "SimpleStringReply | BlobStringReply", + "type": "SimpleStringReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "String save()", + "params": [], + "returns": { + "type": "String", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture save()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono save()", + "params": [], + "returns": { + "type": "Mono", "description": "" } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], "nredisstack_sync": [], "nredisstack_async": [], "php": [ { - "signature": "ping(?string $message = null)", - "params": [ - { - "name": "$message", - "type": "?string", - "description": "Optional message" - } - ], + "signature": "save()", + "params": [], "returns": { "type": "mixed", "description": "" @@ -91507,419 +99026,471 @@ "redis_rs_async": [] } }, - "PSETEX": { + "SCAN": { "api_calls": { "redis_py": [ { - "signature": "psetex(name: KeyT, time_ms: ExpiryT, value: EncodableT)", + "signature": "scan(cursor: int = 0, match: Optional[PatternT] = None, count: Optional[int] = None, _type: Optional[str] = None, **kwargs)", "params": [ { - "name": "name", - "type": "KeyT", + "name": "cursor", + "type": "int", "description": "" }, { - "name": "time_ms", - "type": "ExpiryT", + "name": "match", + "type": "Optional[PatternT]", "description": "" }, { - "name": "value", - "type": "EncodableT", + "name": "count", + "type": "Optional[int]", + "description": "" + }, + { + "name": "_type", + "type": "Optional[str]", "description": "" } ], "returns": { - "type": "Any", + "type": "tuple", "description": "" } } ], "jedis": [ { - "signature": "String psetex(final byte[] key, final long milliseconds, final byte[] value)", + "signature": "ScanResult scan(final byte[] cursor)", "params": [ { - "name": "key", + "name": "cursor", "type": "byte[]", "description": "" - }, + } + ], + "returns": { + "type": "ScanResult", + "description": "ScanResult" + } + }, + { + "signature": "ScanResult scan(final byte[] cursor, final ScanParams params)", + "params": [ { - "name": "milliseconds", - "type": "long", + "name": "cursor", + "type": "byte[]", "description": "" }, { - "name": "value", - "type": "byte[]", + "name": "params", + "type": "ScanParams", "description": "" } ], "returns": { - "type": "String", - "description": "OK @deprecated Use Jedis#set(String, String, redis.clients.jedis.params.SetParams) with redis.clients.jedis.params.SetParams#px(long). Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 2.6.12." + "type": "ScanResult", + "description": "ScanResult" } }, { - "signature": "String psetex(final String key, final long milliseconds, final String value)", + "signature": "ScanResult scan(final String cursor)", "params": [ { - "name": "key", + "name": "cursor", "type": "String", "description": "" - }, + } + ], + "returns": { + "type": "ScanResult", + "description": "ScanResult" + } + }, + { + "signature": "ScanResult scan(final String cursor, final ScanParams params)", + "params": [ { - "name": "milliseconds", - "type": "long", + "name": "cursor", + "type": "String", "description": "" }, { - "name": "value", - "type": "String", + "name": "params", + "type": "ScanParams", "description": "" } ], "returns": { - "type": "String", - "description": "OK @deprecated Use Jedis#set(String, String, redis.clients.jedis.params.SetParams) with redis.clients.jedis.params.SetParams#px(long). Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 2.6.12." + "type": "ScanResult", + "description": "ScanResult" } } ], - "lettuce_sync": [ + "go-redis": [ { - "signature": "String psetex(K key, long milliseconds, V value)", + "signature": "Scan(ctx context.Context, cursor uint64, match string, count int64)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." + "name": "ctx", + "type": "context.Context", + "description": "" }, { - "name": "milliseconds", - "type": "long", - "description": "the milliseconds type: long." + "name": "cursor", + "type": "uint64", + "description": "" }, { - "name": "value", - "type": "V", - "description": "the value." + "name": "match", + "type": "string", + "description": "" + }, + { + "name": "count", + "type": "int64", + "description": "" } ], "returns": { - "type": "String", - "description": "String simple-string-reply." + "type": "*ScanCmd", + "description": "" } } ], - "lettuce_async": [ + "node_redis": [ { - "signature": "RedisFuture psetex(K key, long milliseconds, V value)", + "signature": "SCAN(cursor: number, options?: ScanOptions)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." + "name": "cursor", + "type": "number", + "description": "" }, { - "name": "milliseconds", - "type": "long", - "description": "the milliseconds type: long." + "name": "options?", + "type": "ScanOptions", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "KeyScanCursor scan()", + "params": [], + "returns": { + "type": "KeyScanCursor", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "KeyScanCursor scan(ScanArgs scanArgs)", + "params": [ + { + "name": "scanArgs", + "type": "ScanArgs", + "description": "scan arguments." + } + ], + "returns": { + "type": "KeyScanCursor", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "KeyScanCursor scan(ScanCursor scanCursor)", + "params": [ + { + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan." + } + ], + "returns": { + "type": "KeyScanCursor", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "KeyScanCursor scan(ScanCursor scanCursor, ScanArgs scanArgs)", + "params": [ + { + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan." }, { - "name": "value", - "type": "V", - "description": "the value." + "name": "scanArgs", + "type": "ScanArgs", + "description": "scan arguments." } ], "returns": { - "type": "RedisFuture", - "description": "String simple-string-reply." + "type": "KeyScanCursor", + "description": "KeyScanCursor scan cursor." } } ], - "lettuce_reactive": [ + "lettuce_async": [ { - "signature": "Mono psetex(K key, long milliseconds, V value)", + "signature": "RedisFuture> scan()", + "params": [], + "returns": { + "type": "RedisFuture>", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "RedisFuture> scan(ScanArgs scanArgs)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." - }, + "name": "scanArgs", + "type": "ScanArgs", + "description": "scan arguments." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "RedisFuture> scan(ScanCursor scanCursor)", + "params": [ { - "name": "milliseconds", - "type": "long", - "description": "the milliseconds type: long." + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "RedisFuture> scan(ScanCursor scanCursor, ScanArgs scanArgs)", + "params": [ + { + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan." }, { - "name": "value", - "type": "V", - "description": "the value." + "name": "scanArgs", + "type": "ScanArgs", + "description": "scan arguments." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "KeyScanCursor scan cursor." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> scan()", + "params": [], + "returns": { + "type": "Mono>", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "Mono> scan(ScanArgs scanArgs)", + "params": [ + { + "name": "scanArgs", + "type": "ScanArgs", + "description": "scan arguments." + } + ], + "returns": { + "type": "Mono>", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "Mono> scan(ScanCursor scanCursor)", + "params": [ + { + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan." } ], "returns": { - "type": "Mono", - "description": "String simple-string-reply." + "type": "Mono>", + "description": "KeyScanCursor scan cursor." } - } - ], - "node_redis": [ + }, { - "signature": "PSETEX(key: RedisArgument, ms: number, value: RedisArgument)", + "signature": "Mono> scan(ScanCursor scanCursor, ScanArgs scanArgs)", "params": [ { - "name": "key", - "type": "RedisArgument", - "description": "" - }, - { - "name": "ms", - "type": "number", - "description": "" + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan." }, { - "name": "value", - "type": "RedisArgument", - "description": "" + "name": "scanArgs", + "type": "ScanArgs", + "description": "scan arguments." } ], "returns": { - "type": "Any", - "description": "" + "type": "Mono>", + "description": "KeyScanCursor scan cursor." } } ], - "ioredis": [ + "nredisstack_sync": [ { - "signature": "psetex(key: RedisKey, milliseconds: number | string, value: string | Buffer | number, callback?: Callback)", + "signature": "Scan(RedisValue pattern = default, int pageSize = 250, long cursor = 0, int pageOffset = 0, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" + "name": "pattern", + "type": "RedisValue", + "description": "The pattern to match." }, { - "name": "milliseconds", - "type": "number | string", - "description": "" + "name": "pageSize", + "type": "int", + "description": "The page size." }, { - "name": "value", - "type": "string | Buffer | number", - "description": "" + "name": "cursor", + "type": "long", + "description": "The cursor." }, { - "name": "callback?", - "type": "Callback", - "description": "" + "name": "pageOffset", + "type": "int", + "description": "The page offset." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Any", - "description": "" + "type": "IEnumerable", + "description": "The keys matching the pattern." } } ], - "redis_rs_sync": [ + "nredisstack_async": [ { - "signature": "pset_ex(key: K, value: V, milliseconds: u64)", + "signature": "Scan(RedisValue pattern = default, int pageSize = 250, long cursor = 0, int pageOffset = 0, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "K", - "description": "" + "name": "pattern", + "type": "RedisValue", + "description": "The pattern to match." }, { - "name": "value", - "type": "V", - "description": "" + "name": "pageSize", + "type": "int", + "description": "The page size." }, { - "name": "milliseconds", - "type": "u64", - "description": "" - } - ], - "returns": { - "type": "(())", - "description": "" - } - } - ], - "redis_rs_async": [ - { - "signature": "pset_ex(key: K, value: V, milliseconds: u64)", - "params": [ - { - "name": "key", - "type": "K", - "description": "" + "name": "cursor", + "type": "long", + "description": "The cursor." }, { - "name": "value", - "type": "V", - "description": "" + "name": "pageOffset", + "type": "int", + "description": "The page offset." }, { - "name": "milliseconds", - "type": "u64", - "description": "" + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "(())", - "description": "" + "type": "IAsyncEnumerable", + "description": "The keys matching the pattern." } } ], "php": [ { - "signature": "psetex(string $key, $milliseconds, $value)", + "signature": "scan(?int &$iterator, string|array|null $pattern = null, int $count = 0, string $type = null)", "params": [ { - "name": "$key", - "type": "string", + "name": "&$iterator", + "type": "?int", "description": "" }, { - "name": "$milliseconds", - "type": "Any", + "name": "$pattern", + "type": "string|array|null", "description": "" }, { - "name": "$value", - "type": "Any", + "name": "$count", + "type": "int", + "description": "" + }, + { + "name": "$type", + "type": "string", "description": "" } ], "returns": { - "type": "Status", + "type": "array|bool", "description": "" } } ], "redis_rb": [ { - "signature": "psetex(key, ttl, value)", + "signature": "scan(cursor, **options)", "params": [ { - "name": "key", - "type": "String", - "description": "" - }, - { - "name": "ttl", - "type": "Integer", - "description": "" + "name": "cursor", + "type": "String, Integer", + "description": "the cursor of the iteration" }, { - "name": "value", + "name": "match", "type": "String", - "description": "" - } - ], - "returns": { - "type": "String", - "description": "\"OK\"" - } - } - ] - } - }, - "PSUBSCRIBE": { - "api_calls": { - "redis_py": [], - "jedis": [ - { - "signature": "void psubscribe(BinaryJedisPubSub jedisPubSub, final byte[]... patterns)", - "params": [ - { - "name": "jedisPubSub", - "type": "BinaryJedisPubSub", - "description": "Pub/sub listener object" + "description": "only return keys matching the pattern" }, { - "name": "patterns", - "type": "byte[]...", - "description": "Channel patterns to subscribe to" - } - ], - "returns": { - "type": "void", - "description": "Blocks until unsubscribed" - } - }, - { - "signature": "void psubscribe(final JedisPubSub jedisPubSub, final String... patterns)", - "params": [ - { - "name": "jedisPubSub", - "type": "JedisPubSub", - "description": "Pub/sub listener object" + "name": "count", + "type": "Integer", + "description": "return count keys at most per iteration" }, { - "name": "patterns", - "type": "String...", - "description": "Channel patterns to subscribe to" - } - ], - "returns": { - "type": "void", - "description": "Blocks until unsubscribed" - } - } - ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], - "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rb": [ - { - "signature": "psubscribe(*channels, &block)", - "params": [ - { - "name": "*channels", - "type": "Array", - "description": "" + "name": "type", + "type": "String", + "description": "return keys only of the given type" } ], "returns": { - "type": "nil", - "description": "" + "type": "Array", + "description": "the next cursor and all found keys" } } ] } }, - "PSYNC": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "PTTL": { + "SCARD": { "api_calls": { "redis_py": [ { - "signature": "pttl(name: KeyT)", + "signature": "scard(name: KeyT)", "params": [ { "name": "name", @@ -91928,14 +99499,14 @@ } ], "returns": { - "type": "int", + "type": "Union[Awaitable[int], int]", "description": "" } } ], "jedis": [ { - "signature": "long pttl(final byte[] key)", + "signature": "long scard(final byte[] key)", "params": [ { "name": "key", @@ -91945,11 +99516,11 @@ ], "returns": { "type": "long", - "description": "TTL in milliseconds, or a negative value in order to signal an error" + "description": "The cardinality (number of elements) of the set as an integer" } }, { - "signature": "long pttl(final String key)", + "signature": "long scard(final String key)", "params": [ { "name": "key", @@ -91959,50 +99530,13 @@ ], "returns": { "type": "long", - "description": "TTL in milliseconds, or a negative value in order to signal an error" - } - } - ], - "go-redis": [ - { - "signature": "PTTL(ctx context.Context, key string)", - "params": [ - { - "name": "ctx", - "type": "context.Context", - "description": "" - }, - { - "name": "key", - "type": "string", - "description": "" - } - ], - "returns": { - "type": "*DurationCmd", - "description": "" - } - } - ], - "node_redis": [ - { - "signature": "PTTL(key: RedisArgument)", - "params": [ - { - "name": "key", - "type": "RedisArgument", - "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" + "description": "The cardinality (number of elements) of the set as an integer" } } ], "lettuce_sync": [ { - "signature": "Long pttl(K key)", + "signature": "Long scard(K key)", "params": [ { "name": "key", @@ -92012,13 +99546,13 @@ ], "returns": { "type": "Long", - "description": "Long integer-reply TTL in milliseconds, or a negative value in order to signal an error." + "description": "Long integer-reply the cardinality (number of elements) of the set, or false if key does not exist." } } ], "lettuce_async": [ { - "signature": "RedisFuture pttl(K key)", + "signature": "RedisFuture scard(K key)", "params": [ { "name": "key", @@ -92028,13 +99562,13 @@ ], "returns": { "type": "RedisFuture", - "description": "Long integer-reply TTL in milliseconds, or a negative value in order to signal an error." + "description": "Long integer-reply the cardinality (number of elements) of the set, or false if key does not exist." } } ], "lettuce_reactive": [ { - "signature": "Mono pttl(K key)", + "signature": "Mono scard(K key)", "params": [ { "name": "key", @@ -92044,353 +99578,265 @@ ], "returns": { "type": "Mono", - "description": "Long integer-reply TTL in milliseconds, or a negative value in order to signal an error." + "description": "Long integer-reply the cardinality (number of elements) of the set, or false if key does not exist." } } ], - "nredisstack_sync": [ + "go-redis": [ { - "signature": "KeyTimeToLive(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "SCard(ctx context.Context, key string)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The key to check." + "name": "ctx", + "type": "context.Context", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "key", + "type": "string", + "description": "" } ], "returns": { - "type": "TimeSpan?", - "description": "The time to live, or null if the key does not exist or has no associated expiration." + "type": "*IntCmd", + "description": "" } } ], - "nredisstack_async": [ + "node_redis": [ { - "signature": "KeyTimeToLiveAsync(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "SCARD(key: RedisArgument)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key to check." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "type": "RedisArgument", + "description": "" } ], "returns": { - "type": "Task", - "description": "The time to live, or null if the key does not exist or has no associated expiration." + "type": "Any", + "description": "" } } ], - "php": [ + "ioredis": [ { - "signature": "pttl(string $key)", + "signature": "scard(key: RedisKey, callback?: Callback): Result;, /**, * Set the debug mode for executed scripts., * - _group_: scripting, * - _complexity_: O(1), * - _since_: 3.2.0, */, script(, subcommand: \"DEBUG\", yes: \"YES\", callback?: Callback)", "params": [ { - "name": "$key", - "type": "string", + "name": "key", + "type": "RedisKey", + "description": "" + }, + { + "name": "callback?", + "type": "Callback)", + "description": "" + }, + { + "name": "subcommand", + "type": "\"DEBUG\"", + "description": "" + }, + { + "name": "yes", + "type": "\"YES\"", + "description": "" + }, + { + "name": "callback?", + "type": "Callback", "description": "" } ], "returns": { - "type": "int", + "type": "Any", "description": "" } } ], - "redis_rb": [ + "redis_rs_sync": [ { - "signature": "pttl(key)", + "signature": "scard(key: K)", "params": [ { "name": "key", - "type": "String", + "type": "K", "description": "" } ], "returns": { - "type": "Integer", - "description": "remaining time to live in milliseconds" + "type": "(usize)", + "description": "" } } - ] - } - }, - "PUBLISH": { - "api_calls": { - "redis_py": [ + ], + "redis_rs_async": [ { - "signature": "publish(channel: ChannelT, message: EncodableT, **kwargs)", + "signature": "scard(key: K)", "params": [ { - "name": "channel", - "type": "ChannelT", - "description": "Channel to publish the message to" - }, - { - "name": "message", - "type": "EncodableT", - "description": "Message to publish" - }, - { - "name": "**kwargs", - "type": "Any", - "description": "Additional keyword arguments" + "name": "key", + "type": "K", + "description": "" } ], "returns": { - "type": "ResponseT", - "description": "Number of clients that received the message" + "type": "(usize)", + "description": "" } } ], - "jedis": [ + "nredisstack_sync": [ { - "signature": "long publish(final byte[] channel, final byte[] message)", + "signature": "SetLength(RedisKey key, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "channel", - "type": "byte[]", - "description": "Channel to publish the message to" + "name": "key", + "type": "RedisKey", + "description": "The key of the set." }, { - "name": "message", - "type": "byte[]", - "description": "Message to publish" + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { "type": "long", - "description": "Number of clients that received the message" + "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." } }, { - "signature": "long publish(final String channel, final String message)", + "signature": "SetLength(RedisKey key, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "channel", - "type": "String", - "description": "Channel to publish the message to" + "name": "key", + "type": "RedisKey", + "description": "The key of the set." }, { - "name": "message", - "type": "String", - "description": "Message to publish" + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { "type": "long", - "description": "Number of clients that received the message" - } - } - ], - "go-redis": [ - { - "signature": "Publish(ctx context.Context, channel string, message interface{})", - "params": [ - { - "name": "ctx", - "type": "context.Context", - "description": "Context for the operation" - }, - { - "name": "channel", - "type": "string", - "description": "Channel to publish the message to" - }, - { - "name": "message", - "type": "interface{}", - "description": "Message to publish" - } - ], - "returns": { - "type": "*IntCmd", - "description": "Number of clients that received the message" + "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], - "redisvl": [], - "nredisstack_sync": [ + "nredisstack_async": [ { - "signature": "long Publish(RedisChannel channel, RedisValue message, CommandFlags flags = CommandFlags.None)", + "signature": "SetLength(RedisKey key, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "channel", - "type": "RedisChannel", - "description": "The channel to publish to" - }, - { - "name": "message", - "type": "RedisValue", - "description": "The message to send" + "name": "key", + "type": "RedisKey", + "description": "The key of the set." }, { "name": "flags", "type": "CommandFlags", - "description": "The flags to use for this operation" + "description": "The flags to use for this operation." } ], "returns": { "type": "long", - "description": "The number of clients that received the message on the destination server" + "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." } - } - ], - "nredisstack_async": [ + }, { - "signature": "Task PublishAsync(RedisChannel channel, RedisValue message, CommandFlags flags = CommandFlags.None)", + "signature": "SetLength(RedisKey key, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "channel", - "type": "RedisChannel", - "description": "The channel to publish to" - }, - { - "name": "message", - "type": "RedisValue", - "description": "The message to send" + "name": "key", + "type": "RedisKey", + "description": "The key of the set." }, { "name": "flags", "type": "CommandFlags", - "description": "The flags to use for this operation" + "description": "The flags to use for this operation." } ], "returns": { - "type": "Task", - "description": "The number of clients that received the message on the destination server" + "type": "long", + "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." } } ], "php": [ { - "signature": "publish($channel, $message)", + "signature": "scard(string $key)", "params": [ { - "name": "$channel", - "type": "string", - "description": "Channel to publish the message to" - }, - { - "name": "$message", + "name": "$key", "type": "string", - "description": "Message to publish" + "description": "" } ], "returns": { "type": "int", - "description": "Number of clients that received the message" + "description": "" } } ], "redis_rb": [ { - "signature": "publish(channel, message)", + "signature": "scard(key)", "params": [ { - "name": "channel", - "type": "String", - "description": "" - }, - { - "name": "message", + "name": "key", "type": "String", "description": "" } ], "returns": { "type": "Integer", - "description": "number of clients that received the message" + "description": "" } } ] } }, - "PUBSUB CHANNELS": { + "SCRIPT DEBUG": { "api_calls": { "redis_py": [ { - "signature": "pubsub_channels(pattern: PatternT = \"*\", **kwargs)", + "signature": "script_debug(*args)", "params": [ { - "name": "pattern", - "type": "PatternT", - "description": "Pattern to match channel names (default: \"*\")" - }, - { - "name": "**kwargs", + "name": "*args", "type": "Any", - "description": "Additional keyword arguments" - } - ], - "returns": { - "type": "ResponseT", - "description": "List of active channels matching the pattern" - } - } - ], - "jedis": [ - { - "signature": "List pubsubChannels()", - "params": [], - "returns": { - "type": "List", - "description": "List of all active channels" - } - }, - { - "signature": "List pubsubChannels(final String pattern)", - "params": [ - { - "name": "pattern", - "type": "String", - "description": "Pattern to match channel names" + "description": "Debug mode arguments" } ], "returns": { - "type": "List", - "description": "List of active channels matching the pattern" + "type": "None", + "description": "No return value" } } ], - "go-redis": [ + "jedis": [], + "go-redis": [], + "node_redis": [ { - "signature": "PubSubChannels(ctx context.Context, pattern string)", + "signature": "scriptDebug(mode: 'YES' | 'SYNC' | 'NO')", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context for the operation" - }, - { - "name": "pattern", - "type": "string", - "description": "Pattern to match channel names" + "name": "mode", + "type": "'YES' | 'SYNC' | 'NO'", + "description": "Debug mode" } ], "returns": { - "type": "*StringSliceCmd", - "description": "List of active channels matching the pattern" + "type": "Promise>", + "description": "Status response" } } ], - "node_redis": [], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], @@ -92402,93 +99848,160 @@ "nredisstack_async": [], "php": [ { - "signature": "pubsub($subcommand, $argument)", + "signature": "script($subcommand, $argument = null)", "params": [ { "name": "$subcommand", "type": "string", - "description": "PUBSUB subcommand (e.g., 'CHANNELS')" + "description": "SCRIPT subcommand (e.g., 'DEBUG')" }, { "name": "$argument", "type": "mixed", - "description": "Pattern to match channel names" + "description": "Optional argument for the subcommand" } ], "returns": { "type": "mixed", - "description": "List of active channels matching the pattern" + "description": "Command result" } } ] } }, - "PUBSUB HELP": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], - "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [] - } - }, - "PUBSUB NUMPAT": { + "SCRIPT EXISTS": { "api_calls": { "redis_py": [ { - "signature": "pubsub_numpat(**kwargs)", + "signature": "script_exists(*args: str)", "params": [ { - "name": "**kwargs", - "type": "Any", - "description": "Additional keyword arguments" + "name": "*args", + "type": "str", + "description": "SHA1 digests to check" } ], "returns": { "type": "ResponseT", - "description": "Number of unique pattern subscriptions" + "description": "List of boolean values indicating script existence" } } ], "jedis": [ { - "signature": "Long pubsubNumPat()", - "params": [], + "signature": "Boolean scriptExists(final String sha1)", + "params": [ + { + "name": "sha1", + "type": "String", + "description": "SHA1 digest to check" + } + ], "returns": { - "type": "Long", - "description": "Number of unique pattern subscriptions" + "type": "Boolean", + "description": "True if script exists" + } + }, + { + "signature": "List scriptExists(final String... sha1)", + "params": [ + { + "name": "sha1", + "type": "String...", + "description": "SHA1 digests to check" + } + ], + "returns": { + "type": "List", + "description": "List of boolean values indicating script existence" } } ], "go-redis": [ { - "signature": "PubSubNumPat(ctx context.Context)", + "signature": "ScriptExists(ctx context.Context, hashes ...string)", "params": [ { "name": "ctx", "type": "context.Context", "description": "Context for the operation" + }, + { + "name": "hashes", + "type": "...string", + "description": "SHA1 digests to check" } ], "returns": { - "type": "*IntCmd", - "description": "Number of unique pattern subscriptions" + "type": "*BoolSliceCmd", + "description": "List of boolean values indicating script existence" + } + } + ], + "node_redis": [ + { + "signature": "scriptExists(sha1: RedisVariadicArgument)", + "params": [ + { + "name": "sha1", + "type": "RedisVariadicArgument", + "description": "One or more SHA1 digests of scripts" + } + ], + "returns": { + "type": "Promise>", + "description": "Array of 1s and 0s indicating script existence" + } + } + ], + "lettuce_sync": [ + { + "signature": "List scriptExists(String... digests)", + "params": [ + { + "name": "digests", + "type": "String...", + "description": "SHA1 digests" + } + ], + "returns": { + "type": "List", + "description": "List of boolean values indicating script existence" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> scriptExists(String... digests)", + "params": [ + { + "name": "digests", + "type": "String...", + "description": "SHA1 digests" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "List of boolean values indicating script existence" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux scriptExists(String... digests)", + "params": [ + { + "name": "digests", + "type": "String...", + "description": "SHA1 digests" + } + ], + "returns": { + "type": "Flux", + "description": "Boolean values indicating script existence" } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], "ioredis": [], "redis_rs_sync": [], "redis_rs_async": [], @@ -92497,91 +100010,173 @@ "nredisstack_async": [], "php": [ { - "signature": "pubsub($subcommand, $argument)", + "signature": "script($subcommand, $argument = null)", "params": [ { "name": "$subcommand", "type": "string", - "description": "PUBSUB subcommand (e.g., 'NUMPAT')" + "description": "SCRIPT subcommand (e.g., 'EXISTS')" }, { "name": "$argument", "type": "mixed", - "description": "Not used for NUMPAT" + "description": "Optional argument for the subcommand" } ], "returns": { "type": "mixed", - "description": "Number of unique pattern subscriptions" + "description": "Command result" } } ] } }, - "PUBSUB NUMSUB": { + "SCRIPT FLUSH": { "api_calls": { "redis_py": [ { - "signature": "pubsub_numsub(*args: ChannelT, **kwargs)", + "signature": "script_flush(sync_type: Union[Literal[\"SYNC\"], Literal[\"ASYNC\"]] = None)", "params": [ { - "name": "*args", - "type": "ChannelT", - "description": "Channel names to get subscriber counts for" - }, - { - "name": "**kwargs", - "type": "Any", - "description": "Additional keyword arguments" + "name": "sync_type", + "type": "Union[Literal[\"SYNC\"], Literal[\"ASYNC\"]]", + "description": "Flush mode (SYNC or ASYNC)" } ], "returns": { "type": "ResponseT", - "description": "Map of channel names to subscriber counts" + "description": "Status response" } } ], "jedis": [ { - "signature": "Map pubsubNumSub(String... channels)", + "signature": "String scriptFlush()", + "params": [], + "returns": { + "type": "String", + "description": "Status response" + } + }, + { + "signature": "String scriptFlush(final FlushMode flushMode)", "params": [ { - "name": "channels", - "type": "String...", - "description": "Channel names to get subscriber counts for" + "name": "flushMode", + "type": "FlushMode", + "description": "Flush mode (SYNC or ASYNC)" } ], "returns": { - "type": "Map", - "description": "Map of channel names to subscriber counts" + "type": "String", + "description": "Status response" } } ], "go-redis": [ { - "signature": "PubSubNumSub(ctx context.Context, channels ...string)", + "signature": "ScriptFlush(ctx context.Context)", "params": [ { "name": "ctx", "type": "context.Context", "description": "Context for the operation" - }, + } + ], + "returns": { + "type": "*StatusCmd", + "description": "Status response" + } + } + ], + "node_redis": [ + { + "signature": "scriptFlush(mode?: 'ASYNC' | 'SYNC')", + "params": [ { - "name": "channels", - "type": "...string", - "description": "Channel names to get subscriber counts for" + "name": "mode", + "type": "'ASYNC' | 'SYNC'", + "description": "Optional flush mode" } ], "returns": { - "type": "*MapStringIntCmd", - "description": "Map of channel names to subscriber counts" + "type": "Promise>", + "description": "Status response" + } + } + ], + "lettuce_sync": [ + { + "signature": "String scriptFlush()", + "params": [], + "returns": { + "type": "String", + "description": "Status response" + } + }, + { + "signature": "String scriptFlush(FlushMode flushMode)", + "params": [ + { + "name": "flushMode", + "type": "FlushMode", + "description": "Flush mode (SYNC or ASYNC)" + } + ], + "returns": { + "type": "String", + "description": "Status response" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture scriptFlush()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "Status response" + } + }, + { + "signature": "RedisFuture scriptFlush(FlushMode flushMode)", + "params": [ + { + "name": "flushMode", + "type": "FlushMode", + "description": "Flush mode (SYNC or ASYNC)" + } + ], + "returns": { + "type": "RedisFuture", + "description": "Status response" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono scriptFlush()", + "params": [], + "returns": { + "type": "Mono", + "description": "Status response" + } + }, + { + "signature": "Mono scriptFlush(FlushMode flushMode)", + "params": [ + { + "name": "flushMode", + "type": "FlushMode", + "description": "Flush mode (SYNC or ASYNC)" + } + ], + "returns": { + "type": "Mono", + "description": "Status response" } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], "ioredis": [], "redis_rs_sync": [], "redis_rs_async": [], @@ -92590,99 +100185,123 @@ "nredisstack_async": [], "php": [ { - "signature": "pubsub($subcommand, $argument)", + "signature": "script($subcommand, $argument = null)", "params": [ { "name": "$subcommand", "type": "string", - "description": "PUBSUB subcommand (e.g., 'NUMSUB')" + "description": "SCRIPT subcommand (e.g., 'FLUSH')" }, { "name": "$argument", "type": "mixed", - "description": "Channel names to get subscriber counts for" + "description": "Optional argument for the subcommand" } ], "returns": { "type": "mixed", - "description": "Map of channel names to subscriber counts" + "description": "Command result" } } ] } }, - "PUBSUB SHARDCHANNELS": { + "SCRIPT HELP": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "ioredis": [], + "redis_rs_sync": [], + "redis_rs_async": [], + "redisvl": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [] + } + }, + "SCRIPT KILL": { "api_calls": { "redis_py": [ { - "signature": "pubsub_shardchannels(pattern: PatternT = \"*\", **kwargs)", - "params": [ - { - "name": "pattern", - "type": "PatternT", - "description": "Pattern to match shard channel names (default: \"*\")" - }, - { - "name": "**kwargs", - "type": "Any", - "description": "Additional keyword arguments" - } - ], + "signature": "script_kill()", + "params": [], "returns": { "type": "ResponseT", - "description": "List of active shard channels matching the pattern" + "description": "Status response" } } ], "jedis": [ { - "signature": "List pubsubShardChannels()", + "signature": "String scriptKill()", "params": [], "returns": { - "type": "List", - "description": "List of all active shard channels" - } - }, - { - "signature": "List pubsubShardChannels(final String pattern)", - "params": [ - { - "name": "pattern", - "type": "String", - "description": "Pattern to match shard channel names" - } - ], - "returns": { - "type": "List", - "description": "List of active shard channels matching the pattern" + "type": "String", + "description": "Status response" } } ], "go-redis": [ { - "signature": "PubSubShardChannels(ctx context.Context, pattern string)", + "signature": "ScriptKill(ctx context.Context)", "params": [ { "name": "ctx", "type": "context.Context", "description": "Context for the operation" - }, - { - "name": "pattern", - "type": "string", - "description": "Pattern to match shard channel names" } ], "returns": { - "type": "*StringSliceCmd", - "description": "List of active shard channels matching the pattern" + "type": "*StatusCmd", + "description": "Status response" + } + } + ], + "node_redis": [ + { + "signature": "scriptKill()", + "params": [], + "returns": { + "type": "Promise>", + "description": "Status response" + } + } + ], + "lettuce_sync": [ + { + "signature": "String scriptKill()", + "params": [], + "returns": { + "type": "String", + "description": "Status response" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture scriptKill()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "Status response" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono scriptKill()", + "params": [], + "returns": { + "type": "Mono", + "description": "Status response" } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], "ioredis": [], "redis_rs_sync": [], "redis_rs_async": [], @@ -92691,69 +100310,64 @@ "nredisstack_async": [], "php": [ { - "signature": "pubsub($subcommand, $argument)", + "signature": "script($subcommand, $argument = null)", "params": [ { "name": "$subcommand", "type": "string", - "description": "PUBSUB subcommand (e.g., 'SHARDCHANNELS')" + "description": "SCRIPT subcommand (e.g., 'KILL')" }, { "name": "$argument", "type": "mixed", - "description": "Pattern to match shard channel names" + "description": "Optional argument for the subcommand" } ], "returns": { "type": "mixed", - "description": "List of active shard channels matching the pattern" + "description": "Command result" } } ] } }, - "PUBSUB SHARDNUMSUB": { + "SCRIPT LOAD": { "api_calls": { "redis_py": [ { - "signature": "pubsub_shardnumsub(*args: ChannelT, **kwargs)", + "signature": "script_load(script: ScriptTextT)", "params": [ { - "name": "*args", - "type": "ChannelT", - "description": "Shard channel names to get subscriber counts for" - }, - { - "name": "**kwargs", - "type": "Any", - "description": "Additional keyword arguments" + "name": "script", + "type": "ScriptTextT", + "description": "Lua script to load" } ], "returns": { "type": "ResponseT", - "description": "Map of shard channel names to subscriber counts" + "description": "SHA1 digest of the script" } } ], "jedis": [ { - "signature": "Map pubsubShardNumSub(String... channels)", + "signature": "String scriptLoad(final String script)", "params": [ { - "name": "channels", - "type": "String...", - "description": "Shard channel names to get subscriber counts for" + "name": "script", + "type": "String", + "description": "Lua script to load" } ], "returns": { - "type": "Map", - "description": "Map of shard channel names to subscriber counts" + "type": "String", + "description": "SHA1 digest of the script" } } ], "go-redis": [ { - "signature": "PubSubShardNumSub(ctx context.Context, channels ...string)", + "signature": "ScriptLoad(ctx context.Context, script string)", "params": [ { "name": "ctx", @@ -92761,644 +100375,593 @@ "description": "Context for the operation" }, { - "name": "channels", - "type": "...string", - "description": "Shard channel names to get subscriber counts for" + "name": "script", + "type": "string", + "description": "Lua script to load" } ], "returns": { - "type": "*MapStringIntCmd", - "description": "Map of shard channel names to subscriber counts" + "type": "*StringCmd", + "description": "SHA1 digest of the script" } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], - "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + "node_redis": [ { - "signature": "pubsub($subcommand, $argument)", + "signature": "scriptLoad(script: RedisArgument)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "PUBSUB subcommand (e.g., 'SHARDNUMSUB')" - }, - { - "name": "$argument", - "type": "mixed", - "description": "Shard channel names to get subscriber counts for" + "name": "script", + "type": "RedisArgument", + "description": "Lua script to load" } ], "returns": { - "type": "mixed", - "description": "Map of shard channel names to subscriber counts" + "type": "Promise", + "description": "SHA1 digest of the script" } } - ] - } - }, - "PUNSUBSCRIBE": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], - "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rb": [ + ], + "lettuce_sync": [ { - "signature": "punsubscribe(*channels)", + "signature": "String scriptLoad(String script)", "params": [ { - "name": "*channels", - "type": "Array", - "description": "" + "name": "script", + "type": "String", + "description": "Lua script" } ], "returns": { - "type": "nil", - "description": "" + "type": "String", + "description": "SHA1 digest of the script" } - } - ] - } - }, - "QUIT": { - "api_calls": { - "redis_py": [ + }, { - "signature": "quit(**kwargs)", + "signature": "String scriptLoad(byte[] script)", "params": [ { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "script", + "type": "byte[]", + "description": "Lua script" } ], "returns": { - "type": "ResponseT", - "description": "" + "type": "String", + "description": "SHA1 digest of the script" } } ], - "jedis": [ + "lettuce_async": [ { - "signature": "String quit()", - "params": [], + "signature": "RedisFuture scriptLoad(String script)", + "params": [ + { + "name": "script", + "type": "String", + "description": "Lua script" + } + ], "returns": { - "type": "String", - "description": "OK" + "type": "RedisFuture", + "description": "SHA1 digest of the script" } - } - ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "RANDOMKEY": { - "api_calls": { - "redis_py": [ + }, { - "signature": "randomkey()", - "params": [], + "signature": "RedisFuture scriptLoad(byte[] script)", + "params": [ + { + "name": "script", + "type": "byte[]", + "description": "Lua script" + } + ], "returns": { - "type": "str", - "description": "" + "type": "RedisFuture", + "description": "SHA1 digest of the script" } } ], - "jedis": [ + "lettuce_reactive": [ { - "signature": "byte[] randomBinaryKey()", - "params": [], + "signature": "Mono scriptLoad(String script)", + "params": [ + { + "name": "script", + "type": "String", + "description": "Lua script" + } + ], "returns": { - "type": "byte[]", - "description": "the random key, or null when the database is empty." + "type": "Mono", + "description": "SHA1 digest of the script" } }, { - "signature": "String randomKey()", - "params": [], + "signature": "Mono scriptLoad(byte[] script)", + "params": [ + { + "name": "script", + "type": "byte[]", + "description": "Lua script" + } + ], "returns": { - "type": "String", - "description": "the random key, or null when the database is empty." + "type": "Mono", + "description": "SHA1 digest of the script" } } ], - "go-redis": [ + "ioredis": [], + "redis_rs_sync": [], + "redis_rs_async": [], + "redisvl": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ { - "signature": "RandomKey(ctx context.Context)", + "signature": "script($subcommand, $argument = null)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" + "name": "$subcommand", + "type": "string", + "description": "SCRIPT subcommand (e.g., 'LOAD')" + }, + { + "name": "$argument", + "type": "mixed", + "description": "Optional argument for the subcommand" } ], "returns": { - "type": "*StringCmd", - "description": "" + "type": "mixed", + "description": "Command result" } } - ], - "node_redis": [ + ] + } + }, + "SDIFF": { + "api_calls": { + "redis_py": [ { - "signature": "RANDOMKEY()", - "params": [], + "signature": "sdiff(keys: List, *args: List)", + "params": [ + { + "name": "keys", + "type": "List", + "description": "" + }, + { + "name": "*args", + "type": "List", + "description": "" + } + ], "returns": { - "type": "Any", + "type": "Union[Awaitable[list], list]", "description": "" } } ], - "lettuce_sync": [ - { - "signature": "K randomkey()", - "params": [], - "returns": { - "type": "K", - "description": "K bulk-string-reply the random key, or null when the database is empty." - } - } - ], - "lettuce_async": [ + "jedis": [ { - "signature": "RedisFuture randomkey()", - "params": [], + "signature": "Set sdiff(final String... keys)", + "params": [ + { + "name": "keys", + "type": "String...", + "description": "" + } + ], "returns": { - "type": "RedisFuture", - "description": "K bulk-string-reply the random key, or null when the database is empty." + "type": "Set", + "description": "A set with members of the resulting set" } } ], - "lettuce_reactive": [ + "lettuce_sync": [ { - "signature": "Mono randomkey()", - "params": [], + "signature": "Set sdiff(K... keys)", + "params": [ + { + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], "returns": { - "type": "Mono", - "description": "K bulk-string-reply the random key, or null when the database is empty." + "type": "Set", + "description": "Long count of members of the resulting set." } - } - ], - "nredisstack_sync": [ + }, { - "signature": "KeyRandom(CommandFlags flags = CommandFlags.None)", + "signature": "Long sdiff(ValueStreamingChannel channel, K... keys)", "params": [ { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "channel", + "type": "ValueStreamingChannel", + "description": "the channel." + }, + { + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "RedisKey", - "description": "The random key, or null when the database is empty." + "type": "Long", + "description": "Long count of members of the resulting set." } } ], - "nredisstack_async": [ + "lettuce_async": [ { - "signature": "KeyRandomAsync(CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture> sdiff(K... keys)", "params": [ { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "Task", - "description": "The random key, or null when the database is empty." + "type": "RedisFuture>", + "description": "Long count of members of the resulting set." } - } - ], - "php": [ + }, { - "signature": "randomKey()", - "params": [], + "signature": "RedisFuture sdiff(ValueStreamingChannel channel, K... keys)", + "params": [ + { + "name": "channel", + "type": "ValueStreamingChannel", + "description": "the channel." + }, + { + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], "returns": { - "type": "string", - "description": "" + "type": "RedisFuture", + "description": "Long count of members of the resulting set." } } ], - "redis_rb": [ - { - "signature": "randomkey", - "params": [], - "returns": { - "type": "String", - "description": "" - } - } - ] - } - }, - "READONLY": { - "api_calls": { - "redis_py": [ + "lettuce_reactive": [ { - "signature": "readonly(**kwargs)", + "signature": "Flux sdiff(K... keys)", "params": [ { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "ResponseT", - "description": "" + "type": "Flux", + "description": "Long count of members of the resulting set. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #sdiff." } - } - ], - "jedis": [ + }, { - "signature": "String readonly()", - "params": [], + "signature": "Mono sdiff(ValueStreamingChannel channel, K... keys)", + "params": [ + { + "name": "channel", + "type": "ValueStreamingChannel", + "description": "the channel." + }, + { + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], "returns": { - "type": "String", - "description": "OK" + "type": "Mono", + "description": "Long count of members of the resulting set. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #sdiff." } } ], "go-redis": [ { - "signature": "ReadOnly(ctx context.Context)", + "signature": "SDiff(ctx context.Context, keys ...string)", "params": [ { "name": "ctx", "type": "context.Context", "description": "" + }, + { + "name": "keys", + "type": "...string", + "description": "" } ], "returns": { - "type": "*StatusCmd", + "type": "*StringSliceCmd", "description": "" } } ], "node_redis": [ { - "signature": "parseCommand(parser: CommandParser)", + "signature": "SDIFF(keys: RedisVariadicArgument)", "params": [ { - "name": "parser", - "type": "CommandParser", - "description": "The command parser" + "name": "keys", + "type": "RedisVariadicArgument", + "description": "" } ], "returns": { - "type": "SimpleStringReply", + "type": "Any", "description": "" } } ], - "lettuce_sync": [ - { - "signature": "String readOnly()", - "params": [], - "returns": { - "type": "String", - "description": "OK" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture readOnly()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "OK" - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono readOnly()", - "params": [], - "returns": { - "type": "Mono", - "description": "OK" - } - } - ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "READWRITE": { - "api_calls": { - "redis_py": [ + "ioredis": [ { - "signature": "readwrite(**kwargs)", + "signature": "sdiff(...args: [...keys: RedisKey[], callback: Callback])", "params": [ { - "name": "**kwargs", - "type": "Any", + "name": "...args", + "type": "[...keys", "description": "" } ], "returns": { - "type": "ResponseT", + "type": "Any", "description": "" } - } - ], - "jedis": [ - { - "signature": "String readwrite()", - "params": [], - "returns": { - "type": "String", - "description": "OK" - } - } - ], - "go-redis": [ + }, { - "signature": "ReadWrite(ctx context.Context)", + "signature": "sdiff(...args: [keys: RedisKey[], callback: Callback])", "params": [ { - "name": "ctx", - "type": "context.Context", + "name": "...args", + "type": "[keys", "description": "" } ], "returns": { - "type": "*StatusCmd", + "type": "Any", "description": "" } - } - ], - "node_redis": [ + }, { - "signature": "parseCommand(parser: CommandParser)", + "signature": "sdiff(...args: [...keys: RedisKey[]]): Result;, sdiffBuffer(...args: [...keys: RedisKey[]]): Result;, sdiff(...args: [keys: RedisKey[]]): Result;, sdiffBuffer(...args: [keys: RedisKey[]]): Result;, /**, * Subtract multiple sets and store the resulting set in a key, * - _group_: set, * - _complexity_: O(N) where N is the total number of elements in all given sets., * - _since_: 1.0.0, */, sdiffstore(, ...args: [, destination: RedisKey, ...keys: RedisKey[], callback: Callback, ])", "params": [ { - "name": "parser", - "type": "CommandParser", - "description": "The command parser" + "name": "...args", + "type": "[...keys", + "description": "" + }, + { + "name": "...args", + "type": "[, destination", + "description": "" } ], "returns": { - "type": "SimpleStringReply", + "type": "Any", "description": "" } } ], - "lettuce_sync": [ - { - "signature": "String readWrite()", - "params": [], - "returns": { - "type": "String", - "description": "OK" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture readWrite()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "OK" - } - } - ], - "lettuce_reactive": [ + "redis_rs_sync": [ { - "signature": "Mono readWrite()", - "params": [], + "signature": "sdiff(keys: K)", + "params": [ + { + "name": "keys", + "type": "K", + "description": "" + } + ], "returns": { - "type": "Mono", - "description": "OK" + "type": "(HashSet)", + "description": "" } } ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "RENAME": { - "api_calls": { - "redis_py": [ + "redis_rs_async": [ { - "signature": "rename(src: KeyT, dst: KeyT)", + "signature": "sdiff(keys: K)", "params": [ { - "name": "src", - "type": "KeyT", - "description": "" - }, - { - "name": "dst", - "type": "KeyT", + "name": "keys", + "type": "K", "description": "" } ], "returns": { - "type": "str", + "type": "(HashSet)", "description": "" } } ], - "jedis": [ + "nredisstack_sync": [ { - "signature": "String rename(final byte[] oldkey, final byte[] newkey)", + "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "oldkey", - "type": "byte[]", + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." + }, + { + "name": "first", + "type": "RedisKey", "description": "" }, { - "name": "newkey", - "type": "byte[]", + "name": "second", + "type": "RedisKey", "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "String", - "description": "Status code reply" + "type": "RedisValue[]", + "description": "List with members of the resulting set." } }, { - "signature": "String rename(final String oldkey, final String newkey)", + "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "oldkey", - "type": "String", - "description": "" + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "newkey", - "type": "String", - "description": "" + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "String", - "description": "Status code reply" + "type": "RedisValue[]", + "description": "List with members of the resulting set." } - } - ], - "go-redis": [ + }, { - "signature": "Rename(ctx context.Context, key, newkey string)", + "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "key", - "type": "string", + "name": "first", + "type": "RedisKey", "description": "" }, { - "name": "newkey", - "type": "string", + "name": "second", + "type": "RedisKey", "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "*StatusCmd", - "description": "" + "type": "RedisValue[]", + "description": "List with members of the resulting set." } - } - ], - "node_redis": [ + }, { - "signature": "RENAME(key: RedisArgument, newKey: RedisArgument)", + "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "RedisArgument", - "description": "" + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "newKey", - "type": "RedisArgument", - "description": "" + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Any", - "description": "" + "type": "RedisValue[]", + "description": "List with members of the resulting set." } } ], - "lettuce_sync": [ + "nredisstack_async": [ { - "signature": "String rename(K key, K newKey)", + "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "newKey", - "type": "K", - "description": "the newkey." - } - ], - "returns": { - "type": "String", - "description": "String simple-string-reply" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture rename(K key, K newKey)", - "params": [ + "name": "first", + "type": "RedisKey", + "description": "" + }, { - "name": "key", - "type": "K", - "description": "the key." + "name": "second", + "type": "RedisKey", + "description": "" }, { - "name": "newKey", - "type": "K", - "description": "the newkey." + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "RedisFuture", - "description": "String simple-string-reply" + "type": "RedisValue[]", + "description": "List with members of the resulting set." } - } - ], - "lettuce_reactive": [ + }, { - "signature": "Mono rename(K key, K newKey)", + "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "newKey", - "type": "K", - "description": "the newkey." + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Mono", - "description": "String simple-string-reply" + "type": "RedisValue[]", + "description": "List with members of the resulting set." } - } - ], - "nredisstack_sync": [ + }, { - "signature": "KeyRename(RedisKey key, RedisKey newKey, CommandFlags flags = CommandFlags.None)", + "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." + }, + { + "name": "first", "type": "RedisKey", - "description": "The key to rename." + "description": "" }, { - "name": "newKey", + "name": "second", "type": "RedisKey", - "description": "The new key name." + "description": "" }, { "name": "flags", @@ -93407,24 +100970,22 @@ } ], "returns": { - "type": "bool", - "description": "true if the key was renamed, false otherwise." + "type": "RedisValue[]", + "description": "List with members of the resulting set." } - } - ], - "nredisstack_async": [ + }, { - "signature": "KeyRenameAsync(RedisKey key, RedisKey newKey, CommandFlags flags = CommandFlags.None)", + "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The key to rename." + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "newKey", - "type": "RedisKey", - "description": "The new key name." + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." }, { "name": "flags", @@ -93433,121 +100994,179 @@ } ], "returns": { - "type": "Task", - "description": "true if the key was renamed, false otherwise." + "type": "RedisValue[]", + "description": "List with members of the resulting set." } } ], "php": [ { - "signature": "rename(string $srcKey, string $dstKey)", + "signature": "sdiff(array|string $keys)", "params": [ { - "name": "$srcKey", - "type": "string", - "description": "" - }, - { - "name": "$dstKey", - "type": "string", + "name": "$keys", + "type": "array|string", "description": "" } ], "returns": { - "type": "bool", + "type": "string[]", "description": "" } } ], "redis_rb": [ { - "signature": "rename(old_name, new_name)", + "signature": "sdiff(*keys)", "params": [ { - "name": "old_name", - "type": "String", - "description": "" - }, - { - "name": "new_name", - "type": "String", - "description": "" + "name": "*keys", + "type": "String, Array", + "description": "keys pointing to sets to subtract" } ], "returns": { - "type": "String", - "description": "\"OK\"" + "type": "Array", + "description": "members in the difference" } } ] } }, - "RENAMENX": { + "SDIFFSTORE": { "api_calls": { "redis_py": [ { - "signature": "renamenx(src: KeyT, dst: KeyT)", + "signature": "sdiffstore(dest: str, keys: List, *args: List)", "params": [ { - "name": "src", - "type": "KeyT", + "name": "dest", + "type": "str", "description": "" }, { - "name": "dst", - "type": "KeyT", + "name": "keys", + "type": "List", + "description": "" + }, + { + "name": "*args", + "type": "List", "description": "" } ], "returns": { - "type": "int", + "type": "Union[Awaitable[int], int]", "description": "" } } ], "jedis": [ { - "signature": "long renamenx(final byte[] oldkey, final byte[] newkey)", + "signature": "long sdiffstore(final byte[] dstkey, final byte[]... keys)", "params": [ { - "name": "oldkey", + "name": "dstkey", "type": "byte[]", "description": "" }, { - "name": "newkey", - "type": "byte[]", + "name": "keys", + "type": "byte[]...", "description": "" } ], "returns": { "type": "long", - "description": "1 if key was renamed to newkey, 0 if newkey already exists" + "description": "The number of elements in the resulting set" } }, { - "signature": "long renamenx(final String oldkey, final String newkey)", + "signature": "long sdiffstore(final String dstkey, final String... keys)", "params": [ { - "name": "oldkey", + "name": "dstkey", "type": "String", "description": "" }, { - "name": "newkey", - "type": "String", + "name": "keys", + "type": "String...", "description": "" } ], "returns": { "type": "long", - "description": "1 if key was renamed to newkey, 0 if newkey already exists" + "description": "The number of elements in the resulting set" + } + } + ], + "lettuce_sync": [ + { + "signature": "Long sdiffstore(K destination, K... keys)", + "params": [ + { + "name": "destination", + "type": "K", + "description": "the destination type: key." + }, + { + "name": "keys", + "type": "K...", + "description": "the key." + } + ], + "returns": { + "type": "Long", + "description": "Long integer-reply the number of elements in the resulting set." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture sdiffstore(K destination, K... keys)", + "params": [ + { + "name": "destination", + "type": "K", + "description": "the destination type: key." + }, + { + "name": "keys", + "type": "K...", + "description": "the key." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Long integer-reply the number of elements in the resulting set." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono sdiffstore(K destination, K... keys)", + "params": [ + { + "name": "destination", + "type": "K", + "description": "the destination type: key." + }, + { + "name": "keys", + "type": "K...", + "description": "the key." + } + ], + "returns": { + "type": "Mono", + "description": "Long integer-reply the number of elements in the resulting set." } } ], "go-redis": [ { - "signature": "RenameNX(ctx context.Context, key, newkey string)", + "signature": "SDiffStore(ctx context.Context, destination string, keys ...string)", "params": [ { "name": "ctx", @@ -93555,34 +101174,34 @@ "description": "" }, { - "name": "key", + "name": "destination", "type": "string", "description": "" }, { - "name": "newkey", - "type": "string", + "name": "keys", + "type": "...string", "description": "" } ], "returns": { - "type": "*BoolCmd", + "type": "*IntCmd", "description": "" } } ], "node_redis": [ { - "signature": "RENAMENX(key: RedisArgument, newKey: RedisArgument)", + "signature": "SDIFFSTORE(destination: RedisArgument, keys: RedisVariadicArgument)", "params": [ { - "name": "key", + "name": "destination", "type": "RedisArgument", "description": "" }, { - "name": "newKey", - "type": "RedisArgument", + "name": "keys", + "type": "RedisVariadicArgument", "description": "" } ], @@ -93592,87 +101211,115 @@ } } ], - "lettuce_sync": [ + "ioredis": [ { - "signature": "Boolean renamenx(K key, K newKey)", + "signature": "sdiffstore(...args: [, destination: RedisKey, keys: RedisKey[], callback: Callback, ])", "params": [ { - "name": "key", - "type": "K", - "description": "the key." - }, + "name": "...args", + "type": "[, destination", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "sdiffstore(...args: [destination: RedisKey, ...keys: RedisKey[]])", + "params": [ { - "name": "newKey", - "type": "K", - "description": "the newkey." + "name": "...args", + "type": "[destination", + "description": "" } ], "returns": { - "type": "Boolean", - "description": "Boolean integer-reply specifically: true if key was renamed to newkey. false if newkey already exists." + "type": "Any", + "description": "" + } + }, + { + "signature": "sdiffstore(...args: [destination: RedisKey, keys: RedisKey[]])", + "params": [ + { + "name": "...args", + "type": "[destination", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" } } ], - "lettuce_async": [ + "redis_rs_sync": [ { - "signature": "RedisFuture renamenx(K key, K newKey)", + "signature": "sdiffstore(dstkey: D, keys: K)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." + "name": "dstkey", + "type": "D", + "description": "" }, { - "name": "newKey", + "name": "keys", "type": "K", - "description": "the newkey." + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Boolean integer-reply specifically: true if key was renamed to newkey. false if newkey already exists." + "type": "(usize)", + "description": "" } } ], - "lettuce_reactive": [ + "redis_rs_async": [ { - "signature": "Mono renamenx(K key, K newKey)", + "signature": "sdiffstore(dstkey: D, keys: K)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." + "name": "dstkey", + "type": "D", + "description": "" }, { - "name": "newKey", + "name": "keys", "type": "K", - "description": "the newkey." + "description": "" } ], "returns": { - "type": "Mono", - "description": "Boolean integer-reply specifically: true if key was renamed to newkey. false if newkey already exists." + "type": "(usize)", + "description": "" } } ], "nredisstack_sync": [ { - "signature": "KeyRename(RedisKey key, RedisKey newKey, When when, CommandFlags flags = CommandFlags.None)", + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." + }, + { + "name": "destination", "type": "RedisKey", - "description": "The key to rename." + "description": "The key of the destination set." }, { - "name": "newKey", + "name": "first", "type": "RedisKey", - "description": "The new key name." + "description": "" }, { - "name": "when", - "type": "When", - "description": "Which condition to use for the rename (NotExists for RENAMENX)." + "name": "second", + "type": "RedisKey", + "description": "" }, { "name": "flags", @@ -93681,29 +101328,27 @@ } ], "returns": { - "type": "bool", - "description": "true if key was renamed to newkey. false if newkey already exists." + "type": "long", + "description": "The number of elements in the resulting set." } - } - ], - "nredisstack_async": [ + }, { - "signature": "KeyRenameAsync(RedisKey key, RedisKey newKey, When when, CommandFlags flags = CommandFlags.None)", + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The key to rename." + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "newKey", + "name": "destination", "type": "RedisKey", - "description": "The new key name." + "description": "The key of the destination set." }, { - "name": "when", - "type": "When", - "description": "Which condition to use for the rename (NotExists for RENAMENX)." + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." }, { "name": "flags", @@ -93712,747 +101357,525 @@ } ], "returns": { - "type": "Task", - "description": "true if key was renamed to newkey. false if newkey already exists." + "type": "long", + "description": "The number of elements in the resulting set." } - } - ], - "php": [ + }, { - "signature": "renameNx(string $srcKey, string $dstKey)", + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "$srcKey", - "type": "string", - "description": "" + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "$dstKey", - "type": "string", - "description": "" - } - ], - "returns": { - "type": "int", - "description": "" - } - } - ], - "redis_rb": [ - { - "signature": "renamenx(old_name, new_name)", - "params": [ + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination set." + }, { - "name": "old_name", - "type": "String", + "name": "first", + "type": "RedisKey", "description": "" }, { - "name": "new_name", - "type": "String", + "name": "second", + "type": "RedisKey", "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Boolean", - "description": "whether the key was renamed or not" + "type": "long", + "description": "The number of elements in the resulting set." } - } - ] - } - }, - "REPLCONF": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "REPLICAOF": { - "api_calls": { - "redis_py": [ + }, { - "signature": "replicaof(host: str | None = None, port: int | str | None = None, **kwargs)", + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "host", - "type": "str | None", - "description": "" + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "port", - "type": "int | str | None", - "description": "" + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination set." }, { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "str", - "description": "" + "type": "long", + "description": "The number of elements in the resulting set." } } ], - "jedis": [ + "nredisstack_async": [ { - "signature": "String replicaof(String host, int port)", + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "host", - "type": "String", + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." + }, + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination set." + }, + { + "name": "first", + "type": "RedisKey", "description": "" }, { - "name": "port", - "type": "int", + "name": "second", + "type": "RedisKey", "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "String", - "description": "" + "type": "long", + "description": "The number of elements in the resulting set." } }, { - "signature": "String replicaofNoOne()", - "params": [], - "returns": { - "type": "String", - "description": "" - } - } - ], - "go-redis": [ - { - "signature": "ReplicaOf(ctx context.Context, host, port string) *StatusCmd", + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "host", - "type": "string", - "description": "" + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination set." }, { - "name": "port", - "type": "string", - "description": "" - } - ], - "returns": { - "type": "*StatusCmd", - "description": "" - } - } - ], - "node_redis": [], - "lettuce_sync": [ - { - "signature": "String replicaof(String host, int port)", - "params": [ - { - "name": "host", - "type": "String", - "description": "" + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." }, { - "name": "port", - "type": "int", - "description": "" + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "String", - "description": "" + "type": "long", + "description": "The number of elements in the resulting set." } }, { - "signature": "String replicaofNoOne()", - "params": [], - "returns": { - "type": "String", - "description": "" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture replicaof(String host, int port)", + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "host", - "type": "String", + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." + }, + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination set." + }, + { + "name": "first", + "type": "RedisKey", "description": "" }, { - "name": "port", - "type": "int", + "name": "second", + "type": "RedisKey", "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "RedisFuture", - "description": "" + "type": "long", + "description": "The number of elements in the resulting set." } }, { - "signature": "RedisFuture replicaofNoOne()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "" - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono replicaof(String host, int port)", + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "host", - "type": "String", - "description": "" + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "port", - "type": "int", - "description": "" + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination set." + }, + { + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Mono", - "description": "" - } - }, - { - "signature": "Mono replicaofNoOne()", - "params": [], - "returns": { - "type": "Mono", - "description": "" + "type": "long", + "description": "The number of elements in the resulting set." } } ], - "nredisstack_sync": [], - "nredisstack_async": [], "php": [ { - "signature": "replicaof(string $host, int $port)", + "signature": "sdiffstore(string $destination, array|string $keys)", "params": [ { - "name": "$host", + "name": "$destination", "type": "string", "description": "" }, { - "name": "$port", - "type": "int", + "name": "$keys", + "type": "array|string", "description": "" } ], "returns": { - "type": "string", + "type": "int", "description": "" } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "RESET": { - "api_calls": { - "redis_py": [ + "redis_rb": [ { - "signature": "reset(**kwargs)", + "signature": "sdiffstore(destination, *keys)", "params": [ { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "destination", + "type": "String", + "description": "destination key" + }, + { + "name": "*keys", + "type": "String, Array", + "description": "keys pointing to sets to subtract" } ], "returns": { - "type": "ResponseT", - "description": "" + "type": "Integer", + "description": "number of elements in the resulting set" } } - ], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "RESTORE-ASKING": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], - "redis_rs_sync": [], - "redis_rs_async": [] + ] } }, - "RESTORE": { + "SELECT": { "api_calls": { "redis_py": [ { - "signature": "restore(name: KeyT, ttl: int, value: bytes, replace: bool = False, absttl: bool = False, idletime: Optional[int] = None, frequency: Optional[int] = None)", + "signature": "select(index: int, **kwargs)", "params": [ { - "name": "name", - "type": "KeyT", - "description": "" - }, - { - "name": "ttl", + "name": "index", "type": "int", - "description": "" - }, - { - "name": "value", - "type": "bytes", - "description": "" - }, - { - "name": "replace", - "type": "bool", - "description": "" - }, - { - "name": "absttl", - "type": "bool", - "description": "" - }, - { - "name": "idletime", - "type": "Optional[int]", - "description": "" + "description": "The database index" }, { - "name": "frequency", - "type": "Optional[int]", + "name": "**kwargs", + "type": "Any", "description": "" } ], "returns": { - "type": "str", + "type": "ResponseT", "description": "" } } ], "jedis": [ { - "signature": "String restore(final byte[] key, final long ttl, final byte[] serializedValue)", - "params": [ - { - "name": "key", - "type": "byte[]", - "description": "" - }, - { - "name": "ttl", - "type": "long", - "description": "time to live" - }, - { - "name": "serializedValue", - "type": "byte[]", - "description": "" - } - ], - "returns": { - "type": "String", - "description": "Status code reply" - } - }, - { - "signature": "String restore(final byte[] key, final long ttl, final byte[] serializedValue, final RestoreParams params)", + "signature": "String select(final int index)", "params": [ { - "name": "key", - "type": "byte[]", - "description": "" - }, - { - "name": "ttl", - "type": "long", - "description": "time to live" - }, - { - "name": "serializedValue", - "type": "byte[]", - "description": "" - }, - { - "name": "params", - "type": "RestoreParams", - "description": "" + "name": "index", + "type": "int", + "description": "The database index" } ], "returns": { "type": "String", - "description": "Status code reply" + "description": "OK" } - }, + } + ], + "go-redis": [ { - "signature": "String restore(final String key, final long ttl, final byte[] serializedValue)", + "signature": "Select(ctx context.Context, index int) *StatusCmd", "params": [ { - "name": "key", - "type": "String", - "description": "" - }, - { - "name": "ttl", - "type": "long", - "description": "time to live" + "name": "ctx", + "type": "context.Context", + "description": "Context" }, { - "name": "serializedValue", - "type": "byte[]", - "description": "" + "name": "index", + "type": "int", + "description": "Database index" } ], "returns": { - "type": "String", - "description": "Status code reply" + "type": "*StatusCmd", + "description": "" } - }, + } + ], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ { - "signature": "String restore(final String key, final long ttl, final byte[] serializedValue, final RestoreParams params)", + "signature": "select(int $database)", "params": [ { - "name": "key", - "type": "String", - "description": "" - }, - { - "name": "ttl", - "type": "long", - "description": "time to live" - }, - { - "name": "serializedValue", - "type": "byte[]", - "description": "" - }, - { - "name": "params", - "type": "RestoreParams", - "description": "" + "name": "$database", + "type": "int", + "description": "Database index" } ], "returns": { - "type": "String", - "description": "Status code reply" + "type": "mixed", + "description": "" } } ], - "go-redis": [ + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "SET": { + "api_calls": { + "redis_py": [ { - "signature": "Restore(ctx context.Context, key string, ttl time.Duration, value string)", + "signature": "set(, name: KeyT,, value: EncodableT,, ex: Optional[ExpiryT] = None,, px: Optional[ExpiryT] = None,, nx: bool = False,, xx: bool = False,, keepttl: bool = False,, get: bool = False,, exat: Optional[AbsExpiryT] = None,, pxat: Optional[AbsExpiryT] = None,, ifeq: Optional[Union[bytes, str]] = None,, ifne: Optional[Union[bytes, str]] = None,, ifdeq: Optional[str] = None,, ifdne: Optional[str] = None,)", "params": [ { - "name": "ctx", - "type": "context.Context", + "name": "name", + "type": "KeyT", "description": "" }, { - "name": "key", - "type": "string", + "name": "value", + "type": "EncodableT", "description": "" }, { - "name": "ttl", - "type": "time.Duration", + "name": "ex", + "type": "Optional[ExpiryT] = None", "description": "" }, { - "name": "value", - "type": "string", + "name": "px", + "type": "Optional[ExpiryT] = None", "description": "" - } - ], - "returns": { - "type": "*StatusCmd", - "description": "" - } - }, - { - "signature": "RestoreReplace(ctx context.Context, key string, ttl time.Duration, value string)", - "params": [ + }, { - "name": "ctx", - "type": "context.Context", + "name": "nx", + "type": "bool = False", "description": "" }, { - "name": "key", - "type": "string", + "name": "xx", + "type": "bool = False", "description": "" }, { - "name": "ttl", - "type": "time.Duration", + "name": "keepttl", + "type": "bool = False", "description": "" }, { - "name": "value", - "type": "string", + "name": "get", + "type": "bool = False", "description": "" - } - ], - "returns": { - "type": "*StatusCmd", - "description": "" - } - } - ], - "node_redis": [ - { - "signature": "RESTORE(key: RedisArgument, ttl: number, serializedValue: RedisArgument, options?: RestoreOptions)", - "params": [ + }, { - "name": "key", - "type": "RedisArgument", + "name": "exat", + "type": "Optional[AbsExpiryT] = None", "description": "" }, { - "name": "ttl", - "type": "number", + "name": "pxat", + "type": "Optional[AbsExpiryT] = None", "description": "" }, { - "name": "serializedValue", - "type": "RedisArgument", + "name": "ifeq", + "type": "Optional[Union[bytes, str]] = None", "description": "" }, { - "name": "options?", - "type": "RestoreOptions", + "name": "ifne", + "type": "Optional[Union[bytes, str]] = None", + "description": "" + }, + { + "name": "ifdeq", + "type": "Optional[str] = None", + "description": "" + }, + { + "name": "ifdne", + "type": "Optional[str] = None", "description": "" } ], "returns": { - "type": "Any", + "type": "ResponseT", "description": "" } } ], - "lettuce_sync": [ + "jedis": [ { - "signature": "String restore(K key, byte[] value)", + "signature": "String set(final byte[] key, final byte[] value)", "params": [ { "name": "key", - "type": "K", - "description": "the key." - }, - { - "name": "value", "type": "byte[]", - "description": "the value." - } - ], - "returns": { - "type": "String", - "description": "String simple-string-reply The command returns OK on success." - } - }, - { - "signature": "String restore(K key, long ttl, byte[] value)", - "params": [ - { - "name": "key", - "type": "K", - "description": "the key." - }, - { - "name": "ttl", - "type": "long", - "description": "the ttl." + "description": "" }, { "name": "value", "type": "byte[]", - "description": "the value." + "description": "" } ], "returns": { "type": "String", - "description": "String simple-string-reply The command returns OK on success." + "description": "simple-string-reply OK if SET was executed correctly, or null if the SET operation was not performed because the user specified the NX or XX option but the condition was not met." } }, { - "signature": "String restore(K key, byte[] value, RestoreArgs args)", + "signature": "String set(final byte[] key, final byte[] value, final SetParams params)", "params": [ { "name": "key", - "type": "K", - "description": "the key." + "type": "byte[]", + "description": "" }, { "name": "value", "type": "byte[]", - "description": "the value." + "description": "" }, { - "name": "args", - "type": "RestoreArgs", - "description": "the restore arguments." + "name": "params", + "type": "SetParams", + "description": "key if it already exists. EX|PX, expire time units: EX = seconds; PX = milliseconds" } ], "returns": { "type": "String", - "description": "String simple-string-reply The command returns OK on success." - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture restore(K key, byte[] value)", - "params": [ - { - "name": "key", - "type": "K", - "description": "the key." - }, - { - "name": "value", - "type": "byte[]", - "description": "the value." - } - ], - "returns": { - "type": "RedisFuture", - "description": "String simple-string-reply The command returns OK on success." + "description": "simple-string-reply OK if SET was executed correctly, or null if the SET operation was not performed because the user specified the NX or XX option but the condition was not met." } }, { - "signature": "RedisFuture restore(K key, long ttl, byte[] value)", + "signature": "String set(final String key, final String value)", "params": [ { "name": "key", - "type": "K", - "description": "the key." - }, - { - "name": "ttl", - "type": "long", - "description": "the ttl." + "type": "String", + "description": "" }, { "name": "value", - "type": "byte[]", - "description": "the value." + "type": "String", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "String simple-string-reply The command returns OK on success." + "type": "String", + "description": "simple-string-reply OK if SET was executed correctly, or null if the SET operation was not performed because the user specified the NX or XX option but the condition was not met." } }, { - "signature": "RedisFuture restore(K key, byte[] value, RestoreArgs args)", + "signature": "String set(final String key, final String value, final SetParams params)", "params": [ { "name": "key", - "type": "K", - "description": "the key." + "type": "String", + "description": "" }, { "name": "value", - "type": "byte[]", - "description": "the value." + "type": "String", + "description": "" }, { - "name": "args", - "type": "RestoreArgs", - "description": "the restore arguments." + "name": "params", + "type": "SetParams", + "description": "key if it already exists. EX|PX, expire time units: EX = seconds; PX = milliseconds" } ], "returns": { - "type": "RedisFuture", - "description": "String simple-string-reply The command returns OK on success." + "type": "String", + "description": "simple-string-reply OK if SET was executed correctly, or null if the SET operation was not performed because the user specified the NX or XX option but the condition was not met." } } ], - "lettuce_reactive": [ - { - "signature": "Mono restore(K key, byte[] value)", - "params": [ - { - "name": "key", - "type": "K", - "description": "the key." - }, - { - "name": "value", - "type": "byte[]", - "description": "the value." - } - ], - "returns": { - "type": "Mono", - "description": "String simple-string-reply The command returns OK on success." - } - }, + "lettuce_sync": [ { - "signature": "Mono restore(K key, long ttl, byte[] value)", + "signature": "String set(K key, V value)", "params": [ { "name": "key", "type": "K", "description": "the key." }, - { - "name": "ttl", - "type": "long", - "description": "the ttl." - }, { "name": "value", - "type": "byte[]", + "type": "V", "description": "the value." } ], "returns": { - "type": "Mono", - "description": "String simple-string-reply The command returns OK on success." + "type": "String", + "description": "String simple-string-reply OK if SET was executed correctly." } }, { - "signature": "Mono restore(K key, byte[] value, RestoreArgs args)", + "signature": "String set(K key, V value, SetArgs setArgs)", "params": [ { "name": "key", @@ -94461,471 +101884,442 @@ }, { "name": "value", - "type": "byte[]", + "type": "V", "description": "the value." }, { - "name": "args", - "type": "RestoreArgs", - "description": "the restore arguments." + "name": "setArgs", + "type": "SetArgs", + "description": "the setArgs." } ], "returns": { - "type": "Mono", - "description": "String simple-string-reply The command returns OK on success." + "type": "String", + "description": "String simple-string-reply OK if SET was executed correctly." } } ], - "nredisstack_sync": [ + "lettuce_async": [ { - "signature": "KeyRestore(RedisKey key, byte[] value, TimeSpan? expiry = null, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture set(K key, V value)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key to restore." + "type": "K", + "description": "the key." }, { "name": "value", - "type": "byte[]", - "description": "The serialized value to restore." - }, - { - "name": "expiry", - "type": "TimeSpan?", - "description": "The expiry to set." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "type": "V", + "description": "the value." } ], "returns": { - "type": "void", - "description": "" + "type": "RedisFuture", + "description": "String simple-string-reply OK if SET was executed correctly." } - } - ], - "nredisstack_async": [ + }, { - "signature": "KeyRestoreAsync(RedisKey key, byte[] value, TimeSpan? expiry = null, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture set(K key, V value, SetArgs setArgs)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key to restore." + "type": "K", + "description": "the key." }, { "name": "value", - "type": "byte[]", - "description": "The serialized value to restore." - }, - { - "name": "expiry", - "type": "TimeSpan?", - "description": "The expiry to set." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "Task", - "description": "" - } - } - ], - "php": [ - { - "signature": "restore(string $key, int $ttl, string $value, array $options = null)", - "params": [ - { - "name": "$key", - "type": "string", - "description": "" - }, - { - "name": "$ttl", - "type": "int", - "description": "" - }, - { - "name": "$value", - "type": "string", - "description": "" + "type": "V", + "description": "the value." }, { - "name": "$options", - "type": "array", - "description": "" + "name": "setArgs", + "type": "SetArgs", + "description": "the setArgs." } ], "returns": { - "type": "bool", - "description": "" + "type": "RedisFuture", + "description": "String simple-string-reply OK if SET was executed correctly." } } ], - "redis_rb": [ + "lettuce_reactive": [ { - "signature": "restore(key, ttl, serialized_value, replace: nil)", + "signature": "Mono set(K key, V value)", "params": [ { "name": "key", - "type": "String", - "description": "" - }, - { - "name": "ttl", - "type": "String", - "description": "" - }, - { - "name": "serialized_value", - "type": "String", - "description": "" - }, - { - "name": "replace", - "type": "Boolean", - "description": "if false, raises an error if key already exists" - } - ], - "returns": { - "type": "String", - "description": "\"OK\"" - } - } - ] - } - }, - "ROLE": { - "api_calls": { - "redis_py": [ - { - "signature": "role(**kwargs)", - "params": [ - { - "name": "**kwargs", - "type": "Any", - "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - } - ], - "jedis": [ - { - "signature": "List role()", - "params": [], - "returns": { - "type": "List", - "description": "" - } - } - ], - "go-redis": [ - { - "signature": "Role(ctx context.Context) *RoleCmd", - "params": [ - { - "name": "ctx", - "type": "context.Context", - "description": "Context" - } - ], - "returns": { - "type": "*RoleCmd", - "description": "" - } - } - ], - "node_redis": [ - { - "signature": "ROLE()", - "params": [], - "returns": { - "type": "RoleReply", - "description": "" - } - } - ], - "lettuce_sync": [ - { - "signature": "List role()", - "params": [], - "returns": { - "type": "List", - "description": "" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture> role()", - "params": [], - "returns": { - "type": "RedisFuture>", - "description": "" - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono> role()", - "params": [], - "returns": { - "type": "Mono>", - "description": "" - } - } - ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ - { - "signature": "role()", - "params": [], + "type": "K", + "description": "the key." + }, + { + "name": "value", + "type": "V", + "description": "the value." + } + ], "returns": { - "type": "array", - "description": "" + "type": "Mono", + "description": "String simple-string-reply OK if SET was executed correctly." } - } - ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "RPOP": { - "api_calls": { - "redis_py": [ + }, { - "signature": "rpop(, name: KeyT,, count: Optional[int] = None,)", + "signature": "Mono set(K key, V value, SetArgs setArgs)", "params": [ { - "name": "name", - "type": "KeyT", - "description": "" + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "count", - "type": "Optional[int] = None", - "description": "" + "name": "value", + "type": "V", + "description": "the value." + }, + { + "name": "setArgs", + "type": "SetArgs", + "description": "the setArgs." } ], "returns": { - "type": "Union[Awaitable[Union[str, List, None]], Union[str, List, None]]", - "description": "" + "type": "Mono", + "description": "String simple-string-reply OK if SET was executed correctly." } } ], - "jedis": [ + "go-redis": [ { - "signature": "String rpop(final String key)", + "signature": "Set(ctx context.Context, key string, value interface{}, expiration time.Duration)", "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, { "name": "key", - "type": "String", + "type": "string", + "description": "" + }, + { + "name": "value", + "type": "interface{}", + "description": "" + }, + { + "name": "expiration", + "type": "time.Duration", "description": "" } ], "returns": { - "type": "String", - "description": "A list of count popped elements, or 'nil' when key does not exist." + "type": "*StatusCmd", + "description": "" } }, { - "signature": "List rpop(final String key, final int count)", + "signature": "SetArgs(ctx context.Context, key string, value interface{}, a SetArgs)", "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, { "name": "key", - "type": "String", + "type": "string", "description": "" }, { - "name": "count", - "type": "int", - "description": "return up to count elements" + "name": "value", + "type": "interface{}", + "description": "" + }, + { + "name": "a", + "type": "SetArgs", + "description": "Mode can be `NX`, `XX`, `IFEQ`, `IFNE`, `IFDEQ`, `IFDNE` or empty. MatchValue is used with IFEQ/IFNE; MatchDigest (a uint64 xxh3 hash) is used with IFDEQ/IFDNE." } ], "returns": { - "type": "List", - "description": "A list of count popped elements, or 'nil' when key does not exist." + "type": "*StatusCmd", + "description": "" } }, { - "signature": "String rpop(String key)", + "signature": "SetIFEQ(ctx context.Context, key string, value interface{}, matchValue interface{}, expiration time.Duration)", "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, { "name": "key", - "type": "String", + "type": "string", + "description": "" + }, + { + "name": "value", + "type": "interface{}", + "description": "" + }, + { + "name": "matchValue", + "type": "interface{}", "description": "" + }, + { + "name": "expiration", + "type": "time.Duration", + "description": "Zero expiration means the key has no expiration time." } ], "returns": { - "type": "String", - "description": "A list of count popped elements, or 'nil' when key does not exist." + "type": "*StatusCmd", + "description": "Returns \"OK\" on success. Returns nil if the operation was aborted due to condition not matching." } }, { - "signature": "List rpop(String key, int count)", + "signature": "SetIFNE(ctx context.Context, key string, value interface{}, matchValue interface{}, expiration time.Duration)", "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, { "name": "key", - "type": "String", + "type": "string", "description": "" }, { - "name": "count", - "type": "int", - "description": "return up to count elements" + "name": "value", + "type": "interface{}", + "description": "" + }, + { + "name": "matchValue", + "type": "interface{}", + "description": "" + }, + { + "name": "expiration", + "type": "time.Duration", + "description": "Zero expiration means the key has no expiration time." } ], "returns": { - "type": "List", - "description": "A list of count popped elements, or 'nil' when key does not exist." + "type": "*StatusCmd", + "description": "Returns \"OK\" on success. Returns nil if the operation was aborted due to condition not matching." } - } - ], - "lettuce_sync": [ + }, { - "signature": "V rpop(K key)", + "signature": "SetIFDEQ(ctx context.Context, key string, value interface{}, matchDigest uint64, expiration time.Duration)", "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, { "name": "key", - "type": "K", - "description": "the key." + "type": "string", + "description": "" + }, + { + "name": "value", + "type": "interface{}", + "description": "" + }, + { + "name": "matchDigest", + "type": "uint64", + "description": "A uint64 xxh3 hash value." + }, + { + "name": "expiration", + "type": "time.Duration", + "description": "Zero expiration means the key has no expiration time." } ], "returns": { - "type": "V", - "description": "List<V> array-reply list of the last count elements, or null when key does not exist. @since 6.1" + "type": "*StatusCmd", + "description": "Returns \"OK\" on success. Returns nil if the operation was aborted due to condition not matching." } }, { - "signature": "List rpop(K key, long count)", + "signature": "SetIFDNE(ctx context.Context, key string, value interface{}, matchDigest uint64, expiration time.Duration)", "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, { "name": "key", - "type": "K", - "description": "the key." + "type": "string", + "description": "" }, { - "name": "count", - "type": "long", - "description": "the number of elements to return." + "name": "value", + "type": "interface{}", + "description": "" + }, + { + "name": "matchDigest", + "type": "uint64", + "description": "A uint64 xxh3 hash value." + }, + { + "name": "expiration", + "type": "time.Duration", + "description": "Zero expiration means the key has no expiration time." } ], "returns": { - "type": "List", - "description": "List<V> array-reply list of the last count elements, or null when key does not exist. @since 6.1" + "type": "*StatusCmd", + "description": "Returns \"OK\" on success. Returns nil if the operation was aborted due to condition not matching." } } ], - "lettuce_async": [ + "node_redis": [ { - "signature": "RedisFuture rpop(K key)", + "signature": "SET(key: RedisArgument, value: RedisArgument | number, options?: SetOptions)", "params": [ { "name": "key", - "type": "K", - "description": "the key." - } - ], - "returns": { - "type": "RedisFuture", - "description": "List<V> array-reply list of the last count elements, or null when key does not exist. @since 6.1" - } - }, - { - "signature": "RedisFuture> rpop(K key, long count)", - "params": [ + "type": "RedisArgument", + "description": "" + }, { - "name": "key", - "type": "K", - "description": "the key." + "name": "value", + "type": "RedisArgument | number", + "description": "" }, { - "name": "count", - "type": "long", - "description": "the number of elements to return." + "name": "options?", + "type": "SetOptions", + "description": "" } ], "returns": { - "type": "RedisFuture>", - "description": "List<V> array-reply list of the last count elements, or null when key does not exist. @since 6.1" + "type": "Any", + "description": "" } } ], - "lettuce_reactive": [ + "ioredis": [ { - "signature": "Mono rpop(K key)", + "signature": "set(key: RedisKey, value: string | Buffer | number, callback?: Callback<\"OK\">)", "params": [ { "name": "key", - "type": "K", - "description": "the key." + "type": "RedisKey", + "description": "" + }, + { + "name": "value", + "type": "string | Buffer | number", + "description": "" + }, + { + "name": "callback?", + "type": "Callback<\"OK\">", + "description": "" } ], "returns": { - "type": "Mono", - "description": "V array-reply list of the last count elements, or null when key does not exist. @since 6.1" + "type": "Any", + "description": "" } }, { - "signature": "Flux rpop(K key, long count)", + "signature": "set(key: RedisKey, value: string | Buffer | number, get: \"GET\", callback?: Callback)", "params": [ { "name": "key", - "type": "K", - "description": "the key." + "type": "RedisKey", + "description": "" }, { - "name": "count", - "type": "long", - "description": "the number of elements to return." + "name": "value", + "type": "string | Buffer | number", + "description": "" + }, + { + "name": "get", + "type": "\"GET\"", + "description": "" + }, + { + "name": "callback?", + "type": "Callback", + "description": "" } ], "returns": { - "type": "Flux", - "description": "V array-reply list of the last count elements, or null when key does not exist. @since 6.1" + "type": "Any", + "description": "" } - } - ], - "go-redis": [ + }, { - "signature": "RPop(ctx context.Context, key string)", + "signature": "set(key: RedisKey, value: string | Buffer | number, nx: \"NX\", callback?: Callback<\"OK\" | null>)", "params": [ { - "name": "ctx", - "type": "context.Context", + "name": "key", + "type": "RedisKey", "description": "" }, { - "name": "key", - "type": "string", + "name": "value", + "type": "string | Buffer | number", + "description": "" + }, + { + "name": "nx", + "type": "\"NX\"", + "description": "" + }, + { + "name": "callback?", + "type": "Callback<\"OK\" | null>", "description": "" } ], "returns": { - "type": "*StringCmd", + "type": "Any", "description": "" } - } - ], - "node_redis": [ + }, { - "signature": "RPOP(key: RedisArgument)", + "signature": "set(key: RedisKey, value: string | Buffer | number, nx: \"NX\", get: \"GET\", callback?: Callback)", "params": [ { "name": "key", - "type": "RedisArgument", + "type": "RedisKey", + "description": "" + }, + { + "name": "value", + "type": "string | Buffer | number", + "description": "" + }, + { + "name": "nx", + "type": "\"NX\"", + "description": "" + }, + { + "name": "get", + "type": "\"GET\"", + "description": "" + }, + { + "name": "callback?", + "type": "Callback", "description": "" } ], @@ -94933,11 +102327,9 @@ "type": "Any", "description": "" } - } - ], - "ioredis": [ + }, { - "signature": "rpop(key: RedisKey, count: number | string, callback?: Callback)", + "signature": "set(key: RedisKey, value: string | Buffer | number, xx: \"XX\", callback?: Callback<\"OK\" | null>)", "params": [ { "name": "key", @@ -94945,13 +102337,18 @@ "description": "" }, { - "name": "count", - "type": "number | string", + "name": "value", + "type": "string | Buffer | number", + "description": "" + }, + { + "name": "xx", + "type": "\"XX\"", "description": "" }, { "name": "callback?", - "type": "Callback", + "type": "Callback<\"OK\" | null>", "description": "" } ], @@ -94963,7 +102360,7 @@ ], "redis_rs_sync": [ { - "signature": "rpop(key: K, count: Option)", + "signature": "set(key: K, value: V)", "params": [ { "name": "key", @@ -94971,20 +102368,18 @@ "description": "" }, { - "name": "count", - "type": "Option)", + "signature": "set_options(key: K, value: V, options: SetOptions)", "params": [ { "name": "key", @@ -94992,93 +102387,120 @@ "description": "" }, { - "name": "count", - "type": "Option)", "description": "" } } ], - "nredisstack_sync": [ + "redis_rs_async": [ { - "signature": "ListRightPop(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "set(key: K, value: V)", "params": [ { "name": "key", - "type": "RedisKey", + "type": "K", "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "value", + "type": "V", + "description": "" } ], "returns": { - "type": "RedisValue", - "description": "A span of contiguous elements from the list, or Null if no non-empty lists are found." + "type": "(())", + "description": "" } }, { - "signature": "ListRightPop(RedisKey key, long count, CommandFlags flags = CommandFlags.None)", + "signature": "set_options(key: K, value: V, options: SetOptions)", "params": [ { "name": "key", - "type": "RedisKey", + "type": "K", "description": "" }, { - "name": "count", - "type": "long", - "description": "The maximum number of elements to pop from the list." + "name": "value", + "type": "V", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "options", + "type": "SetOptions", + "description": "" } ], "returns": { - "type": "RedisValue[]", - "description": "A span of contiguous elements from the list, or Null if no non-empty lists are found." + "type": "(Option)", + "description": "" } - }, + } + ], + "nredisstack_sync": [ { - "signature": "ListRightPop(RedisKey[] keys, long count, CommandFlags flags = CommandFlags.None)", + "signature": "StringSet(RedisKey key, RedisValue value, TimeSpan? expiry, When when)", "params": [ { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys to look through for elements to pop." + "name": "key", + "type": "RedisKey", + "description": "" }, { - "name": "count", - "type": "long", - "description": "The maximum number of elements to pop from the list." + "name": "value", + "type": "RedisValue", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "expiry", + "type": "TimeSpan?", + "description": "The expiry to set." + }, + { + "name": "when", + "type": "When", + "description": "Which condition to set the value under (defaults to always)." } ], "returns": { - "type": "ListPopResult", - "description": "A span of contiguous elements from the list, or Null if no non-empty lists are found." + "type": "bool", + "description": "true if the keys were set, false otherwise." } }, { - "signature": "ListRightPop(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "StringSet(RedisKey key, RedisValue value, TimeSpan? expiry, When when, CommandFlags flags)", "params": [ { "name": "key", "type": "RedisKey", "description": "" }, + { + "name": "value", + "type": "RedisValue", + "description": "" + }, + { + "name": "expiry", + "type": "TimeSpan?", + "description": "The expiry to set." + }, + { + "name": "when", + "type": "When", + "description": "Which condition to set the value under (defaults to always)." + }, { "name": "flags", "type": "CommandFlags", @@ -95086,12 +102508,12 @@ } ], "returns": { - "type": "RedisValue", - "description": "A span of contiguous elements from the list, or Null if no non-empty lists are found." + "type": "bool", + "description": "true if the keys were set, false otherwise." } }, { - "signature": "ListRightPop(RedisKey key, long count, CommandFlags flags = CommandFlags.None)", + "signature": "StringSet(RedisKey key, RedisValue value, TimeSpan? expiry, bool keepTtl, When when = When.Always, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", @@ -95099,31 +102521,25 @@ "description": "" }, { - "name": "count", - "type": "long", - "description": "The maximum number of elements to pop from the list." + "name": "value", + "type": "RedisValue", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "RedisValue[]", - "description": "A span of contiguous elements from the list, or Null if no non-empty lists are found." - } - } - ], - "nredisstack_async": [ - { - "signature": "ListRightPop(RedisKey key, CommandFlags flags = CommandFlags.None)", - "params": [ + "name": "expiry", + "type": "TimeSpan?", + "description": "The expiry to set." + }, { - "name": "key", - "type": "RedisKey", + "name": "keepTtl", + "type": "bool", "description": "" }, + { + "name": "when", + "type": "When", + "description": "Which condition to set the value under (defaults to always)." + }, { "name": "flags", "type": "CommandFlags", @@ -95131,12 +102547,12 @@ } ], "returns": { - "type": "RedisValue", - "description": "A span of contiguous elements from the list, or Null if no non-empty lists are found." + "type": "bool", + "description": "true if the keys were set, false otherwise." } }, { - "signature": "ListRightPop(RedisKey key, long count, CommandFlags flags = CommandFlags.None)", + "signature": "StringSet(RedisKey key, RedisValue value, Expiration expiry = default, ValueCondition when = default, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", @@ -95144,9 +102560,19 @@ "description": "" }, { - "name": "count", - "type": "long", - "description": "The maximum number of elements to pop from the list." + "name": "value", + "type": "RedisValue", + "description": "" + }, + { + "name": "expiry", + "type": "Expiration", + "description": "The expiry to set." + }, + { + "name": "when", + "type": "ValueCondition", + "description": "Which condition to set the value under (defaults to always)." }, { "name": "flags", @@ -95155,22 +102581,22 @@ } ], "returns": { - "type": "RedisValue[]", - "description": "A span of contiguous elements from the list, or Null if no non-empty lists are found." + "type": "bool", + "description": "true if the keys were set, false otherwise." } }, { - "signature": "ListRightPop(RedisKey[] keys, long count, CommandFlags flags = CommandFlags.None)", + "signature": "StringSet(KeyValuePair[] values, When when, CommandFlags flags)", "params": [ { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys to look through for elements to pop." + "name": "values", + "type": "KeyValuePair[]", + "description": "The keys and values to set." }, { - "name": "count", - "type": "long", - "description": "The maximum number of elements to pop from the list." + "name": "when", + "type": "When", + "description": "Which condition to set the value under (defaults to always)." }, { "name": "flags", @@ -95179,12 +102605,14 @@ } ], "returns": { - "type": "ListPopResult", - "description": "A span of contiguous elements from the list, or Null if no non-empty lists are found." + "type": "bool", + "description": "true if the keys were set, false otherwise." } - }, + } + ], + "nredisstack_async": [ { - "signature": "ListRightPop(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "StringSet(RedisKey key, RedisValue value, TimeSpan? expiry, When when)", "params": [ { "name": "key", @@ -95192,18 +102620,28 @@ "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "value", + "type": "RedisValue", + "description": "" + }, + { + "name": "expiry", + "type": "TimeSpan?", + "description": "The expiry to set." + }, + { + "name": "when", + "type": "When", + "description": "Which condition to set the value under (defaults to always)." } ], "returns": { - "type": "RedisValue", - "description": "A span of contiguous elements from the list, or Null if no non-empty lists are found." + "type": "bool", + "description": "true if the keys were set, false otherwise." } }, { - "signature": "ListRightPop(RedisKey key, long count, CommandFlags flags = CommandFlags.None)", + "signature": "StringSet(RedisKey key, RedisValue value, TimeSpan? expiry, When when, CommandFlags flags)", "params": [ { "name": "key", @@ -95211,9 +102649,19 @@ "description": "" }, { - "name": "count", - "type": "long", - "description": "The maximum number of elements to pop from the list." + "name": "value", + "type": "RedisValue", + "description": "" + }, + { + "name": "expiry", + "type": "TimeSpan?", + "description": "The expiry to set." + }, + { + "name": "when", + "type": "When", + "description": "Which condition to set the value under (defaults to always)." }, { "name": "flags", @@ -95222,319 +102670,217 @@ } ], "returns": { - "type": "RedisValue[]", - "description": "A span of contiguous elements from the list, or Null if no non-empty lists are found." - } - } - ], - "php": [ - { - "signature": "rpop(string $key)", - "params": [ - { - "name": "$key", - "type": "string", - "description": "" - } - ], - "returns": { - "type": "string|null", - "description": "" + "type": "bool", + "description": "true if the keys were set, false otherwise." } - } - ], - "redis_rb": [ + }, { - "signature": "rpop(key, count = nil)", + "signature": "StringSet(RedisKey key, RedisValue value, TimeSpan? expiry, bool keepTtl, When when = When.Always, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", - "type": "String", + "type": "RedisKey", "description": "" }, { - "name": "count", - "type": "Integer", - "description": "number of elements to remove" - } - ], - "returns": { - "type": "nil, String, Array", - "description": "the values of the last elements" - } - } - ] - } - }, - "RPOPLPUSH": { - "api_calls": { - "redis_py": [ - { - "signature": "rpoplpush(src: KeyT, dst: KeyT)", - "params": [ - { - "name": "src", - "type": "KeyT", + "name": "value", + "type": "RedisValue", "description": "" }, { - "name": "dst", - "type": "KeyT", - "description": "" - } - ], - "returns": { - "type": "Union[Awaitable[str], str]", - "description": "" - } - } - ], - "jedis": [ - { - "signature": "String rpoplpush(final String srckey, final String dstkey)", - "params": [ + "name": "expiry", + "type": "TimeSpan?", + "description": "The expiry to set." + }, { - "name": "srckey", - "type": "String", + "name": "keepTtl", + "type": "bool", "description": "" }, { - "name": "dstkey", - "type": "String", - "description": "" + "name": "when", + "type": "When", + "description": "Which condition to set the value under (defaults to always)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "String", - "description": "Bulk reply @deprecated Use ListCommands#lmove(String, String, ListDirection, ListDirection) with ListDirection#RIGHT and ListDirection#LEFT. Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 6.2.0." + "type": "bool", + "description": "true if the keys were set, false otherwise." } }, { - "signature": "String rpoplpush(String srckey, String dstkey)", + "signature": "StringSet(RedisKey key, RedisValue value, Expiration expiry = default, ValueCondition when = default, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "srckey", - "type": "String", + "name": "key", + "type": "RedisKey", "description": "" }, { - "name": "dstkey", - "type": "String", + "name": "value", + "type": "RedisValue", "description": "" - } - ], - "returns": { - "type": "String", - "description": "Bulk reply @deprecated Use ListCommands#lmove(String, String, ListDirection, ListDirection) with ListDirection#RIGHT and ListDirection#LEFT. Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 6.2.0." - } - } - ], - "lettuce_sync": [ - { - "signature": "V rpoplpush(K source, K destination)", - "params": [ - { - "name": "source", - "type": "K", - "description": "the source key." }, { - "name": "destination", - "type": "K", - "description": "the destination type: key." - } - ], - "returns": { - "type": "V", - "description": "V bulk-string-reply the element being popped and pushed." - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture rpoplpush(K source, K destination)", - "params": [ + "name": "expiry", + "type": "Expiration", + "description": "The expiry to set." + }, { - "name": "source", - "type": "K", - "description": "the source key." + "name": "when", + "type": "ValueCondition", + "description": "Which condition to set the value under (defaults to always)." }, { - "name": "destination", - "type": "K", - "description": "the destination type: key." + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "RedisFuture", - "description": "V bulk-string-reply the element being popped and pushed." + "type": "bool", + "description": "true if the keys were set, false otherwise." } - } - ], - "lettuce_reactive": [ + }, { - "signature": "Mono rpoplpush(K source, K destination)", + "signature": "StringSet(KeyValuePair[] values, When when, CommandFlags flags)", "params": [ { - "name": "source", - "type": "K", - "description": "the source key." + "name": "values", + "type": "KeyValuePair[]", + "description": "The keys and values to set." }, { - "name": "destination", - "type": "K", - "description": "the destination type: key." + "name": "when", + "type": "When", + "description": "Which condition to set the value under (defaults to always)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Mono", - "description": "V bulk-string-reply the element being popped and pushed." + "type": "bool", + "description": "true if the keys were set, false otherwise." } } ], - "go-redis": [ + "php": [ { - "signature": "RPopLPush(ctx context.Context, source, destination string)", + "signature": "set(string $key, $value, $expireResolution = null, $expireTTL = null, $flag = null, $flagValue = null)", "params": [ { - "name": "ctx", - "type": "context.Context", + "name": "$key", + "type": "string", "description": "" }, { - "name": "source", + "name": "$value", "type": "Any", "description": "" }, { - "name": "destination", - "type": "string", + "name": "$expireResolution = null", + "type": "Any", "description": "" - } - ], - "returns": { - "type": "*StringCmd", - "description": "" - } - } - ], - "ioredis": [ - { - "signature": "rpoplpush(source: RedisKey, destination: RedisKey, callback?: Callback)", - "params": [ + }, { - "name": "source", - "type": "RedisKey", + "name": "$expireTTL = null", + "type": "Any", "description": "" }, { - "name": "destination", - "type": "RedisKey", + "name": "$flag = null", + "type": "Any", "description": "" }, { - "name": "callback?", - "type": "Callback", + "name": "$flagValue = null", + "type": "Any", "description": "" } ], "returns": { - "type": "Any", + "type": "Status|null", "description": "" } } ], - "redis_rs_sync": [ + "redis_rb": [ { - "signature": "rpoplpush(key: K, dstkey: D)", + "signature": "set(key, value, ex: nil, px: nil, exat: nil, pxat: nil, nx: nil, xx: nil, keepttl: nil, get: nil)", "params": [ { "name": "key", - "type": "K", + "type": "String", "description": "" }, { - "name": "dstkey", - "type": "D", + "name": "value", + "type": "String", "description": "" - } - ], - "returns": { - "type": "(Option)", - "description": "" - } - } - ], - "redis_rs_async": [ - { - "signature": "rpoplpush(key: K, dstkey: D)", - "params": [ + }, { - "name": "key", - "type": "K", - "description": "" + "name": "ex", + "type": "Integer", + "description": "Set the specified expire time, in seconds." }, { - "name": "dstkey", - "type": "D", - "description": "" - } - ], - "returns": { - "type": "(Option)", - "description": "" - } - } - ], - "php": [ - { - "signature": "rpoplpush(string $source, string $destination)", - "params": [ + "name": "px", + "type": "Integer", + "description": "Set the specified expire time, in milliseconds." + }, { - "name": "$source", - "type": "string", - "description": "" + "name": "exat", + "type": "Integer", + "description": "Set the specified Unix time at which the key will expire, in seconds." }, { - "name": "$destination", - "type": "string", - "description": "" - } - ], - "returns": { - "type": "string|null", - "description": "" - } - } - ], - "redis_rb": [ - { - "signature": "rpoplpush(source, destination)", - "params": [ + "name": "pxat", + "type": "Integer", + "description": "Set the specified Unix time at which the key will expire, in milliseconds." + }, { - "name": "source", - "type": "String", - "description": "source key" + "name": "nx", + "type": "Boolean", + "description": "Only set the key if it does not already exist." }, { - "name": "destination", - "type": "String", - "description": "destination key" + "name": "xx", + "type": "Boolean", + "description": "Only set the key if it already exists." + }, + { + "name": "keepttl", + "type": "Boolean", + "description": "Retain the time to live associated with the key." + }, + { + "name": "get", + "type": "Boolean", + "description": "Return the old string stored at key, or nil if key did not exist." } ], "returns": { - "type": "nil, String", - "description": "the element, or nil when the source key does not exist" + "type": "String, Boolean", + "description": "\"OK\" or true, false if :nx => true or :xx => true" } } ] } }, - "RPUSH": { + "SETBIT": { "api_calls": { "redis_py": [ { - "signature": "rpush(name: KeyT, *values: FieldT)", + "signature": "setbit(name: KeyT, offset: int, value: int)", "params": [ { "name": "name", @@ -95542,20 +102888,25 @@ "description": "" }, { - "name": "*values", - "type": "FieldT", + "name": "offset", + "type": "int", + "description": "" + }, + { + "name": "value", + "type": "int", "description": "" } ], "returns": { - "type": "Union[Awaitable[int], int]", + "type": "ResponseT", "description": "" } } ], "jedis": [ { - "signature": "long rpush(final byte[] key, final byte[]... strings)", + "signature": "boolean setbit(final byte[] key, final long offset, final boolean value)", "params": [ { "name": "key", @@ -95563,37 +102914,23 @@ "description": "" }, { - "name": "strings", - "type": "byte[]...", - "description": "data to push" - } - ], - "returns": { - "type": "long", - "description": "The number of elements inside the list after the push operation" - } - }, - { - "signature": "long rpush(final String key, final String... strings)", - "params": [ - { - "name": "key", - "type": "String", + "name": "offset", + "type": "long", "description": "" }, { - "name": "strings", - "type": "String...", - "description": "data to push" + "name": "value", + "type": "boolean", + "description": "" } ], "returns": { - "type": "long", - "description": "The number of elements inside the list after the push operation" + "type": "boolean", + "description": "" } }, { - "signature": "long rpush(String key, String... strings)", + "signature": "boolean setbit(final String key, final long offset, final boolean value)", "params": [ { "name": "key", @@ -95601,20 +102938,25 @@ "description": "" }, { - "name": "strings", - "type": "String...", - "description": "data to push" + "name": "offset", + "type": "long", + "description": "" + }, + { + "name": "value", + "type": "boolean", + "description": "" } ], "returns": { - "type": "long", - "description": "The number of elements inside the list after the push operation" + "type": "boolean", + "description": "" } } ], "lettuce_sync": [ { - "signature": "Long rpush(K key, V... values)", + "signature": "Long setbit(K key, long offset, int value)", "params": [ { "name": "key", @@ -95622,20 +102964,25 @@ "description": "the key." }, { - "name": "values", - "type": "V...", - "description": "the value." + "name": "offset", + "type": "long", + "description": "the offset type: long." + }, + { + "name": "value", + "type": "int", + "description": "the value type: string." } ], "returns": { "type": "Long", - "description": "Long integer-reply the length of the list after the push operation." + "description": "Long integer-reply the original bit value stored at offset." } } ], "lettuce_async": [ { - "signature": "RedisFuture rpush(K key, V... values)", + "signature": "RedisFuture setbit(K key, long offset, int value)", "params": [ { "name": "key", @@ -95643,20 +102990,25 @@ "description": "the key." }, { - "name": "values", - "type": "V...", - "description": "the value." + "name": "offset", + "type": "long", + "description": "the offset type: long." + }, + { + "name": "value", + "type": "int", + "description": "the value type: string." } ], "returns": { "type": "RedisFuture", - "description": "Long integer-reply the length of the list after the push operation." + "description": "Long integer-reply the original bit value stored at offset." } } ], "lettuce_reactive": [ { - "signature": "Mono rpush(K key, V... values)", + "signature": "Mono setbit(K key, long offset, int value)", "params": [ { "name": "key", @@ -95664,20 +103016,25 @@ "description": "the key." }, { - "name": "values", - "type": "V...", - "description": "the value." + "name": "offset", + "type": "long", + "description": "the offset type: long." + }, + { + "name": "value", + "type": "int", + "description": "the value type: string." } ], "returns": { "type": "Mono", - "description": "Long integer-reply the length of the list after the push operation." + "description": "Long integer-reply the original bit value stored at offset." } } ], "go-redis": [ { - "signature": "RPush(ctx context.Context, key string, values ...interface{})", + "signature": "SetBit(ctx context.Context, key string, offset int64, value int)", "params": [ { "name": "ctx", @@ -95690,8 +103047,13 @@ "description": "" }, { - "name": "values", - "type": "...interface{}", + "name": "offset", + "type": "int64", + "description": "" + }, + { + "name": "value", + "type": "int", "description": "" } ], @@ -95703,7 +103065,7 @@ ], "node_redis": [ { - "signature": "RPUSH(key: RedisArgument, element: RedisVariadicArgument)", + "signature": "SETBIT(key: RedisArgument, offset: number, value: BitValue)", "params": [ { "name": "key", @@ -95711,8 +103073,13 @@ "description": "" }, { - "name": "element", - "type": "RedisVariadicArgument", + "name": "offset", + "type": "number", + "description": "" + }, + { + "name": "value", + "type": "BitValue", "description": "" } ], @@ -95724,25 +103091,26 @@ ], "ioredis": [ { - "signature": "rpush(...args: [, key: RedisKey, ...elements: (string | Buffer | number)[], callback: Callback, ])", + "signature": "setbit(key: RedisKey, offset: number | string, value: number | string, callback?: Callback)", "params": [ { - "name": "...args", - "type": "[, key", + "name": "key", + "type": "RedisKey", "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "rpush(...args: [key: RedisKey, ...elements: (string | Buffer | number)[]])", - "params": [ + }, { - "name": "...args", - "type": "[key", + "name": "offset", + "type": "number | string", + "description": "" + }, + { + "name": "value", + "type": "number | string", + "description": "" + }, + { + "name": "callback?", + "type": "Callback", "description": "" } ], @@ -95754,64 +103122,74 @@ ], "redis_rs_sync": [ { - "signature": "rpush(key: K, value: V)", + "signature": "setbit(key: K, offset: usize, value: bool)", "params": [ { "name": "key", "type": "K", "description": "" }, + { + "name": "offset", + "type": "usize", + "description": "" + }, { "name": "value", - "type": "V", + "type": "bool", "description": "" } ], "returns": { - "type": "(usize)", + "type": "(bool)", "description": "" } } ], "redis_rs_async": [ { - "signature": "rpush(key: K, value: V)", + "signature": "setbit(key: K, offset: usize, value: bool)", "params": [ { "name": "key", "type": "K", "description": "" }, + { + "name": "offset", + "type": "usize", + "description": "" + }, { "name": "value", - "type": "V", + "type": "bool", "description": "" } ], "returns": { - "type": "(usize)", + "type": "(bool)", "description": "" } } ], "nredisstack_sync": [ { - "signature": "ListRightPush(RedisKey key, RedisValue value, When when = When.Always, CommandFlags flags = CommandFlags.None)", + "signature": "StringSetBit(RedisKey key, long offset, bool bit, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key of the list." + "description": "The key of the string." }, { - "name": "value", - "type": "RedisValue", - "description": "" + "name": "offset", + "type": "long", + "description": "The offset in the string to set bit." }, { - "name": "when", - "type": "When", - "description": "" + "name": "bit", + "type": "bool", + "description": "The bit value to set, true for 1, false for 0." }, { "name": "flags", @@ -95820,80 +103198,56 @@ } ], "returns": { - "type": "long", - "description": "The length of the list after the push operation." + "type": "bool", + "description": "The original bit value stored at offset." } }, { - "signature": "ListRightPush(RedisKey key, RedisValue[] values, When when = When.Always, CommandFlags flags = CommandFlags.None)", + "signature": "StringSetBitAsync(RedisKey key, long offset, bool bit, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key of the list." - }, - { - "name": "values", - "type": "RedisValue[]", - "description": "The values to add to the tail of the list." - }, - { - "name": "when", - "type": "When", "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "long", - "description": "The length of the list after the push operation." - } - }, - { - "signature": "ListRightPush(RedisKey key, RedisValue[] values, CommandFlags flags)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the list." + "name": "offset", + "type": "long", + "description": "" }, { - "name": "values", - "type": "RedisValue[]", - "description": "The values to add to the tail of the list." + "name": "bit", + "type": "bool", + "description": "" }, { "name": "flags", "type": "CommandFlags", - "description": "The flags to use for this operation." + "description": "" } ], "returns": { - "type": "long", - "description": "The length of the list after the push operation." + "type": "Task", + "description": "" } }, { - "signature": "ListRightPush(RedisKey key, RedisValue value, When when = When.Always, CommandFlags flags = CommandFlags.None)", + "signature": "StringSetBit(RedisKey key, long offset, bool bit, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key of the list." + "description": "The key of the string." }, { - "name": "value", - "type": "RedisValue", - "description": "" + "name": "offset", + "type": "long", + "description": "The offset in the string to set bit." }, { - "name": "when", - "type": "When", - "description": "" + "name": "bit", + "type": "bool", + "description": "The bit value to set, true for 1, false for 0." }, { "name": "flags", @@ -95902,111 +103256,87 @@ } ], "returns": { - "type": "long", - "description": "The length of the list after the push operation." + "type": "bool", + "description": "The original bit value stored at offset." } }, { - "signature": "ListRightPush(RedisKey key, RedisValue[] values, When when = When.Always, CommandFlags flags = CommandFlags.None)", + "signature": "StringSetBitAsync(RedisKey key, long offset, bool value, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key of the list." + "description": "" }, { - "name": "values", - "type": "RedisValue[]", - "description": "The values to add to the tail of the list." + "name": "offset", + "type": "long", + "description": "" }, { - "name": "when", - "type": "When", + "name": "value", + "type": "bool", "description": "" }, { "name": "flags", "type": "CommandFlags", - "description": "The flags to use for this operation." + "description": "" } ], "returns": { - "type": "long", - "description": "The length of the list after the push operation." + "type": "Task", + "description": "" } } ], "nredisstack_async": [ { - "signature": "ListRightPush(RedisKey key, RedisValue value, When when = When.Always, CommandFlags flags = CommandFlags.None)", + "signature": "StringSetBitAsync(RedisKey key, long offset, bool bit, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key of the list." + "description": "" }, { - "name": "value", - "type": "RedisValue", + "name": "offset", + "type": "long", "description": "" }, { - "name": "when", - "type": "When", + "name": "bit", + "type": "bool", "description": "" }, { "name": "flags", "type": "CommandFlags", - "description": "The flags to use for this operation." + "description": "" } ], "returns": { - "type": "long", - "description": "The length of the list after the push operation." + "type": "Task", + "description": "" } }, { - "signature": "ListRightPush(RedisKey key, RedisValue[] values, When when = When.Always, CommandFlags flags = CommandFlags.None)", + "signature": "StringSetBit(RedisKey key, long offset, bool bit, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key of the list." - }, - { - "name": "values", - "type": "RedisValue[]", - "description": "The values to add to the tail of the list." - }, - { - "name": "when", - "type": "When", - "description": "" + "description": "The key of the string." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "long", - "description": "The length of the list after the push operation." - } - }, - { - "signature": "ListRightPush(RedisKey key, RedisValue[] values, CommandFlags flags)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the list." + "name": "offset", + "type": "long", + "description": "The offset in the string to set bit." }, { - "name": "values", - "type": "RedisValue[]", - "description": "The values to add to the tail of the list." + "name": "bit", + "type": "bool", + "description": "The bit value to set, true for 1, false for 0." }, { "name": "flags", @@ -96015,27 +103345,27 @@ } ], "returns": { - "type": "long", - "description": "The length of the list after the push operation." + "type": "bool", + "description": "The original bit value stored at offset." } }, { - "signature": "ListRightPush(RedisKey key, RedisValue value, When when = When.Always, CommandFlags flags = CommandFlags.None)", + "signature": "StringSetBit(RedisKey key, long offset, bool bit, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key of the list." + "description": "The key of the string." }, { - "name": "value", - "type": "RedisValue", - "description": "" + "name": "offset", + "type": "long", + "description": "The offset in the string to set bit." }, { - "name": "when", - "type": "When", - "description": "" + "name": "bit", + "type": "bool", + "description": "The bit value to set, true for 1, false for 0." }, { "name": "flags", @@ -96044,43 +103374,43 @@ } ], "returns": { - "type": "long", - "description": "The length of the list after the push operation." + "type": "bool", + "description": "The original bit value stored at offset." } }, { - "signature": "ListRightPush(RedisKey key, RedisValue[] values, When when = When.Always, CommandFlags flags = CommandFlags.None)", + "signature": "StringSetBitAsync(RedisKey key, long offset, bool value, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key of the list." + "description": "" }, { - "name": "values", - "type": "RedisValue[]", - "description": "The values to add to the tail of the list." + "name": "offset", + "type": "long", + "description": "" }, { - "name": "when", - "type": "When", + "name": "value", + "type": "bool", "description": "" }, { "name": "flags", "type": "CommandFlags", - "description": "The flags to use for this operation." + "description": "" } ], "returns": { - "type": "long", - "description": "The length of the list after the push operation." + "type": "Task", + "description": "" } } ], "php": [ { - "signature": "rpush(string $key, array $values)", + "signature": "setbit(string $key, $offset, $value)", "params": [ { "name": "$key", @@ -96088,45 +103418,29 @@ "description": "" }, { - "name": "$values", - "type": "array", - "description": "" - } - ], - "returns": { - "type": "int", - "description": "" - } - } - ], - "redis_rb": [ - { - "signature": "rpush(key, value)", - "params": [ - { - "name": "key", - "type": "String", + "name": "$offset", + "type": "Any", "description": "" }, { - "name": "value", - "type": "String, Array", - "description": "string value, or array of string values to push" + "name": "$value", + "type": "Any", + "description": "" } ], "returns": { - "type": "Integer", - "description": "the length of the list after the push operation" + "type": "int", + "description": "" } } ] } }, - "RPUSHX": { + "SETEX": { "api_calls": { "redis_py": [ { - "signature": "rpushx(name: KeyT, *values: str)", + "signature": "setex(name: KeyT, time: ExpiryT, value: EncodableT)", "params": [ { "name": "name", @@ -96134,20 +103448,25 @@ "description": "" }, { - "name": "*values", - "type": "str", + "name": "time", + "type": "ExpiryT", + "description": "" + }, + { + "name": "value", + "type": "EncodableT", "description": "" } ], "returns": { - "type": "Union[Awaitable[int], int]", + "type": "ResponseT", "description": "" } } ], "jedis": [ { - "signature": "long rpushx(final byte[] key, final byte[]... strings)", + "signature": "String setex(final byte[] key, final long seconds, final byte[] value)", "params": [ { "name": "key", @@ -96155,37 +103474,23 @@ "description": "" }, { - "name": "strings", - "type": "byte[]...", - "description": "the strings to push" - } - ], - "returns": { - "type": "long", - "description": "The length of the list after the push operation" - } - }, - { - "signature": "long rpushx(final String key, final String... strings)", - "params": [ - { - "name": "key", - "type": "String", + "name": "seconds", + "type": "long", "description": "" }, { - "name": "strings", - "type": "String...", - "description": "the strings to push" + "name": "value", + "type": "byte[]", + "description": "" } ], "returns": { - "type": "long", - "description": "The length of the list after the push operation" + "type": "String", + "description": "OK @deprecated Use Jedis#set(String, String, redis.clients.jedis.params.SetParams) with redis.clients.jedis.params.SetParams#ex(long). Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 2.6.12." } }, { - "signature": "long rpushx(String key, String... strings)", + "signature": "String setex(final String key, final long seconds, final String value)", "params": [ { "name": "key", @@ -96193,20 +103498,25 @@ "description": "" }, { - "name": "strings", - "type": "String...", - "description": "the strings to push" + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "value", + "type": "String", + "description": "" } ], "returns": { - "type": "long", - "description": "The length of the list after the push operation" + "type": "String", + "description": "OK @deprecated Use Jedis#set(String, String, redis.clients.jedis.params.SetParams) with redis.clients.jedis.params.SetParams#ex(long). Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 2.6.12." } } ], "lettuce_sync": [ { - "signature": "Long rpushx(K key, V... values)", + "signature": "String setex(K key, long seconds, V value)", "params": [ { "name": "key", @@ -96214,20 +103524,25 @@ "description": "the key." }, { - "name": "values", - "type": "V...", - "description": "the values." + "name": "seconds", + "type": "long", + "description": "the seconds type: long." + }, + { + "name": "value", + "type": "V", + "description": "the value." } ], "returns": { - "type": "Long", - "description": "Long integer-reply the length of the list after the push operation." + "type": "String", + "description": "String simple-string-reply." } } ], "lettuce_async": [ { - "signature": "RedisFuture rpushx(K key, V... values)", + "signature": "RedisFuture setex(K key, long seconds, V value)", "params": [ { "name": "key", @@ -96235,20 +103550,25 @@ "description": "the key." }, { - "name": "values", - "type": "V...", - "description": "the values." + "name": "seconds", + "type": "long", + "description": "the seconds type: long." + }, + { + "name": "value", + "type": "V", + "description": "the value." } ], "returns": { - "type": "RedisFuture", - "description": "Long integer-reply the length of the list after the push operation." + "type": "RedisFuture", + "description": "String simple-string-reply." } } ], "lettuce_reactive": [ { - "signature": "Mono rpushx(K key, V... values)", + "signature": "Mono setex(K key, long seconds, V value)", "params": [ { "name": "key", @@ -96256,20 +103576,25 @@ "description": "the key." }, { - "name": "values", - "type": "V...", - "description": "the values." + "name": "seconds", + "type": "long", + "description": "the seconds type: long." + }, + { + "name": "value", + "type": "V", + "description": "the value." } ], "returns": { - "type": "Mono", - "description": "Long integer-reply the length of the list after the push operation." + "type": "Mono", + "description": "String simple-string-reply." } } ], "go-redis": [ { - "signature": "RPushX(ctx context.Context, key string, values ...interface{})", + "signature": "SetEx(ctx context.Context, key string, value interface{}, expiration time.Duration)", "params": [ { "name": "ctx", @@ -96282,24 +103607,39 @@ "description": "" }, { - "name": "values", - "type": "...interface{}", + "name": "value", + "type": "interface{}", + "description": "" + }, + { + "name": "expiration", + "type": "time.Duration", "description": "" } ], "returns": { - "type": "*IntCmd", + "type": "*StatusCmd", "description": "" } } ], - "ioredis": [ + "node_redis": [ { - "signature": "rpushx(...args: [, key: RedisKey, ...elements: (string | Buffer | number)[], callback: Callback, ])", + "signature": "SETEX(key: RedisArgument, seconds: number, value: RedisArgument)", "params": [ { - "name": "...args", - "type": "[, key", + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "seconds", + "type": "number", + "description": "" + }, + { + "name": "value", + "type": "RedisArgument", "description": "" } ], @@ -96307,13 +103647,30 @@ "type": "Any", "description": "" } - }, + } + ], + "ioredis": [ { - "signature": "rpushx(...args: [key: RedisKey, ...elements: (string | Buffer | number)[]])", + "signature": "setex(key: RedisKey, seconds: number | string, value: string | Buffer | number, callback?: Callback<\"OK\">)", "params": [ { - "name": "...args", - "type": "[key", + "name": "key", + "type": "RedisKey", + "description": "" + }, + { + "name": "seconds", + "type": "number | string", + "description": "" + }, + { + "name": "value", + "type": "string | Buffer | number", + "description": "" + }, + { + "name": "callback?", + "type": "Callback<\"OK\">", "description": "" } ], @@ -96325,7 +103682,7 @@ ], "redis_rs_sync": [ { - "signature": "rpush_exists(key: K, value: V)", + "signature": "set_ex(key: K, value: V, seconds: u64)", "params": [ { "name": "key", @@ -96336,17 +103693,22 @@ "name": "value", "type": "V", "description": "" + }, + { + "name": "seconds", + "type": "u64", + "description": "" } ], "returns": { - "type": "(usize)", + "type": "(())", "description": "" } } ], "redis_rs_async": [ { - "signature": "rpush_exists(key: K, value: V)", + "signature": "set_ex(key: K, value: V, seconds: u64)", "params": [ { "name": "key", @@ -96357,17 +103719,22 @@ "name": "value", "type": "V", "description": "" + }, + { + "name": "seconds", + "type": "u64", + "description": "" } ], "returns": { - "type": "(usize)", + "type": "(())", "description": "" } } ], "php": [ { - "signature": "rpushx(string $key, array $values)", + "signature": "setex(string $key, $seconds, $value)", "params": [ { "name": "$key", @@ -96375,26 +103742,36 @@ "description": "" }, { - "name": "$values", - "type": "array", + "name": "$seconds", + "type": "Any", + "description": "" + }, + { + "name": "$value", + "type": "Any", "description": "" } ], "returns": { - "type": "int", + "type": "Status", "description": "" } } ], "redis_rb": [ { - "signature": "rpushx(key, value)", + "signature": "setex(key, ttl, value)", "params": [ { "name": "key", "type": "String", "description": "" }, + { + "name": "ttl", + "type": "Integer", + "description": "" + }, { "name": "value", "type": "String", @@ -96402,18 +103779,18 @@ } ], "returns": { - "type": "Integer", - "description": "the length of the list after the push operation" + "type": "String", + "description": "\"OK\"" } } ] } }, - "SADD": { + "SETNX": { "api_calls": { "redis_py": [ { - "signature": "sadd(name: KeyT, *values: FieldT)", + "signature": "setnx(name: KeyT, value: EncodableT)", "params": [ { "name": "name", @@ -96421,20 +103798,20 @@ "description": "" }, { - "name": "*values", - "type": "FieldT", + "name": "value", + "type": "EncodableT", "description": "" } ], "returns": { - "type": "Union[Awaitable[int], int]", + "type": "ResponseT", "description": "" } } ], "jedis": [ { - "signature": "long sadd(final byte[] key, final byte[]... members)", + "signature": "long setnx(final byte[] key, final byte[] value)", "params": [ { "name": "key", @@ -96442,18 +103819,18 @@ "description": "" }, { - "name": "members", - "type": "byte[]...", + "name": "value", + "type": "byte[]", "description": "" } ], "returns": { "type": "long", - "description": "1 if the new element was added, 0 if the element was already a member of the set" + "description": "1 if the key was set, 0 if the key was not set @deprecated Use Jedis#set(String, String, redis.clients.jedis.params.SetParams) with redis.clients.jedis.params.SetParams#nx(). Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 2.6.12." } }, { - "signature": "long sadd(final String key, final String... members)", + "signature": "long setnx(final String key, final String value)", "params": [ { "name": "key", @@ -96461,20 +103838,20 @@ "description": "" }, { - "name": "members", - "type": "String...", + "name": "value", + "type": "String", "description": "" } ], "returns": { "type": "long", - "description": "1 if the new element was added, 0 if the element was already a member of the set" + "description": "1 if the key was set, 0 if the key was not set @deprecated Use Jedis#set(String, String, redis.clients.jedis.params.SetParams) with redis.clients.jedis.params.SetParams#nx(). Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 2.6.12." } } ], "lettuce_sync": [ { - "signature": "Long sadd(K key, V... members)", + "signature": "Boolean setnx(K key, V value)", "params": [ { "name": "key", @@ -96482,20 +103859,20 @@ "description": "the key." }, { - "name": "members", - "type": "V...", - "description": "the member type: value." + "name": "value", + "type": "V", + "description": "the value." } ], "returns": { - "type": "Long", - "description": "Long integer-reply the number of elements that were added to the set, not including all the elements already present into the set." + "type": "Boolean", + "description": "Boolean integer-reply specifically: 1 if the key was set 0 if the key was not set." } } ], "lettuce_async": [ { - "signature": "RedisFuture sadd(K key, V... members)", + "signature": "RedisFuture setnx(K key, V value)", "params": [ { "name": "key", @@ -96503,20 +103880,20 @@ "description": "the key." }, { - "name": "members", - "type": "V...", - "description": "the member type: value." + "name": "value", + "type": "V", + "description": "the value." } ], "returns": { - "type": "RedisFuture", - "description": "Long integer-reply the number of elements that were added to the set, not including all the elements already present into the set." + "type": "RedisFuture", + "description": "Boolean integer-reply specifically: 1 if the key was set 0 if the key was not set." } } ], "lettuce_reactive": [ { - "signature": "Mono sadd(K key, V... members)", + "signature": "Mono setnx(K key, V value)", "params": [ { "name": "key", @@ -96524,20 +103901,20 @@ "description": "the key." }, { - "name": "members", - "type": "V...", - "description": "the member type: value." + "name": "value", + "type": "V", + "description": "the value." } ], "returns": { - "type": "Mono", - "description": "Long integer-reply the number of elements that were added to the set, not including all the elements already present into the set." + "type": "Mono", + "description": "Boolean integer-reply specifically: 1 if the key was set 0 if the key was not set." } } ], "go-redis": [ { - "signature": "SAdd(ctx context.Context, key string, members ...interface{})", + "signature": "SetNX(ctx context.Context, key string, value interface{}, expiration time.Duration)", "params": [ { "name": "ctx", @@ -96550,20 +103927,25 @@ "description": "" }, { - "name": "members", - "type": "...interface{}", + "name": "value", + "type": "interface{}", + "description": "" + }, + { + "name": "expiration", + "type": "time.Duration", "description": "" } ], "returns": { - "type": "*IntCmd", + "type": "*BoolCmd", "description": "" } } ], "node_redis": [ { - "signature": "SADD(key: RedisArgument, members: RedisVariadicArgument)", + "signature": "SETNX(key: RedisArgument, value: RedisArgument)", "params": [ { "name": "key", @@ -96571,8 +103953,8 @@ "description": "" }, { - "name": "members", - "type": "RedisVariadicArgument", + "name": "value", + "type": "RedisArgument", "description": "" } ], @@ -96584,53 +103966,21 @@ ], "ioredis": [ { - "signature": "sadd(...args: [, key: RedisKey, ...members: (string | Buffer | number)[], callback: Callback, ])", - "params": [ - { - "name": "...args", - "type": "[, key", - "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "sadd(...args: [, key: RedisKey, members: (string | Buffer | number)[], callback: Callback, ])", + "signature": "setnx(key: RedisKey, value: string | Buffer | number, callback?: Callback)", "params": [ { - "name": "...args", - "type": "[, key", + "name": "key", + "type": "RedisKey", "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "sadd(...args: [key: RedisKey, ...members: (string | Buffer | number)[]])", - "params": [ + }, { - "name": "...args", - "type": "[key", + "name": "value", + "type": "string | Buffer | number", "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "sadd(...args: [key: RedisKey, members: (string | Buffer | number)[]])", - "params": [ + }, { - "name": "...args", - "type": "[key", + "name": "callback?", + "type": "Callback", "description": "" } ], @@ -96642,7 +103992,7 @@ ], "redis_rs_sync": [ { - "signature": "sadd(key: K, member: M)", + "signature": "set_nx(key: K, value: V)", "params": [ { "name": "key", @@ -96650,237 +104000,41 @@ "description": "" }, { - "name": "member", - "type": "M", + "name": "value", + "type": "V", "description": "" } ], "returns": { - "type": "(usize)", + "type": "(bool)", "description": "" } } ], "redis_rs_async": [ { - "signature": "sadd(key: K, member: M)", + "signature": "set_nx(key: K, value: V)", "params": [ { "name": "key", "type": "K", "description": "" }, - { - "name": "member", - "type": "M", - "description": "" - } - ], - "returns": { - "type": "(usize)", - "description": "" - } - } - ], - "nredisstack_sync": [ - { - "signature": "SetAdd(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the set." - }, - { - "name": "value", - "type": "RedisValue", - "description": "" - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "bool", - "description": "The number of elements that were added to the set, not including all the elements already present into the set." - } - }, - { - "signature": "SetAdd(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the set." - }, - { - "name": "values", - "type": "RedisValue[]", - "description": "The values to add to the set." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "long", - "description": "The number of elements that were added to the set, not including all the elements already present into the set." - } - }, - { - "signature": "SetAdd(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the set." - }, - { - "name": "value", - "type": "RedisValue", - "description": "" - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "bool", - "description": "The number of elements that were added to the set, not including all the elements already present into the set." - } - }, - { - "signature": "SetAdd(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the set." - }, - { - "name": "values", - "type": "RedisValue[]", - "description": "The values to add to the set." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "long", - "description": "The number of elements that were added to the set, not including all the elements already present into the set." - } - } - ], - "nredisstack_async": [ - { - "signature": "SetAdd(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the set." - }, - { - "name": "value", - "type": "RedisValue", - "description": "" - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "bool", - "description": "The number of elements that were added to the set, not including all the elements already present into the set." - } - }, - { - "signature": "SetAdd(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the set." - }, - { - "name": "values", - "type": "RedisValue[]", - "description": "The values to add to the set." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "long", - "description": "The number of elements that were added to the set, not including all the elements already present into the set." - } - }, - { - "signature": "SetAdd(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the set." - }, { "name": "value", - "type": "RedisValue", + "type": "V", "description": "" - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "bool", - "description": "The number of elements that were added to the set, not including all the elements already present into the set." - } - }, - { - "signature": "SetAdd(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the set." - }, - { - "name": "values", - "type": "RedisValue[]", - "description": "The values to add to the set." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." } ], "returns": { - "type": "long", - "description": "The number of elements that were added to the set, not including all the elements already present into the set." + "type": "(bool)", + "description": "" } } ], "php": [ { - "signature": "sadd(string $key, array $members)", + "signature": "setnx(string $key, $value)", "params": [ { "name": "$key", @@ -96888,8 +104042,8 @@ "description": "" }, { - "name": "$members", - "type": "array", + "name": "$value", + "type": "Any", "description": "" } ], @@ -96901,7 +104055,7 @@ ], "redis_rb": [ { - "signature": "sadd(key, *members)", + "signature": "setnx(key, value)", "params": [ { "name": "key", @@ -96909,28 +104063,38 @@ "description": "" }, { - "name": "*members", - "type": "String, Array", - "description": "one member, or array of members" + "name": "value", + "type": "String", + "description": "" } ], "returns": { - "type": "Integer", - "description": "The number of members that were successfully added" + "type": "Boolean", + "description": "whether the key was set or not" } } ] } }, - "SAVE": { + "SETRANGE": { "api_calls": { "redis_py": [ { - "signature": "save(**kwargs)", + "signature": "setrange(name: KeyT, offset: int, value: EncodableT)", "params": [ { - "name": "**kwargs", - "type": "Any", + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "offset", + "type": "int", + "description": "" + }, + { + "name": "value", + "type": "EncodableT", "description": "" } ], @@ -96942,190 +104106,135 @@ ], "jedis": [ { - "signature": "String save()", - "params": [], - "returns": { - "type": "String", - "description": "OK" - } - } - ], - "go-redis": [ - { - "signature": "Save(ctx context.Context) *StatusCmd", + "signature": "long setrange(final byte[] key, final long offset, final byte[] value)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "offset", + "type": "long", + "description": "" + }, + { + "name": "value", + "type": "byte[]", + "description": "" } ], "returns": { - "type": "*StatusCmd", - "description": "" - } - } - ], - "node_redis": [ - { - "signature": "SAVE()", - "params": [], - "returns": { - "type": "SimpleStringReply", - "description": "" - } - } - ], - "lettuce_sync": [ - { - "signature": "String save()", - "params": [], - "returns": { - "type": "String", - "description": "" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture save()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "" - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono save()", - "params": [], - "returns": { - "type": "Mono", - "description": "" - } - } - ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ - { - "signature": "save()", - "params": [], - "returns": { - "type": "mixed", + "type": "long", "description": "" } - } - ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "SCAN": { - "api_calls": { - "redis_py": [ + }, { - "signature": "scan(cursor: int = 0, match: Optional[PatternT] = None, count: Optional[int] = None, _type: Optional[str] = None, **kwargs)", + "signature": "long setrange(final String key, final long offset, final String value)", "params": [ { - "name": "cursor", - "type": "int", - "description": "" - }, - { - "name": "match", - "type": "Optional[PatternT]", + "name": "key", + "type": "String", "description": "" }, { - "name": "count", - "type": "Optional[int]", + "name": "offset", + "type": "long", "description": "" }, - { - "name": "_type", - "type": "Optional[str]", + { + "name": "value", + "type": "String", "description": "" } ], "returns": { - "type": "tuple", + "type": "long", "description": "" } } ], - "jedis": [ + "lettuce_sync": [ { - "signature": "ScanResult scan(final byte[] cursor)", + "signature": "Long setrange(K key, long offset, V value)", "params": [ { - "name": "cursor", - "type": "byte[]", - "description": "" - } - ], - "returns": { - "type": "ScanResult", - "description": "ScanResult" - } - }, - { - "signature": "ScanResult scan(final byte[] cursor, final ScanParams params)", - "params": [ + "name": "key", + "type": "K", + "description": "the key." + }, { - "name": "cursor", - "type": "byte[]", - "description": "" + "name": "offset", + "type": "long", + "description": "the offset type: long." }, { - "name": "params", - "type": "ScanParams", - "description": "" + "name": "value", + "type": "V", + "description": "the value." } ], "returns": { - "type": "ScanResult", - "description": "ScanResult" + "type": "Long", + "description": "Long integer-reply the length of the string after it was modified by the command." } - }, + } + ], + "lettuce_async": [ { - "signature": "ScanResult scan(final String cursor)", + "signature": "RedisFuture setrange(K key, long offset, V value)", "params": [ { - "name": "cursor", - "type": "String", - "description": "" + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "offset", + "type": "long", + "description": "the offset type: long." + }, + { + "name": "value", + "type": "V", + "description": "the value." } ], "returns": { - "type": "ScanResult", - "description": "ScanResult" + "type": "RedisFuture", + "description": "Long integer-reply the length of the string after it was modified by the command." } - }, + } + ], + "lettuce_reactive": [ { - "signature": "ScanResult scan(final String cursor, final ScanParams params)", + "signature": "Mono setrange(K key, long offset, V value)", "params": [ { - "name": "cursor", - "type": "String", - "description": "" + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "params", - "type": "ScanParams", - "description": "" + "name": "offset", + "type": "long", + "description": "the offset type: long." + }, + { + "name": "value", + "type": "V", + "description": "the value." } ], "returns": { - "type": "ScanResult", - "description": "ScanResult" + "type": "Mono", + "description": "Long integer-reply the length of the string after it was modified by the command." } } ], "go-redis": [ { - "signature": "Scan(ctx context.Context, cursor uint64, match string, count int64)", + "signature": "SetRange(ctx context.Context, key string, offset int64, value string)", "params": [ { "name": "ctx", @@ -97133,39 +104242,44 @@ "description": "" }, { - "name": "cursor", - "type": "uint64", + "name": "key", + "type": "string", "description": "" }, { - "name": "match", - "type": "string", + "name": "offset", + "type": "int64", "description": "" }, { - "name": "count", - "type": "int64", + "name": "value", + "type": "string", "description": "" } ], "returns": { - "type": "*ScanCmd", + "type": "*IntCmd", "description": "" } } ], "node_redis": [ { - "signature": "SCAN(cursor: number, options?: ScanOptions)", + "signature": "SETRANGE(key: RedisArgument, offset: number, value: RedisArgument)", "params": [ { - "name": "cursor", + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "offset", "type": "number", "description": "" }, { - "name": "options?", - "type": "ScanOptions", + "name": "value", + "type": "RedisArgument", "description": "" } ], @@ -97175,200 +104289,167 @@ } } ], - "lettuce_sync": [ - { - "signature": "KeyScanCursor scan()", - "params": [], - "returns": { - "type": "KeyScanCursor", - "description": "KeyScanCursor scan cursor." - } - }, + "ioredis": [ { - "signature": "KeyScanCursor scan(ScanArgs scanArgs)", + "signature": "setrange(key: RedisKey, offset: number | string, value: string | Buffer | number, callback?: Callback)", "params": [ { - "name": "scanArgs", - "type": "ScanArgs", - "description": "scan arguments." - } - ], - "returns": { - "type": "KeyScanCursor", - "description": "KeyScanCursor scan cursor." - } - }, - { - "signature": "KeyScanCursor scan(ScanCursor scanCursor)", - "params": [ + "name": "key", + "type": "RedisKey", + "description": "" + }, { - "name": "scanCursor", - "type": "ScanCursor", - "description": "cursor to resume from a previous scan." - } - ], - "returns": { - "type": "KeyScanCursor", - "description": "KeyScanCursor scan cursor." - } - }, - { - "signature": "KeyScanCursor scan(ScanCursor scanCursor, ScanArgs scanArgs)", - "params": [ + "name": "offset", + "type": "number | string", + "description": "" + }, { - "name": "scanCursor", - "type": "ScanCursor", - "description": "cursor to resume from a previous scan." + "name": "value", + "type": "string | Buffer | number", + "description": "" }, { - "name": "scanArgs", - "type": "ScanArgs", - "description": "scan arguments." + "name": "callback?", + "type": "Callback", + "description": "" } ], "returns": { - "type": "KeyScanCursor", - "description": "KeyScanCursor scan cursor." + "type": "Any", + "description": "" } } ], - "lettuce_async": [ - { - "signature": "RedisFuture> scan()", - "params": [], - "returns": { - "type": "RedisFuture>", - "description": "KeyScanCursor scan cursor." - } - }, + "redis_rs_sync": [ { - "signature": "RedisFuture> scan(ScanArgs scanArgs)", + "signature": "setrange(key: K, offset: isize, value: V)", "params": [ { - "name": "scanArgs", - "type": "ScanArgs", - "description": "scan arguments." - } - ], - "returns": { - "type": "RedisFuture>", - "description": "KeyScanCursor scan cursor." - } - }, - { - "signature": "RedisFuture> scan(ScanCursor scanCursor)", - "params": [ + "name": "key", + "type": "K", + "description": "" + }, { - "name": "scanCursor", - "type": "ScanCursor", - "description": "cursor to resume from a previous scan." + "name": "offset", + "type": "isize", + "description": "" + }, + { + "name": "value", + "type": "V", + "description": "" } ], "returns": { - "type": "RedisFuture>", - "description": "KeyScanCursor scan cursor." + "type": "(usize)", + "description": "" } - }, + } + ], + "redis_rs_async": [ { - "signature": "RedisFuture> scan(ScanCursor scanCursor, ScanArgs scanArgs)", + "signature": "setrange(key: K, offset: isize, value: V)", "params": [ { - "name": "scanCursor", - "type": "ScanCursor", - "description": "cursor to resume from a previous scan." + "name": "key", + "type": "K", + "description": "" }, { - "name": "scanArgs", - "type": "ScanArgs", - "description": "scan arguments." + "name": "offset", + "type": "isize", + "description": "" + }, + { + "name": "value", + "type": "V", + "description": "" } ], "returns": { - "type": "RedisFuture>", - "description": "KeyScanCursor scan cursor." + "type": "(usize)", + "description": "" } } ], - "lettuce_reactive": [ - { - "signature": "Mono> scan()", - "params": [], - "returns": { - "type": "Mono>", - "description": "KeyScanCursor scan cursor." - } - }, + "nredisstack_sync": [ { - "signature": "Mono> scan(ScanArgs scanArgs)", + "signature": "StringSetRange(RedisKey key, long offset, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "scanArgs", - "type": "ScanArgs", - "description": "scan arguments." - } - ], - "returns": { - "type": "Mono>", - "description": "KeyScanCursor scan cursor." - } - }, - { - "signature": "Mono> scan(ScanCursor scanCursor)", - "params": [ + "name": "key", + "type": "RedisKey", + "description": "The key of the string." + }, { - "name": "scanCursor", - "type": "ScanCursor", - "description": "cursor to resume from a previous scan." + "name": "offset", + "type": "long", + "description": "The offset in the string to overwrite." + }, + { + "name": "value", + "type": "RedisValue", + "description": "The value to overwrite with." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Mono>", - "description": "KeyScanCursor scan cursor." + "type": "RedisValue", + "description": "The length of the string after it was modified by the command." } }, { - "signature": "Mono> scan(ScanCursor scanCursor, ScanArgs scanArgs)", + "signature": "StringSetRange(RedisKey key, long offset, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "scanCursor", - "type": "ScanCursor", - "description": "cursor to resume from a previous scan." + "name": "key", + "type": "RedisKey", + "description": "The key of the string." }, { - "name": "scanArgs", - "type": "ScanArgs", - "description": "scan arguments." + "name": "offset", + "type": "long", + "description": "The offset in the string to overwrite." + }, + { + "name": "value", + "type": "RedisValue", + "description": "The value to overwrite with." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Mono>", - "description": "KeyScanCursor scan cursor." + "type": "RedisValue", + "description": "The length of the string after it was modified by the command." } } ], - "nredisstack_sync": [ + "nredisstack_async": [ { - "signature": "Scan(RedisValue pattern = default, int pageSize = 250, long cursor = 0, int pageOffset = 0, CommandFlags flags = CommandFlags.None)", + "signature": "StringSetRange(RedisKey key, long offset, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "pattern", - "type": "RedisValue", - "description": "The pattern to match." - }, - { - "name": "pageSize", - "type": "int", - "description": "The page size." + "name": "key", + "type": "RedisKey", + "description": "The key of the string." }, { - "name": "cursor", + "name": "offset", "type": "long", - "description": "The cursor." + "description": "The offset in the string to overwrite." }, { - "name": "pageOffset", - "type": "int", - "description": "The page offset." + "name": "value", + "type": "RedisValue", + "description": "The value to overwrite with." }, { "name": "flags", @@ -97377,34 +104458,27 @@ } ], "returns": { - "type": "IEnumerable", - "description": "The keys matching the pattern." + "type": "RedisValue", + "description": "The length of the string after it was modified by the command." } - } - ], - "nredisstack_async": [ + }, { - "signature": "Scan(RedisValue pattern = default, int pageSize = 250, long cursor = 0, int pageOffset = 0, CommandFlags flags = CommandFlags.None)", + "signature": "StringSetRange(RedisKey key, long offset, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "pattern", - "type": "RedisValue", - "description": "The pattern to match." - }, - { - "name": "pageSize", - "type": "int", - "description": "The page size." + "name": "key", + "type": "RedisKey", + "description": "The key of the string." }, { - "name": "cursor", + "name": "offset", "type": "long", - "description": "The cursor." + "description": "The offset in the string to overwrite." }, { - "name": "pageOffset", - "type": "int", - "description": "The page offset." + "name": "value", + "type": "RedisValue", + "description": "The value to overwrite with." }, { "name": "flags", @@ -97413,174 +104487,147 @@ } ], "returns": { - "type": "IAsyncEnumerable", - "description": "The keys matching the pattern." + "type": "RedisValue", + "description": "The length of the string after it was modified by the command." } } ], "php": [ { - "signature": "scan(?int &$iterator, string|array|null $pattern = null, int $count = 0, string $type = null)", + "signature": "setrange(string $key, $offset, $value)", "params": [ { - "name": "&$iterator", - "type": "?int", - "description": "" - }, - { - "name": "$pattern", - "type": "string|array|null", + "name": "$key", + "type": "string", "description": "" }, { - "name": "$count", - "type": "int", + "name": "$offset", + "type": "Any", "description": "" }, { - "name": "$type", - "type": "string", + "name": "$value", + "type": "Any", "description": "" } ], "returns": { - "type": "array|bool", + "type": "int", "description": "" } } ], "redis_rb": [ { - "signature": "scan(cursor, **options)", + "signature": "setrange(key, offset, value)", "params": [ { - "name": "cursor", - "type": "String, Integer", - "description": "the cursor of the iteration" - }, - { - "name": "match", + "name": "key", "type": "String", - "description": "only return keys matching the pattern" + "description": "" }, { - "name": "count", + "name": "offset", "type": "Integer", - "description": "return count keys at most per iteration" + "description": "byte offset" }, { - "name": "type", + "name": "value", "type": "String", - "description": "return keys only of the given type" + "description": "" } ], "returns": { - "type": "Array", - "description": "the next cursor and all found keys" + "type": "Integer", + "description": "length of the string after it was modified" } } ] } }, - "SCARD": { + "SEXPIRE": { "api_calls": { "redis_py": [ { - "signature": "scard(name: KeyT)", + "signature": "sexpire(name: KeyT, seconds: ExpiryT, *members: FieldT, nx: bool = False, xx: bool = False, gt: bool = False, lt: bool = False)", "params": [ { "name": "name", "type": "KeyT", "description": "" - } - ], - "returns": { - "type": "Union[Awaitable[int], int]", - "description": "" - } - } - ], - "jedis": [ - { - "signature": "long scard(final byte[] key)", - "params": [ + }, { - "name": "key", - "type": "byte[]", + "name": "seconds", + "type": "ExpiryT", "description": "" - } - ], - "returns": { - "type": "long", - "description": "The cardinality (number of elements) of the set as an integer" - } - }, - { - "signature": "long scard(final String key)", - "params": [ + }, { - "name": "key", - "type": "String", + "name": "*members", + "type": "FieldT", "description": "" - } - ], - "returns": { - "type": "long", - "description": "The cardinality (number of elements) of the set as an integer" - } - } - ], - "lettuce_sync": [ - { - "signature": "Long scard(K key)", - "params": [ + }, { - "name": "key", - "type": "K", - "description": "the key." - } - ], - "returns": { - "type": "Long", - "description": "Long integer-reply the cardinality (number of elements) of the set, or false if key does not exist." - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture scard(K key)", - "params": [ + "name": "nx", + "type": "bool", + "description": "" + }, + { + "name": "xx", + "type": "bool", + "description": "" + }, + { + "name": "gt", + "type": "bool", + "description": "" + }, { - "name": "key", - "type": "K", - "description": "the key." + "name": "lt", + "type": "bool", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Long integer-reply the cardinality (number of elements) of the set, or false if key does not exist." + "type": "list[int]", + "description": "" } } ], - "lettuce_reactive": [ + "node_redis": [ { - "signature": "Mono scard(K key)", + "signature": "sExpire(key: RedisArgument, members: RedisVariadicArgument, seconds: number, mode?: 'NX' | 'XX' | 'GT' | 'LT')", "params": [ { "name": "key", - "type": "K", - "description": "the key." + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + }, + { + "name": "seconds", + "type": "number", + "description": "" + }, + { + "name": "mode?", + "type": "'NX' | 'XX' | 'GT' | 'LT'", + "description": "" } ], "returns": { - "type": "Mono", - "description": "Long integer-reply the cardinality (number of elements) of the set, or false if key does not exist." + "type": "ArrayReply>", + "description": "" } } ], "go-redis": [ { - "signature": "SCard(ctx context.Context, key string)", + "signature": "SExpire(ctx context.Context, key string, expiration time.Duration, members ...string) *IntSliceCmd", "params": [ { "name": "ctx", @@ -97591,2242 +104638,2484 @@ "name": "key", "type": "string", "description": "" - } - ], - "returns": { - "type": "*IntCmd", - "description": "" - } - } - ], - "node_redis": [ - { - "signature": "SCARD(key: RedisArgument)", - "params": [ + }, { - "name": "key", - "type": "RedisArgument", + "name": "expiration", + "type": "time.Duration", + "description": "" + }, + { + "name": "members", + "type": "...string", "description": "" } ], "returns": { - "type": "Any", + "type": "*IntSliceCmd", "description": "" } - } - ], - "ioredis": [ + }, { - "signature": "scard(key: RedisKey, callback?: Callback): Result;, /**, * Set the debug mode for executed scripts., * - _group_: scripting, * - _complexity_: O(1), * - _since_: 3.2.0, */, script(, subcommand: \"DEBUG\", yes: \"YES\", callback?: Callback)", + "signature": "SExpireWithArgs(ctx context.Context, key string, expiration time.Duration, condition SExpireCondition, members ...string) *IntSliceCmd", "params": [ { - "name": "key", - "type": "RedisKey", + "name": "ctx", + "type": "context.Context", "description": "" }, { - "name": "callback?", - "type": "Callback)", + "name": "key", + "type": "string", "description": "" }, { - "name": "subcommand", - "type": "\"DEBUG\"", + "name": "expiration", + "type": "time.Duration", "description": "" }, { - "name": "yes", - "type": "\"YES\"", + "name": "condition", + "type": "SExpireCondition", "description": "" }, { - "name": "callback?", - "type": "Callback", + "name": "members", + "type": "...string", "description": "" } ], "returns": { - "type": "Any", + "type": "*IntSliceCmd", "description": "" } } ], - "redis_rs_sync": [ + "php": [ { - "signature": "scard(key: K)", + "signature": "sexpire(string $key, int $seconds, array $members, ?string $flag = null)", "params": [ { - "name": "key", - "type": "K", + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$seconds", + "type": "int", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + }, + { + "name": "$flag", + "type": "?string", "description": "" } ], "returns": { - "type": "(usize)", + "type": "array", "description": "" } } ], - "redis_rs_async": [ + "redis_rb": [ { - "signature": "scard(key: K)", + "signature": "sexpire(key, ttl, *members, nx: nil, xx: nil, gt: nil, lt: nil)", "params": [ { "name": "key", - "type": "K", + "type": "String", + "description": "" + }, + { + "name": "ttl", + "type": "Integer", + "description": "" + }, + { + "name": "*members", + "type": "Array", + "description": "" + }, + { + "name": "nx", + "type": "Boolean", + "description": "" + }, + { + "name": "xx", + "type": "Boolean", + "description": "" + }, + { + "name": "gt", + "type": "Boolean", + "description": "" + }, + { + "name": "lt", + "type": "Boolean", "description": "" } ], "returns": { - "type": "(usize)", + "type": "Array", "description": "" } } ], - "nredisstack_sync": [ + "lettuce_sync": [ { - "signature": "SetLength(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "List sexpire(K key, long seconds, V... members)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "long", - "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetLength(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "Long sexpire(K key, long seconds, V member)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "long", - "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "nredisstack_async": [ + }, { - "signature": "SetLength(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "List sexpire(K key, long seconds, ExpireArgs expireArgs, V... members)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "long", - "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetLength(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "Long sexpire(K key, long seconds, ExpireArgs expireArgs, V member)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "long", - "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." - } - } - ], - "php": [ - { - "signature": "scard(string $key)", - "params": [ + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, { - "name": "$key", - "type": "string", - "description": "" + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "int", - "description": "" + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "redis_rb": [ + }, { - "signature": "scard(key)", + "signature": "List sexpire(K key, Duration seconds, V... members)", "params": [ { "name": "key", - "type": "String", - "description": "" - } - ], - "returns": { - "type": "Integer", - "description": "" - } - } - ] - } - }, - "SCRIPT DEBUG": { - "api_calls": { - "redis_py": [ - { - "signature": "script_debug(*args)", - "params": [ + "type": "K", + "description": "the key of the set, must not be null." + }, { - "name": "*args", - "type": "Any", - "description": "Debug mode arguments" - } - ], - "returns": { - "type": "None", - "description": "No return value" - } - } - ], - "jedis": [], - "go-redis": [], - "node_redis": [ - { - "signature": "scriptDebug(mode: 'YES' | 'SYNC' | 'NO')", - "params": [ + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, { - "name": "mode", - "type": "'YES' | 'SYNC' | 'NO'", - "description": "Debug mode" + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "Promise>", - "description": "Status response" + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], - "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + }, { - "signature": "script($subcommand, $argument = null)", + "signature": "Long sexpire(K key, Duration seconds, V member)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "SCRIPT subcommand (e.g., 'DEBUG')" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "$argument", - "type": "mixed", - "description": "Optional argument for the subcommand" - } - ], - "returns": { - "type": "mixed", - "description": "Command result" - } - } - ] - } - }, - "SCRIPT EXISTS": { - "api_calls": { - "redis_py": [ - { - "signature": "script_exists(*args: str)", - "params": [ - { - "name": "*args", - "type": "str", - "description": "SHA1 digests to check" - } - ], - "returns": { - "type": "ResponseT", - "description": "List of boolean values indicating script existence" - } - } - ], - "jedis": [ - { - "signature": "Boolean scriptExists(final String sha1)", - "params": [ + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, { - "name": "sha1", - "type": "String", - "description": "SHA1 digest to check" + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "Boolean", - "description": "True if script exists" + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "List scriptExists(final String... sha1)", + "signature": "List sexpire(K key, Duration seconds, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "sha1", - "type": "String...", - "description": "SHA1 digests to check" - } - ], - "returns": { - "type": "List", - "description": "List of boolean values indicating script existence" - } - } - ], - "go-redis": [ - { - "signature": "ScriptExists(ctx context.Context, hashes ...string)", - "params": [ + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, { - "name": "ctx", - "type": "context.Context", - "description": "Context for the operation" + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." }, { - "name": "hashes", - "type": "...string", - "description": "SHA1 digests to check" - } - ], - "returns": { - "type": "*BoolSliceCmd", - "description": "List of boolean values indicating script existence" - } - } - ], - "node_redis": [ - { - "signature": "scriptExists(sha1: RedisVariadicArgument)", - "params": [ + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, { - "name": "sha1", - "type": "RedisVariadicArgument", - "description": "One or more SHA1 digests of scripts" + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "Promise>", - "description": "Array of 1s and 0s indicating script existence" + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "lettuce_sync": [ + }, { - "signature": "List scriptExists(String... digests)", + "signature": "Long sexpire(K key, Duration seconds, ExpireArgs expireArgs, V member)", "params": [ { - "name": "digests", - "type": "String...", - "description": "SHA1 digests" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "List", - "description": "List of boolean values indicating script existence" + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], "lettuce_async": [ { - "signature": "RedisFuture> scriptExists(String... digests)", + "signature": "RedisFuture> sexpire(K key, long seconds, V... members)", "params": [ { - "name": "digests", - "type": "String...", - "description": "SHA1 digests" - } - ], - "returns": { - "type": "RedisFuture>", - "description": "List of boolean values indicating script existence" - } - } - ], - "lettuce_reactive": [ - { - "signature": "Flux scriptExists(String... digests)", - "params": [ + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, { - "name": "digests", - "type": "String...", - "description": "SHA1 digests" + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "Flux", - "description": "Boolean values indicating script existence" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], - "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + }, { - "signature": "script($subcommand, $argument = null)", + "signature": "RedisFuture sexpire(K key, long seconds, V member)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "SCRIPT subcommand (e.g., 'EXISTS')" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "$argument", - "type": "mixed", - "description": "Optional argument for the subcommand" + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "mixed", - "description": "Command result" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ] - } - }, - "SCRIPT FLUSH": { - "api_calls": { - "redis_py": [ + }, { - "signature": "script_flush(sync_type: Union[Literal[\"SYNC\"], Literal[\"ASYNC\"]] = None)", + "signature": "RedisFuture> sexpire(K key, long seconds, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "sync_type", - "type": "Union[Literal[\"SYNC\"], Literal[\"ASYNC\"]]", - "description": "Flush mode (SYNC or ASYNC)" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "ResponseT", - "description": "Status response" - } - } - ], - "jedis": [ - { - "signature": "String scriptFlush()", - "params": [], - "returns": { - "type": "String", - "description": "Status response" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "String scriptFlush(final FlushMode flushMode)", + "signature": "RedisFuture sexpire(K key, long seconds, ExpireArgs expireArgs, V member)", "params": [ { - "name": "flushMode", - "type": "FlushMode", - "description": "Flush mode (SYNC or ASYNC)" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "String", - "description": "Status response" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "go-redis": [ + }, { - "signature": "ScriptFlush(ctx context.Context)", + "signature": "RedisFuture> sexpire(K key, Duration seconds, V... members)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context for the operation" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "*StatusCmd", - "description": "Status response" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "node_redis": [ + }, { - "signature": "scriptFlush(mode?: 'ASYNC' | 'SYNC')", + "signature": "RedisFuture sexpire(K key, Duration seconds, V member)", "params": [ { - "name": "mode", - "type": "'ASYNC' | 'SYNC'", - "description": "Optional flush mode" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "Promise>", - "description": "Status response" - } - } - ], - "lettuce_sync": [ - { - "signature": "String scriptFlush()", - "params": [], - "returns": { - "type": "String", - "description": "Status response" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "String scriptFlush(FlushMode flushMode)", + "signature": "RedisFuture> sexpire(K key, Duration seconds, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "flushMode", - "type": "FlushMode", - "description": "Flush mode (SYNC or ASYNC)" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "String", - "description": "Status response" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture scriptFlush()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "Status response" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "RedisFuture scriptFlush(FlushMode flushMode)", + "signature": "RedisFuture sexpire(K key, Duration seconds, ExpireArgs expireArgs, V member)", "params": [ { - "name": "flushMode", - "type": "FlushMode", - "description": "Flush mode (SYNC or ASYNC)" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "RedisFuture", - "description": "Status response" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], "lettuce_reactive": [ { - "signature": "Mono scriptFlush()", - "params": [], + "signature": "Flux sexpire(K key, long seconds, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], "returns": { - "type": "Mono", - "description": "Status response" + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "Mono scriptFlush(FlushMode flushMode)", + "signature": "Mono sexpire(K key, long seconds, V member)", "params": [ { - "name": "flushMode", - "type": "FlushMode", - "description": "Flush mode (SYNC or ASYNC)" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "Mono", - "description": "Status response" + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], - "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + }, { - "signature": "script($subcommand, $argument = null)", + "signature": "Flux sexpire(K key, long seconds, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "SCRIPT subcommand (e.g., 'FLUSH')" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "$argument", - "type": "mixed", - "description": "Optional argument for the subcommand" + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "mixed", - "description": "Command result" - } - } - ] - } - }, - "SCRIPT HELP": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], - "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [] - } - }, - "SCRIPT KILL": { - "api_calls": { - "redis_py": [ - { - "signature": "script_kill()", - "params": [], - "returns": { - "type": "ResponseT", - "description": "Status response" - } - } - ], - "jedis": [ - { - "signature": "String scriptKill()", - "params": [], - "returns": { - "type": "String", - "description": "Status response" + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "go-redis": [ + }, { - "signature": "ScriptKill(ctx context.Context)", + "signature": "Mono sexpire(K key, long seconds, ExpireArgs expireArgs, V member)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context for the operation" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "*StatusCmd", - "description": "Status response" - } - } - ], - "node_redis": [ - { - "signature": "scriptKill()", - "params": [], - "returns": { - "type": "Promise>", - "description": "Status response" - } - } - ], - "lettuce_sync": [ - { - "signature": "String scriptKill()", - "params": [], - "returns": { - "type": "String", - "description": "Status response" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture scriptKill()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "Status response" - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono scriptKill()", - "params": [], - "returns": { - "type": "Mono", - "description": "Status response" + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], - "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + }, { - "signature": "script($subcommand, $argument = null)", + "signature": "Flux sexpire(K key, Duration seconds, V... members)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "SCRIPT subcommand (e.g., 'KILL')" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "$argument", - "type": "mixed", - "description": "Optional argument for the subcommand" + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "mixed", - "description": "Command result" + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ] - } - }, - "SCRIPT LOAD": { - "api_calls": { - "redis_py": [ + }, { - "signature": "script_load(script: ScriptTextT)", + "signature": "Mono sexpire(K key, Duration seconds, V member)", "params": [ { - "name": "script", - "type": "ScriptTextT", - "description": "Lua script to load" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "ResponseT", - "description": "SHA1 digest of the script" + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "jedis": [ + }, { - "signature": "String scriptLoad(final String script)", + "signature": "Flux sexpire(K key, Duration seconds, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "script", - "type": "String", - "description": "Lua script to load" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "String", - "description": "SHA1 digest of the script" + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "go-redis": [ + }, { - "signature": "ScriptLoad(ctx context.Context, script string)", + "signature": "Mono sexpire(K key, Duration seconds, ExpireArgs expireArgs, V member)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context for the operation" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "script", - "type": "string", - "description": "Lua script to load" + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "*StringCmd", - "description": "SHA1 digest of the script" + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], - "node_redis": [ + "jedis": [ { - "signature": "scriptLoad(script: RedisArgument)", + "signature": "List sexpire(byte[] key, long seconds, byte[]... members)", "params": [ { - "name": "script", - "type": "RedisArgument", - "description": "Lua script to load" + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" } ], "returns": { - "type": "Promise", - "description": "SHA1 digest of the script" + "type": "List", + "description": "" } - } - ], - "lettuce_sync": [ + }, { - "signature": "String scriptLoad(String script)", + "signature": "List sexpire(byte[] key, long seconds, ExpiryOption condition, byte[]... members)", "params": [ { - "name": "script", - "type": "String", - "description": "Lua script" + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" } ], "returns": { - "type": "String", - "description": "SHA1 digest of the script" + "type": "List", + "description": "" } }, { - "signature": "String scriptLoad(byte[] script)", + "signature": "long sexpire(byte[] key, long seconds, byte[] member)", "params": [ { - "name": "script", + "name": "key", "type": "byte[]", - "description": "Lua script" + "description": "" + }, + { + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" } ], "returns": { - "type": "String", - "description": "SHA1 digest of the script" + "type": "long", + "description": "" } - } - ], - "lettuce_async": [ + }, { - "signature": "RedisFuture scriptLoad(String script)", + "signature": "long sexpire(byte[] key, long seconds, ExpiryOption condition, byte[] member)", "params": [ { - "name": "script", - "type": "String", - "description": "Lua script" + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "SHA1 digest of the script" + "type": "long", + "description": "" } }, { - "signature": "RedisFuture scriptLoad(byte[] script)", + "signature": "List sexpire(String key, long seconds, String... members)", "params": [ { - "name": "script", - "type": "byte[]", - "description": "Lua script" + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "SHA1 digest of the script" + "type": "List", + "description": "" } - } - ], - "lettuce_reactive": [ + }, { - "signature": "Mono scriptLoad(String script)", + "signature": "List sexpire(String key, long seconds, ExpiryOption condition, String... members)", "params": [ { - "name": "script", + "name": "key", "type": "String", - "description": "Lua script" + "description": "" + }, + { + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" } ], "returns": { - "type": "Mono", - "description": "SHA1 digest of the script" + "type": "List", + "description": "" } }, { - "signature": "Mono scriptLoad(byte[] script)", + "signature": "long sexpire(String key, long seconds, String member)", "params": [ { - "name": "script", - "type": "byte[]", - "description": "Lua script" + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" } ], "returns": { - "type": "Mono", - "description": "SHA1 digest of the script" + "type": "long", + "description": "" } - } - ], - "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], - "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + }, { - "signature": "script($subcommand, $argument = null)", + "signature": "long sexpire(String key, long seconds, ExpiryOption condition, String member)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "SCRIPT subcommand (e.g., 'LOAD')" + "name": "key", + "type": "String", + "description": "" }, { - "name": "$argument", - "type": "mixed", - "description": "Optional argument for the subcommand" + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" } ], "returns": { - "type": "mixed", - "description": "Command result" + "type": "long", + "description": "" } } ] } }, - "SDIFF": { + "SEXPIREAT": { "api_calls": { "redis_py": [ { - "signature": "sdiff(keys: List, *args: List)", + "signature": "sexpireat(name: KeyT, unix_time_seconds: AbsExpiryT, *members: FieldT, nx: bool = False, xx: bool = False, gt: bool = False, lt: bool = False)", "params": [ { - "name": "keys", - "type": "List", + "name": "name", + "type": "KeyT", "description": "" }, { - "name": "*args", - "type": "List", + "name": "unix_time_seconds", + "type": "AbsExpiryT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", + "description": "" + }, + { + "name": "nx", + "type": "bool", + "description": "" + }, + { + "name": "xx", + "type": "bool", + "description": "" + }, + { + "name": "gt", + "type": "bool", + "description": "" + }, + { + "name": "lt", + "type": "bool", "description": "" } ], "returns": { - "type": "Union[Awaitable[list], list]", + "type": "list[int]", "description": "" } } ], - "jedis": [ + "node_redis": [ { - "signature": "Set sdiff(final String... keys)", + "signature": "sExpireAt(key: RedisArgument, members: RedisVariadicArgument, timestamp: number | Date, mode?: 'NX' | 'XX' | 'GT' | 'LT')", "params": [ { - "name": "keys", - "type": "String...", + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + }, + { + "name": "timestamp", + "type": "number | Date", + "description": "" + }, + { + "name": "mode?", + "type": "'NX' | 'XX' | 'GT' | 'LT'", "description": "" } ], "returns": { - "type": "Set", - "description": "A set with members of the resulting set" + "type": "ArrayReply>", + "description": "" } } ], - "lettuce_sync": [ + "go-redis": [ { - "signature": "Set sdiff(K... keys)", + "signature": "SExpireAt(ctx context.Context, key string, tm time.Time, members ...string) *IntSliceCmd", "params": [ { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "tm", + "type": "time.Time", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" } ], "returns": { - "type": "Set", - "description": "Long count of members of the resulting set." + "type": "*IntSliceCmd", + "description": "" } }, { - "signature": "Long sdiff(ValueStreamingChannel channel, K... keys)", + "signature": "SExpireAtWithArgs(ctx context.Context, key string, tm time.Time, condition SExpireCondition, members ...string) *IntSliceCmd", "params": [ { - "name": "channel", - "type": "ValueStreamingChannel", - "description": "the channel." + "name": "ctx", + "type": "context.Context", + "description": "" }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "tm", + "type": "time.Time", + "description": "" + }, + { + "name": "condition", + "type": "SExpireCondition", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" } ], "returns": { - "type": "Long", - "description": "Long count of members of the resulting set." + "type": "*IntSliceCmd", + "description": "" } } ], - "lettuce_async": [ + "php": [ { - "signature": "RedisFuture> sdiff(K... keys)", + "signature": "sexpireat(string $key, int $unixTimeSeconds, array $members, ?string $flag = null)", "params": [ { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$unixTimeSeconds", + "type": "int", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + }, + { + "name": "$flag", + "type": "?string", + "description": "" } ], "returns": { - "type": "RedisFuture>", - "description": "Long count of members of the resulting set." + "type": "array", + "description": "" } - }, + } + ], + "redis_rb": [ { - "signature": "RedisFuture sdiff(ValueStreamingChannel channel, K... keys)", + "signature": "sexpireat(key, unix_time_seconds, *members, nx: nil, xx: nil, gt: nil, lt: nil)", "params": [ { - "name": "channel", - "type": "ValueStreamingChannel", - "description": "the channel." + "name": "key", + "type": "String", + "description": "" }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "unix_time_seconds", + "type": "Integer", + "description": "" + }, + { + "name": "*members", + "type": "Array", + "description": "" + }, + { + "name": "nx", + "type": "Boolean", + "description": "" + }, + { + "name": "xx", + "type": "Boolean", + "description": "" + }, + { + "name": "gt", + "type": "Boolean", + "description": "" + }, + { + "name": "lt", + "type": "Boolean", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Long count of members of the resulting set." + "type": "Array", + "description": "" } } ], - "lettuce_reactive": [ + "lettuce_sync": [ { - "signature": "Flux sdiff(K... keys)", + "signature": "List sexpireat(K key, long timestamp, V... members)", "params": [ { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "Flux", - "description": "Long count of members of the resulting set. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #sdiff." + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "Mono sdiff(ValueStreamingChannel channel, K... keys)", + "signature": "Long sexpireat(K key, long timestamp, V member)", "params": [ { - "name": "channel", - "type": "ValueStreamingChannel", - "description": "the channel." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "Mono", - "description": "Long count of members of the resulting set. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #sdiff." + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "go-redis": [ + }, { - "signature": "SDiff(ctx context.Context, keys ...string)", + "signature": "List sexpireat(K key, long timestamp, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "...string", - "description": "" - } - ], - "returns": { - "type": "*StringSliceCmd", - "description": "" - } - } - ], - "node_redis": [ - { - "signature": "SDIFF(keys: RedisVariadicArgument)", - "params": [ + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, { - "name": "keys", - "type": "RedisVariadicArgument", - "description": "" + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "Any", - "description": "" + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "ioredis": [ + }, { - "signature": "sdiff(...args: [...keys: RedisKey[], callback: Callback])", + "signature": "Long sexpireat(K key, long timestamp, ExpireArgs expireArgs, V member)", "params": [ { - "name": "...args", - "type": "[...keys", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "Any", - "description": "" + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "sdiff(...args: [keys: RedisKey[], callback: Callback])", + "signature": "List sexpireat(K key, Date timestamp, V... members)", "params": [ { - "name": "...args", - "type": "[keys", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "Any", - "description": "" + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "sdiff(...args: [...keys: RedisKey[]]): Result;, sdiffBuffer(...args: [...keys: RedisKey[]]): Result;, sdiff(...args: [keys: RedisKey[]]): Result;, sdiffBuffer(...args: [keys: RedisKey[]]): Result;, /**, * Subtract multiple sets and store the resulting set in a key, * - _group_: set, * - _complexity_: O(N) where N is the total number of elements in all given sets., * - _since_: 1.0.0, */, sdiffstore(, ...args: [, destination: RedisKey, ...keys: RedisKey[], callback: Callback, ])", + "signature": "Long sexpireat(K key, Date timestamp, V member)", "params": [ { - "name": "...args", - "type": "[...keys", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "...args", - "type": "[, destination", - "description": "" + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "Any", - "description": "" + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "redis_rs_sync": [ + }, { - "signature": "sdiff(keys: K)", + "signature": "List sexpireat(K key, Date timestamp, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "keys", + "name": "key", "type": "K", - "description": "" + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "(HashSet)", - "description": "" + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "redis_rs_async": [ + }, { - "signature": "sdiff(keys: K)", + "signature": "Long sexpireat(K key, Date timestamp, ExpireArgs expireArgs, V member)", "params": [ { - "name": "keys", + "name": "key", "type": "K", - "description": "" + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "(HashSet)", - "description": "" + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "nredisstack_sync": [ + }, { - "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "List sexpireat(K key, Instant timestamp, V... members)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "first", - "type": "RedisKey", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "second", - "type": "RedisKey", - "description": "" + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "RedisValue[]", - "description": "List with members of the resulting set." + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "signature": "Long sexpireat(K key, Instant timestamp, V member)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "RedisValue[]", - "description": "List with members of the resulting set." + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "List sexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "first", - "type": "RedisKey", - "description": "" + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." }, { - "name": "second", - "type": "RedisKey", - "description": "" + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "RedisValue[]", - "description": "List with members of the resulting set." + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "signature": "Long sexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V member)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "RedisValue[]", - "description": "List with members of the resulting set." + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], - "nredisstack_async": [ + "lettuce_async": [ { - "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture> sexpireat(K key, long timestamp, V... members)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "first", - "type": "RedisKey", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "second", - "type": "RedisKey", - "description": "" + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "RedisValue[]", - "description": "List with members of the resulting set." + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture sexpireat(K key, long timestamp, V member)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "RedisValue[]", - "description": "List with members of the resulting set." + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture> sexpireat(K key, long timestamp, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "first", - "type": "RedisKey", - "description": "" + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." }, { - "name": "second", - "type": "RedisKey", - "description": "" + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "RedisValue[]", - "description": "List with members of the resulting set." + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture sexpireat(K key, long timestamp, ExpireArgs expireArgs, V member)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "RedisValue[]", - "description": "List with members of the resulting set." - } - } - ], - "php": [ - { - "signature": "sdiff(array|string $keys)", - "params": [ + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, { - "name": "$keys", - "type": "array|string", - "description": "" + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "string[]", - "description": "" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "redis_rb": [ + }, { - "signature": "sdiff(*keys)", + "signature": "RedisFuture> sexpireat(K key, Date timestamp, V... members)", "params": [ { - "name": "*keys", - "type": "String, Array", - "description": "keys pointing to sets to subtract" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "Array", - "description": "members in the difference" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ] - } - }, - "SDIFFSTORE": { - "api_calls": { - "redis_py": [ + }, { - "signature": "sdiffstore(dest: str, keys: List, *args: List)", + "signature": "RedisFuture sexpireat(K key, Date timestamp, V member)", "params": [ { - "name": "dest", - "type": "str", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "List", - "description": "" + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." }, { - "name": "*args", - "type": "List", - "description": "" + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "Union[Awaitable[int], int]", - "description": "" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "jedis": [ + }, { - "signature": "long sdiffstore(final byte[] dstkey, final byte[]... keys)", + "signature": "RedisFuture> sexpireat(K key, Date timestamp, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "dstkey", - "type": "byte[]", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "byte[]...", - "description": "" + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "long", - "description": "The number of elements in the resulting set" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "long sdiffstore(final String dstkey, final String... keys)", + "signature": "RedisFuture sexpireat(K key, Date timestamp, ExpireArgs expireArgs, V member)", "params": [ { - "name": "dstkey", - "type": "String", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "String...", - "description": "" + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "long", - "description": "The number of elements in the resulting set" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "lettuce_sync": [ + }, { - "signature": "Long sdiffstore(K destination, K... keys)", + "signature": "RedisFuture> sexpireat(K key, Instant timestamp, V... members)", "params": [ { - "name": "destination", + "name": "key", "type": "K", - "description": "the destination type: key." + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "K...", - "description": "the key." + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "Long", - "description": "Long integer-reply the number of elements in the resulting set." + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "lettuce_async": [ + }, { - "signature": "RedisFuture sdiffstore(K destination, K... keys)", + "signature": "RedisFuture sexpireat(K key, Instant timestamp, V member)", "params": [ { - "name": "destination", + "name": "key", "type": "K", - "description": "the destination type: key." + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "K...", - "description": "the key." + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { "type": "RedisFuture", - "description": "Long integer-reply the number of elements in the resulting set." + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "lettuce_reactive": [ + }, { - "signature": "Mono sdiffstore(K destination, K... keys)", + "signature": "RedisFuture> sexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "destination", + "name": "key", "type": "K", - "description": "the destination type: key." + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "K...", - "description": "the key." + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "Mono", - "description": "Long integer-reply the number of elements in the resulting set." + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "go-redis": [ + }, { - "signature": "SDiffStore(ctx context.Context, destination string, keys ...string)", + "signature": "RedisFuture sexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V member)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "destination", - "type": "string", - "description": "" + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." }, { - "name": "keys", - "type": "...string", - "description": "" + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "*IntCmd", - "description": "" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], - "node_redis": [ + "lettuce_reactive": [ { - "signature": "SDIFFSTORE(destination: RedisArgument, keys: RedisVariadicArgument)", + "signature": "Flux sexpireat(K key, long timestamp, V... members)", "params": [ { - "name": "destination", - "type": "RedisArgument", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "RedisVariadicArgument", - "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - } - ], - "ioredis": [ - { - "signature": "sdiffstore(...args: [, destination: RedisKey, keys: RedisKey[], callback: Callback, ])", - "params": [ + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, { - "name": "...args", - "type": "[, destination", - "description": "" + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "Any", - "description": "" + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "sdiffstore(...args: [destination: RedisKey, ...keys: RedisKey[]])", + "signature": "Mono sexpireat(K key, long timestamp, V member)", "params": [ { - "name": "...args", - "type": "[destination", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "Any", - "description": "" + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "sdiffstore(...args: [destination: RedisKey, keys: RedisKey[]])", + "signature": "Flux sexpireat(K key, long timestamp, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "...args", - "type": "[destination", - "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - } - ], - "redis_rs_sync": [ - { - "signature": "sdiffstore(dstkey: D, keys: K)", - "params": [ + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, { - "name": "dstkey", - "type": "D", - "description": "" + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." }, { - "name": "keys", - "type": "K", - "description": "" + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "(usize)", - "description": "" + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "redis_rs_async": [ + }, { - "signature": "sdiffstore(dstkey: D, keys: K)", + "signature": "Mono sexpireat(K key, long timestamp, ExpireArgs expireArgs, V member)", "params": [ { - "name": "dstkey", - "type": "D", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "K", - "description": "" + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "(usize)", - "description": "" + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "nredisstack_sync": [ + }, { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "Flux sexpireat(K key, Date timestamp, V... members)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." - }, - { - "name": "first", - "type": "RedisKey", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "second", - "type": "RedisKey", - "description": "" + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "long", - "description": "The number of elements in the resulting set." + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "signature": "Mono sexpireat(K key, Date timestamp, V member)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "long", - "description": "The number of elements in the resulting set." + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "Flux sexpireat(K key, Date timestamp, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "first", - "type": "RedisKey", - "description": "" + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." }, { - "name": "second", - "type": "RedisKey", - "description": "" + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "long", - "description": "The number of elements in the resulting set." + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "signature": "Mono sexpireat(K key, Date timestamp, ExpireArgs expireArgs, V member)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." }, { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "long", - "description": "The number of elements in the resulting set." + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "nredisstack_async": [ + }, { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "Flux sexpireat(K key, Instant timestamp, V... members)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." - }, - { - "name": "first", - "type": "RedisKey", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "second", - "type": "RedisKey", - "description": "" + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "long", - "description": "The number of elements in the resulting set." + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "signature": "Mono sexpireat(K key, Instant timestamp, V member)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "long", - "description": "The number of elements in the resulting set." + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "Flux sexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "first", - "type": "RedisKey", - "description": "" + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." }, { - "name": "second", - "type": "RedisKey", - "description": "" + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "long", - "description": "The number of elements in the resulting set." + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "signature": "Mono sexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V member)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." }, { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "long", - "description": "The number of elements in the resulting set." + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], - "php": [ + "jedis": [ { - "signature": "sdiffstore(string $destination, array|string $keys)", + "signature": "List sexpireAt(byte[] key, long unixTimeSeconds, byte[]... members)", "params": [ { - "name": "$destination", - "type": "string", + "name": "key", + "type": "byte[]", "description": "" }, { - "name": "$keys", - "type": "array|string", + "name": "unixTimeSeconds", + "type": "long", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", "description": "" } ], "returns": { - "type": "int", + "type": "List", "description": "" } - } - ], - "redis_rb": [ + }, { - "signature": "sdiffstore(destination, *keys)", + "signature": "List sexpireAt(byte[] key, long unixTimeSeconds, ExpiryOption condition, byte[]... members)", "params": [ { - "name": "destination", - "type": "String", - "description": "destination key" + "name": "key", + "type": "byte[]", + "description": "" }, { - "name": "*keys", - "type": "String, Array", - "description": "keys pointing to sets to subtract" - } - ], - "returns": { - "type": "Integer", - "description": "number of elements in the resulting set" - } - } - ] - } - }, - "SELECT": { - "api_calls": { - "redis_py": [ - { - "signature": "select(index: int, **kwargs)", - "params": [ + "name": "unixTimeSeconds", + "type": "long", + "description": "" + }, { - "name": "index", - "type": "int", - "description": "The database index" + "name": "condition", + "type": "ExpiryOption", + "description": "" }, { - "name": "**kwargs", - "type": "Any", + "name": "members", + "type": "byte[]...", "description": "" } ], "returns": { - "type": "ResponseT", + "type": "List", "description": "" } - } - ], - "jedis": [ + }, { - "signature": "String select(final int index)", + "signature": "long sexpireAt(byte[] key, long unixTimeSeconds, byte[] member)", "params": [ { - "name": "index", - "type": "int", - "description": "The database index" + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "unixTimeSeconds", + "type": "long", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" } ], "returns": { - "type": "String", - "description": "OK" + "type": "long", + "description": "" } - } - ], - "go-redis": [ + }, { - "signature": "Select(ctx context.Context, index int) *StatusCmd", + "signature": "long sexpireAt(byte[] key, long unixTimeSeconds, ExpiryOption condition, byte[] member)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" + "name": "key", + "type": "byte[]", + "description": "" }, { - "name": "index", - "type": "int", - "description": "Database index" + "name": "unixTimeSeconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" } ], "returns": { - "type": "*StatusCmd", + "type": "long", "description": "" } - } - ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + }, { - "signature": "select(int $database)", + "signature": "List sexpireAt(String key, long unixTimeSeconds, String... members)", "params": [ { - "name": "$database", - "type": "int", - "description": "Database index" + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "unixTimeSeconds", + "type": "long", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" } ], "returns": { - "type": "mixed", + "type": "List", "description": "" } - } - ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "SET": { - "api_calls": { - "redis_py": [ + }, { - "signature": "set(, name: KeyT,, value: EncodableT,, ex: Optional[ExpiryT] = None,, px: Optional[ExpiryT] = None,, nx: bool = False,, xx: bool = False,, keepttl: bool = False,, get: bool = False,, exat: Optional[AbsExpiryT] = None,, pxat: Optional[AbsExpiryT] = None,, ifeq: Optional[Union[bytes, str]] = None,, ifne: Optional[Union[bytes, str]] = None,, ifdeq: Optional[str] = None,, ifdne: Optional[str] = None,)", + "signature": "List sexpireAt(String key, long unixTimeSeconds, ExpiryOption condition, String... members)", "params": [ { - "name": "name", - "type": "KeyT", - "description": "" - }, - { - "name": "value", - "type": "EncodableT", + "name": "key", + "type": "String", "description": "" }, { - "name": "ex", - "type": "Optional[ExpiryT] = None", + "name": "unixTimeSeconds", + "type": "long", "description": "" }, { - "name": "px", - "type": "Optional[ExpiryT] = None", + "name": "condition", + "type": "ExpiryOption", "description": "" }, { - "name": "nx", - "type": "bool = False", + "name": "members", + "type": "String...", "description": "" - }, + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long sexpireAt(String key, long unixTimeSeconds, String member)", + "params": [ { - "name": "xx", - "type": "bool = False", + "name": "key", + "type": "String", "description": "" }, { - "name": "keepttl", - "type": "bool = False", + "name": "unixTimeSeconds", + "type": "long", "description": "" }, { - "name": "get", - "type": "bool = False", + "name": "member", + "type": "String", "description": "" - }, + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long sexpireAt(String key, long unixTimeSeconds, ExpiryOption condition, String member)", + "params": [ { - "name": "exat", - "type": "Optional[AbsExpiryT] = None", + "name": "key", + "type": "String", "description": "" }, { - "name": "pxat", - "type": "Optional[AbsExpiryT] = None", + "name": "unixTimeSeconds", + "type": "long", "description": "" }, { - "name": "ifeq", - "type": "Optional[Union[bytes, str]] = None", + "name": "condition", + "type": "ExpiryOption", "description": "" }, { - "name": "ifne", - "type": "Optional[Union[bytes, str]] = None", + "name": "member", + "type": "String", "description": "" - }, + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ] + } + }, + "SEXPIRETIME": { + "api_calls": { + "redis_py": [ + { + "signature": "sexpiretime(name: KeyT, *members: FieldT)", + "params": [ { - "name": "ifdeq", - "type": "Optional[str] = None", + "name": "name", + "type": "KeyT", "description": "" }, { - "name": "ifdne", - "type": "Optional[str] = None", + "name": "*members", + "type": "FieldT", "description": "" } ], "returns": { - "type": "ResponseT", + "type": "list[int]", "description": "" } } ], - "jedis": [ + "node_redis": [ { - "signature": "String set(final byte[] key, final byte[] value)", + "signature": "sExpireTime(key: RedisArgument, members: RedisVariadicArgument)", "params": [ { "name": "key", - "type": "byte[]", + "type": "RedisArgument", "description": "" }, { - "name": "value", - "type": "byte[]", + "name": "members", + "type": "RedisVariadicArgument", "description": "" } ], "returns": { - "type": "String", - "description": "simple-string-reply OK if SET was executed correctly, or null if the SET operation was not performed because the user specified the NX or XX option but the condition was not met." + "type": "ArrayReply", + "description": "" } - }, + } + ], + "go-redis": [ { - "signature": "String set(final byte[] key, final byte[] value, final SetParams params)", + "signature": "SExpireTime(ctx context.Context, key string, members ...string) *IntSliceCmd", "params": [ { - "name": "key", - "type": "byte[]", + "name": "ctx", + "type": "context.Context", "description": "" }, { - "name": "value", - "type": "byte[]", + "name": "key", + "type": "string", "description": "" }, { - "name": "params", - "type": "SetParams", - "description": "key if it already exists. EX|PX, expire time units: EX = seconds; PX = milliseconds" + "name": "members", + "type": "...string", + "description": "" } ], "returns": { - "type": "String", - "description": "simple-string-reply OK if SET was executed correctly, or null if the SET operation was not performed because the user specified the NX or XX option but the condition was not met." + "type": "*IntSliceCmd", + "description": "" } - }, + } + ], + "php": [ { - "signature": "String set(final String key, final String value)", + "signature": "sexpiretime(string $key, array $members)", "params": [ { - "name": "key", - "type": "String", + "name": "$key", + "type": "string", "description": "" }, { - "name": "value", - "type": "String", + "name": "$members", + "type": "array", "description": "" } ], "returns": { - "type": "String", - "description": "simple-string-reply OK if SET was executed correctly, or null if the SET operation was not performed because the user specified the NX or XX option but the condition was not met." + "type": "array", + "description": "" } - }, + } + ], + "redis_rb": [ { - "signature": "String set(final String key, final String value, final SetParams params)", + "signature": "sexpiretime(key, *members)", "params": [ { "name": "key", @@ -99834,517 +107123,623 @@ "description": "" }, { - "name": "value", - "type": "String", - "description": "" - }, - { - "name": "params", - "type": "SetParams", - "description": "key if it already exists. EX|PX, expire time units: EX = seconds; PX = milliseconds" + "name": "*members", + "type": "Array", + "description": "" } ], "returns": { - "type": "String", - "description": "simple-string-reply OK if SET was executed correctly, or null if the SET operation was not performed because the user specified the NX or XX option but the condition was not met." + "type": "Array", + "description": "" } } ], "lettuce_sync": [ { - "signature": "String set(K key, V value)", + "signature": "List sexpiretime(K key, V... members)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "value", - "type": "V", - "description": "the value." + "name": "members", + "type": "V...", + "description": "the members to get the expiration time for, must not be null or empty." } ], "returns": { - "type": "String", - "description": "String simple-string-reply OK if SET was executed correctly." + "type": "List", + "description": "a list with one Long per member, in the order of members: the Unix time in seconds at which the member expires, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "String set(K key, V value, SetArgs setArgs)", + "signature": "Long sexpiretime(K key, V member)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "value", + "name": "member", "type": "V", - "description": "the value." - }, - { - "name": "setArgs", - "type": "SetArgs", - "description": "the setArgs." + "description": "the member to get the expiration time for." } ], "returns": { - "type": "String", - "description": "String simple-string-reply OK if SET was executed correctly." + "type": "Long", + "description": "the Unix time in seconds at which the member expires, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], "lettuce_async": [ { - "signature": "RedisFuture set(K key, V value)", + "signature": "RedisFuture> sexpiretime(K key, V... members)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "value", - "type": "V", - "description": "the value." + "name": "members", + "type": "V...", + "description": "the members to get the expiration time for, must not be null or empty." } ], "returns": { - "type": "RedisFuture", - "description": "String simple-string-reply OK if SET was executed correctly." + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: the Unix time in seconds at which the member expires, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "RedisFuture set(K key, V value, SetArgs setArgs)", + "signature": "RedisFuture sexpiretime(K key, V member)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "value", + "name": "member", "type": "V", - "description": "the value." - }, - { - "name": "setArgs", - "type": "SetArgs", - "description": "the setArgs." + "description": "the member to get the expiration time for." } ], "returns": { - "type": "RedisFuture", - "description": "String simple-string-reply OK if SET was executed correctly." + "type": "RedisFuture", + "description": "the Unix time in seconds at which the member expires, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], "lettuce_reactive": [ { - "signature": "Mono set(K key, V value)", + "signature": "Flux sexpiretime(K key, V... members)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "value", - "type": "V", - "description": "the value." + "name": "members", + "type": "V...", + "description": "the members to get the expiration time for, must not be null or empty." } ], "returns": { - "type": "Mono", - "description": "String simple-string-reply OK if SET was executed correctly." + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: the Unix time in seconds at which the member expires, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "Mono set(K key, V value, SetArgs setArgs)", + "signature": "Mono sexpiretime(K key, V member)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "value", + "name": "member", "type": "V", - "description": "the value." - }, - { - "name": "setArgs", - "type": "SetArgs", - "description": "the setArgs." + "description": "the member to get the expiration time for." } ], "returns": { - "type": "Mono", - "description": "String simple-string-reply OK if SET was executed correctly." + "type": "Mono", + "description": "a Mono emitting the Unix time in seconds at which the member expires, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], - "go-redis": [ + "jedis": [ { - "signature": "Set(ctx context.Context, key string, value interface{}, expiration time.Duration)", + "signature": "List sexpireTime(byte[] key, byte[]... members)", "params": [ - { - "name": "ctx", - "type": "context.Context", - "description": "" - }, { "name": "key", - "type": "string", - "description": "" - }, - { - "name": "value", - "type": "interface{}", + "type": "byte[]", "description": "" }, { - "name": "expiration", - "type": "time.Duration", + "name": "members", + "type": "byte[]...", "description": "" } ], "returns": { - "type": "*StatusCmd", + "type": "List", "description": "" } }, { - "signature": "SetArgs(ctx context.Context, key string, value interface{}, a SetArgs)", + "signature": "long sexpireTime(byte[] key, byte[] member)", "params": [ - { - "name": "ctx", - "type": "context.Context", - "description": "" - }, { "name": "key", - "type": "string", + "type": "byte[]", "description": "" }, { - "name": "value", - "type": "interface{}", + "name": "member", + "type": "byte[]", "description": "" - }, - { - "name": "a", - "type": "SetArgs", - "description": "Mode can be `NX`, `XX`, `IFEQ`, `IFNE`, `IFDEQ`, `IFDNE` or empty. MatchValue is used with IFEQ/IFNE; MatchDigest (a uint64 xxh3 hash) is used with IFDEQ/IFDNE." } ], "returns": { - "type": "*StatusCmd", + "type": "long", "description": "" } }, { - "signature": "SetIFEQ(ctx context.Context, key string, value interface{}, matchValue interface{}, expiration time.Duration)", + "signature": "List sexpireTime(String key, String... members)", "params": [ - { - "name": "ctx", - "type": "context.Context", - "description": "" - }, { "name": "key", - "type": "string", + "type": "String", "description": "" }, { - "name": "value", - "type": "interface{}", + "name": "members", + "type": "String...", "description": "" - }, + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long sexpireTime(String key, String member)", + "params": [ { - "name": "matchValue", - "type": "interface{}", + "name": "key", + "type": "String", "description": "" }, { - "name": "expiration", - "type": "time.Duration", - "description": "Zero expiration means the key has no expiration time." + "name": "member", + "type": "String", + "description": "" } ], "returns": { - "type": "*StatusCmd", - "description": "Returns \"OK\" on success. Returns nil if the operation was aborted due to condition not matching." + "type": "long", + "description": "" } - }, + } + ] + } + }, + "SHUTDOWN": { + "api_calls": { + "redis_py": [ { - "signature": "SetIFNE(ctx context.Context, key string, value interface{}, matchValue interface{}, expiration time.Duration)", + "signature": "shutdown(save: bool = False, nosave: bool = False, now: bool = False, force: bool = False, abort: bool = False, **kwargs)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" + "name": "save", + "type": "bool", + "description": "Save before shutdown" }, { - "name": "key", - "type": "string", - "description": "" + "name": "nosave", + "type": "bool", + "description": "Don't save" }, { - "name": "value", - "type": "interface{}", - "description": "" + "name": "now", + "type": "bool", + "description": "Shutdown now" }, { - "name": "matchValue", - "type": "interface{}", - "description": "" + "name": "force", + "type": "bool", + "description": "Force shutdown" }, { - "name": "expiration", - "type": "time.Duration", - "description": "Zero expiration means the key has no expiration time." + "name": "abort", + "type": "bool", + "description": "Abort shutdown" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" } ], "returns": { - "type": "*StatusCmd", - "description": "Returns \"OK\" on success. Returns nil if the operation was aborted due to condition not matching." + "type": "None", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "void shutdown()", + "params": [], + "returns": { + "type": "void", + "description": "" } }, { - "signature": "SetIFDEQ(ctx context.Context, key string, value interface{}, matchDigest uint64, expiration time.Duration)", + "signature": "void shutdown(ShutdownParams shutdownParams)", + "params": [ + { + "name": "shutdownParams", + "type": "ShutdownParams", + "description": "Shutdown parameters" + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "String shutdownAbort()", + "params": [], + "returns": { + "type": "String", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "Shutdown(ctx context.Context) *StatusCmd", "params": [ { "name": "ctx", "type": "context.Context", - "description": "" - }, + "description": "Context" + } + ], + "returns": { + "type": "*StatusCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "SHUTDOWN(options?: ShutdownOptions)", + "params": [ { - "name": "key", - "type": "string", - "description": "" - }, + "name": "options", + "type": "ShutdownOptions", + "description": "Options for the shutdown process" + } + ], + "returns": { + "type": "void | SimpleStringReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "void shutdown(boolean save)", + "params": [ { - "name": "value", - "type": "interface{}", + "name": "save", + "type": "boolean", "description": "" - }, - { - "name": "matchDigest", - "type": "uint64", - "description": "A uint64 xxh3 hash value." - }, - { - "name": "expiration", - "type": "time.Duration", - "description": "Zero expiration means the key has no expiration time." } ], "returns": { - "type": "*StatusCmd", - "description": "Returns \"OK\" on success. Returns nil if the operation was aborted due to condition not matching." + "type": "void", + "description": "" } }, { - "signature": "SetIFDNE(ctx context.Context, key string, value interface{}, matchDigest uint64, expiration time.Duration)", + "signature": "void shutdown(ShutdownArgs args)", "params": [ { - "name": "ctx", - "type": "context.Context", + "name": "args", + "type": "ShutdownArgs", "description": "" - }, + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "void shutdown(boolean save)", + "params": [ { - "name": "key", - "type": "string", + "name": "save", + "type": "boolean", "description": "" - }, + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void shutdown(ShutdownArgs args)", + "params": [ { - "name": "value", - "type": "interface{}", + "name": "args", + "type": "ShutdownArgs", "description": "" - }, + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono shutdown(boolean save)", + "params": [ { - "name": "matchDigest", - "type": "uint64", - "description": "A uint64 xxh3 hash value." - }, + "name": "save", + "type": "boolean", + "description": "" + } + ], + "returns": { + "type": "Mono", + "description": "" + } + }, + { + "signature": "Mono shutdown(ShutdownArgs args)", + "params": [ { - "name": "expiration", - "type": "time.Duration", - "description": "Zero expiration means the key has no expiration time." + "name": "args", + "type": "ShutdownArgs", + "description": "" } ], "returns": { - "type": "*StatusCmd", - "description": "Returns \"OK\" on success. Returns nil if the operation was aborted due to condition not matching." + "type": "Mono", + "description": "" } } ], - "node_redis": [ + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ { - "signature": "SET(key: RedisArgument, value: RedisArgument | number, options?: SetOptions)", + "signature": "shutdown(?bool $noSave = null, bool $now = false, bool $force = false, bool $abort = false)", "params": [ { - "name": "key", - "type": "RedisArgument", + "name": "$noSave", + "type": "bool|null", "description": "" }, { - "name": "value", - "type": "RedisArgument | number", + "name": "$now", + "type": "bool", "description": "" }, { - "name": "options?", - "type": "SetOptions", + "name": "$force", + "type": "bool", + "description": "" + }, + { + "name": "$abort", + "type": "bool", "description": "" } ], "returns": { - "type": "Any", + "type": "Status", "description": "" } } ], - "ioredis": [ + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "SINTER": { + "api_calls": { + "redis_py": [ { - "signature": "set(key: RedisKey, value: string | Buffer | number, callback?: Callback<\"OK\">)", + "signature": "sinter(keys: List, *args: List)", "params": [ { - "name": "key", - "type": "RedisKey", + "name": "keys", + "type": "List", "description": "" }, { - "name": "value", - "type": "string | Buffer | number", + "name": "*args", + "type": "List", "description": "" - }, + } + ], + "returns": { + "type": "Union[Awaitable[list], list]", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "Set sinter(final String... keys)", + "params": [ { - "name": "callback?", - "type": "Callback<\"OK\">", + "name": "keys", + "type": "String...", "description": "" } ], "returns": { - "type": "Any", - "description": "" + "type": "Set", + "description": "A set with members of the resulting set" + } + } + ], + "lettuce_sync": [ + { + "signature": "Set sinter(K... keys)", + "params": [ + { + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], + "returns": { + "type": "Set", + "description": "Long count of members of the resulting set." } }, { - "signature": "set(key: RedisKey, value: string | Buffer | number, get: \"GET\", callback?: Callback)", + "signature": "Long sinter(ValueStreamingChannel channel, K... keys)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" + "name": "channel", + "type": "ValueStreamingChannel", + "description": "the channel." }, { - "name": "value", - "type": "string | Buffer | number", - "description": "" - }, + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], + "returns": { + "type": "Long", + "description": "Long count of members of the resulting set." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> sinter(K... keys)", + "params": [ { - "name": "get", - "type": "\"GET\"", - "description": "" + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "Long count of members of the resulting set." + } + }, + { + "signature": "RedisFuture sinter(ValueStreamingChannel channel, K... keys)", + "params": [ + { + "name": "channel", + "type": "ValueStreamingChannel", + "description": "the channel." }, { - "name": "callback?", - "type": "Callback", - "description": "" + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Long count of members of the resulting set." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux sinter(K... keys)", + "params": [ + { + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "Any", - "description": "" + "type": "Flux", + "description": "Long count of members of the resulting set. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #sinter." } }, { - "signature": "set(key: RedisKey, value: string | Buffer | number, nx: \"NX\", callback?: Callback<\"OK\" | null>)", + "signature": "Mono sinter(ValueStreamingChannel channel, K... keys)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "value", - "type": "string | Buffer | number", - "description": "" - }, - { - "name": "nx", - "type": "\"NX\"", - "description": "" + "name": "channel", + "type": "ValueStreamingChannel", + "description": "the channel." }, { - "name": "callback?", - "type": "Callback<\"OK\" | null>", - "description": "" + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { - "type": "Any", - "description": "" + "type": "Mono", + "description": "Long count of members of the resulting set. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #sinter." } - }, + } + ], + "go-redis": [ { - "signature": "set(key: RedisKey, value: string | Buffer | number, nx: \"NX\", get: \"GET\", callback?: Callback)", + "signature": "SInter(ctx context.Context, keys ...string)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "value", - "type": "string | Buffer | number", - "description": "" - }, - { - "name": "nx", - "type": "\"NX\"", - "description": "" - }, - { - "name": "get", - "type": "\"GET\"", + "name": "ctx", + "type": "context.Context", "description": "" }, { - "name": "callback?", - "type": "Callback", + "name": "keys", + "type": "...string", "description": "" } ], "returns": { - "type": "Any", + "type": "*StringSliceCmd", "description": "" } - }, + } + ], + "node_redis": [ { - "signature": "set(key: RedisKey, value: string | Buffer | number, xx: \"XX\", callback?: Callback<\"OK\" | null>)", + "signature": "SINTER(keys: RedisVariadicArgument)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "value", - "type": "string | Buffer | number", - "description": "" - }, - { - "name": "xx", - "type": "\"XX\"", - "description": "" - }, - { - "name": "callback?", - "type": "Callback<\"OK\" | null>", + "name": "keys", + "type": "RedisVariadicArgument", "description": "" } ], @@ -100354,148 +107749,105 @@ } } ], - "redis_rs_sync": [ + "ioredis": [ { - "signature": "set(key: K, value: V)", + "signature": "sinter(...args: [...keys: RedisKey[], callback: Callback])", "params": [ { - "name": "key", - "type": "K", - "description": "" - }, - { - "name": "value", - "type": "V", + "name": "...args", + "type": "[...keys", "description": "" } ], "returns": { - "type": "(())", + "type": "Any", "description": "" } }, { - "signature": "set_options(key: K, value: V, options: SetOptions)", + "signature": "sinter(...args: [keys: RedisKey[], callback: Callback])", "params": [ { - "name": "key", - "type": "K", - "description": "" - }, - { - "name": "value", - "type": "V", - "description": "" - }, - { - "name": "options", - "type": "SetOptions", + "name": "...args", + "type": "[keys", "description": "" } ], "returns": { - "type": "(Option)", + "type": "Any", "description": "" } - } - ], - "redis_rs_async": [ + }, { - "signature": "set(key: K, value: V)", + "signature": "sinter(...args: [...keys: RedisKey[]]): Result;, sinterBuffer(...args: [...keys: RedisKey[]]): Result;, sinter(...args: [keys: RedisKey[]]): Result;, sinterBuffer(...args: [keys: RedisKey[]]): Result;, /**, * Intersect multiple sets and return the cardinality of the result, * - _group_: set, * - _complexity_: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets., * - _since_: 7.0.0, */, sintercard(, ...args: [, numkeys: number | string, ...keys: RedisKey[], callback: Callback, ])", "params": [ { - "name": "key", - "type": "K", + "name": "...args", + "type": "[...keys", "description": "" }, { - "name": "value", - "type": "V", + "name": "...args", + "type": "[, numkeys", "description": "" } ], "returns": { - "type": "(())", + "type": "Any", "description": "" } - }, + } + ], + "redis_rs_sync": [ { - "signature": "set_options(key: K, value: V, options: SetOptions)", + "signature": "sinter(keys: K)", "params": [ { - "name": "key", + "name": "keys", "type": "K", "description": "" - }, - { - "name": "value", - "type": "V", - "description": "" - }, - { - "name": "options", - "type": "SetOptions", - "description": "" } ], "returns": { - "type": "(Option)", + "type": "(HashSet)", "description": "" } } ], - "nredisstack_sync": [ + "redis_rs_async": [ { - "signature": "StringSet(RedisKey key, RedisValue value, TimeSpan? expiry, When when)", + "signature": "sinter(keys: K)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "value", - "type": "RedisValue", + "name": "keys", + "type": "K", "description": "" - }, - { - "name": "expiry", - "type": "TimeSpan?", - "description": "The expiry to set." - }, - { - "name": "when", - "type": "When", - "description": "Which condition to set the value under (defaults to always)." } ], "returns": { - "type": "bool", - "description": "true if the keys were set, false otherwise." + "type": "(HashSet)", + "description": "" } - }, + } + ], + "nredisstack_sync": [ { - "signature": "StringSet(RedisKey key, RedisValue value, TimeSpan? expiry, When when, CommandFlags flags)", + "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "value", - "type": "RedisValue", + "name": "first", + "type": "RedisKey", "description": "" }, { - "name": "expiry", - "type": "TimeSpan?", - "description": "The expiry to set." - }, - { - "name": "when", - "type": "When", - "description": "Which condition to set the value under (defaults to always)." + "name": "second", + "type": "RedisKey", + "description": "" }, { "name": "flags", @@ -100504,37 +107856,22 @@ } ], "returns": { - "type": "bool", - "description": "true if the keys were set, false otherwise." + "type": "RedisValue[]", + "description": "List with members of the resulting set." } }, { - "signature": "StringSet(RedisKey key, RedisValue value, TimeSpan? expiry, bool keepTtl, When when = When.Always, CommandFlags flags = CommandFlags.None)", + "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "value", - "type": "RedisValue", - "description": "" - }, - { - "name": "expiry", - "type": "TimeSpan?", - "description": "The expiry to set." - }, - { - "name": "keepTtl", - "type": "bool", - "description": "" + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "when", - "type": "When", - "description": "Which condition to set the value under (defaults to always)." + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." }, { "name": "flags", @@ -100543,32 +107880,27 @@ } ], "returns": { - "type": "bool", - "description": "true if the keys were set, false otherwise." + "type": "RedisValue[]", + "description": "List with members of the resulting set." } }, { - "signature": "StringSet(RedisKey key, RedisValue value, Expiration expiry = default, ValueCondition when = default, CommandFlags flags = CommandFlags.None)", + "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "value", - "type": "RedisValue", + "name": "first", + "type": "RedisKey", "description": "" }, { - "name": "expiry", - "type": "Expiration", - "description": "The expiry to set." - }, - { - "name": "when", - "type": "ValueCondition", - "description": "Which condition to set the value under (defaults to always)." + "name": "second", + "type": "RedisKey", + "description": "" }, { "name": "flags", @@ -100577,22 +107909,22 @@ } ], "returns": { - "type": "bool", - "description": "true if the keys were set, false otherwise." + "type": "RedisValue[]", + "description": "List with members of the resulting set." } }, { - "signature": "StringSet(KeyValuePair[] values, When when, CommandFlags flags)", + "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "values", - "type": "KeyValuePair[]", - "description": "The keys and values to set." + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "when", - "type": "When", - "description": "Which condition to set the value under (defaults to always)." + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." }, { "name": "flags", @@ -100601,64 +107933,30 @@ } ], "returns": { - "type": "bool", - "description": "true if the keys were set, false otherwise." + "type": "RedisValue[]", + "description": "List with members of the resulting set." } } ], "nredisstack_async": [ { - "signature": "StringSet(RedisKey key, RedisValue value, TimeSpan? expiry, When when)", + "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "value", - "type": "RedisValue", - "description": "" - }, - { - "name": "expiry", - "type": "TimeSpan?", - "description": "The expiry to set." + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "when", - "type": "When", - "description": "Which condition to set the value under (defaults to always)." - } - ], - "returns": { - "type": "bool", - "description": "true if the keys were set, false otherwise." - } - }, - { - "signature": "StringSet(RedisKey key, RedisValue value, TimeSpan? expiry, When when, CommandFlags flags)", - "params": [ - { - "name": "key", + "name": "first", "type": "RedisKey", "description": "" }, { - "name": "value", - "type": "RedisValue", + "name": "second", + "type": "RedisKey", "description": "" }, - { - "name": "expiry", - "type": "TimeSpan?", - "description": "The expiry to set." - }, - { - "name": "when", - "type": "When", - "description": "Which condition to set the value under (defaults to always)." - }, { "name": "flags", "type": "CommandFlags", @@ -100666,37 +107964,22 @@ } ], "returns": { - "type": "bool", - "description": "true if the keys were set, false otherwise." + "type": "RedisValue[]", + "description": "List with members of the resulting set." } }, { - "signature": "StringSet(RedisKey key, RedisValue value, TimeSpan? expiry, bool keepTtl, When when = When.Always, CommandFlags flags = CommandFlags.None)", + "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "value", - "type": "RedisValue", - "description": "" - }, - { - "name": "expiry", - "type": "TimeSpan?", - "description": "The expiry to set." - }, - { - "name": "keepTtl", - "type": "bool", - "description": "" + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "when", - "type": "When", - "description": "Which condition to set the value under (defaults to always)." + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." }, { "name": "flags", @@ -100705,32 +107988,27 @@ } ], "returns": { - "type": "bool", - "description": "true if the keys were set, false otherwise." + "type": "RedisValue[]", + "description": "List with members of the resulting set." } }, { - "signature": "StringSet(RedisKey key, RedisValue value, Expiration expiry = default, ValueCondition when = default, CommandFlags flags = CommandFlags.None)", + "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "value", - "type": "RedisValue", + "name": "first", + "type": "RedisKey", "description": "" }, { - "name": "expiry", - "type": "Expiration", - "description": "The expiry to set." - }, - { - "name": "when", - "type": "ValueCondition", - "description": "Which condition to set the value under (defaults to always)." + "name": "second", + "type": "RedisKey", + "description": "" }, { "name": "flags", @@ -100739,22 +108017,22 @@ } ], "returns": { - "type": "bool", - "description": "true if the keys were set, false otherwise." + "type": "RedisValue[]", + "description": "List with members of the resulting set." } }, { - "signature": "StringSet(KeyValuePair[] values, When when, CommandFlags flags)", + "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "values", - "type": "KeyValuePair[]", - "description": "The keys and values to set." + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." }, { - "name": "when", - "type": "When", - "description": "Which condition to set the value under (defaults to always)." + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." }, { "name": "flags", @@ -100763,274 +108041,249 @@ } ], "returns": { - "type": "bool", - "description": "true if the keys were set, false otherwise." - } - } - ], - "php": [ - { - "signature": "set(string $key, $value, $expireResolution = null, $expireTTL = null, $flag = null, $flagValue = null)", - "params": [ - { - "name": "$key", - "type": "string", - "description": "" - }, - { - "name": "$value", - "type": "Any", - "description": "" - }, - { - "name": "$expireResolution = null", - "type": "Any", - "description": "" - }, - { - "name": "$expireTTL = null", - "type": "Any", - "description": "" - }, - { - "name": "$flag = null", - "type": "Any", - "description": "" - }, - { - "name": "$flagValue = null", - "type": "Any", - "description": "" - } - ], - "returns": { - "type": "Status|null", - "description": "" + "type": "RedisValue[]", + "description": "List with members of the resulting set." } - } - ], - "redis_rb": [ - { - "signature": "set(key, value, ex: nil, px: nil, exat: nil, pxat: nil, nx: nil, xx: nil, keepttl: nil, get: nil)", - "params": [ - { - "name": "key", - "type": "String", - "description": "" - }, - { - "name": "value", - "type": "String", - "description": "" - }, - { - "name": "ex", - "type": "Integer", - "description": "Set the specified expire time, in seconds." - }, - { - "name": "px", - "type": "Integer", - "description": "Set the specified expire time, in milliseconds." - }, - { - "name": "exat", - "type": "Integer", - "description": "Set the specified Unix time at which the key will expire, in seconds." - }, - { - "name": "pxat", - "type": "Integer", - "description": "Set the specified Unix time at which the key will expire, in milliseconds." - }, - { - "name": "nx", - "type": "Boolean", - "description": "Only set the key if it does not already exist." - }, - { - "name": "xx", - "type": "Boolean", - "description": "Only set the key if it already exists." - }, + } + ], + "php": [ + { + "signature": "sinter(array|string $keys)", + "params": [ { - "name": "keepttl", - "type": "Boolean", - "description": "Retain the time to live associated with the key." - }, + "name": "$keys", + "type": "array|string", + "description": "" + } + ], + "returns": { + "type": "string[]", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "sinter(*keys)", + "params": [ { - "name": "get", - "type": "Boolean", - "description": "Return the old string stored at key, or nil if key did not exist." + "name": "*keys", + "type": "String, Array", + "description": "keys pointing to sets to intersect" } ], "returns": { - "type": "String, Boolean", - "description": "\"OK\" or true, false if :nx => true or :xx => true" + "type": "Array", + "description": "members in the intersection" } } ] } }, - "SETBIT": { + "SINTERCARD": { "api_calls": { "redis_py": [ { - "signature": "setbit(name: KeyT, offset: int, value: int)", + "signature": "sintercard(numkeys: int, keys: List[KeyT], limit: int = 0)", "params": [ { - "name": "name", - "type": "KeyT", + "name": "numkeys", + "type": "int", "description": "" }, { - "name": "offset", - "type": "int", + "name": "keys", + "type": "List[KeyT]", "description": "" }, { - "name": "value", - "type": "int", + "name": "limit", + "type": "int = 0", "description": "" } ], "returns": { - "type": "ResponseT", + "type": "Union[Awaitable[int], int]", "description": "" } } ], "jedis": [ { - "signature": "boolean setbit(final byte[] key, final long offset, final boolean value)", + "signature": "long sintercard(byte[]... keys)", "params": [ { - "name": "key", - "type": "byte[]", + "name": "keys", + "type": "byte[]...", "description": "" - }, + } + ], + "returns": { + "type": "long", + "description": "The cardinality of the set which would result from the intersection of all the given sets" + } + }, + { + "signature": "long sintercard(int limit, byte[]... keys)", + "params": [ { - "name": "offset", - "type": "long", - "description": "" + "name": "limit", + "type": "int", + "description": "If the intersection cardinality reaches limit partway through the computation," }, { - "name": "value", - "type": "boolean", + "name": "keys", + "type": "byte[]...", "description": "" } ], "returns": { - "type": "boolean", - "description": "" + "type": "long", + "description": "The cardinality of the set which would result from the intersection of all the given sets" } }, { - "signature": "boolean setbit(final String key, final long offset, final boolean value)", + "signature": "long sintercard(String... keys)", "params": [ { - "name": "key", - "type": "String", + "name": "keys", + "type": "String...", "description": "" - }, + } + ], + "returns": { + "type": "long", + "description": "The cardinality of the set which would result from the intersection of all the given sets" + } + }, + { + "signature": "long sintercard(int limit, String... keys)", + "params": [ { - "name": "offset", - "type": "long", - "description": "" + "name": "limit", + "type": "int", + "description": "If the intersection cardinality reaches limit partway through the computation," }, { - "name": "value", - "type": "boolean", + "name": "keys", + "type": "String...", "description": "" } ], "returns": { - "type": "boolean", - "description": "" + "type": "long", + "description": "The cardinality of the set which would result from the intersection of all the given sets" } } ], "lettuce_sync": [ { - "signature": "Long setbit(K key, long offset, int value)", + "signature": "Long sintercard(K... keys)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." - }, + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], + "returns": { + "type": "Long", + "description": "The cardinality of the set which would result from the intersection of all the given sets. @since 6.2" + } + }, + { + "signature": "Long sintercard(long limit, K... keys)", + "params": [ { - "name": "offset", + "name": "limit", "type": "long", - "description": "the offset type: long." + "description": "If the intersection cardinality reaches limit partway through the computation, the algorithm will exit and" }, { - "name": "value", - "type": "int", - "description": "the value type: string." + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { "type": "Long", - "description": "Long integer-reply the original bit value stored at offset." + "description": "The cardinality of the set which would result from the intersection of all the given sets. @since 6.2" } } ], "lettuce_async": [ { - "signature": "RedisFuture setbit(K key, long offset, int value)", + "signature": "RedisFuture sintercard(K... keys)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." - }, + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], + "returns": { + "type": "RedisFuture", + "description": "The cardinality of the set which would result from the intersection of all the given sets. @since 6.2" + } + }, + { + "signature": "RedisFuture sintercard(long limit, K... keys)", + "params": [ { - "name": "offset", + "name": "limit", "type": "long", - "description": "the offset type: long." + "description": "If the intersection cardinality reaches limit partway through the computation, the algorithm will exit and" }, { - "name": "value", - "type": "int", - "description": "the value type: string." + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { "type": "RedisFuture", - "description": "Long integer-reply the original bit value stored at offset." + "description": "The cardinality of the set which would result from the intersection of all the given sets. @since 6.2" } } ], "lettuce_reactive": [ { - "signature": "Mono setbit(K key, long offset, int value)", + "signature": "Mono sintercard(K... keys)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." - }, + "name": "keys", + "type": "K...", + "description": "the keys." + } + ], + "returns": { + "type": "Mono", + "description": "The cardinality of the set which would result from the intersection of all the given sets. @since 6.2" + } + }, + { + "signature": "Mono sintercard(long limit, K... keys)", + "params": [ { - "name": "offset", + "name": "limit", "type": "long", - "description": "the offset type: long." + "description": "If the intersection cardinality reaches limit partway through the computation, the algorithm will exit and" }, { - "name": "value", - "type": "int", - "description": "the value type: string." + "name": "keys", + "type": "K...", + "description": "the keys." } ], "returns": { "type": "Mono", - "description": "Long integer-reply the original bit value stored at offset." + "description": "The cardinality of the set which would result from the intersection of all the given sets. @since 6.2" } } ], "go-redis": [ { - "signature": "SetBit(ctx context.Context, key string, offset int64, value int)", + "signature": "SInterCard(ctx context.Context, limit int64, keys ...string)", "params": [ { "name": "ctx", @@ -101038,18 +108291,13 @@ "description": "" }, { - "name": "key", - "type": "string", - "description": "" - }, - { - "name": "offset", + "name": "limit", "type": "int64", "description": "" }, { - "name": "value", - "type": "int", + "name": "keys", + "type": "...string", "description": "" } ], @@ -101061,21 +108309,16 @@ ], "node_redis": [ { - "signature": "SETBIT(key: RedisArgument, offset: number, value: BitValue)", + "signature": "SINTERCARD(keys: RedisVariadicArgument, options?: SInterCardOptions | number)", "params": [ { - "name": "key", - "type": "RedisArgument", - "description": "" - }, - { - "name": "offset", - "type": "number", + "name": "keys", + "type": "RedisVariadicArgument", "description": "" }, { - "name": "value", - "type": "BitValue", + "name": "options?", + "type": "SInterCardOptions | number", "description": "" } ], @@ -101087,26 +108330,11 @@ ], "ioredis": [ { - "signature": "setbit(key: RedisKey, offset: number | string, value: number | string, callback?: Callback)", + "signature": "sintercard(...args: [, numkeys: number | string, keys: RedisKey[], callback: Callback, ])", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "offset", - "type": "number | string", - "description": "" - }, - { - "name": "value", - "type": "number | string", - "description": "" - }, - { - "name": "callback?", - "type": "Callback", + "name": "...args", + "type": "[, numkeys", "description": "" } ], @@ -101114,225 +108342,101 @@ "type": "Any", "description": "" } - } - ], - "redis_rs_sync": [ + }, { - "signature": "setbit(key: K, offset: usize, value: bool)", + "signature": "sintercard(...args: [numkeys: number | string, ...keys: RedisKey[]])", "params": [ { - "name": "key", - "type": "K", - "description": "" - }, - { - "name": "offset", - "type": "usize", - "description": "" - }, - { - "name": "value", - "type": "bool", + "name": "...args", + "type": "[numkeys", "description": "" } ], "returns": { - "type": "(bool)", + "type": "Any", "description": "" } - } - ], - "redis_rs_async": [ + }, { - "signature": "setbit(key: K, offset: usize, value: bool)", + "signature": "sintercard(...args: [numkeys: number | string, keys: RedisKey[]])", "params": [ { - "name": "key", - "type": "K", - "description": "" - }, - { - "name": "offset", - "type": "usize", - "description": "" - }, - { - "name": "value", - "type": "bool", + "name": "...args", + "type": "[numkeys", "description": "" } ], "returns": { - "type": "(bool)", + "type": "Any", "description": "" } - } - ], - "nredisstack_sync": [ - { - "signature": "StringSetBit(RedisKey key, long offset, bool bit, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the string." - }, - { - "name": "offset", - "type": "long", - "description": "The offset in the string to set bit." - }, - { - "name": "bit", - "type": "bool", - "description": "The bit value to set, true for 1, false for 0." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "bool", - "description": "The original bit value stored at offset." - } }, { - "signature": "StringSetBitAsync(RedisKey key, long offset, bool bit, CommandFlags flags = CommandFlags.None)", + "signature": "sintercard(...args: [, numkeys: number | string, ...keys: RedisKey[], limitToken: \"LIMIT\", limit: number | string, callback: Callback, ])", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "offset", - "type": "long", - "description": "" - }, - { - "name": "bit", - "type": "bool", - "description": "" - }, - { - "name": "flags", - "type": "CommandFlags", + "name": "...args", + "type": "[, numkeys", "description": "" } ], "returns": { - "type": "Task", + "type": "Any", "description": "" } }, { - "signature": "StringSetBit(RedisKey key, long offset, bool bit, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the string." - }, - { - "name": "offset", - "type": "long", - "description": "The offset in the string to set bit." - }, - { - "name": "bit", - "type": "bool", - "description": "The bit value to set, true for 1, false for 0." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "bool", - "description": "The original bit value stored at offset." - } - }, - { - "signature": "StringSetBitAsync(RedisKey key, long offset, bool value, CommandFlags flags = CommandFlags.None)", + "signature": "sintercard(...args: [, numkeys: number | string, keys: RedisKey[], limitToken: \"LIMIT\", limit: number | string, callback: Callback, ])", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "offset", - "type": "long", - "description": "" - }, - { - "name": "value", - "type": "bool", - "description": "" - }, - { - "name": "flags", - "type": "CommandFlags", + "name": "...args", + "type": "[, numkeys", "description": "" } ], "returns": { - "type": "Task", + "type": "Any", "description": "" } } ], - "nredisstack_async": [ + "nredisstack_sync": [ { - "signature": "StringSetBitAsync(RedisKey key, long offset, bool bit, CommandFlags flags = CommandFlags.None)", + "signature": "SetIntersectionLength(RedisKey[] keys, long limit = 0, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets." }, { - "name": "offset", + "name": "limit", "type": "long", - "description": "" - }, - { - "name": "bit", - "type": "bool", - "description": "" + "description": "The number of elements to check (defaults to 0 and means unlimited)." }, { "name": "flags", "type": "CommandFlags", - "description": "" + "description": "The flags to use for this operation." } ], "returns": { - "type": "Task", - "description": "" + "type": "long", + "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." } }, { - "signature": "StringSetBit(RedisKey key, long offset, bool bit, CommandFlags flags = CommandFlags.None)", + "signature": "SetIntersectionLength(RedisKey[] keys, long limit = 0, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The key of the string." + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets." }, { - "name": "offset", + "name": "limit", "type": "long", - "description": "The offset in the string to set bit." - }, - { - "name": "bit", - "type": "bool", - "description": "The bit value to set, true for 1, false for 0." + "description": "The number of elements to check (defaults to 0 and means unlimited)." }, { "name": "flags", @@ -101341,27 +108445,24 @@ } ], "returns": { - "type": "bool", - "description": "The original bit value stored at offset." + "type": "long", + "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." } - }, + } + ], + "nredisstack_async": [ { - "signature": "StringSetBit(RedisKey key, long offset, bool bit, CommandFlags flags = CommandFlags.None)", + "signature": "SetIntersectionLength(RedisKey[] keys, long limit = 0, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The key of the string." + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets." }, { - "name": "offset", + "name": "limit", "type": "long", - "description": "The offset in the string to set bit." - }, - { - "name": "bit", - "type": "bool", - "description": "The bit value to set, true for 1, false for 0." + "description": "The number of elements to check (defaults to 0 and means unlimited)." }, { "name": "flags", @@ -101370,56 +108471,46 @@ } ], "returns": { - "type": "bool", - "description": "The original bit value stored at offset." + "type": "long", + "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." } }, { - "signature": "StringSetBitAsync(RedisKey key, long offset, bool value, CommandFlags flags = CommandFlags.None)", + "signature": "SetIntersectionLength(RedisKey[] keys, long limit = 0, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "" + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets." }, { - "name": "offset", + "name": "limit", "type": "long", - "description": "" - }, - { - "name": "value", - "type": "bool", - "description": "" + "description": "The number of elements to check (defaults to 0 and means unlimited)." }, { "name": "flags", "type": "CommandFlags", - "description": "" + "description": "The flags to use for this operation." } ], "returns": { - "type": "Task", - "description": "" + "type": "long", + "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." } } ], "php": [ { - "signature": "setbit(string $key, $offset, $value)", + "signature": "sintercard(array $keys, int $limit = 0)", "params": [ { - "name": "$key", - "type": "string", - "description": "" - }, - { - "name": "$offset", - "type": "Any", + "name": "$keys", + "type": "array", "description": "" }, { - "name": "$value", + "name": "int $limit = 0", "type": "Any", "description": "" } @@ -101432,165 +108523,140 @@ ] } }, - "SETEX": { + "SINTERSTORE": { "api_calls": { "redis_py": [ { - "signature": "setex(name: KeyT, time: ExpiryT, value: EncodableT)", + "signature": "sinterstore(dest: KeyT, keys: List, *args: List)", "params": [ { - "name": "name", + "name": "dest", "type": "KeyT", "description": "" }, { - "name": "time", - "type": "ExpiryT", + "name": "keys", + "type": "List", "description": "" }, { - "name": "value", - "type": "EncodableT", + "name": "*args", + "type": "List", "description": "" } ], "returns": { - "type": "ResponseT", + "type": "Union[Awaitable[int], int]", "description": "" } } ], "jedis": [ { - "signature": "String setex(final byte[] key, final long seconds, final byte[] value)", + "signature": "long sinterstore(final byte[] dstkey, final byte[]... keys)", "params": [ { - "name": "key", + "name": "dstkey", "type": "byte[]", "description": "" }, { - "name": "seconds", - "type": "long", - "description": "" - }, - { - "name": "value", - "type": "byte[]", + "name": "keys", + "type": "byte[]...", "description": "" } ], "returns": { - "type": "String", - "description": "OK @deprecated Use Jedis#set(String, String, redis.clients.jedis.params.SetParams) with redis.clients.jedis.params.SetParams#ex(long). Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 2.6.12." + "type": "long", + "description": "The number of elements in the resulting set" } }, { - "signature": "String setex(final String key, final long seconds, final String value)", + "signature": "long sinterstore(final String dstkey, final String... keys)", "params": [ { - "name": "key", + "name": "dstkey", "type": "String", "description": "" }, { - "name": "seconds", - "type": "long", - "description": "" - }, - { - "name": "value", - "type": "String", + "name": "keys", + "type": "String...", "description": "" } ], "returns": { - "type": "String", - "description": "OK @deprecated Use Jedis#set(String, String, redis.clients.jedis.params.SetParams) with redis.clients.jedis.params.SetParams#ex(long). Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 2.6.12." + "type": "long", + "description": "The number of elements in the resulting set" } } ], "lettuce_sync": [ { - "signature": "String setex(K key, long seconds, V value)", + "signature": "Long sinterstore(K destination, K... keys)", "params": [ { - "name": "key", + "name": "destination", "type": "K", - "description": "the key." - }, - { - "name": "seconds", - "type": "long", - "description": "the seconds type: long." + "description": "the destination type: key." }, { - "name": "value", - "type": "V", - "description": "the value." + "name": "keys", + "type": "K...", + "description": "the key." } ], "returns": { - "type": "String", - "description": "String simple-string-reply." + "type": "Long", + "description": "Long integer-reply the number of elements in the resulting set." } } ], "lettuce_async": [ { - "signature": "RedisFuture setex(K key, long seconds, V value)", + "signature": "RedisFuture sinterstore(K destination, K... keys)", "params": [ { - "name": "key", + "name": "destination", "type": "K", - "description": "the key." - }, - { - "name": "seconds", - "type": "long", - "description": "the seconds type: long." + "description": "the destination type: key." }, { - "name": "value", - "type": "V", - "description": "the value." + "name": "keys", + "type": "K...", + "description": "the key." } ], "returns": { - "type": "RedisFuture", - "description": "String simple-string-reply." + "type": "RedisFuture", + "description": "Long integer-reply the number of elements in the resulting set." } } ], "lettuce_reactive": [ { - "signature": "Mono setex(K key, long seconds, V value)", + "signature": "Mono sinterstore(K destination, K... keys)", "params": [ { - "name": "key", + "name": "destination", "type": "K", - "description": "the key." - }, - { - "name": "seconds", - "type": "long", - "description": "the seconds type: long." + "description": "the destination type: key." }, { - "name": "value", - "type": "V", - "description": "the value." + "name": "keys", + "type": "K...", + "description": "the key." } ], "returns": { - "type": "Mono", - "description": "String simple-string-reply." + "type": "Mono", + "description": "Long integer-reply the number of elements in the resulting set." } } ], "go-redis": [ { - "signature": "SetEx(ctx context.Context, key string, value interface{}, expiration time.Duration)", + "signature": "SInterStore(ctx context.Context, destination string, keys ...string)", "params": [ { "name": "ctx", @@ -101598,44 +108664,34 @@ "description": "" }, { - "name": "key", + "name": "destination", "type": "string", "description": "" }, { - "name": "value", - "type": "interface{}", - "description": "" - }, - { - "name": "expiration", - "type": "time.Duration", + "name": "keys", + "type": "...string", "description": "" } ], "returns": { - "type": "*StatusCmd", + "type": "*IntCmd", "description": "" } } ], "node_redis": [ { - "signature": "SETEX(key: RedisArgument, seconds: number, value: RedisArgument)", + "signature": "SINTERSTORE(destination: RedisArgument, keys: RedisVariadicArgument)", "params": [ { - "name": "key", + "name": "destination", "type": "RedisArgument", "description": "" }, { - "name": "seconds", - "type": "number", - "description": "" - }, - { - "name": "value", - "type": "RedisArgument", + "name": "keys", + "type": "RedisVariadicArgument", "description": "" } ], @@ -101647,26 +108703,53 @@ ], "ioredis": [ { - "signature": "setex(key: RedisKey, seconds: number | string, value: string | Buffer | number, callback?: Callback<\"OK\">)", + "signature": "sinterstore(...args: [, destination: RedisKey, ...keys: RedisKey[], callback: Callback, ])", "params": [ { - "name": "key", - "type": "RedisKey", + "name": "...args", + "type": "[, destination", "description": "" - }, + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "sinterstore(...args: [, destination: RedisKey, keys: RedisKey[], callback: Callback, ])", + "params": [ { - "name": "seconds", - "type": "number | string", + "name": "...args", + "type": "[, destination", "description": "" - }, + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "sinterstore(...args: [destination: RedisKey, ...keys: RedisKey[]])", + "params": [ { - "name": "value", - "type": "string | Buffer | number", + "name": "...args", + "type": "[destination", "description": "" - }, + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "sinterstore(...args: [destination: RedisKey, keys: RedisKey[]])", + "params": [ { - "name": "callback?", - "type": "Callback<\"OK\">", + "name": "...args", + "type": "[destination", "description": "" } ], @@ -101678,115 +108761,351 @@ ], "redis_rs_sync": [ { - "signature": "set_ex(key: K, value: V, seconds: u64)", + "signature": "sinterstore(dstkey: D, keys: K)", "params": [ { - "name": "key", - "type": "K", + "name": "dstkey", + "type": "D", "description": "" }, { - "name": "value", - "type": "V", + "name": "keys", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(usize)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "sinterstore(dstkey: D, keys: K)", + "params": [ + { + "name": "dstkey", + "type": "D", "description": "" }, { - "name": "seconds", - "type": "u64", + "name": "keys", + "type": "K", "description": "" } ], "returns": { - "type": "(())", + "type": "(usize)", "description": "" } } ], - "redis_rs_async": [ + "nredisstack_sync": [ { - "signature": "set_ex(key: K, value: V, seconds: u64)", + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "key", - "type": "K", + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." + }, + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination set." + }, + { + "name": "first", + "type": "RedisKey", "description": "" }, { - "name": "value", - "type": "V", + "name": "second", + "type": "RedisKey", "description": "" }, { - "name": "seconds", - "type": "u64", + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "long", + "description": "The number of elements in the resulting set." + } + }, + { + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." + }, + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination set." + }, + { + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "long", + "description": "The number of elements in the resulting set." + } + }, + { + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." + }, + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination set." + }, + { + "name": "first", + "type": "RedisKey", + "description": "" + }, + { + "name": "second", + "type": "RedisKey", "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "(())", - "description": "" + "type": "long", + "description": "The number of elements in the resulting set." + } + }, + { + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." + }, + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination set." + }, + { + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "long", + "description": "The number of elements in the resulting set." } } ], - "php": [ + "nredisstack_async": [ { - "signature": "setex(string $key, $seconds, $value)", + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "$key", - "type": "string", + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." + }, + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination set." + }, + { + "name": "first", + "type": "RedisKey", "description": "" }, { - "name": "$seconds", - "type": "Any", + "name": "second", + "type": "RedisKey", "description": "" }, { - "name": "$value", - "type": "Any", + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "long", + "description": "The number of elements in the resulting set." + } + }, + { + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." + }, + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination set." + }, + { + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "long", + "description": "The number of elements in the resulting set." + } + }, + { + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." + }, + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination set." + }, + { + "name": "first", + "type": "RedisKey", + "description": "" + }, + { + "name": "second", + "type": "RedisKey", "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Status", - "description": "" + "type": "long", + "description": "The number of elements in the resulting set." + } + }, + { + "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "operation", + "type": "SetOperation", + "description": "The operation to perform." + }, + { + "name": "destination", + "type": "RedisKey", + "description": "The key of the destination set." + }, + { + "name": "keys", + "type": "RedisKey[]", + "description": "The keys of the sets to operate on." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "long", + "description": "The number of elements in the resulting set." } } ], - "redis_rb": [ + "php": [ { - "signature": "setex(key, ttl, value)", + "signature": "sinterstore(string $destination, array|string $keys)", "params": [ { - "name": "key", - "type": "String", + "name": "$destination", + "type": "string", "description": "" }, { - "name": "ttl", - "type": "Integer", + "name": "$keys", + "type": "array|string", "description": "" - }, + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "sinterstore(destination, *keys)", + "params": [ { - "name": "value", + "name": "destination", "type": "String", - "description": "" + "description": "destination key" + }, + { + "name": "*keys", + "type": "String, Array", + "description": "keys pointing to sets to intersect" } ], "returns": { - "type": "String", - "description": "\"OK\"" + "type": "Integer", + "description": "number of elements in the resulting set" } } ] } }, - "SETNX": { + "SISMEMBER": { "api_calls": { "redis_py": [ { - "signature": "setnx(name: KeyT, value: EncodableT)", + "signature": "sismember(name: KeyT, value: str)", "params": [ { "name": "name", @@ -101795,19 +109114,19 @@ }, { "name": "value", - "type": "EncodableT", + "type": "str", "description": "" } ], "returns": { - "type": "ResponseT", + "type": "Union[Awaitable[Union[Literal[0], Literal[1]]], Union[Literal[0], Literal[1]]]", "description": "" } } ], "jedis": [ { - "signature": "long setnx(final byte[] key, final byte[] value)", + "signature": "boolean sismember(final byte[] key, final byte[] member)", "params": [ { "name": "key", @@ -101815,18 +109134,18 @@ "description": "" }, { - "name": "value", + "name": "member", "type": "byte[]", "description": "" } ], "returns": { - "type": "long", - "description": "1 if the key was set, 0 if the key was not set @deprecated Use Jedis#set(String, String, redis.clients.jedis.params.SetParams) with redis.clients.jedis.params.SetParams#nx(). Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 2.6.12." + "type": "boolean", + "description": "true if the element is a member of the set, false otherwise" } }, { - "signature": "long setnx(final String key, final String value)", + "signature": "boolean sismember(final String key, final String member)", "params": [ { "name": "key", @@ -101834,20 +109153,20 @@ "description": "" }, { - "name": "value", + "name": "member", "type": "String", "description": "" } ], "returns": { - "type": "long", - "description": "1 if the key was set, 0 if the key was not set @deprecated Use Jedis#set(String, String, redis.clients.jedis.params.SetParams) with redis.clients.jedis.params.SetParams#nx(). Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 2.6.12." + "type": "boolean", + "description": "true if the element is a member of the set, false otherwise" } } ], "lettuce_sync": [ { - "signature": "Boolean setnx(K key, V value)", + "signature": "Boolean sismember(K key, V member)", "params": [ { "name": "key", @@ -101855,20 +109174,20 @@ "description": "the key." }, { - "name": "value", + "name": "member", "type": "V", - "description": "the value." + "description": "the member type: value." } ], "returns": { "type": "Boolean", - "description": "Boolean integer-reply specifically: 1 if the key was set 0 if the key was not set." + "description": "Boolean integer-reply specifically: true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." } } ], "lettuce_async": [ { - "signature": "RedisFuture setnx(K key, V value)", + "signature": "RedisFuture sismember(K key, V member)", "params": [ { "name": "key", @@ -101876,20 +109195,20 @@ "description": "the key." }, { - "name": "value", + "name": "member", "type": "V", - "description": "the value." + "description": "the member type: value." } ], "returns": { "type": "RedisFuture", - "description": "Boolean integer-reply specifically: 1 if the key was set 0 if the key was not set." + "description": "Boolean integer-reply specifically: true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." } } ], "lettuce_reactive": [ { - "signature": "Mono setnx(K key, V value)", + "signature": "Mono sismember(K key, V member)", "params": [ { "name": "key", @@ -101897,20 +109216,20 @@ "description": "the key." }, { - "name": "value", + "name": "member", "type": "V", - "description": "the value." + "description": "the member type: value." } ], "returns": { "type": "Mono", - "description": "Boolean integer-reply specifically: 1 if the key was set 0 if the key was not set." + "description": "Boolean integer-reply specifically: true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." } } ], "go-redis": [ { - "signature": "SetNX(ctx context.Context, key string, value interface{}, expiration time.Duration)", + "signature": "SIsMember(ctx context.Context, key string, member interface{})", "params": [ { "name": "ctx", @@ -101923,14 +109242,9 @@ "description": "" }, { - "name": "value", + "name": "member", "type": "interface{}", "description": "" - }, - { - "name": "expiration", - "type": "time.Duration", - "description": "" } ], "returns": { @@ -101941,7 +109255,7 @@ ], "node_redis": [ { - "signature": "SETNX(key: RedisArgument, value: RedisArgument)", + "signature": "SISMEMBER(key: RedisArgument, member: RedisArgument)", "params": [ { "name": "key", @@ -101949,7 +109263,7 @@ "description": "" }, { - "name": "value", + "name": "member", "type": "RedisArgument", "description": "" } @@ -101962,7 +109276,7 @@ ], "ioredis": [ { - "signature": "setnx(key: RedisKey, value: string | Buffer | number, callback?: Callback)", + "signature": "sismember(key: RedisKey, member: string | Buffer | number, callback?: Callback)", "params": [ { "name": "key", @@ -101970,7 +109284,7 @@ "description": "" }, { - "name": "value", + "name": "member", "type": "string | Buffer | number", "description": "" }, @@ -101988,7 +109302,7 @@ ], "redis_rs_sync": [ { - "signature": "set_nx(key: K, value: V)", + "signature": "sismember(key: K, member: M)", "params": [ { "name": "key", @@ -101996,8 +109310,8 @@ "description": "" }, { - "name": "value", - "type": "V", + "name": "member", + "type": "M", "description": "" } ], @@ -102009,7 +109323,7 @@ ], "redis_rs_async": [ { - "signature": "set_nx(key: K, value: V)", + "signature": "sismember(key: K, member: M)", "params": [ { "name": "key", @@ -102017,8 +109331,8 @@ "description": "" }, { - "name": "value", - "type": "V", + "name": "member", + "type": "M", "description": "" } ], @@ -102028,9 +109342,205 @@ } } ], + "nredisstack_sync": [ + { + "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "value", + "type": "RedisValue", + "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "bool", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + } + }, + { + "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "values", + "type": "RedisValue[]", + "description": "The members to check for." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "bool[]", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + } + }, + { + "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "value", + "type": "RedisValue", + "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "bool", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + } + }, + { + "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "values", + "type": "RedisValue[]", + "description": "The members to check for." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "bool[]", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + } + } + ], + "nredisstack_async": [ + { + "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "value", + "type": "RedisValue", + "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "bool", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + } + }, + { + "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "values", + "type": "RedisValue[]", + "description": "The members to check for." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "bool[]", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + } + }, + { + "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "value", + "type": "RedisValue", + "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "bool", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + } + }, + { + "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "key", + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "values", + "type": "RedisValue[]", + "description": "The members to check for." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." + } + ], + "returns": { + "type": "bool[]", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + } + } + ], "php": [ { - "signature": "setnx(string $key, $value)", + "signature": "sismember(string $key, string $member)", "params": [ { "name": "$key", @@ -102038,8 +109548,8 @@ "description": "" }, { - "name": "$value", - "type": "Any", + "name": "$member", + "type": "string", "description": "" } ], @@ -102051,7 +109561,7 @@ ], "redis_rb": [ { - "signature": "setnx(key, value)", + "signature": "sismember(key, member)", "params": [ { "name": "key", @@ -102059,223 +109569,231 @@ "description": "" }, { - "name": "value", + "name": "member", "type": "String", "description": "" } ], "returns": { "type": "Boolean", - "description": "whether the key was set or not" + "description": "" } } ] } }, - "SETRANGE": { + "SLAVEOF": { "api_calls": { "redis_py": [ { - "signature": "setrange(name: KeyT, offset: int, value: EncodableT)", + "signature": "slaveof(host: str | None = None, port: int | str | None = None, **kwargs)", "params": [ { - "name": "name", - "type": "KeyT", + "name": "host", + "type": "str | None", "description": "" }, { - "name": "offset", - "type": "int", + "name": "port", + "type": "int | str | None", "description": "" }, { - "name": "value", - "type": "EncodableT", + "name": "**kwargs", + "type": "Any", "description": "" } ], "returns": { - "type": "ResponseT", + "type": "str", "description": "" } } ], "jedis": [ { - "signature": "long setrange(final byte[] key, final long offset, final byte[] value)", + "signature": "String slaveof(String host, int port)", "params": [ { - "name": "key", - "type": "byte[]", - "description": "" - }, - { - "name": "offset", - "type": "long", + "name": "host", + "type": "String", "description": "" }, { - "name": "value", - "type": "byte[]", + "name": "port", + "type": "int", "description": "" } ], "returns": { - "type": "long", + "type": "String", "description": "" } }, { - "signature": "long setrange(final String key, final long offset, final String value)", + "signature": "String slaveofNoOne()", + "params": [], + "returns": { + "type": "String", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "SlaveOf(ctx context.Context, host, port string) *StatusCmd", "params": [ { - "name": "key", - "type": "String", - "description": "" + "name": "ctx", + "type": "context.Context", + "description": "Context" }, { - "name": "offset", - "type": "long", + "name": "host", + "type": "string", "description": "" }, { - "name": "value", - "type": "String", + "name": "port", + "type": "string", "description": "" } ], "returns": { - "type": "long", + "type": "*StatusCmd", "description": "" } } ], + "node_redis": [], "lettuce_sync": [ { - "signature": "Long setrange(K key, long offset, V value)", + "signature": "String slaveof(String host, int port)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." - }, - { - "name": "offset", - "type": "long", - "description": "the offset type: long." + "name": "host", + "type": "String", + "description": "" }, { - "name": "value", - "type": "V", - "description": "the value." + "name": "port", + "type": "int", + "description": "" } ], "returns": { - "type": "Long", - "description": "Long integer-reply the length of the string after it was modified by the command." + "type": "String", + "description": "" + } + }, + { + "signature": "String slaveofNoOne()", + "params": [], + "returns": { + "type": "String", + "description": "" } } ], "lettuce_async": [ { - "signature": "RedisFuture setrange(K key, long offset, V value)", + "signature": "RedisFuture slaveof(String host, int port)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." - }, - { - "name": "offset", - "type": "long", - "description": "the offset type: long." + "name": "host", + "type": "String", + "description": "" }, { - "name": "value", - "type": "V", - "description": "the value." + "name": "port", + "type": "int", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Long integer-reply the length of the string after it was modified by the command." + "type": "RedisFuture", + "description": "" + } + }, + { + "signature": "RedisFuture slaveofNoOne()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "" } } ], "lettuce_reactive": [ { - "signature": "Mono setrange(K key, long offset, V value)", + "signature": "Mono slaveof(String host, int port)", "params": [ { - "name": "key", - "type": "K", - "description": "the key." - }, - { - "name": "offset", - "type": "long", - "description": "the offset type: long." + "name": "host", + "type": "String", + "description": "" }, { - "name": "value", - "type": "V", - "description": "the value." + "name": "port", + "type": "int", + "description": "" } ], "returns": { - "type": "Mono", - "description": "Long integer-reply the length of the string after it was modified by the command." + "type": "Mono", + "description": "" + } + }, + { + "signature": "Mono slaveofNoOne()", + "params": [], + "returns": { + "type": "Mono", + "description": "" } } ], - "go-redis": [ + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ { - "signature": "SetRange(ctx context.Context, key string, offset int64, value string)", + "signature": "slaveof(string $host, int $port)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" - }, - { - "name": "key", + "name": "$host", "type": "string", "description": "" }, { - "name": "offset", - "type": "int64", - "description": "" - }, - { - "name": "value", - "type": "string", + "name": "$port", + "type": "int", "description": "" } ], "returns": { - "type": "*IntCmd", + "type": "string", "description": "" } } ], - "node_redis": [ + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "SLOWLOG GET": { + "api_calls": { + "redis_py": [ { - "signature": "SETRANGE(key: RedisArgument, offset: number, value: RedisArgument)", + "signature": "slowlog_get(num: int | None = None, **kwargs)", "params": [ { - "name": "key", - "type": "RedisArgument", - "description": "" - }, - { - "name": "offset", - "type": "number", + "name": "num", + "type": "int | None", "description": "" }, { - "name": "value", - "type": "RedisArgument", + "name": "**kwargs", + "type": "Any", "description": "" } ], @@ -102285,294 +109803,193 @@ } } ], - "ioredis": [ + "jedis": [ { - "signature": "setrange(key: RedisKey, offset: number | string, value: string | Buffer | number, callback?: Callback)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "offset", - "type": "number | string", - "description": "" - }, - { - "name": "value", - "type": "string | Buffer | number", - "description": "" - }, + "signature": "List slowlogGet()", + "params": [], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "List slowlogGet(long entries)", + "params": [ { - "name": "callback?", - "type": "Callback", + "name": "entries", + "type": "long", "description": "" } ], "returns": { - "type": "Any", + "type": "List", "description": "" } } ], - "redis_rs_sync": [ + "go-redis": [ { - "signature": "setrange(key: K, offset: isize, value: V)", + "signature": "SlowLogGet(ctx context.Context, num int64) *SlowLogCmd", "params": [ { - "name": "key", - "type": "K", - "description": "" - }, - { - "name": "offset", - "type": "isize", - "description": "" + "name": "ctx", + "type": "context.Context", + "description": "Context" }, { - "name": "value", - "type": "V", + "name": "num", + "type": "int64", "description": "" } ], "returns": { - "type": "(usize)", + "type": "*SlowLogCmd", "description": "" } } ], - "redis_rs_async": [ + "node_redis": [], + "lettuce_sync": [ { - "signature": "setrange(key: K, offset: isize, value: V)", + "signature": "List slowlogGet()", + "params": [], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "List slowlogGet(int count)", "params": [ { - "name": "key", - "type": "K", - "description": "" - }, - { - "name": "offset", - "type": "isize", - "description": "" - }, - { - "name": "value", - "type": "V", + "name": "count", + "type": "int", "description": "" } ], "returns": { - "type": "(usize)", + "type": "List", "description": "" } } ], - "nredisstack_sync": [ + "lettuce_async": [ { - "signature": "StringSetRange(RedisKey key, long offset, RedisValue value, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the string." - }, - { - "name": "offset", - "type": "long", - "description": "The offset in the string to overwrite." - }, - { - "name": "value", - "type": "RedisValue", - "description": "The value to overwrite with." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], + "signature": "RedisFuture> slowlogGet()", + "params": [], "returns": { - "type": "RedisValue", - "description": "The length of the string after it was modified by the command." + "type": "RedisFuture>", + "description": "" } }, { - "signature": "StringSetRange(RedisKey key, long offset, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture> slowlogGet(int count)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The key of the string." - }, - { - "name": "offset", - "type": "long", - "description": "The offset in the string to overwrite." - }, - { - "name": "value", - "type": "RedisValue", - "description": "The value to overwrite with." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "count", + "type": "int", + "description": "" } ], "returns": { - "type": "RedisValue", - "description": "The length of the string after it was modified by the command." + "type": "RedisFuture>", + "description": "" } } ], - "nredisstack_async": [ + "lettuce_reactive": [ { - "signature": "StringSetRange(RedisKey key, long offset, RedisValue value, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "key", - "type": "RedisKey", - "description": "The key of the string." - }, - { - "name": "offset", - "type": "long", - "description": "The offset in the string to overwrite." - }, - { - "name": "value", - "type": "RedisValue", - "description": "The value to overwrite with." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], + "signature": "Flux slowlogGet()", + "params": [], "returns": { - "type": "RedisValue", - "description": "The length of the string after it was modified by the command." + "type": "Flux", + "description": "" } }, { - "signature": "StringSetRange(RedisKey key, long offset, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "Flux slowlogGet(int count)", "params": [ { - "name": "key", - "type": "RedisKey", - "description": "The key of the string." - }, - { - "name": "offset", - "type": "long", - "description": "The offset in the string to overwrite." - }, - { - "name": "value", - "type": "RedisValue", - "description": "The value to overwrite with." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "count", + "type": "int", + "description": "" } ], "returns": { - "type": "RedisValue", - "description": "The length of the string after it was modified by the command." + "type": "Flux", + "description": "" } } ], + "nredisstack_sync": [], + "nredisstack_async": [], "php": [ { - "signature": "setrange(string $key, $offset, $value)", + "signature": "slowlog(string $operation, ?int $length = null)", "params": [ { - "name": "$key", + "name": "$operation", "type": "string", "description": "" }, { - "name": "$offset", - "type": "Any", - "description": "" - }, - { - "name": "$value", - "type": "Any", + "name": "$length", + "type": "int|null", "description": "" } ], "returns": { - "type": "int", + "type": "array|int|bool", "description": "" } } ], - "redis_rb": [ + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "SLOWLOG HELP": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ { - "signature": "setrange(key, offset, value)", + "signature": "slowlog(string $subcommand, ...$args)", "params": [ { - "name": "key", - "type": "String", + "name": "$subcommand", + "type": "string", "description": "" }, { - "name": "offset", - "type": "Integer", - "description": "byte offset" - }, - { - "name": "value", - "type": "String", + "name": "$args", + "type": "mixed", "description": "" } ], "returns": { - "type": "Integer", - "description": "length of the string after it was modified" + "type": "array", + "description": "" } } - ] + ], + "redis_rs_sync": [], + "redis_rs_async": [] } }, - "SHUTDOWN": { + "SLOWLOG LEN": { "api_calls": { "redis_py": [ { - "signature": "shutdown(save: bool = False, nosave: bool = False, now: bool = False, force: bool = False, abort: bool = False, **kwargs)", + "signature": "slowlog_len(**kwargs)", "params": [ - { - "name": "save", - "type": "bool", - "description": "Save before shutdown" - }, - { - "name": "nosave", - "type": "bool", - "description": "Don't save" - }, - { - "name": "now", - "type": "bool", - "description": "Shutdown now" - }, - { - "name": "force", - "type": "bool", - "description": "Force shutdown" - }, - { - "name": "abort", - "type": "bool", - "description": "Abort shutdown" - }, { "name": "**kwargs", "type": "Any", @@ -102580,194 +109997,225 @@ } ], "returns": { - "type": "None", + "type": "int", "description": "" } } ], "jedis": [ { - "signature": "void shutdown()", + "signature": "long slowlogLen()", "params": [], "returns": { - "type": "void", + "type": "long", "description": "" } - }, + } + ], + "go-redis": [ { - "signature": "void shutdown(ShutdownParams shutdownParams)", + "signature": "SlowLogLen(ctx context.Context) *IntCmd", "params": [ { - "name": "shutdownParams", - "type": "ShutdownParams", - "description": "Shutdown parameters" + "name": "ctx", + "type": "context.Context", + "description": "Context" } ], "returns": { - "type": "void", + "type": "*IntCmd", "description": "" } - }, + } + ], + "node_redis": [], + "lettuce_sync": [ { - "signature": "String shutdownAbort()", + "signature": "Long slowlogLen()", "params": [], "returns": { - "type": "String", + "type": "Long", "description": "" } } ], - "go-redis": [ + "lettuce_async": [ { - "signature": "Shutdown(ctx context.Context) *StatusCmd", - "params": [ - { - "name": "ctx", - "type": "context.Context", - "description": "Context" - } - ], + "signature": "RedisFuture slowlogLen()", + "params": [], "returns": { - "type": "*StatusCmd", + "type": "RedisFuture", "description": "" } } ], - "node_redis": [ + "lettuce_reactive": [ { - "signature": "SHUTDOWN(options?: ShutdownOptions)", - "params": [ - { - "name": "options", - "type": "ShutdownOptions", - "description": "Options for the shutdown process" - } - ], + "signature": "Mono slowlogLen()", + "params": [], "returns": { - "type": "void | SimpleStringReply", + "type": "Mono", "description": "" } } ], - "lettuce_sync": [ + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ { - "signature": "void shutdown(boolean save)", + "signature": "slowlog(string $operation, ?int $length = null)", "params": [ { - "name": "save", - "type": "boolean", + "name": "$operation", + "type": "string", + "description": "" + }, + { + "name": "$length", + "type": "int|null", "description": "" } ], "returns": { - "type": "void", + "type": "array|int|bool", "description": "" } - }, + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "SLOWLOG RESET": { + "api_calls": { + "redis_py": [ { - "signature": "void shutdown(ShutdownArgs args)", + "signature": "slowlog_reset(**kwargs)", "params": [ { - "name": "args", - "type": "ShutdownArgs", + "name": "**kwargs", + "type": "Any", "description": "" } ], "returns": { - "type": "void", + "type": "Any", "description": "" } } ], - "lettuce_async": [ + "jedis": [ { - "signature": "void shutdown(boolean save)", - "params": [ - { - "name": "save", - "type": "boolean", - "description": "" - } - ], + "signature": "String slowlogReset()", + "params": [], "returns": { - "type": "void", + "type": "String", "description": "" } - }, + } + ], + "go-redis": [ { - "signature": "void shutdown(ShutdownArgs args)", + "signature": "SlowLogReset(ctx context.Context) *StatusCmd", "params": [ { - "name": "args", - "type": "ShutdownArgs", - "description": "" + "name": "ctx", + "type": "context.Context", + "description": "Context" } ], "returns": { - "type": "void", + "type": "*StatusCmd", + "description": "" + } + } + ], + "node_redis": [], + "lettuce_sync": [ + { + "signature": "String slowlogReset()", + "params": [], + "returns": { + "type": "String", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture slowlogReset()", + "params": [], + "returns": { + "type": "RedisFuture", "description": "" } } ], "lettuce_reactive": [ { - "signature": "Mono shutdown(boolean save)", - "params": [ - { - "name": "save", - "type": "boolean", - "description": "" - } - ], + "signature": "Mono slowlogReset()", + "params": [], "returns": { - "type": "Mono", + "type": "Mono", "description": "" } - }, + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ { - "signature": "Mono shutdown(ShutdownArgs args)", + "signature": "slowlog(string $operation, ?int $length = null)", "params": [ { - "name": "args", - "type": "ShutdownArgs", + "name": "$operation", + "type": "string", + "description": "" + }, + { + "name": "$length", + "type": "int|null", "description": "" } ], "returns": { - "type": "Mono", + "type": "array|int|bool", "description": "" } } ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "SLOWLOG": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], "nredisstack_sync": [], "nredisstack_async": [], "php": [ { - "signature": "shutdown(?bool $noSave = null, bool $now = false, bool $force = false, bool $abort = false)", + "signature": "slowlog(string $subcommand, ...$args)", "params": [ { - "name": "$noSave", - "type": "bool|null", - "description": "" - }, - { - "name": "$now", - "type": "bool", - "description": "" - }, - { - "name": "$force", - "type": "bool", + "name": "$subcommand", + "type": "string", "description": "" }, { - "name": "$abort", - "type": "bool", + "name": "$args", + "type": "mixed", "description": "" } ], "returns": { - "type": "Status", + "type": "mixed", "description": "" } } @@ -102776,52 +110224,47 @@ "redis_rs_async": [] } }, - "SINTER": { + "SMEMBERS": { "api_calls": { "redis_py": [ { - "signature": "sinter(keys: List, *args: List)", + "signature": "smembers(name: KeyT)", "params": [ { - "name": "keys", - "type": "List", - "description": "" - }, - { - "name": "*args", - "type": "List", + "name": "name", + "type": "KeyT", "description": "" } ], "returns": { - "type": "Union[Awaitable[list], list]", + "type": "Union[Awaitable[Set], Set]", "description": "" } } ], "jedis": [ { - "signature": "Set sinter(final String... keys)", + "signature": "Set smembers(final String key)", "params": [ { - "name": "keys", - "type": "String...", + "name": "key", + "type": "String", "description": "" } ], "returns": { "type": "Set", - "description": "A set with members of the resulting set" + "description": "Multi bulk reply" } } ], "lettuce_sync": [ { - "signature": "Set sinter(K... keys)", + "signature": "Set smembers(K key)", "params": [ { - "name": "keys", - "type": "K...", + "name": "key", + "type": "K", "description": "the keys." } ], @@ -102831,7 +110274,7 @@ } }, { - "signature": "Long sinter(ValueStreamingChannel channel, K... keys)", + "signature": "Long smembers(ValueStreamingChannel channel, K key)", "params": [ { "name": "channel", @@ -102839,8 +110282,8 @@ "description": "the channel." }, { - "name": "keys", - "type": "K...", + "name": "key", + "type": "K", "description": "the keys." } ], @@ -102852,11 +110295,11 @@ ], "lettuce_async": [ { - "signature": "RedisFuture> sinter(K... keys)", + "signature": "RedisFuture> smembers(K key)", "params": [ { - "name": "keys", - "type": "K...", + "name": "key", + "type": "K", "description": "the keys." } ], @@ -102866,7 +110309,7 @@ } }, { - "signature": "RedisFuture sinter(ValueStreamingChannel channel, K... keys)", + "signature": "RedisFuture smembers(ValueStreamingChannel channel, K key)", "params": [ { "name": "channel", @@ -102874,8 +110317,8 @@ "description": "the channel." }, { - "name": "keys", - "type": "K...", + "name": "key", + "type": "K", "description": "the keys." } ], @@ -102887,21 +110330,21 @@ ], "lettuce_reactive": [ { - "signature": "Flux sinter(K... keys)", + "signature": "Flux smembers(K key)", "params": [ { - "name": "keys", - "type": "K...", + "name": "key", + "type": "K", "description": "the keys." } ], "returns": { "type": "Flux", - "description": "Long count of members of the resulting set. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #sinter." + "description": "Long count of members of the resulting set. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #smembers." } }, { - "signature": "Mono sinter(ValueStreamingChannel channel, K... keys)", + "signature": "Mono smembers(ValueStreamingChannel channel, K key)", "params": [ { "name": "channel", @@ -102909,20 +110352,20 @@ "description": "the channel." }, { - "name": "keys", - "type": "K...", + "name": "key", + "type": "K", "description": "the keys." } ], "returns": { "type": "Mono", - "description": "Long count of members of the resulting set. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #sinter." + "description": "Long count of members of the resulting set. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #smembers." } } ], "go-redis": [ { - "signature": "SInter(ctx context.Context, keys ...string)", + "signature": "SMembers(ctx context.Context, key string)", "params": [ { "name": "ctx", @@ -102930,8 +110373,8 @@ "description": "" }, { - "name": "keys", - "type": "...string", + "name": "key", + "type": "string", "description": "" } ], @@ -102943,11 +110386,11 @@ ], "node_redis": [ { - "signature": "SINTER(keys: RedisVariadicArgument)", + "signature": "SMEMBERS(key: RedisArgument)", "params": [ { - "name": "keys", - "type": "RedisVariadicArgument", + "name": "key", + "type": "RedisArgument", "description": "" } ], @@ -102959,44 +110402,16 @@ ], "ioredis": [ { - "signature": "sinter(...args: [...keys: RedisKey[], callback: Callback])", - "params": [ - { - "name": "...args", - "type": "[...keys", - "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "sinter(...args: [keys: RedisKey[], callback: Callback])", - "params": [ - { - "name": "...args", - "type": "[keys", - "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "sinter(...args: [...keys: RedisKey[]]): Result;, sinterBuffer(...args: [...keys: RedisKey[]]): Result;, sinter(...args: [keys: RedisKey[]]): Result;, sinterBuffer(...args: [keys: RedisKey[]]): Result;, /**, * Intersect multiple sets and return the cardinality of the result, * - _group_: set, * - _complexity_: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets., * - _since_: 7.0.0, */, sintercard(, ...args: [, numkeys: number | string, ...keys: RedisKey[], callback: Callback, ])", + "signature": "smembers(key: RedisKey, callback?: Callback)", "params": [ { - "name": "...args", - "type": "[...keys", + "name": "key", + "type": "RedisKey", "description": "" }, { - "name": "...args", - "type": "[, numkeys", + "name": "callback?", + "type": "Callback", "description": "" } ], @@ -103008,10 +110423,10 @@ ], "redis_rs_sync": [ { - "signature": "sinter(keys: K)", + "signature": "smembers(key: K)", "params": [ { - "name": "keys", + "name": "key", "type": "K", "description": "" } @@ -103024,10 +110439,10 @@ ], "redis_rs_async": [ { - "signature": "sinter(keys: K)", + "signature": "smembers(key: K)", "params": [ { - "name": "keys", + "name": "key", "type": "K", "description": "" } @@ -103040,46 +110455,12 @@ ], "nredisstack_sync": [ { - "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "SetMembers(RedisKey key, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "first", - "type": "RedisKey", - "description": "" - }, - { - "name": "second", + "name": "key", "type": "RedisKey", - "description": "" - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "RedisValue[]", - "description": "List with members of the resulting set." - } - }, - { - "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." + "description": "The key of the set." }, { "name": "flags", @@ -103089,50 +110470,16 @@ ], "returns": { "type": "RedisValue[]", - "description": "List with members of the resulting set." + "description": "All elements of the set." } }, { - "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "SetMembers(RedisKey key, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "first", - "type": "RedisKey", - "description": "" - }, - { - "name": "second", + "name": "key", "type": "RedisKey", - "description": "" - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "RedisValue[]", - "description": "List with members of the resulting set." - } - }, - { - "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." + "description": "The key of the set." }, { "name": "flags", @@ -103142,52 +110489,18 @@ ], "returns": { "type": "RedisValue[]", - "description": "List with members of the resulting set." + "description": "All elements of the set." } } ], "nredisstack_async": [ { - "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "SetMembers(RedisKey key, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "first", - "type": "RedisKey", - "description": "" - }, - { - "name": "second", + "name": "key", "type": "RedisKey", - "description": "" - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "RedisValue[]", - "description": "List with members of the resulting set." - } - }, - { - "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." + "description": "The key of the set." }, { "name": "flags", @@ -103197,50 +110510,16 @@ ], "returns": { "type": "RedisValue[]", - "description": "List with members of the resulting set." + "description": "All elements of the set." } }, { - "signature": "SetCombine(SetOperation operation, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "SetMembers(RedisKey key, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "first", - "type": "RedisKey", - "description": "" - }, - { - "name": "second", + "name": "key", "type": "RedisKey", - "description": "" - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "RedisValue[]", - "description": "List with members of the resulting set." - } - }, - { - "signature": "SetCombine(SetOperation operation, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." + "description": "The key of the set." }, { "name": "flags", @@ -103250,17 +110529,17 @@ ], "returns": { "type": "RedisValue[]", - "description": "List with members of the resulting set." + "description": "All elements of the set." } } ], "php": [ { - "signature": "sinter(array|string $keys)", + "signature": "smembers(string $key)", "params": [ { - "name": "$keys", - "type": "array|string", + "name": "$key", + "type": "string", "description": "" } ], @@ -103272,355 +110551,411 @@ ], "redis_rb": [ { - "signature": "sinter(*keys)", + "signature": "smembers(key)", "params": [ { - "name": "*keys", - "type": "String, Array", - "description": "keys pointing to sets to intersect" + "name": "key", + "type": "String", + "description": "" } ], "returns": { "type": "Array", - "description": "members in the intersection" + "description": "" } } ] } }, - "SINTERCARD": { + "SMISMEMBER": { "api_calls": { "redis_py": [ { - "signature": "sintercard(numkeys: int, keys: List[KeyT], limit: int = 0)", + "signature": "smismember(name: KeyT, values: List, *args: List)", "params": [ { - "name": "numkeys", - "type": "int", + "name": "name", + "type": "KeyT", "description": "" }, { - "name": "keys", - "type": "List[KeyT]", + "name": "values", + "type": "List", "description": "" }, { - "name": "limit", - "type": "int = 0", + "name": "*args", + "type": "List", "description": "" } ], "returns": { - "type": "Union[Awaitable[int], int]", + "type": "Union[", "description": "" } } ], "jedis": [ { - "signature": "long sintercard(byte[]... keys)", + "signature": "List smismember(final byte[] key, final byte[]... members)", "params": [ { - "name": "keys", - "type": "byte[]...", + "name": "key", + "type": "byte[]", "description": "" - } - ], - "returns": { - "type": "long", - "description": "The cardinality of the set which would result from the intersection of all the given sets" - } - }, - { - "signature": "long sintercard(int limit, byte[]... keys)", - "params": [ - { - "name": "limit", - "type": "int", - "description": "If the intersection cardinality reaches limit partway through the computation," }, { - "name": "keys", + "name": "members", "type": "byte[]...", "description": "" } ], "returns": { - "type": "long", - "description": "The cardinality of the set which would result from the intersection of all the given sets" + "type": "List", + "description": "List representing the membership of the given elements, in the same order as they are requested" } }, { - "signature": "long sintercard(String... keys)", + "signature": "List smismember(final String key, final String... members)", "params": [ { - "name": "keys", + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "members", "type": "String...", "description": "" } ], "returns": { - "type": "long", - "description": "The cardinality of the set which would result from the intersection of all the given sets" + "type": "List", + "description": "List representing the membership of the given elements, in the same order as they are requested" } - }, + } + ], + "lettuce_sync": [ { - "signature": "long sintercard(int limit, String... keys)", + "signature": "List smismember(K key, V... members)", "params": [ { - "name": "limit", - "type": "int", - "description": "If the intersection cardinality reaches limit partway through the computation," + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "keys", - "type": "String...", - "description": "" + "name": "members", + "type": "V...", + "description": "the member type: value." } ], "returns": { - "type": "long", - "description": "The cardinality of the set which would result from the intersection of all the given sets" + "type": "List", + "description": "List<Boolean> array-reply list representing the membership of the given elements, in the same order as they are requested. @since 6.1" } } ], - "lettuce_sync": [ + "lettuce_async": [ { - "signature": "Long sintercard(K... keys)", + "signature": "RedisFuture> smismember(K key, V... members)", "params": [ { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "members", + "type": "V...", + "description": "the member type: value." } ], "returns": { - "type": "Long", - "description": "The cardinality of the set which would result from the intersection of all the given sets. @since 6.2" + "type": "RedisFuture>", + "description": "List<Boolean> array-reply list representing the membership of the given elements, in the same order as they are requested. @since 6.1" } - }, + } + ], + "lettuce_reactive": [ { - "signature": "Long sintercard(long limit, K... keys)", + "signature": "Flux smismember(K key, V... members)", "params": [ { - "name": "limit", - "type": "long", - "description": "If the intersection cardinality reaches limit partway through the computation, the algorithm will exit and" + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "members", + "type": "V...", + "description": "the member type: value." } ], "returns": { - "type": "Long", - "description": "The cardinality of the set which would result from the intersection of all the given sets. @since 6.2" + "type": "Flux", + "description": "Boolean array-reply list representing the membership of the given elements, in the same order as they are requested. @since 6.1" } } ], - "lettuce_async": [ + "go-redis": [ { - "signature": "RedisFuture sintercard(K... keys)", + "signature": "SMIsMember(ctx context.Context, key string, members ...interface{})", "params": [ { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "members", + "type": "...interface{}", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "The cardinality of the set which would result from the intersection of all the given sets. @since 6.2" + "type": "*BoolSliceCmd", + "description": "" } - }, + } + ], + "node_redis": [ { - "signature": "RedisFuture sintercard(long limit, K... keys)", + "signature": "SMISMEMBER(key: RedisArgument, members: Array)", "params": [ { - "name": "limit", - "type": "long", - "description": "If the intersection cardinality reaches limit partway through the computation, the algorithm will exit and" + "name": "key", + "type": "RedisArgument", + "description": "" }, { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "members", + "type": "Array", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "The cardinality of the set which would result from the intersection of all the given sets. @since 6.2" + "type": "Any", + "description": "" } } ], - "lettuce_reactive": [ + "ioredis": [ { - "signature": "Mono sintercard(K... keys)", + "signature": "smismember(...args: [, key: RedisKey, ...members: (string | Buffer | number)[], callback: Callback, ])", "params": [ { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "...args", + "type": "[, key", + "description": "" } ], "returns": { - "type": "Mono", - "description": "The cardinality of the set which would result from the intersection of all the given sets. @since 6.2" + "type": "Any", + "description": "" } }, { - "signature": "Mono sintercard(long limit, K... keys)", + "signature": "smismember(...args: [, key: RedisKey, members: (string | Buffer | number)[], callback: Callback, ])", "params": [ { - "name": "limit", - "type": "long", - "description": "If the intersection cardinality reaches limit partway through the computation, the algorithm will exit and" - }, - { - "name": "keys", - "type": "K...", - "description": "the keys." + "name": "...args", + "type": "[, key", + "description": "" } ], "returns": { - "type": "Mono", - "description": "The cardinality of the set which would result from the intersection of all the given sets. @since 6.2" + "type": "Any", + "description": "" } - } - ], - "go-redis": [ + }, { - "signature": "SInterCard(ctx context.Context, limit int64, keys ...string)", + "signature": "smismember(...args: [key: RedisKey, ...members: (string | Buffer | number)[]])", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" - }, - { - "name": "limit", - "type": "int64", + "name": "...args", + "type": "[key", "description": "" - }, + } + ], + "returns": { + "type": "Any", + "description": "" + } + }, + { + "signature": "smismember(...args: [key: RedisKey, members: (string | Buffer | number)[]])", + "params": [ { - "name": "keys", - "type": "...string", + "name": "...args", + "type": "[key", "description": "" } ], "returns": { - "type": "*IntCmd", + "type": "Any", "description": "" } } ], - "node_redis": [ + "redis_rs_sync": [ { - "signature": "SINTERCARD(keys: RedisVariadicArgument, options?: SInterCardOptions | number)", + "signature": "smismember(key: K, members: M)", "params": [ { - "name": "keys", - "type": "RedisVariadicArgument", + "name": "key", + "type": "K", "description": "" }, { - "name": "options?", - "type": "SInterCardOptions | number", + "name": "members", + "type": "M", "description": "" } ], "returns": { - "type": "Any", + "type": "(Vec)", "description": "" } } ], - "ioredis": [ + "redis_rs_async": [ { - "signature": "sintercard(...args: [, numkeys: number | string, keys: RedisKey[], callback: Callback, ])", + "signature": "smismember(key: K, members: M)", "params": [ { - "name": "...args", - "type": "[, numkeys", + "name": "key", + "type": "K", + "description": "" + }, + { + "name": "members", + "type": "M", "description": "" } ], "returns": { - "type": "Any", + "type": "(Vec)", "description": "" } - }, + } + ], + "nredisstack_sync": [ { - "signature": "sintercard(...args: [numkeys: number | string, ...keys: RedisKey[]])", + "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "...args", - "type": "[numkeys", + "name": "key", + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "value", + "type": "RedisValue", "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Any", - "description": "" + "type": "bool", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." } }, { - "signature": "sintercard(...args: [numkeys: number | string, keys: RedisKey[]])", + "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "...args", - "type": "[numkeys", - "description": "" + "name": "key", + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "values", + "type": "RedisValue[]", + "description": "The members to check for." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Any", - "description": "" + "type": "bool[]", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." } }, { - "signature": "sintercard(...args: [, numkeys: number | string, ...keys: RedisKey[], limitToken: \"LIMIT\", limit: number | string, callback: Callback, ])", + "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "...args", - "type": "[, numkeys", + "name": "key", + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "value", + "type": "RedisValue", "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Any", - "description": "" + "type": "bool", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." } }, { - "signature": "sintercard(...args: [, numkeys: number | string, keys: RedisKey[], limitToken: \"LIMIT\", limit: number | string, callback: Callback, ])", + "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "...args", - "type": "[, numkeys", - "description": "" + "name": "key", + "type": "RedisKey", + "description": "The key of the set." + }, + { + "name": "values", + "type": "RedisValue[]", + "description": "The members to check for." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Any", - "description": "" + "type": "bool[]", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." } } ], - "nredisstack_sync": [ + "nredisstack_async": [ { - "signature": "SetIntersectionLength(RedisKey[] keys, long limit = 0, CommandFlags flags = CommandFlags.None)", + "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets." + "name": "key", + "type": "RedisKey", + "description": "The key of the set." }, { - "name": "limit", - "type": "long", - "description": "The number of elements to check (defaults to 0 and means unlimited)." + "name": "value", + "type": "RedisValue", + "description": "" }, { "name": "flags", @@ -103629,22 +110964,22 @@ } ], "returns": { - "type": "long", - "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." + "type": "bool", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." } }, { - "signature": "SetIntersectionLength(RedisKey[] keys, long limit = 0, CommandFlags flags = CommandFlags.None)", + "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets." + "name": "key", + "type": "RedisKey", + "description": "The key of the set." }, { - "name": "limit", - "type": "long", - "description": "The number of elements to check (defaults to 0 and means unlimited)." + "name": "values", + "type": "RedisValue[]", + "description": "The members to check for." }, { "name": "flags", @@ -103653,24 +110988,22 @@ } ], "returns": { - "type": "long", - "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." + "type": "bool[]", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." } - } - ], - "nredisstack_async": [ + }, { - "signature": "SetIntersectionLength(RedisKey[] keys, long limit = 0, CommandFlags flags = CommandFlags.None)", + "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets." + "name": "key", + "type": "RedisKey", + "description": "The key of the set." }, { - "name": "limit", - "type": "long", - "description": "The number of elements to check (defaults to 0 and means unlimited)." + "name": "value", + "type": "RedisValue", + "description": "" }, { "name": "flags", @@ -103679,22 +111012,22 @@ } ], "returns": { - "type": "long", - "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." + "type": "bool", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." } }, { - "signature": "SetIntersectionLength(RedisKey[] keys, long limit = 0, CommandFlags flags = CommandFlags.None)", + "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets." + "name": "key", + "type": "RedisKey", + "description": "The key of the set." }, { - "name": "limit", - "type": "long", - "description": "The number of elements to check (defaults to 0 and means unlimited)." + "name": "values", + "type": "RedisValue[]", + "description": "The members to check for." }, { "name": "flags", @@ -103703,203 +111036,259 @@ } ], "returns": { - "type": "long", - "description": "The cardinality (number of elements) of the set, or 0 if key does not exist." + "type": "bool[]", + "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." } } ], "php": [ { - "signature": "sintercard(array $keys, int $limit = 0)", + "signature": "smismember(string $key, string ...$members)", "params": [ { - "name": "$keys", - "type": "array", + "name": "$key", + "type": "string", "description": "" }, { - "name": "int $limit = 0", - "type": "Any", + "name": "$members", + "type": "string ...", "description": "" } ], "returns": { - "type": "int", + "type": "array", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "smismember(key, *members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "*members", + "type": "String, Array", + "description": "" + } + ], + "returns": { + "type": "Array", "description": "" } } ] } }, - "SINTERSTORE": { + "SMOVE": { "api_calls": { "redis_py": [ { - "signature": "sinterstore(dest: KeyT, keys: List, *args: List)", + "signature": "smove(src: KeyT, dst: KeyT, value: str)", "params": [ { - "name": "dest", + "name": "src", "type": "KeyT", "description": "" }, { - "name": "keys", - "type": "List", + "name": "dst", + "type": "KeyT", "description": "" }, { - "name": "*args", - "type": "List", + "name": "value", + "type": "str", "description": "" } ], "returns": { - "type": "Union[Awaitable[int], int]", + "type": "Union[Awaitable[bool], bool]", "description": "" } } ], "jedis": [ { - "signature": "long sinterstore(final byte[] dstkey, final byte[]... keys)", + "signature": "long smove(final byte[] srckey, final byte[] dstkey, final byte[] member)", "params": [ + { + "name": "srckey", + "type": "byte[]", + "description": "" + }, { "name": "dstkey", "type": "byte[]", "description": "" }, { - "name": "keys", - "type": "byte[]...", + "name": "member", + "type": "byte[]", "description": "" } ], "returns": { "type": "long", - "description": "The number of elements in the resulting set" + "description": "1 if the element was moved, 0 if the element was not found on the first set and no operation was performed" } }, { - "signature": "long sinterstore(final String dstkey, final String... keys)", + "signature": "long smove(final String srckey, final String dstkey, final String member)", "params": [ + { + "name": "srckey", + "type": "String", + "description": "" + }, { "name": "dstkey", "type": "String", "description": "" }, { - "name": "keys", - "type": "String...", + "name": "member", + "type": "String", "description": "" } ], "returns": { "type": "long", - "description": "The number of elements in the resulting set" + "description": "1 if the element was moved, 0 if the element was not found on the first set and no operation was performed" } } ], "lettuce_sync": [ { - "signature": "Long sinterstore(K destination, K... keys)", + "signature": "Boolean smove(K source, K destination, V member)", "params": [ + { + "name": "source", + "type": "K", + "description": "the source key." + }, { "name": "destination", "type": "K", "description": "the destination type: key." }, { - "name": "keys", - "type": "K...", - "description": "the key." + "name": "member", + "type": "V", + "description": "the member type: value." } ], "returns": { - "type": "Long", - "description": "Long integer-reply the number of elements in the resulting set." + "type": "Boolean", + "description": "Boolean integer-reply specifically: true if the element is moved. false if the element is not a member of source and no operation was performed." } } ], "lettuce_async": [ { - "signature": "RedisFuture sinterstore(K destination, K... keys)", + "signature": "RedisFuture smove(K source, K destination, V member)", "params": [ + { + "name": "source", + "type": "K", + "description": "the source key." + }, { "name": "destination", "type": "K", "description": "the destination type: key." }, { - "name": "keys", - "type": "K...", - "description": "the key." + "name": "member", + "type": "V", + "description": "the member type: value." } ], "returns": { - "type": "RedisFuture", - "description": "Long integer-reply the number of elements in the resulting set." + "type": "RedisFuture", + "description": "Boolean integer-reply specifically: true if the element is moved. false if the element is not a member of source and no operation was performed." } } ], "lettuce_reactive": [ { - "signature": "Mono sinterstore(K destination, K... keys)", + "signature": "Mono smove(K source, K destination, V member)", "params": [ + { + "name": "source", + "type": "K", + "description": "the source key." + }, { "name": "destination", "type": "K", "description": "the destination type: key." }, { - "name": "keys", - "type": "K...", - "description": "the key." + "name": "member", + "type": "V", + "description": "the member type: value." } ], "returns": { - "type": "Mono", - "description": "Long integer-reply the number of elements in the resulting set." + "type": "Mono", + "description": "Boolean integer-reply specifically: true if the element is moved. false if the element is not a member of source and no operation was performed." } } ], "go-redis": [ { - "signature": "SInterStore(ctx context.Context, destination string, keys ...string)", + "signature": "SMove(ctx context.Context, source, destination string, member interface{})", "params": [ { "name": "ctx", "type": "context.Context", "description": "" }, + { + "name": "source", + "type": "Any", + "description": "" + }, { "name": "destination", "type": "string", "description": "" }, { - "name": "keys", - "type": "...string", + "name": "member", + "type": "interface{}", "description": "" } ], "returns": { - "type": "*IntCmd", + "type": "*BoolCmd", "description": "" } } ], "node_redis": [ { - "signature": "SINTERSTORE(destination: RedisArgument, keys: RedisVariadicArgument)", + "signature": "SMOVE(source: RedisArgument, destination: RedisArgument, member: RedisArgument)", "params": [ + { + "name": "source", + "type": "RedisArgument", + "description": "" + }, { "name": "destination", "type": "RedisArgument", "description": "" }, { - "name": "keys", - "type": "RedisVariadicArgument", + "name": "member", + "type": "RedisArgument", "description": "" } ], @@ -103911,53 +111300,26 @@ ], "ioredis": [ { - "signature": "sinterstore(...args: [, destination: RedisKey, ...keys: RedisKey[], callback: Callback, ])", + "signature": "smove(source: RedisKey, destination: RedisKey, member: string | Buffer | number, callback?: Callback)", "params": [ { - "name": "...args", - "type": "[, destination", + "name": "source", + "type": "RedisKey", "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "sinterstore(...args: [, destination: RedisKey, keys: RedisKey[], callback: Callback, ])", - "params": [ + }, { - "name": "...args", - "type": "[, destination", + "name": "destination", + "type": "RedisKey", "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "sinterstore(...args: [destination: RedisKey, ...keys: RedisKey[]])", - "params": [ + }, { - "name": "...args", - "type": "[destination", + "name": "member", + "type": "string | Buffer | number", "description": "" - } - ], - "returns": { - "type": "Any", - "description": "" - } - }, - { - "signature": "sinterstore(...args: [destination: RedisKey, keys: RedisKey[]])", - "params": [ + }, { - "name": "...args", - "type": "[destination", + "name": "callback?", + "type": "Callback", "description": "" } ], @@ -103969,182 +111331,64 @@ ], "redis_rs_sync": [ { - "signature": "sinterstore(dstkey: D, keys: K)", + "signature": "smove(srckey: S, dstkey: D, member: M)", "params": [ { - "name": "dstkey", - "type": "D", + "name": "srckey", + "type": "S", "description": "" }, - { - "name": "keys", - "type": "K", - "description": "" - } - ], - "returns": { - "type": "(usize)", - "description": "" - } - } - ], - "redis_rs_async": [ - { - "signature": "sinterstore(dstkey: D, keys: K)", - "params": [ { "name": "dstkey", "type": "D", "description": "" }, { - "name": "keys", - "type": "K", + "name": "member", + "type": "M", "description": "" } ], "returns": { - "type": "(usize)", + "type": "(bool)", "description": "" } } ], - "nredisstack_sync": [ - { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." - }, - { - "name": "first", - "type": "RedisKey", - "description": "" - }, - { - "name": "second", - "type": "RedisKey", - "description": "" - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "long", - "description": "The number of elements in the resulting set." - } - }, - { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." - }, - { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "long", - "description": "The number of elements in the resulting set." - } - }, - { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." - }, - { - "name": "first", - "type": "RedisKey", - "description": "" - }, - { - "name": "second", - "type": "RedisKey", - "description": "" - }, - { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." - } - ], - "returns": { - "type": "long", - "description": "The number of elements in the resulting set." - } - }, + "redis_rs_async": [ { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", - "params": [ - { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." - }, - { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." + "signature": "smove(srckey: S, dstkey: D, member: M)", + "params": [ + { + "name": "srckey", + "type": "S", + "description": "" }, { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." + "name": "dstkey", + "type": "D", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "member", + "type": "M", + "description": "" } ], "returns": { - "type": "long", - "description": "The number of elements in the resulting set." + "type": "(bool)", + "description": "" } } ], - "nredisstack_async": [ + "nredisstack_sync": [ { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "SetMove(RedisKey source, RedisKey destination, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." + "name": "source", + "type": "RedisKey", + "description": "The key of the source set." }, { "name": "destination", @@ -104152,14 +111396,9 @@ "description": "The key of the destination set." }, { - "name": "first", - "type": "RedisKey", - "description": "" - }, - { - "name": "second", - "type": "RedisKey", - "description": "" + "name": "value", + "type": "RedisValue", + "description": "The value to move." }, { "name": "flags", @@ -104168,17 +111407,17 @@ } ], "returns": { - "type": "long", - "description": "The number of elements in the resulting set." + "type": "bool", + "description": "true if the element is moved. false if the element is not a member of source and no operation was performed." } }, { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "signature": "SetMove(RedisKey source, RedisKey destination, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." + "name": "source", + "type": "RedisKey", + "description": "The key of the source set." }, { "name": "destination", @@ -104186,9 +111425,9 @@ "description": "The key of the destination set." }, { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." + "name": "value", + "type": "RedisValue", + "description": "The value to move." }, { "name": "flags", @@ -104197,17 +111436,19 @@ } ], "returns": { - "type": "long", - "description": "The number of elements in the resulting set." + "type": "bool", + "description": "true if the element is moved. false if the element is not a member of source and no operation was performed." } - }, + } + ], + "nredisstack_async": [ { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey first, RedisKey second, CommandFlags flags = CommandFlags.None)", + "signature": "SetMove(RedisKey source, RedisKey destination, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." + "name": "source", + "type": "RedisKey", + "description": "The key of the source set." }, { "name": "destination", @@ -104215,14 +111456,9 @@ "description": "The key of the destination set." }, { - "name": "first", - "type": "RedisKey", - "description": "" - }, - { - "name": "second", - "type": "RedisKey", - "description": "" + "name": "value", + "type": "RedisValue", + "description": "The value to move." }, { "name": "flags", @@ -104231,17 +111467,17 @@ } ], "returns": { - "type": "long", - "description": "The number of elements in the resulting set." + "type": "bool", + "description": "true if the element is moved. false if the element is not a member of source and no operation was performed." } }, { - "signature": "SetCombineAndStore(SetOperation operation, RedisKey destination, RedisKey[] keys, CommandFlags flags = CommandFlags.None)", + "signature": "SetMove(RedisKey source, RedisKey destination, RedisValue value, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "operation", - "type": "SetOperation", - "description": "The operation to perform." + "name": "source", + "type": "RedisKey", + "description": "The key of the source set." }, { "name": "destination", @@ -104249,9 +111485,9 @@ "description": "The key of the destination set." }, { - "name": "keys", - "type": "RedisKey[]", - "description": "The keys of the sets to operate on." + "name": "value", + "type": "RedisValue", + "description": "The value to move." }, { "name": "flags", @@ -104260,23 +111496,28 @@ } ], "returns": { - "type": "long", - "description": "The number of elements in the resulting set." + "type": "bool", + "description": "true if the element is moved. false if the element is not a member of source and no operation was performed." } } ], "php": [ { - "signature": "sinterstore(string $destination, array|string $keys)", + "signature": "smove(string $source, string $destination, string $member)", "params": [ + { + "name": "$source", + "type": "string", + "description": "" + }, { "name": "$destination", "type": "string", "description": "" }, { - "name": "$keys", - "type": "array|string", + "name": "$member", + "type": "string", "description": "" } ], @@ -104288,32 +111529,37 @@ ], "redis_rb": [ { - "signature": "sinterstore(destination, *keys)", + "signature": "smove(source, destination, member)", "params": [ + { + "name": "source", + "type": "String", + "description": "source key" + }, { "name": "destination", "type": "String", "description": "destination key" }, { - "name": "*keys", - "type": "String, Array", - "description": "keys pointing to sets to intersect" + "name": "member", + "type": "String", + "description": "member to move from source to destination" } ], "returns": { - "type": "Integer", - "description": "number of elements in the resulting set" + "type": "Boolean", + "description": "" } } ] } }, - "SISMEMBER": { + "SORT": { "api_calls": { "redis_py": [ { - "signature": "sismember(name: KeyT, value: str)", + "signature": "sort(name: KeyT, start: Optional[int] = None, num: Optional[int] = None, by: Optional[str] = None, get: Optional[List[str]] = None, desc: bool = False, alpha: bool = False, store: Optional[KeyT] = None, groups: bool = False)", "params": [ { "name": "name", @@ -104321,123 +111567,209 @@ "description": "" }, { - "name": "value", - "type": "str", + "name": "start", + "type": "Optional[int]", + "description": "" + }, + { + "name": "num", + "type": "Optional[int]", + "description": "" + }, + { + "name": "by", + "type": "Optional[str]", + "description": "" + }, + { + "name": "get", + "type": "Optional[List[str]]", + "description": "" + }, + { + "name": "desc", + "type": "bool", + "description": "" + }, + { + "name": "alpha", + "type": "bool", + "description": "" + }, + { + "name": "store", + "type": "Optional[KeyT]", + "description": "" + }, + { + "name": "groups", + "type": "bool", "description": "" } ], "returns": { - "type": "Union[Awaitable[Union[Literal[0], Literal[1]]], Union[Literal[0], Literal[1]]]", + "type": "list", "description": "" } } ], "jedis": [ { - "signature": "boolean sismember(final byte[] key, final byte[] member)", + "signature": "List sort(final byte[] key)", "params": [ { "name": "key", "type": "byte[]", "description": "" - }, + } + ], + "returns": { + "type": "List", + "description": "Sorted elements" + } + }, + { + "signature": "List sort(final byte[] key, final SortingParams sortingParams)", + "params": [ { - "name": "member", + "name": "key", "type": "byte[]", "description": "" + }, + { + "name": "sortingParams", + "type": "SortingParams", + "description": "" } ], "returns": { - "type": "boolean", - "description": "true if the element is a member of the set, false otherwise" + "type": "List", + "description": "Sorted elements" } }, { - "signature": "boolean sismember(final String key, final String member)", + "signature": "List sort(final String key)", "params": [ { "name": "key", "type": "String", "description": "" - }, + } + ], + "returns": { + "type": "List", + "description": "Sorted elements" + } + }, + { + "signature": "List sort(final String key, final SortingParams sortingParams)", + "params": [ { - "name": "member", + "name": "key", "type": "String", "description": "" + }, + { + "name": "sortingParams", + "type": "SortingParams", + "description": "" } ], "returns": { - "type": "boolean", - "description": "true if the element is a member of the set, false otherwise" + "type": "List", + "description": "Sorted elements" } - } - ], - "lettuce_sync": [ + }, { - "signature": "Boolean sismember(K key, V member)", + "signature": "long sort(final byte[] key, final byte[] dstkey)", "params": [ { "name": "key", - "type": "K", - "description": "the key." + "type": "byte[]", + "description": "" }, { - "name": "member", - "type": "V", - "description": "the member type: value." + "name": "dstkey", + "type": "byte[]", + "description": "" } ], "returns": { - "type": "Boolean", - "description": "Boolean integer-reply specifically: true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "long", + "description": "The number of elements in the sorted list" } - } - ], - "lettuce_async": [ + }, { - "signature": "RedisFuture sismember(K key, V member)", + "signature": "long sort(final byte[] key, final SortingParams sortingParams, final byte[] dstkey)", "params": [ { "name": "key", - "type": "K", - "description": "the key." + "type": "byte[]", + "description": "" }, { - "name": "member", - "type": "V", - "description": "the member type: value." + "name": "sortingParams", + "type": "SortingParams", + "description": "" + }, + { + "name": "dstkey", + "type": "byte[]", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Boolean integer-reply specifically: true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "long", + "description": "The number of elements in the sorted list" } - } - ], - "lettuce_reactive": [ + }, { - "signature": "Mono sismember(K key, V member)", + "signature": "long sort(final String key, final String dstkey)", "params": [ { "name": "key", - "type": "K", - "description": "the key." + "type": "String", + "description": "" }, { - "name": "member", - "type": "V", - "description": "the member type: value." + "name": "dstkey", + "type": "String", + "description": "" } ], "returns": { - "type": "Mono", - "description": "Boolean integer-reply specifically: true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "long", + "description": "The number of elements in the sorted list" + } + }, + { + "signature": "long sort(final String key, final SortingParams sortingParams, final String dstkey)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "sortingParams", + "type": "SortingParams", + "description": "" + }, + { + "name": "dstkey", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "The number of elements in the sorted list" } } ], "go-redis": [ { - "signature": "SIsMember(ctx context.Context, key string, member interface{})", + "signature": "Sort(ctx context.Context, key string, sort *Sort)", "params": [ { "name": "ctx", @@ -104450,55 +111782,58 @@ "description": "" }, { - "name": "member", - "type": "interface{}", + "name": "sort", + "type": "*Sort", "description": "" } ], "returns": { - "type": "*BoolCmd", + "type": "*StringSliceCmd", "description": "" } - } - ], - "node_redis": [ + }, { - "signature": "SISMEMBER(key: RedisArgument, member: RedisArgument)", + "signature": "SortStore(ctx context.Context, key, store string, sort *Sort)", "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, { "name": "key", - "type": "RedisArgument", + "type": "string", "description": "" }, { - "name": "member", - "type": "RedisArgument", + "name": "store", + "type": "string", + "description": "" + }, + { + "name": "sort", + "type": "*Sort", "description": "" } ], "returns": { - "type": "Any", + "type": "*IntCmd", "description": "" } } ], - "ioredis": [ + "node_redis": [ { - "signature": "sismember(key: RedisKey, member: string | Buffer | number, callback?: Callback)", + "signature": "SORT(key: RedisArgument, options?: SortOptions)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "" - }, - { - "name": "member", - "type": "string | Buffer | number", + "type": "RedisArgument", "description": "" }, { - "name": "callback?", - "type": "Callback", + "name": "options?", + "type": "SortOptions", "description": "" } ], @@ -104508,159 +111843,221 @@ } } ], - "redis_rs_sync": [ + "lettuce_sync": [ { - "signature": "sismember(key: K, member: M)", + "signature": "List sort(K key)", "params": [ { "name": "key", "type": "K", - "description": "" + "description": "the key." + } + ], + "returns": { + "type": "List", + "description": "List array-reply list of sorted elements." + } + }, + { + "signature": "List sort(K key, SortArgs sortArgs)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "member", - "type": "M", - "description": "" + "name": "sortArgs", + "type": "SortArgs", + "description": "sort arguments." } ], "returns": { - "type": "(bool)", - "description": "" + "type": "List", + "description": "List array-reply list of sorted elements." } - } - ], - "redis_rs_async": [ + }, { - "signature": "sismember(key: K, member: M)", + "signature": "Long sortStore(K key, SortArgs sortArgs, K destination)", "params": [ { "name": "key", "type": "K", - "description": "" + "description": "the key." }, { - "name": "member", - "type": "M", - "description": "" + "name": "sortArgs", + "type": "SortArgs", + "description": "sort arguments." + }, + { + "name": "destination", + "type": "K", + "description": "the destination key." } ], "returns": { - "type": "(bool)", - "description": "" + "type": "Long", + "description": "Long integer-reply the number of elements in the sorted list." } } ], - "nredisstack_sync": [ + "lettuce_async": [ { - "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture> sort(K key)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." - }, + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "List array-reply list of sorted elements." + } + }, + { + "signature": "RedisFuture> sort(K key, SortArgs sortArgs)", + "params": [ { - "name": "value", - "type": "RedisValue", - "description": "" + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "sortArgs", + "type": "SortArgs", + "description": "sort arguments." } ], "returns": { - "type": "bool", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "RedisFuture>", + "description": "List array-reply list of sorted elements." } }, { - "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "signature": "RedisFuture sortStore(K key, SortArgs sortArgs, K destination)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "K", + "description": "the key." }, { - "name": "values", - "type": "RedisValue[]", - "description": "The members to check for." + "name": "sortArgs", + "type": "SortArgs", + "description": "sort arguments." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "destination", + "type": "K", + "description": "the destination key." } ], "returns": { - "type": "bool[]", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "RedisFuture", + "description": "Long integer-reply the number of elements in the sorted list." } - }, + } + ], + "lettuce_reactive": [ { - "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "Flux sort(K key)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." - }, + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "Flux", + "description": "List array-reply list of sorted elements." + } + }, + { + "signature": "Flux sort(K key, SortArgs sortArgs)", + "params": [ { - "name": "value", - "type": "RedisValue", - "description": "" + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "sortArgs", + "type": "SortArgs", + "description": "sort arguments." } ], "returns": { - "type": "bool", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "Flux", + "description": "List array-reply list of sorted elements." } }, { - "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "signature": "Mono sortStore(K key, SortArgs sortArgs, K destination)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "K", + "description": "the key." }, { - "name": "values", - "type": "RedisValue[]", - "description": "The members to check for." + "name": "sortArgs", + "type": "SortArgs", + "description": "sort arguments." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "destination", + "type": "K", + "description": "the destination key." } ], "returns": { - "type": "bool[]", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "Mono", + "description": "Long integer-reply the number of elements in the sorted list." } } ], - "nredisstack_async": [ + "nredisstack_sync": [ { - "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "Sort(RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default, RedisValue[] get = null, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key of the set." + "description": "The key to sort." }, { - "name": "value", + "name": "skip", + "type": "long", + "description": "The number of elements to skip." + }, + { + "name": "take", + "type": "long", + "description": "The number of elements to take." + }, + { + "name": "order", + "type": "Order", + "description": "The sort order." + }, + { + "name": "sortType", + "type": "SortType", + "description": "The sort type." + }, + { + "name": "by", "type": "RedisValue", - "description": "" + "description": "The pattern to sort by." + }, + { + "name": "get", + "type": "RedisValue[]", + "description": "The patterns to get." }, { "name": "flags", @@ -104669,22 +112066,52 @@ } ], "returns": { - "type": "bool", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "RedisValue[]", + "description": "The sorted elements." } }, { - "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "signature": "SortAndStore(RedisKey destination, RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default, RedisValue[] get = null, CommandFlags flags = CommandFlags.None)", "params": [ + { + "name": "destination", + "type": "RedisKey", + "description": "The destination key." + }, { "name": "key", "type": "RedisKey", - "description": "The key of the set." + "description": "The key to sort." }, { - "name": "values", + "name": "skip", + "type": "long", + "description": "The number of elements to skip." + }, + { + "name": "take", + "type": "long", + "description": "The number of elements to take." + }, + { + "name": "order", + "type": "Order", + "description": "The sort order." + }, + { + "name": "sortType", + "type": "SortType", + "description": "The sort type." + }, + { + "name": "by", + "type": "RedisValue", + "description": "The pattern to sort by." + }, + { + "name": "get", "type": "RedisValue[]", - "description": "The members to check for." + "description": "The patterns to get." }, { "name": "flags", @@ -104693,22 +112120,49 @@ } ], "returns": { - "type": "bool[]", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "long", + "description": "The number of elements in the sorted list." } - }, + } + ], + "nredisstack_async": [ { - "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "SortAsync(RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default, RedisValue[] get = null, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "key", "type": "RedisKey", - "description": "The key of the set." + "description": "The key to sort." }, { - "name": "value", + "name": "skip", + "type": "long", + "description": "The number of elements to skip." + }, + { + "name": "take", + "type": "long", + "description": "The number of elements to take." + }, + { + "name": "order", + "type": "Order", + "description": "The sort order." + }, + { + "name": "sortType", + "type": "SortType", + "description": "The sort type." + }, + { + "name": "by", "type": "RedisValue", - "description": "" + "description": "The pattern to sort by." + }, + { + "name": "get", + "type": "RedisValue[]", + "description": "The patterns to get." }, { "name": "flags", @@ -104717,22 +112171,52 @@ } ], "returns": { - "type": "bool", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "Task", + "description": "The sorted elements." } }, { - "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "signature": "SortAndStoreAsync(RedisKey destination, RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default, RedisValue[] get = null, CommandFlags flags = CommandFlags.None)", "params": [ + { + "name": "destination", + "type": "RedisKey", + "description": "The destination key." + }, { "name": "key", "type": "RedisKey", - "description": "The key of the set." + "description": "The key to sort." }, { - "name": "values", + "name": "skip", + "type": "long", + "description": "The number of elements to skip." + }, + { + "name": "take", + "type": "long", + "description": "The number of elements to take." + }, + { + "name": "order", + "type": "Order", + "description": "The sort order." + }, + { + "name": "sortType", + "type": "SortType", + "description": "The sort type." + }, + { + "name": "by", + "type": "RedisValue", + "description": "The pattern to sort by." + }, + { + "name": "get", "type": "RedisValue[]", - "description": "The members to check for." + "description": "The patterns to get." }, { "name": "flags", @@ -104741,14 +112225,14 @@ } ], "returns": { - "type": "bool[]", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "Task", + "description": "The number of elements in the sorted list." } } ], "php": [ { - "signature": "sismember(string $key, string $member)", + "signature": "sort(string $key, array|null $options = null)", "params": [ { "name": "$key", @@ -104756,20 +112240,20 @@ "description": "" }, { - "name": "$member", - "type": "string", + "name": "$options", + "type": "array|null", "description": "" } ], "returns": { - "type": "int", + "type": "array|int|bool", "description": "" } } ], "redis_rb": [ { - "signature": "sismember(key, member)", + "signature": "sort(key, by: nil, limit: nil, get: nil, order: nil, store: nil)", "params": [ { "name": "key", @@ -104777,231 +112261,165 @@ "description": "" }, { - "name": "member", + "name": "by", "type": "String", - "description": "" + "description": "use external key to sort elements by" + }, + { + "name": "limit", + "type": "Array", + "description": "[offset, count] skip offset elements, return max count elements" + }, + { + "name": "get", + "type": "String, Array", + "description": "keys to retrieve per element" + }, + { + "name": "order", + "type": "String", + "description": "combination of ASC, DESC and optionally ALPHA" + }, + { + "name": "store", + "type": "String", + "description": "key to store the result at" } ], "returns": { - "type": "Boolean", - "description": "" + "type": "Array, Integer", + "description": "array of elements or count when store is specified" } } ] } }, - "SLAVEOF": { + "SORT_RO": { "api_calls": { "redis_py": [ { - "signature": "slaveof(host: str | None = None, port: int | str | None = None, **kwargs)", + "signature": "sort_ro(key: str, start: Optional[int] = None, num: Optional[int] = None, by: Optional[str] = None, get: Optional[List[str]] = None, desc: bool = False, alpha: bool = False)", "params": [ { - "name": "host", - "type": "str | None", + "name": "key", + "type": "str", "description": "" }, { - "name": "port", - "type": "int | str | None", + "name": "start", + "type": "Optional[int]", "description": "" }, { - "name": "**kwargs", - "type": "Any", + "name": "num", + "type": "Optional[int]", "description": "" - } - ], - "returns": { - "type": "str", - "description": "" - } - } - ], - "jedis": [ - { - "signature": "String slaveof(String host, int port)", - "params": [ + }, { - "name": "host", - "type": "String", + "name": "by", + "type": "Optional[str]", "description": "" }, { - "name": "port", - "type": "int", + "name": "get", + "type": "Optional[List[str]]", "description": "" - } - ], - "returns": { - "type": "String", - "description": "" - } - }, - { - "signature": "String slaveofNoOne()", - "params": [], - "returns": { - "type": "String", - "description": "" - } - } - ], - "go-redis": [ - { - "signature": "SlaveOf(ctx context.Context, host, port string) *StatusCmd", - "params": [ - { - "name": "ctx", - "type": "context.Context", - "description": "Context" }, { - "name": "host", - "type": "string", + "name": "desc", + "type": "bool", "description": "" }, { - "name": "port", - "type": "string", + "name": "alpha", + "type": "bool", "description": "" } ], "returns": { - "type": "*StatusCmd", + "type": "list", "description": "" } } ], - "node_redis": [], - "lettuce_sync": [ + "jedis": [ { - "signature": "String slaveof(String host, int port)", + "signature": "List sortReadonly(final byte[] key, final SortingParams sortingParams)", "params": [ { - "name": "host", - "type": "String", + "name": "key", + "type": "byte[]", "description": "" }, { - "name": "port", - "type": "int", + "name": "sortingParams", + "type": "SortingParams", "description": "" } ], "returns": { - "type": "String", - "description": "" + "type": "List", + "description": "Sorted elements" } }, { - "signature": "String slaveofNoOne()", - "params": [], - "returns": { - "type": "String", - "description": "" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture slaveof(String host, int port)", + "signature": "List sortReadonly(final String key, final SortingParams sortingParams)", "params": [ { - "name": "host", + "name": "key", "type": "String", "description": "" }, { - "name": "port", - "type": "int", + "name": "sortingParams", + "type": "SortingParams", "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "" - } - }, - { - "signature": "RedisFuture slaveofNoOne()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "" + "type": "List", + "description": "Sorted elements" } } ], - "lettuce_reactive": [ + "go-redis": [ { - "signature": "Mono slaveof(String host, int port)", + "signature": "SortRO(ctx context.Context, key string, sort *Sort)", "params": [ { - "name": "host", - "type": "String", + "name": "ctx", + "type": "context.Context", "description": "" }, { - "name": "port", - "type": "int", - "description": "" - } - ], - "returns": { - "type": "Mono", - "description": "" - } - }, - { - "signature": "Mono slaveofNoOne()", - "params": [], - "returns": { - "type": "Mono", - "description": "" - } - } - ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ - { - "signature": "slaveof(string $host, int $port)", - "params": [ - { - "name": "$host", + "name": "key", "type": "string", "description": "" }, { - "name": "$port", - "type": "int", + "name": "sort", + "type": "*Sort", "description": "" } ], "returns": { - "type": "string", + "type": "*StringSliceCmd", "description": "" } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "SLOWLOG GET": { - "api_calls": { - "redis_py": [ + "node_redis": [ { - "signature": "slowlog_get(num: int | None = None, **kwargs)", + "signature": "SORT_RO(key: RedisArgument, options?: SortOptions)", "params": [ { - "name": "num", - "type": "int | None", + "name": "key", + "type": "RedisArgument", "description": "" }, { - "name": "**kwargs", - "type": "Any", + "name": "options?", + "type": "SortOptions", "description": "" } ], @@ -105011,174 +112429,225 @@ } } ], - "jedis": [ - { - "signature": "List slowlogGet()", - "params": [], - "returns": { - "type": "List", - "description": "" - } - }, + "lettuce_sync": [ { - "signature": "List slowlogGet(long entries)", + "signature": "List sortReadOnly(K key)", "params": [ { - "name": "entries", - "type": "long", - "description": "" + "name": "key", + "type": "K", + "description": "the key." } ], "returns": { - "type": "List", - "description": "" + "type": "List", + "description": "List array-reply list of sorted elements." } - } - ], - "go-redis": [ + }, { - "signature": "SlowLogGet(ctx context.Context, num int64) *SlowLogCmd", + "signature": "List sortReadOnly(K key, SortArgs sortArgs)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" + "name": "key", + "type": "K", + "description": "the key." }, { - "name": "num", - "type": "int64", - "description": "" + "name": "sortArgs", + "type": "SortArgs", + "description": "sort arguments." } ], "returns": { - "type": "*SlowLogCmd", - "description": "" + "type": "List", + "description": "List array-reply list of sorted elements." } } ], - "node_redis": [], - "lettuce_sync": [ + "lettuce_async": [ { - "signature": "List slowlogGet()", - "params": [], + "signature": "RedisFuture> sortReadOnly(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], "returns": { - "type": "List", - "description": "" + "type": "RedisFuture>", + "description": "List array-reply list of sorted elements." } }, { - "signature": "List slowlogGet(int count)", + "signature": "RedisFuture> sortReadOnly(K key, SortArgs sortArgs)", "params": [ { - "name": "count", - "type": "int", - "description": "" + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "sortArgs", + "type": "SortArgs", + "description": "sort arguments." } ], "returns": { - "type": "List", - "description": "" + "type": "RedisFuture>", + "description": "List array-reply list of sorted elements." } } ], - "lettuce_async": [ + "lettuce_reactive": [ { - "signature": "RedisFuture> slowlogGet()", - "params": [], + "signature": "Flux sortReadOnly(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key." + } + ], "returns": { - "type": "RedisFuture>", - "description": "" + "type": "Flux", + "description": "List array-reply list of sorted elements." } }, { - "signature": "RedisFuture> slowlogGet(int count)", + "signature": "Flux sortReadOnly(K key, SortArgs sortArgs)", "params": [ { - "name": "count", - "type": "int", - "description": "" + "name": "key", + "type": "K", + "description": "the key." + }, + { + "name": "sortArgs", + "type": "SortArgs", + "description": "sort arguments." } ], "returns": { - "type": "RedisFuture>", - "description": "" + "type": "Flux", + "description": "List array-reply list of sorted elements." } } ], - "lettuce_reactive": [ - { - "signature": "Flux slowlogGet()", - "params": [], - "returns": { - "type": "Flux", - "description": "" - } - }, + "nredisstack_sync": [ { - "signature": "Flux slowlogGet(int count)", + "signature": "Sort(RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default, RedisValue[] get = null, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "count", - "type": "int", - "description": "" + "name": "key", + "type": "RedisKey", + "description": "The key to sort." + }, + { + "name": "skip", + "type": "long", + "description": "The number of elements to skip." + }, + { + "name": "take", + "type": "long", + "description": "The number of elements to take." + }, + { + "name": "order", + "type": "Order", + "description": "The sort order." + }, + { + "name": "sortType", + "type": "SortType", + "description": "The sort type." + }, + { + "name": "by", + "type": "RedisValue", + "description": "The pattern to sort by." + }, + { + "name": "get", + "type": "RedisValue[]", + "description": "The patterns to get." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "Flux", - "description": "" + "type": "RedisValue[]", + "description": "The sorted elements." } } ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + "nredisstack_async": [ { - "signature": "slowlog(string $operation, ?int $length = null)", + "signature": "SortAsync(RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default, RedisValue[] get = null, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "$operation", - "type": "string", - "description": "" + "name": "key", + "type": "RedisKey", + "description": "The key to sort." }, { - "name": "$length", - "type": "int|null", - "description": "" + "name": "skip", + "type": "long", + "description": "The number of elements to skip." + }, + { + "name": "take", + "type": "long", + "description": "The number of elements to take." + }, + { + "name": "order", + "type": "Order", + "description": "The sort order." + }, + { + "name": "sortType", + "type": "SortType", + "description": "The sort type." + }, + { + "name": "by", + "type": "RedisValue", + "description": "The pattern to sort by." + }, + { + "name": "get", + "type": "RedisValue[]", + "description": "The patterns to get." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The flags to use for this operation." } ], "returns": { - "type": "array|int|bool", - "description": "" + "type": "Task", + "description": "The sorted elements." } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "SLOWLOG HELP": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], "php": [ { - "signature": "slowlog(string $subcommand, ...$args)", + "signature": "sort_ro(string $key, array|null $options = null)", "params": [ { - "name": "$subcommand", + "name": "$key", "type": "string", "description": "" }, { - "name": "$args", - "type": "mixed", + "name": "$options", + "type": "array|null", "description": "" } ], @@ -105187,393 +112656,403 @@ "description": "" } } - ], - "redis_rs_sync": [], - "redis_rs_async": [] + ] } }, - "SLOWLOG LEN": { + "SPERSIST": { "api_calls": { "redis_py": [ { - "signature": "slowlog_len(**kwargs)", + "signature": "spersist(name: KeyT, *members: FieldT)", "params": [ { - "name": "**kwargs", - "type": "Any", + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", "description": "" } ], "returns": { - "type": "int", + "type": "list[int]", "description": "" } } ], - "jedis": [ + "node_redis": [ { - "signature": "long slowlogLen()", - "params": [], + "signature": "sPersist(key: RedisArgument, members: RedisVariadicArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + } + ], "returns": { - "type": "long", + "type": "ArrayReply", "description": "" } } ], "go-redis": [ { - "signature": "SlowLogLen(ctx context.Context) *IntCmd", + "signature": "SPersist(ctx context.Context, key string, members ...string) *IntSliceCmd", "params": [ { "name": "ctx", "type": "context.Context", - "description": "Context" + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" } ], "returns": { - "type": "*IntCmd", - "description": "" - } - } - ], - "node_redis": [], - "lettuce_sync": [ - { - "signature": "Long slowlogLen()", - "params": [], - "returns": { - "type": "Long", - "description": "" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture slowlogLen()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "" - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono slowlogLen()", - "params": [], - "returns": { - "type": "Mono", + "type": "*IntSliceCmd", "description": "" } } ], - "nredisstack_sync": [], - "nredisstack_async": [], "php": [ { - "signature": "slowlog(string $operation, ?int $length = null)", + "signature": "spersist(string $key, array $members)", "params": [ { - "name": "$operation", + "name": "$key", "type": "string", "description": "" }, { - "name": "$length", - "type": "int|null", + "name": "$members", + "type": "array", "description": "" } ], "returns": { - "type": "array|int|bool", + "type": "array", "description": "" } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "SLOWLOG RESET": { - "api_calls": { - "redis_py": [ + "redis_rb": [ { - "signature": "slowlog_reset(**kwargs)", + "signature": "spersist(key, *members)", "params": [ { - "name": "**kwargs", - "type": "Any", + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "*members", + "type": "Array", "description": "" } ], "returns": { - "type": "Any", - "description": "" - } - } - ], - "jedis": [ - { - "signature": "String slowlogReset()", - "params": [], - "returns": { - "type": "String", + "type": "Array", "description": "" } } ], - "go-redis": [ + "lettuce_sync": [ { - "signature": "SlowLogReset(ctx context.Context) *StatusCmd", + "signature": "List spersist(K key, V... members)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to remove the expiration from, must not be null or empty." } ], "returns": { - "type": "*StatusCmd", - "description": "" + "type": "List", + "description": "a list with one Long per member, in the order of members: 1 if the expiration was removed; -1 if the member exists but has no expiration; -2 if the member does not exist or key does not exist." } - } - ], - "node_redis": [], - "lettuce_sync": [ + }, { - "signature": "String slowlogReset()", - "params": [], + "signature": "Long spersist(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to remove the expiration from." + } + ], "returns": { - "type": "String", - "description": "" + "type": "Long", + "description": "1 if the expiration was removed; -1 if the member exists but has no expiration; -2 if the member does not exist or key does not exist." } } ], "lettuce_async": [ { - "signature": "RedisFuture slowlogReset()", - "params": [], - "returns": { - "type": "RedisFuture", - "description": "" - } - } - ], - "lettuce_reactive": [ - { - "signature": "Mono slowlogReset()", - "params": [], - "returns": { - "type": "Mono", - "description": "" - } - } - ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ - { - "signature": "slowlog(string $operation, ?int $length = null)", + "signature": "RedisFuture> spersist(K key, V... members)", "params": [ { - "name": "$operation", - "type": "string", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "$length", - "type": "int|null", - "description": "" + "name": "members", + "type": "V...", + "description": "the members to remove the expiration from, must not be null or empty." } ], "returns": { - "type": "array|int|bool", - "description": "" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 1 if the expiration was removed; -1 if the member exists but has no expiration; -2 if the member does not exist or key does not exist." } - } - ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "SLOWLOG": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + }, { - "signature": "slowlog(string $subcommand, ...$args)", + "signature": "RedisFuture spersist(K key, V member)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "member", + "type": "V", + "description": "the member to remove the expiration from." } ], "returns": { - "type": "mixed", - "description": "" + "type": "RedisFuture", + "description": "1 if the expiration was removed; -1 if the member exists but has no expiration; -2 if the member does not exist or key does not exist." } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "SMEMBERS": { - "api_calls": { - "redis_py": [ + "lettuce_reactive": [ { - "signature": "smembers(name: KeyT)", + "signature": "Flux spersist(K key, V... members)", "params": [ { - "name": "name", - "type": "KeyT", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to remove the expiration from, must not be null or empty." } ], "returns": { - "type": "Union[Awaitable[Set], Set]", - "description": "" + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 1 if the expiration was removed; -1 if the member exists but has no expiration; -2 if the member does not exist or key does not exist." } - } - ], - "jedis": [ + }, { - "signature": "Set smembers(final String key)", + "signature": "Mono spersist(K key, V member)", "params": [ { "name": "key", - "type": "String", - "description": "" + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to remove the expiration from." } ], "returns": { - "type": "Set", - "description": "Multi bulk reply" + "type": "Mono", + "description": "a Mono emitting 1 if the expiration was removed; -1 if the member exists but has no expiration; -2 if the member does not exist or key does not exist." } } ], - "lettuce_sync": [ + "jedis": [ { - "signature": "Set smembers(K key)", + "signature": "List spersist(byte[] key, byte[]... members)", "params": [ { "name": "key", - "type": "K", - "description": "the keys." + "type": "byte[]", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" } ], "returns": { - "type": "Set", - "description": "Long count of members of the resulting set." + "type": "List", + "description": "" } }, { - "signature": "Long smembers(ValueStreamingChannel channel, K key)", + "signature": "long spersist(byte[] key, byte[] member)", "params": [ { - "name": "channel", - "type": "ValueStreamingChannel", - "description": "the channel." + "name": "key", + "type": "byte[]", + "description": "" }, { - "name": "key", - "type": "K", - "description": "the keys." + "name": "member", + "type": "byte[]", + "description": "" } ], "returns": { - "type": "Long", - "description": "Long count of members of the resulting set." + "type": "long", + "description": "" } - } - ], - "lettuce_async": [ + }, { - "signature": "RedisFuture> smembers(K key)", + "signature": "List spersist(String key, String... members)", "params": [ { "name": "key", - "type": "K", - "description": "the keys." + "type": "String", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" } ], "returns": { - "type": "RedisFuture>", - "description": "Long count of members of the resulting set." + "type": "List", + "description": "" } }, { - "signature": "RedisFuture smembers(ValueStreamingChannel channel, K key)", + "signature": "long spersist(String key, String member)", "params": [ { - "name": "channel", - "type": "ValueStreamingChannel", - "description": "the channel." + "name": "key", + "type": "String", + "description": "" }, { - "name": "key", - "type": "K", - "description": "the keys." + "name": "member", + "type": "String", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Long count of members of the resulting set." + "type": "long", + "description": "" } } - ], - "lettuce_reactive": [ + ] + } + }, + "SPEXPIRE": { + "api_calls": { + "redis_py": [ { - "signature": "Flux smembers(K key)", + "signature": "spexpire(name: KeyT, milliseconds: ExpiryT, *members: FieldT, nx: bool = False, xx: bool = False, gt: bool = False, lt: bool = False)", "params": [ { - "name": "key", - "type": "K", - "description": "the keys." + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "milliseconds", + "type": "ExpiryT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", + "description": "" + }, + { + "name": "nx", + "type": "bool", + "description": "" + }, + { + "name": "xx", + "type": "bool", + "description": "" + }, + { + "name": "gt", + "type": "bool", + "description": "" + }, + { + "name": "lt", + "type": "bool", + "description": "" } ], "returns": { - "type": "Flux", - "description": "Long count of members of the resulting set. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #smembers." + "type": "list[int]", + "description": "" } - }, + } + ], + "node_redis": [ { - "signature": "Mono smembers(ValueStreamingChannel channel, K key)", + "signature": "spExpire(key: RedisArgument, members: RedisVariadicArgument, ms: number, mode?: 'NX' | 'XX' | 'GT' | 'LT')", "params": [ { - "name": "channel", - "type": "ValueStreamingChannel", - "description": "the channel." + "name": "key", + "type": "RedisArgument", + "description": "" }, { - "name": "key", - "type": "K", - "description": "the keys." + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + }, + { + "name": "ms", + "type": "number", + "description": "" + }, + { + "name": "mode?", + "type": "'NX' | 'XX' | 'GT' | 'LT'", + "description": "" } ], "returns": { - "type": "Mono", - "description": "Long count of members of the resulting set. @deprecated since 6.0 in favor of consuming large results through the org.reactivestreams.Publisher returned by #smembers." + "type": "ArrayReply>", + "description": "" } } ], "go-redis": [ { - "signature": "SMembers(ctx context.Context, key string)", + "signature": "SPExpire(ctx context.Context, key string, expiration time.Duration, members ...string) *IntSliceCmd", "params": [ { "name": "ctx", @@ -105584,695 +113063,963 @@ "name": "key", "type": "string", "description": "" + }, + { + "name": "expiration", + "type": "time.Duration", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" } ], "returns": { - "type": "*StringSliceCmd", + "type": "*IntSliceCmd", "description": "" } - } - ], - "node_redis": [ + }, { - "signature": "SMEMBERS(key: RedisArgument)", + "signature": "SPExpireWithArgs(ctx context.Context, key string, expiration time.Duration, condition SExpireCondition, members ...string) *IntSliceCmd", "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, { "name": "key", - "type": "RedisArgument", + "type": "string", + "description": "" + }, + { + "name": "expiration", + "type": "time.Duration", + "description": "" + }, + { + "name": "condition", + "type": "SExpireCondition", + "description": "" + }, + { + "name": "members", + "type": "...string", "description": "" } ], "returns": { - "type": "Any", + "type": "*IntSliceCmd", "description": "" } } ], - "ioredis": [ + "php": [ { - "signature": "smembers(key: RedisKey, callback?: Callback)", + "signature": "spexpire(string $key, int $milliseconds, array $members, ?string $flag = null)", "params": [ { - "name": "key", - "type": "RedisKey", + "name": "$key", + "type": "string", "description": "" }, { - "name": "callback?", - "type": "Callback", + "name": "$milliseconds", + "type": "int", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + }, + { + "name": "$flag", + "type": "?string", "description": "" } ], "returns": { - "type": "Any", + "type": "array", "description": "" } } ], - "redis_rs_sync": [ + "redis_rb": [ { - "signature": "smembers(key: K)", + "signature": "spexpire(key, ttl, *members, nx: nil, xx: nil, gt: nil, lt: nil)", "params": [ { "name": "key", - "type": "K", + "type": "String", + "description": "" + }, + { + "name": "ttl", + "type": "Integer", + "description": "" + }, + { + "name": "*members", + "type": "Array", + "description": "" + }, + { + "name": "nx", + "type": "Boolean", + "description": "" + }, + { + "name": "xx", + "type": "Boolean", + "description": "" + }, + { + "name": "gt", + "type": "Boolean", + "description": "" + }, + { + "name": "lt", + "type": "Boolean", "description": "" } ], "returns": { - "type": "(HashSet)", + "type": "Array", "description": "" } } ], - "redis_rs_async": [ + "lettuce_sync": [ { - "signature": "smembers(key: K)", + "signature": "List spexpire(K key, long milliseconds, V... members)", "params": [ { "name": "key", "type": "K", - "description": "" + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "(HashSet)", - "description": "" + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "nredisstack_sync": [ + }, { - "signature": "SetMembers(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "Long spexpire(K key, long milliseconds, V member)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "RedisValue[]", - "description": "All elements of the set." + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetMembers(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "List spexpire(K key, long milliseconds, ExpireArgs expireArgs, V... members)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "RedisValue[]", - "description": "All elements of the set." + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "nredisstack_async": [ + }, { - "signature": "SetMembers(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "Long spexpire(K key, long milliseconds, ExpireArgs expireArgs, V member)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "RedisValue[]", - "description": "All elements of the set." + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetMembers(RedisKey key, CommandFlags flags = CommandFlags.None)", + "signature": "List spexpire(K key, Duration milliseconds, V... members)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "RedisValue[]", - "description": "All elements of the set." + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "php": [ + }, { - "signature": "smembers(string $key)", + "signature": "Long spexpire(K key, Duration milliseconds, V member)", "params": [ { - "name": "$key", - "type": "string", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "string[]", - "description": "" + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "redis_rb": [ + }, { - "signature": "smembers(key)", + "signature": "List spexpire(K key, Duration milliseconds, ExpireArgs expireArgs, V... members)", "params": [ { "name": "key", - "type": "String", - "description": "" + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "Array", - "description": "" + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ] - } - }, - "SMISMEMBER": { - "api_calls": { - "redis_py": [ + }, { - "signature": "smismember(name: KeyT, values: List, *args: List)", + "signature": "Long spexpire(K key, Duration milliseconds, ExpireArgs expireArgs, V member)", "params": [ { - "name": "name", - "type": "KeyT", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "values", - "type": "List", - "description": "" + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." }, { - "name": "*args", - "type": "List", - "description": "" + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "Union[", - "description": "" + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], - "jedis": [ + "lettuce_async": [ { - "signature": "List smismember(final byte[] key, final byte[]... members)", + "signature": "RedisFuture> spexpire(K key, long milliseconds, V... members)", "params": [ { "name": "key", - "type": "byte[]", - "description": "" + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." }, { "name": "members", - "type": "byte[]...", - "description": "" + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "List", - "description": "List representing the membership of the given elements, in the same order as they are requested" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "List smismember(final String key, final String... members)", + "signature": "RedisFuture spexpire(K key, long milliseconds, V member)", "params": [ { "name": "key", - "type": "String", - "description": "" + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "members", - "type": "String...", - "description": "" + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "List", - "description": "List representing the membership of the given elements, in the same order as they are requested" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "lettuce_sync": [ + }, { - "signature": "List smismember(K key, V... members)", + "signature": "RedisFuture> spexpire(K key, long milliseconds, ExpireArgs expireArgs, V... members)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { "name": "members", "type": "V...", - "description": "the member type: value." + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "List", - "description": "List<Boolean> array-reply list representing the membership of the given elements, in the same order as they are requested. @since 6.1" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "lettuce_async": [ + }, { - "signature": "RedisFuture> smismember(K key, V... members)", + "signature": "RedisFuture spexpire(K key, long milliseconds, ExpireArgs expireArgs, V member)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "members", - "type": "V...", - "description": "the member type: value." + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "RedisFuture>", - "description": "List<Boolean> array-reply list representing the membership of the given elements, in the same order as they are requested. @since 6.1" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "lettuce_reactive": [ + }, { - "signature": "Flux smismember(K key, V... members)", + "signature": "RedisFuture> spexpire(K key, Duration milliseconds, V... members)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." }, { "name": "members", "type": "V...", - "description": "the member type: value." + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "Flux", - "description": "Boolean array-reply list representing the membership of the given elements, in the same order as they are requested. @since 6.1" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "go-redis": [ + }, { - "signature": "SMIsMember(ctx context.Context, key string, members ...interface{})", + "signature": "RedisFuture spexpire(K key, Duration milliseconds, V member)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> spexpire(K key, Duration milliseconds, ExpireArgs expireArgs, V... members)", + "params": [ { "name": "key", - "type": "string", - "description": "" + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { "name": "members", - "type": "...interface{}", - "description": "" + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "*BoolSliceCmd", - "description": "" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "node_redis": [ + }, { - "signature": "SMISMEMBER(key: RedisArgument, members: Array)", + "signature": "RedisFuture spexpire(K key, Duration milliseconds, ExpireArgs expireArgs, V member)", "params": [ { "name": "key", - "type": "RedisArgument", - "description": "" + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "members", - "type": "Array", - "description": "" + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "Any", - "description": "" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], - "ioredis": [ + "lettuce_reactive": [ { - "signature": "smismember(...args: [, key: RedisKey, ...members: (string | Buffer | number)[], callback: Callback, ])", + "signature": "Flux spexpire(K key, long milliseconds, V... members)", "params": [ { - "name": "...args", - "type": "[, key", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "Any", - "description": "" + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "smismember(...args: [, key: RedisKey, members: (string | Buffer | number)[], callback: Callback, ])", + "signature": "Mono spexpire(K key, long milliseconds, V member)", "params": [ { - "name": "...args", - "type": "[, key", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "Any", - "description": "" + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "smismember(...args: [key: RedisKey, ...members: (string | Buffer | number)[]])", + "signature": "Flux spexpire(K key, long milliseconds, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "...args", - "type": "[key", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "Any", - "description": "" + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "smismember(...args: [key: RedisKey, members: (string | Buffer | number)[]])", + "signature": "Mono spexpire(K key, long milliseconds, ExpireArgs expireArgs, V member)", "params": [ { - "name": "...args", - "type": "[key", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "Any", - "description": "" + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "redis_rs_sync": [ + }, { - "signature": "smismember(key: K, members: M)", + "signature": "Flux spexpire(K key, Duration milliseconds, V... members)", "params": [ { "name": "key", "type": "K", - "description": "" + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." }, { "name": "members", - "type": "M", - "description": "" + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "(Vec)", - "description": "" + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "redis_rs_async": [ + }, { - "signature": "smismember(key: K, members: M)", + "signature": "Mono spexpire(K key, Duration milliseconds, V member)", "params": [ { "name": "key", "type": "K", - "description": "" + "description": "the key of the set, must not be null." }, { - "name": "members", - "type": "M", - "description": "" + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "(Vec)", - "description": "" + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "nredisstack_sync": [ + }, { - "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "Flux spexpire(K key, Duration milliseconds, ExpireArgs expireArgs, V... members)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "value", - "type": "RedisValue", - "description": "" + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." } ], "returns": { - "type": "bool", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "signature": "Mono spexpire(K key, Duration milliseconds, ExpireArgs expireArgs, V member)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "values", - "type": "RedisValue[]", - "description": "The members to check for." + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." } ], "returns": { - "type": "bool[]", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - }, + } + ], + "jedis": [ { - "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "List spexpire(byte[] key, long milliseconds, byte[]... members)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "byte[]", + "description": "" }, { - "name": "value", - "type": "RedisValue", + "name": "milliseconds", + "type": "long", "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "members", + "type": "byte[]...", + "description": "" } ], "returns": { - "type": "bool", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "List", + "description": "" } }, { - "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "signature": "List spexpire(byte[] key, long milliseconds, ExpiryOption condition, byte[]... members)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "byte[]", + "description": "" }, { - "name": "values", - "type": "RedisValue[]", - "description": "The members to check for." + "name": "milliseconds", + "type": "long", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" } ], "returns": { - "type": "bool[]", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "List", + "description": "" } - } - ], - "nredisstack_async": [ + }, { - "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "long spexpire(byte[] key, long milliseconds, byte[] member)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "byte[]", + "description": "" }, { - "name": "value", - "type": "RedisValue", + "name": "milliseconds", + "type": "long", "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "member", + "type": "byte[]", + "description": "" } ], "returns": { - "type": "bool", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "long", + "description": "" } }, { - "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "signature": "long spexpire(byte[] key, long milliseconds, ExpiryOption condition, byte[] member)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "byte[]", + "description": "" }, { - "name": "values", - "type": "RedisValue[]", - "description": "The members to check for." + "name": "milliseconds", + "type": "long", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" } ], "returns": { - "type": "bool[]", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "long", + "description": "" } }, { - "signature": "SetContains(RedisKey key, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "List spexpire(String key, long milliseconds, String... members)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "String", + "description": "" }, { - "name": "value", - "type": "RedisValue", + "name": "milliseconds", + "type": "long", "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "members", + "type": "String...", + "description": "" } ], "returns": { - "type": "bool", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "List", + "description": "" } }, { - "signature": "SetContains(RedisKey key, RedisValue[] values, CommandFlags flags = CommandFlags.None)", + "signature": "List spexpire(String key, long milliseconds, ExpiryOption condition, String... members)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key of the set." + "type": "String", + "description": "" }, { - "name": "values", - "type": "RedisValue[]", - "description": "The members to check for." + "name": "milliseconds", + "type": "long", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" } ], "returns": { - "type": "bool[]", - "description": "true if the element is a member of the set. false if the element is not a member of the set, or if key does not exist." + "type": "List", + "description": "" } - } - ], - "php": [ + }, { - "signature": "smismember(string $key, string ...$members)", + "signature": "long spexpire(String key, long milliseconds, String member)", "params": [ { - "name": "$key", - "type": "string", + "name": "key", + "type": "String", "description": "" }, { - "name": "$members", - "type": "string ...", + "name": "milliseconds", + "type": "long", + "description": "" + }, + { + "name": "member", + "type": "String", "description": "" } ], "returns": { - "type": "array", + "type": "long", "description": "" } - } - ], - "redis_rb": [ + }, { - "signature": "smismember(key, *members)", + "signature": "long spexpire(String key, long milliseconds, ExpiryOption condition, String member)", "params": [ { "name": "key", @@ -106280,1188 +114027,1343 @@ "description": "" }, { - "name": "*members", - "type": "String, Array", + "name": "milliseconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "member", + "type": "String", "description": "" } ], "returns": { - "type": "Array", + "type": "long", "description": "" } } ] } }, - "SMOVE": { + "SPEXPIREAT": { "api_calls": { "redis_py": [ { - "signature": "smove(src: KeyT, dst: KeyT, value: str)", + "signature": "spexpireat(name: KeyT, unix_time_milliseconds: AbsExpiryT, *members: FieldT, nx: bool = False, xx: bool = False, gt: bool = False, lt: bool = False)", "params": [ { - "name": "src", + "name": "name", "type": "KeyT", "description": "" }, { - "name": "dst", - "type": "KeyT", + "name": "unix_time_milliseconds", + "type": "AbsExpiryT", "description": "" }, { - "name": "value", - "type": "str", + "name": "*members", + "type": "FieldT", + "description": "" + }, + { + "name": "nx", + "type": "bool", + "description": "" + }, + { + "name": "xx", + "type": "bool", + "description": "" + }, + { + "name": "gt", + "type": "bool", + "description": "" + }, + { + "name": "lt", + "type": "bool", "description": "" } ], "returns": { - "type": "Union[Awaitable[bool], bool]", + "type": "list[int]", "description": "" } } ], - "jedis": [ + "node_redis": [ { - "signature": "long smove(final byte[] srckey, final byte[] dstkey, final byte[] member)", + "signature": "spExpireAt(key: RedisArgument, members: RedisVariadicArgument, timestamp: number | Date, mode?: 'NX' | 'XX' | 'GT' | 'LT')", "params": [ { - "name": "srckey", - "type": "byte[]", + "name": "key", + "type": "RedisArgument", "description": "" }, { - "name": "dstkey", - "type": "byte[]", + "name": "members", + "type": "RedisVariadicArgument", "description": "" }, { - "name": "member", - "type": "byte[]", + "name": "timestamp", + "type": "number | Date", + "description": "" + }, + { + "name": "mode?", + "type": "'NX' | 'XX' | 'GT' | 'LT'", "description": "" } ], "returns": { - "type": "long", - "description": "1 if the element was moved, 0 if the element was not found on the first set and no operation was performed" + "type": "ArrayReply>", + "description": "" } - }, + } + ], + "go-redis": [ { - "signature": "long smove(final String srckey, final String dstkey, final String member)", + "signature": "SPExpireAt(ctx context.Context, key string, tm time.Time, members ...string) *IntSliceCmd", "params": [ { - "name": "srckey", - "type": "String", + "name": "ctx", + "type": "context.Context", "description": "" }, { - "name": "dstkey", - "type": "String", + "name": "key", + "type": "string", "description": "" }, { - "name": "member", - "type": "String", + "name": "tm", + "type": "time.Time", + "description": "" + }, + { + "name": "members", + "type": "...string", "description": "" } ], "returns": { - "type": "long", - "description": "1 if the element was moved, 0 if the element was not found on the first set and no operation was performed" + "type": "*IntSliceCmd", + "description": "" } - } - ], - "lettuce_sync": [ + }, { - "signature": "Boolean smove(K source, K destination, V member)", + "signature": "SPExpireAtWithArgs(ctx context.Context, key string, tm time.Time, condition SExpireCondition, members ...string) *IntSliceCmd", "params": [ { - "name": "source", - "type": "K", - "description": "the source key." + "name": "ctx", + "type": "context.Context", + "description": "" }, { - "name": "destination", - "type": "K", - "description": "the destination type: key." + "name": "key", + "type": "string", + "description": "" }, { - "name": "member", - "type": "V", - "description": "the member type: value." + "name": "tm", + "type": "time.Time", + "description": "" + }, + { + "name": "condition", + "type": "SExpireCondition", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" } ], "returns": { - "type": "Boolean", - "description": "Boolean integer-reply specifically: true if the element is moved. false if the element is not a member of source and no operation was performed." + "type": "*IntSliceCmd", + "description": "" } } ], - "lettuce_async": [ + "php": [ { - "signature": "RedisFuture smove(K source, K destination, V member)", + "signature": "spexpireat(string $key, int $unixTimeMilliseconds, array $members, ?string $flag = null)", "params": [ { - "name": "source", - "type": "K", - "description": "the source key." + "name": "$key", + "type": "string", + "description": "" }, { - "name": "destination", - "type": "K", - "description": "the destination type: key." + "name": "$unixTimeMilliseconds", + "type": "int", + "description": "" }, { - "name": "member", - "type": "V", - "description": "the member type: value." + "name": "$members", + "type": "array", + "description": "" + }, + { + "name": "$flag", + "type": "?string", + "description": "" } ], "returns": { - "type": "RedisFuture", - "description": "Boolean integer-reply specifically: true if the element is moved. false if the element is not a member of source and no operation was performed." + "type": "array", + "description": "" } } ], - "lettuce_reactive": [ + "redis_rb": [ { - "signature": "Mono smove(K source, K destination, V member)", + "signature": "spexpireat(key, unix_time_milliseconds, *members, nx: nil, xx: nil, gt: nil, lt: nil)", "params": [ { - "name": "source", - "type": "K", - "description": "the source key." + "name": "key", + "type": "String", + "description": "" }, { - "name": "destination", - "type": "K", - "description": "the destination type: key." + "name": "unix_time_milliseconds", + "type": "Integer", + "description": "" }, { - "name": "member", - "type": "V", - "description": "the member type: value." - } - ], - "returns": { - "type": "Mono", - "description": "Boolean integer-reply specifically: true if the element is moved. false if the element is not a member of source and no operation was performed." - } - } - ], - "go-redis": [ - { - "signature": "SMove(ctx context.Context, source, destination string, member interface{})", - "params": [ + "name": "*members", + "type": "Array", + "description": "" + }, { - "name": "ctx", - "type": "context.Context", + "name": "nx", + "type": "Boolean", "description": "" }, { - "name": "source", - "type": "Any", + "name": "xx", + "type": "Boolean", "description": "" }, { - "name": "destination", - "type": "string", + "name": "gt", + "type": "Boolean", "description": "" }, { - "name": "member", - "type": "interface{}", + "name": "lt", + "type": "Boolean", "description": "" } ], "returns": { - "type": "*BoolCmd", + "type": "Array", "description": "" } } ], - "node_redis": [ + "lettuce_sync": [ { - "signature": "SMOVE(source: RedisArgument, destination: RedisArgument, member: RedisArgument)", + "signature": "List spexpireat(K key, long timestamp, V... members)", "params": [ { - "name": "source", - "type": "RedisArgument", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "destination", - "type": "RedisArgument", - "description": "" + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long spexpireat(K key, long timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." }, { "name": "member", - "type": "RedisArgument", - "description": "" + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "Any", - "description": "" + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "ioredis": [ + }, { - "signature": "smove(source: RedisKey, destination: RedisKey, member: string | Buffer | number, callback?: Callback)", + "signature": "List spexpireat(K key, long timestamp, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "source", - "type": "RedisKey", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "destination", - "type": "RedisKey", - "description": "" + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." }, { - "name": "member", - "type": "string | Buffer | number", - "description": "" + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { - "name": "callback?", - "type": "Callback", - "description": "" + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "Any", - "description": "" + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "redis_rs_sync": [ + }, { - "signature": "smove(srckey: S, dstkey: D, member: M)", + "signature": "Long spexpireat(K key, long timestamp, ExpireArgs expireArgs, V member)", "params": [ { - "name": "srckey", - "type": "S", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "dstkey", - "type": "D", - "description": "" + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { "name": "member", - "type": "M", - "description": "" + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "(bool)", - "description": "" + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "redis_rs_async": [ + }, { - "signature": "smove(srckey: S, dstkey: D, member: M)", + "signature": "List spexpireat(K key, Date timestamp, V... members)", "params": [ { - "name": "srckey", - "type": "S", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "dstkey", - "type": "D", - "description": "" + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "member", - "type": "M", - "description": "" + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "(bool)", - "description": "" + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "nredisstack_sync": [ + }, { - "signature": "SetMove(RedisKey source, RedisKey destination, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "Long spexpireat(K key, Date timestamp, V member)", "params": [ { - "name": "source", - "type": "RedisKey", - "description": "The key of the source set." - }, - { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "value", - "type": "RedisValue", - "description": "The value to move." + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "bool", - "description": "true if the element is moved. false if the element is not a member of source and no operation was performed." + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetMove(RedisKey source, RedisKey destination, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "List spexpireat(K key, Date timestamp, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "source", - "type": "RedisKey", - "description": "The key of the source set." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "value", - "type": "RedisValue", - "description": "The value to move." + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "bool", - "description": "true if the element is moved. false if the element is not a member of source and no operation was performed." + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "nredisstack_async": [ + }, { - "signature": "SetMove(RedisKey source, RedisKey destination, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "Long spexpireat(K key, Date timestamp, ExpireArgs expireArgs, V member)", "params": [ { - "name": "source", - "type": "RedisKey", - "description": "The key of the source set." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "value", - "type": "RedisValue", - "description": "The value to move." + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "bool", - "description": "true if the element is moved. false if the element is not a member of source and no operation was performed." + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SetMove(RedisKey source, RedisKey destination, RedisValue value, CommandFlags flags = CommandFlags.None)", + "signature": "List spexpireat(K key, Instant timestamp, V... members)", "params": [ { - "name": "source", - "type": "RedisKey", - "description": "The key of the source set." - }, - { - "name": "destination", - "type": "RedisKey", - "description": "The key of the destination set." + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "value", - "type": "RedisValue", - "description": "The value to move." + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "bool", - "description": "true if the element is moved. false if the element is not a member of source and no operation was performed." + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "php": [ + }, { - "signature": "smove(string $source, string $destination, string $member)", + "signature": "Long spexpireat(K key, Instant timestamp, V member)", "params": [ { - "name": "$source", - "type": "string", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "$destination", - "type": "string", - "description": "" + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "$member", - "type": "string", - "description": "" + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "int", - "description": "" + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "redis_rb": [ + }, { - "signature": "smove(source, destination, member)", + "signature": "List spexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "source", - "type": "String", - "description": "source key" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "destination", - "type": "String", - "description": "destination key" + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "member", - "type": "String", - "description": "member to move from source to destination" + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "Boolean", - "description": "" + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ] - } - }, - "SORT": { - "api_calls": { - "redis_py": [ + }, { - "signature": "sort(name: KeyT, start: Optional[int] = None, num: Optional[int] = None, by: Optional[str] = None, get: Optional[List[str]] = None, desc: bool = False, alpha: bool = False, store: Optional[KeyT] = None, groups: bool = False)", + "signature": "Long spexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V member)", "params": [ { - "name": "name", - "type": "KeyT", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "start", - "type": "Optional[int]", - "description": "" + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "num", - "type": "Optional[int]", - "description": "" + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { - "name": "by", - "type": "Optional[str]", - "description": "" - }, + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> spexpireat(K key, long timestamp, V... members)", + "params": [ { - "name": "get", - "type": "Optional[List[str]]", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "desc", - "type": "bool", - "description": "" + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." }, { - "name": "alpha", - "type": "bool", - "description": "" + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture spexpireat(K key, long timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "store", - "type": "Optional[KeyT]", - "description": "" + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." }, { - "name": "groups", - "type": "bool", - "description": "" + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "list", - "description": "" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "jedis": [ + }, { - "signature": "List sort(final byte[] key)", + "signature": "RedisFuture> spexpireat(K key, long timestamp, ExpireArgs expireArgs, V... members)", "params": [ { "name": "key", - "type": "byte[]", - "description": "" + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "List", - "description": "Sorted elements" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "List sort(final byte[] key, final SortingParams sortingParams)", + "signature": "RedisFuture spexpireat(K key, long timestamp, ExpireArgs expireArgs, V member)", "params": [ { "name": "key", - "type": "byte[]", - "description": "" + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "sortingParams", - "type": "SortingParams", - "description": "" + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "List", - "description": "Sorted elements" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "List sort(final String key)", + "signature": "RedisFuture> spexpireat(K key, Date timestamp, V... members)", "params": [ { "name": "key", - "type": "String", - "description": "" + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "List", - "description": "Sorted elements" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "List sort(final String key, final SortingParams sortingParams)", + "signature": "RedisFuture spexpireat(K key, Date timestamp, V member)", "params": [ { "name": "key", - "type": "String", - "description": "" + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "sortingParams", - "type": "SortingParams", - "description": "" + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "List", - "description": "Sorted elements" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "long sort(final byte[] key, final byte[] dstkey)", + "signature": "RedisFuture> spexpireat(K key, Date timestamp, ExpireArgs expireArgs, V... members)", "params": [ { "name": "key", - "type": "byte[]", - "description": "" + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "dstkey", - "type": "byte[]", - "description": "" + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "long", - "description": "The number of elements in the sorted list" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "long sort(final byte[] key, final SortingParams sortingParams, final byte[] dstkey)", + "signature": "RedisFuture spexpireat(K key, Date timestamp, ExpireArgs expireArgs, V member)", "params": [ { "name": "key", - "type": "byte[]", - "description": "" + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "sortingParams", - "type": "SortingParams", - "description": "" + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "dstkey", - "type": "byte[]", - "description": "" + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "long", - "description": "The number of elements in the sorted list" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "long sort(final String key, final String dstkey)", + "signature": "RedisFuture> spexpireat(K key, Instant timestamp, V... members)", "params": [ { "name": "key", - "type": "String", - "description": "" + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "dstkey", - "type": "String", - "description": "" + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "long", - "description": "The number of elements in the sorted list" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "long sort(final String key, final SortingParams sortingParams, final String dstkey)", + "signature": "RedisFuture spexpireat(K key, Instant timestamp, V member)", "params": [ { "name": "key", - "type": "String", - "description": "" + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "sortingParams", - "type": "SortingParams", - "description": "" + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "dstkey", - "type": "String", - "description": "" + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "long", - "description": "The number of elements in the sorted list" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "go-redis": [ + }, { - "signature": "Sort(ctx context.Context, key string, sort *Sort)", + "signature": "RedisFuture> spexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V... members)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "key", - "type": "string", - "description": "" + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "sort", - "type": "*Sort", - "description": "" + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "*StringSliceCmd", - "description": "" + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SortStore(ctx context.Context, key, store string, sort *Sort)", + "signature": "RedisFuture spexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V member)", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "" + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "key", - "type": "string", - "description": "" + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "store", - "type": "string", - "description": "" + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { - "name": "sort", - "type": "*Sort", - "description": "" + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "*IntCmd", - "description": "" + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], - "node_redis": [ + "lettuce_reactive": [ { - "signature": "SORT(key: RedisArgument, options?: SortOptions)", + "signature": "Flux spexpireat(K key, long timestamp, V... members)", "params": [ { "name": "key", - "type": "RedisArgument", - "description": "" + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "options?", - "type": "SortOptions", - "description": "" + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "Any", - "description": "" + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "lettuce_sync": [ + }, { - "signature": "List sort(K key)", + "signature": "Mono spexpireat(K key, long timestamp, V member)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "List", - "description": "List array-reply list of sorted elements." + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "List sort(K key, SortArgs sortArgs)", + "signature": "Flux spexpireat(K key, long timestamp, ExpireArgs expireArgs, V... members)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "sortArgs", - "type": "SortArgs", - "description": "sort arguments." + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "List", - "description": "List array-reply list of sorted elements." + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "Long sortStore(K key, SortArgs sortArgs, K destination)", + "signature": "Mono spexpireat(K key, long timestamp, ExpireArgs expireArgs, V member)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "sortArgs", - "type": "SortArgs", - "description": "sort arguments." + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." }, { - "name": "destination", - "type": "K", - "description": "the destination key." + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "Long", - "description": "Long integer-reply the number of elements in the sorted list." + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "lettuce_async": [ + }, { - "signature": "RedisFuture> sort(K key)", + "signature": "Flux spexpireat(K key, Date timestamp, V... members)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "RedisFuture>", - "description": "List array-reply list of sorted elements." + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "RedisFuture> sort(K key, SortArgs sortArgs)", + "signature": "Mono spexpireat(K key, Date timestamp, V member)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "sortArgs", - "type": "SortArgs", - "description": "sort arguments." + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "RedisFuture>", - "description": "List array-reply list of sorted elements." + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "RedisFuture sortStore(K key, SortArgs sortArgs, K destination)", + "signature": "Flux spexpireat(K key, Date timestamp, ExpireArgs expireArgs, V... members)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "sortArgs", - "type": "SortArgs", - "description": "sort arguments." + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "destination", - "type": "K", - "description": "the destination key." + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "RedisFuture", - "description": "Long integer-reply the number of elements in the sorted list." + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "lettuce_reactive": [ + }, { - "signature": "Flux sort(K key)", + "signature": "Mono spexpireat(K key, Date timestamp, ExpireArgs expireArgs, V member)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "Flux", - "description": "List array-reply list of sorted elements." + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "Flux sort(K key, SortArgs sortArgs)", + "signature": "Flux spexpireat(K key, Instant timestamp, V... members)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "sortArgs", - "type": "SortArgs", - "description": "sort arguments." + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "Flux", - "description": "List array-reply list of sorted elements." + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "Mono sortStore(K key, SortArgs sortArgs, K destination)", + "signature": "Mono spexpireat(K key, Instant timestamp, V member)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "sortArgs", - "type": "SortArgs", - "description": "sort arguments." + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "destination", - "type": "K", - "description": "the destination key." + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { "type": "Mono", - "description": "Long integer-reply the number of elements in the sorted list." + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } - } - ], - "nredisstack_sync": [ + }, { - "signature": "Sort(RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default, RedisValue[] get = null, CommandFlags flags = CommandFlags.None)", + "signature": "Flux spexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V... members)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key to sort." - }, - { - "name": "skip", - "type": "long", - "description": "The number of elements to skip." - }, - { - "name": "take", - "type": "long", - "description": "The number of elements to take." - }, - { - "name": "order", - "type": "Order", - "description": "The sort order." - }, - { - "name": "sortType", - "type": "SortType", - "description": "The sort type." + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "by", - "type": "RedisValue", - "description": "The pattern to sort by." + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "get", - "type": "RedisValue[]", - "description": "The patterns to get." + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." } ], "returns": { - "type": "RedisValue[]", - "description": "The sorted elements." + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "SortAndStore(RedisKey destination, RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default, RedisValue[] get = null, CommandFlags flags = CommandFlags.None)", + "signature": "Mono spexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V member)", "params": [ - { - "name": "destination", - "type": "RedisKey", - "description": "The destination key." - }, { "name": "key", - "type": "RedisKey", - "description": "The key to sort." - }, - { - "name": "skip", - "type": "long", - "description": "The number of elements to skip." - }, - { - "name": "take", - "type": "long", - "description": "The number of elements to take." - }, - { - "name": "order", - "type": "Order", - "description": "The sort order." - }, - { - "name": "sortType", - "type": "SortType", - "description": "The sort type." + "type": "K", + "description": "the key of the set, must not be null." }, { - "name": "by", - "type": "RedisValue", - "description": "The pattern to sort by." + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." }, { - "name": "get", - "type": "RedisValue[]", - "description": "The patterns to get." + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "member", + "type": "V", + "description": "the member to set the expiration for." } ], "returns": { - "type": "long", - "description": "The number of elements in the sorted list." + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], - "nredisstack_async": [ + "jedis": [ { - "signature": "SortAsync(RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default, RedisValue[] get = null, CommandFlags flags = CommandFlags.None)", + "signature": "List spexpireAt(byte[] key, long unixTimeMillis, byte[]... members)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key to sort." - }, - { - "name": "skip", - "type": "long", - "description": "The number of elements to skip." + "type": "byte[]", + "description": "" }, { - "name": "take", + "name": "unixTimeMillis", "type": "long", - "description": "The number of elements to take." + "description": "" }, { - "name": "order", - "type": "Order", - "description": "The sort order." - }, + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "List spexpireAt(byte[] key, long unixTimeMillis, ExpiryOption condition, byte[]... members)", + "params": [ { - "name": "sortType", - "type": "SortType", - "description": "The sort type." + "name": "key", + "type": "byte[]", + "description": "" }, { - "name": "by", - "type": "RedisValue", - "description": "The pattern to sort by." + "name": "unixTimeMillis", + "type": "long", + "description": "" }, { - "name": "get", - "type": "RedisValue[]", - "description": "The patterns to get." + "name": "condition", + "type": "ExpiryOption", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "members", + "type": "byte[]...", + "description": "" } ], "returns": { - "type": "Task", - "description": "The sorted elements." + "type": "List", + "description": "" } }, { - "signature": "SortAndStoreAsync(RedisKey destination, RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default, RedisValue[] get = null, CommandFlags flags = CommandFlags.None)", + "signature": "long spexpireAt(byte[] key, long unixTimeMillis, byte[] member)", "params": [ - { - "name": "destination", - "type": "RedisKey", - "description": "The destination key." - }, { "name": "key", - "type": "RedisKey", - "description": "The key to sort." - }, - { - "name": "skip", - "type": "long", - "description": "The number of elements to skip." + "type": "byte[]", + "description": "" }, { - "name": "take", + "name": "unixTimeMillis", "type": "long", - "description": "The number of elements to take." + "description": "" }, { - "name": "order", - "type": "Order", - "description": "The sort order." - }, + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long spexpireAt(byte[] key, long unixTimeMillis, ExpiryOption condition, byte[] member)", + "params": [ { - "name": "sortType", - "type": "SortType", - "description": "The sort type." + "name": "key", + "type": "byte[]", + "description": "" }, { - "name": "by", - "type": "RedisValue", - "description": "The pattern to sort by." + "name": "unixTimeMillis", + "type": "long", + "description": "" }, { - "name": "get", - "type": "RedisValue[]", - "description": "The patterns to get." + "name": "condition", + "type": "ExpiryOption", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "member", + "type": "byte[]", + "description": "" } ], "returns": { - "type": "Task", - "description": "The number of elements in the sorted list." + "type": "long", + "description": "" } - } - ], - "php": [ + }, { - "signature": "sort(string $key, array|null $options = null)", + "signature": "List spexpireAt(String key, long unixTimeMillis, String... members)", "params": [ { - "name": "$key", - "type": "string", + "name": "key", + "type": "String", "description": "" }, { - "name": "$options", - "type": "array|null", + "name": "unixTimeMillis", + "type": "long", + "description": "" + }, + { + "name": "members", + "type": "String...", "description": "" } ], "returns": { - "type": "array|int|bool", + "type": "List", "description": "" } - } - ], - "redis_rb": [ + }, { - "signature": "sort(key, by: nil, limit: nil, get: nil, order: nil, store: nil)", + "signature": "List spexpireAt(String key, long unixTimeMillis, ExpiryOption condition, String... members)", "params": [ { "name": "key", @@ -107469,130 +115371,129 @@ "description": "" }, { - "name": "by", - "type": "String", - "description": "use external key to sort elements by" - }, - { - "name": "limit", - "type": "Array", - "description": "[offset, count] skip offset elements, return max count elements" - }, - { - "name": "get", - "type": "String, Array", - "description": "keys to retrieve per element" + "name": "unixTimeMillis", + "type": "long", + "description": "" }, { - "name": "order", - "type": "String", - "description": "combination of ASC, DESC and optionally ALPHA" + "name": "condition", + "type": "ExpiryOption", + "description": "" }, { - "name": "store", - "type": "String", - "description": "key to store the result at" + "name": "members", + "type": "String...", + "description": "" } ], "returns": { - "type": "Array, Integer", - "description": "array of elements or count when store is specified" + "type": "List", + "description": "" } - } - ] - } - }, - "SORT_RO": { - "api_calls": { - "redis_py": [ + }, { - "signature": "sort_ro(key: str, start: Optional[int] = None, num: Optional[int] = None, by: Optional[str] = None, get: Optional[List[str]] = None, desc: bool = False, alpha: bool = False)", + "signature": "long spexpireAt(String key, long unixTimeMillis, String member)", "params": [ { "name": "key", - "type": "str", + "type": "String", "description": "" }, { - "name": "start", - "type": "Optional[int]", + "name": "unixTimeMillis", + "type": "long", "description": "" }, { - "name": "num", - "type": "Optional[int]", + "name": "member", + "type": "String", "description": "" - }, + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long spexpireAt(String key, long unixTimeMillis, ExpiryOption condition, String member)", + "params": [ { - "name": "by", - "type": "Optional[str]", + "name": "key", + "type": "String", "description": "" }, { - "name": "get", - "type": "Optional[List[str]]", + "name": "unixTimeMillis", + "type": "long", "description": "" }, { - "name": "desc", - "type": "bool", + "name": "condition", + "type": "ExpiryOption", "description": "" }, { - "name": "alpha", - "type": "bool", + "name": "member", + "type": "String", "description": "" } ], "returns": { - "type": "list", + "type": "long", "description": "" } } - ], - "jedis": [ + ] + } + }, + "SPEXPIRETIME": { + "api_calls": { + "redis_py": [ { - "signature": "List sortReadonly(final byte[] key, final SortingParams sortingParams)", + "signature": "spexpiretime(name: KeyT, *members: FieldT)", "params": [ { - "name": "key", - "type": "byte[]", + "name": "name", + "type": "KeyT", "description": "" }, { - "name": "sortingParams", - "type": "SortingParams", + "name": "*members", + "type": "FieldT", "description": "" } ], - "returns": { - "type": "List", - "description": "Sorted elements" + "returns": { + "type": "list[int]", + "description": "" } - }, + } + ], + "node_redis": [ { - "signature": "List sortReadonly(final String key, final SortingParams sortingParams)", + "signature": "spExpireTime(key: RedisArgument, members: RedisVariadicArgument)", "params": [ { "name": "key", - "type": "String", + "type": "RedisArgument", "description": "" }, { - "name": "sortingParams", - "type": "SortingParams", + "name": "members", + "type": "RedisVariadicArgument", "description": "" } ], "returns": { - "type": "List", - "description": "Sorted elements" + "type": "ArrayReply", + "description": "" } } ], "go-redis": [ { - "signature": "SortRO(ctx context.Context, key string, sort *Sort)", + "signature": "SPExpireTime(ctx context.Context, key string, members ...string) *IntSliceCmd", "params": [ { "name": "ctx", @@ -107605,262 +115506,253 @@ "description": "" }, { - "name": "sort", - "type": "*Sort", + "name": "members", + "type": "...string", "description": "" } ], "returns": { - "type": "*StringSliceCmd", + "type": "*IntSliceCmd", "description": "" } } ], - "node_redis": [ + "php": [ { - "signature": "SORT_RO(key: RedisArgument, options?: SortOptions)", + "signature": "spexpiretime(string $key, array $members)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "spexpiretime(key, *members)", "params": [ { "name": "key", - "type": "RedisArgument", + "type": "String", "description": "" }, { - "name": "options?", - "type": "SortOptions", + "name": "*members", + "type": "Array", "description": "" } ], "returns": { - "type": "Any", + "type": "Array", "description": "" } } ], "lettuce_sync": [ { - "signature": "List sortReadOnly(K key)", + "signature": "List spexpiretime(K key, V... members)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the expiration time for, must not be null or empty." } ], "returns": { - "type": "List", - "description": "List array-reply list of sorted elements." + "type": "List", + "description": "a list with one Long per member, in the order of members: the Unix time in milliseconds at which the member expires; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "List sortReadOnly(K key, SortArgs sortArgs)", + "signature": "Long spexpiretime(K key, V member)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "sortArgs", - "type": "SortArgs", - "description": "sort arguments." + "name": "member", + "type": "V", + "description": "the member to get the expiration time for." } ], "returns": { - "type": "List", - "description": "List array-reply list of sorted elements." + "type": "Long", + "description": "the Unix time in milliseconds at which the member expires; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], "lettuce_async": [ { - "signature": "RedisFuture> sortReadOnly(K key)", + "signature": "RedisFuture> spexpiretime(K key, V... members)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the expiration time for, must not be null or empty." } ], "returns": { - "type": "RedisFuture>", - "description": "List array-reply list of sorted elements." + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: the Unix time in milliseconds at which the member expires; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "RedisFuture> sortReadOnly(K key, SortArgs sortArgs)", + "signature": "RedisFuture spexpiretime(K key, V member)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "sortArgs", - "type": "SortArgs", - "description": "sort arguments." + "name": "member", + "type": "V", + "description": "the member to get the expiration time for." } ], "returns": { - "type": "RedisFuture>", - "description": "List array-reply list of sorted elements." + "type": "RedisFuture", + "description": "the Unix time in milliseconds at which the member expires; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], "lettuce_reactive": [ { - "signature": "Flux sortReadOnly(K key)", + "signature": "Flux spexpiretime(K key, V... members)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the expiration time for, must not be null or empty." } ], "returns": { - "type": "Flux", - "description": "List array-reply list of sorted elements." + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: the Unix time in milliseconds at which the member expires; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } }, { - "signature": "Flux sortReadOnly(K key, SortArgs sortArgs)", + "signature": "Mono spexpiretime(K key, V member)", "params": [ { "name": "key", "type": "K", - "description": "the key." + "description": "the key of the set, must not be null." }, { - "name": "sortArgs", - "type": "SortArgs", - "description": "sort arguments." + "name": "member", + "type": "V", + "description": "the member to get the expiration time for." } ], "returns": { - "type": "Flux", - "description": "List array-reply list of sorted elements." + "type": "Mono", + "description": "a Mono emitting the Unix time in milliseconds at which the member expires; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." } } ], - "nredisstack_sync": [ + "jedis": [ { - "signature": "Sort(RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default, RedisValue[] get = null, CommandFlags flags = CommandFlags.None)", + "signature": "List spexpireTime(byte[] key, byte[]... members)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key to sort." - }, - { - "name": "skip", - "type": "long", - "description": "The number of elements to skip." - }, - { - "name": "take", - "type": "long", - "description": "The number of elements to take." - }, - { - "name": "order", - "type": "Order", - "description": "The sort order." - }, - { - "name": "sortType", - "type": "SortType", - "description": "The sort type." - }, - { - "name": "by", - "type": "RedisValue", - "description": "The pattern to sort by." - }, - { - "name": "get", - "type": "RedisValue[]", - "description": "The patterns to get." + "type": "byte[]", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "members", + "type": "byte[]...", + "description": "" } ], "returns": { - "type": "RedisValue[]", - "description": "The sorted elements." + "type": "List", + "description": "" } - } - ], - "nredisstack_async": [ + }, { - "signature": "SortAsync(RedisKey key, long skip = 0, long take = -1, Order order = Order.Ascending, SortType sortType = SortType.Numeric, RedisValue by = default, RedisValue[] get = null, CommandFlags flags = CommandFlags.None)", + "signature": "long spexpireTime(byte[] key, byte[] member)", "params": [ { "name": "key", - "type": "RedisKey", - "description": "The key to sort." - }, - { - "name": "skip", - "type": "long", - "description": "The number of elements to skip." - }, - { - "name": "take", - "type": "long", - "description": "The number of elements to take." - }, - { - "name": "order", - "type": "Order", - "description": "The sort order." - }, - { - "name": "sortType", - "type": "SortType", - "description": "The sort type." + "type": "byte[]", + "description": "" }, { - "name": "by", - "type": "RedisValue", - "description": "The pattern to sort by." - }, + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "List spexpireTime(String key, String... members)", + "params": [ { - "name": "get", - "type": "RedisValue[]", - "description": "The patterns to get." + "name": "key", + "type": "String", + "description": "" }, { - "name": "flags", - "type": "CommandFlags", - "description": "The flags to use for this operation." + "name": "members", + "type": "String...", + "description": "" } ], "returns": { - "type": "Task", - "description": "The sorted elements." + "type": "List", + "description": "" } - } - ], - "php": [ + }, { - "signature": "sort_ro(string $key, array|null $options = null)", + "signature": "long spexpireTime(String key, String member)", "params": [ { - "name": "$key", - "type": "string", + "name": "key", + "type": "String", "description": "" }, { - "name": "$options", - "type": "array|null", + "name": "member", + "type": "String", "description": "" } ], "returns": { - "type": "array", + "type": "long", "description": "" } } @@ -108364,6 +116256,318 @@ ] } }, + "SPTTL": { + "api_calls": { + "redis_py": [ + { + "signature": "spttl(name: KeyT, *members: FieldT)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", + "description": "" + } + ], + "returns": { + "type": "list[int]", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "spTTL(key: RedisArgument, members: RedisVariadicArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "SPTTL(ctx context.Context, key string, members ...string) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "spttl(string $key, array $members)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "spttl(key, *members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "*members", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "Array", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List spttl(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: the remaining time to live in milliseconds, 0 if the member is expiring now; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long spttl(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the time to live for." + } + ], + "returns": { + "type": "Long", + "description": "the remaining time to live in milliseconds, 0 if the member is expiring now; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> spttl(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: the remaining time to live in milliseconds, 0 if the member is expiring now; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture spttl(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the time to live for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "the remaining time to live in milliseconds, 0 if the member is expiring now; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux spttl(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: the remaining time to live in milliseconds, 0 if the member is expiring now; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono spttl(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the time to live for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting the remaining time to live in milliseconds, 0 if the member is expiring now; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "jedis": [ + { + "signature": "List spttl(byte[] key, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long spttl(byte[] key, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "List spttl(String key, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long spttl(String key, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ] + } + }, "SPUBLISH": { "api_calls": { "redis_py": [ @@ -110597,6 +118801,318 @@ ] } }, + "STTL": { + "api_calls": { + "redis_py": [ + { + "signature": "sttl(name: KeyT, *members: FieldT)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", + "description": "" + } + ], + "returns": { + "type": "list[int]", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "sTTL(key: RedisArgument, members: RedisVariadicArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "STTL(ctx context.Context, key string, members ...string) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "sttl(string $key, array $members)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "sttl(key, *members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "*members", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "Array", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List sttl(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: the remaining time to live in seconds, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long sttl(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the time to live for." + } + ], + "returns": { + "type": "Long", + "description": "the remaining time to live in seconds, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> sttl(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: the remaining time to live in seconds, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture sttl(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the time to live for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "the remaining time to live in seconds, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux sttl(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: the remaining time to live in seconds, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono sttl(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the time to live for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting the remaining time to live in seconds, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "jedis": [ + { + "signature": "List sttl(byte[] key, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long sttl(byte[] key, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "List sttl(String key, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long sttl(String key, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ] + } + }, "SUBSCRIBE": { "api_calls": { "redis_py": [], diff --git a/data/command-api-mapping/BITRANGEINTARRAY.json b/data/command-api-mapping/BITRANGEINTARRAY.json new file mode 100644 index 0000000000..80e0954599 --- /dev/null +++ b/data/command-api-mapping/BITRANGEINTARRAY.json @@ -0,0 +1,347 @@ +{ + "api_calls": { + "redis_py": [ + { + "signature": "bitrangeintarray(key: KeyT, start: int, end: int, mode: str | None = None, limit: int | None = None, zeros: bool = False)", + "params": [ + { + "name": "key", + "type": "KeyT", + "description": "" + }, + { + "name": "start", + "type": "int", + "description": "" + }, + { + "name": "end", + "type": "int", + "description": "" + }, + { + "name": "mode", + "type": "str | None", + "description": "" + }, + { + "name": "limit", + "type": "int | None", + "description": "" + }, + { + "name": "zeros", + "type": "bool", + "description": "" + } + ], + "returns": { + "type": "list[int]", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "bitRangeIntArray(key: RedisArgument, start: number | string, end: number | string, options?: BitRangeIntArrayOptions)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "start", + "type": "number | string", + "description": "" + }, + { + "name": "end", + "type": "number | string", + "description": "" + }, + { + "name": "options?", + "type": "BitRangeIntArrayOptions", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "BitRangeIntArray(ctx context.Context, key string, start, end int64) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "start", + "type": "int64", + "description": "" + }, + { + "name": "end", + "type": "int64", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + }, + { + "signature": "BitRangeIntArrayWithArgs(ctx context.Context, key string, start, end int64, args *BitRangeIntArrayArgs) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "start", + "type": "int64", + "description": "" + }, + { + "name": "end", + "type": "int64", + "description": "" + }, + { + "name": "args", + "type": "*BitRangeIntArrayArgs", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "bitrangeintarray(key, start, stop, scale: nil, limit: nil, zeros: false)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "start", + "type": "Integer", + "description": "" + }, + { + "name": "stop", + "type": "Integer", + "description": "" + }, + { + "name": "scale", + "type": "String, Symbol", + "description": "" + }, + { + "name": "limit", + "type": "Integer", + "description": "" + }, + { + "name": "zeros", + "type": "Boolean", + "description": "" + } + ], + "returns": { + "type": "Array", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List bitrangeintarray(K key, long start, long end)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key, must not be null." + }, + { + "name": "start", + "type": "long", + "description": "the first byte of the range, inclusive; negative values count from the end." + }, + { + "name": "end", + "type": "long", + "description": "the last byte of the range, inclusive; negative values count from the end." + } + ], + "returns": { + "type": "List", + "description": "the bit offsets, possibly empty, never null." + } + }, + { + "signature": "List bitrangeintarray(K key, long start, long end, BitRangeIntArrayArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key, must not be null." + }, + { + "name": "start", + "type": "long", + "description": "the first index of the range, inclusive, in the unit of args; negative values count from the end." + }, + { + "name": "end", + "type": "long", + "description": "the last index of the range, inclusive, in the unit of args; negative values count from the end." + }, + { + "name": "args", + "type": "BitRangeIntArrayArgs", + "description": "the unit, limit and clear-bit options, must not be null." + } + ], + "returns": { + "type": "List", + "description": "the bit offsets, possibly empty, never null." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> bitrangeintarray(K key, long start, long end)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key, must not be null." + }, + { + "name": "start", + "type": "long", + "description": "the first byte of the range, inclusive; negative values count from the end." + }, + { + "name": "end", + "type": "long", + "description": "the last byte of the range, inclusive; negative values count from the end." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the bit offsets, possibly empty, never null." + } + }, + { + "signature": "RedisFuture> bitrangeintarray(K key, long start, long end, BitRangeIntArrayArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key, must not be null." + }, + { + "name": "start", + "type": "long", + "description": "the first index of the range, inclusive, in the unit of args; negative values count from the end." + }, + { + "name": "end", + "type": "long", + "description": "the last index of the range, inclusive, in the unit of args; negative values count from the end." + }, + { + "name": "args", + "type": "BitRangeIntArrayArgs", + "description": "the unit, limit and clear-bit options, must not be null." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the bit offsets, possibly empty, never null." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux bitrangeintarray(K key, long start, long end)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key, must not be null." + }, + { + "name": "start", + "type": "long", + "description": "the first byte of the range, inclusive; negative values count from the end." + }, + { + "name": "end", + "type": "long", + "description": "the last byte of the range, inclusive; negative values count from the end." + } + ], + "returns": { + "type": "Flux", + "description": "the bit offsets, possibly none." + } + }, + { + "signature": "Flux bitrangeintarray(K key, long start, long end, BitRangeIntArrayArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key, must not be null." + }, + { + "name": "start", + "type": "long", + "description": "the first index of the range, inclusive, in the unit of args; negative values count from the end." + }, + { + "name": "end", + "type": "long", + "description": "the last index of the range, inclusive, in the unit of args; negative values count from the end." + }, + { + "name": "args", + "type": "BitRangeIntArrayArgs", + "description": "the unit, limit and clear-bit options, must not be null." + } + ], + "returns": { + "type": "Flux", + "description": "the bit offsets, possibly none." + } + } + ] + } +} diff --git a/data/command-api-mapping/BLESS CLEAR.json b/data/command-api-mapping/BLESS CLEAR.json new file mode 100644 index 0000000000..eb1170312f --- /dev/null +++ b/data/command-api-mapping/BLESS CLEAR.json @@ -0,0 +1,217 @@ +{ + "api_calls": { + "redis_py": [ + { + "signature": "bless_clear(name: KeyT, flag: BlessFlag)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "blessClear(key: RedisArgument, flag: BlessFlag)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + } + ], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "BlessClear(ctx context.Context, key string, flag BlessFlag) *IntCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + } + ], + "returns": { + "type": "*IntCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "clear(string $key, string $flag)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$flag", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "bless_clear(key, flag)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "flag", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "Boolean", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Boolean blessClear(K key, BlessFlag flag)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key, must not be null." + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to turn off, must not be null." + } + ], + "returns": { + "type": "Boolean", + "description": "true if the flag was turned off, false if it was not set on key." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture blessClear(K key, BlessFlag flag)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key, must not be null." + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to turn off, must not be null." + } + ], + "returns": { + "type": "RedisFuture", + "description": "true if the flag was turned off, false if it was not set on key." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono blessClear(K key, BlessFlag flag)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key, must not be null." + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to turn off, must not be null." + } + ], + "returns": { + "type": "Mono", + "description": "true if the flag was turned off, false if it was not set on key." + } + } + ], + "jedis": [ + { + "signature": "long blessClear(byte[] key, BlessFlag flag)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long blessClear(String key, BlessFlag flag)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ] + } +} diff --git a/data/command-api-mapping/BLESS GET.json b/data/command-api-mapping/BLESS GET.json new file mode 100644 index 0000000000..21d09e39fa --- /dev/null +++ b/data/command-api-mapping/BLESS GET.json @@ -0,0 +1,167 @@ +{ + "api_calls": { + "redis_py": [ + { + "signature": "bless_get(name: KeyT)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + } + ], + "returns": { + "type": "list[bytes | str]", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "blessGet(key: RedisArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "BlessGet(ctx context.Context, key string) *StringSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "*StringSliceCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "get(string $key)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "bless_get(key)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "Array", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List blessGet(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key, must not be null." + } + ], + "returns": { + "type": "List", + "description": "List array-reply the active blessing flags of key, empty if the key is not blessed." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> blessGet(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key, must not be null." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "List array-reply the active blessing flags of key, empty if the key is not blessed." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux blessGet(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key, must not be null." + } + ], + "returns": { + "type": "Flux", + "description": "the active blessing flags of key; completes empty if the key is not blessed." + } + } + ], + "jedis": [ + { + "signature": "List blessGet(byte[] key)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "List blessGet(String key)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + } + ] + } +} diff --git a/data/command-api-mapping/BLESS SCAN.json b/data/command-api-mapping/BLESS SCAN.json new file mode 100644 index 0000000000..15d418e2ba --- /dev/null +++ b/data/command-api-mapping/BLESS SCAN.json @@ -0,0 +1,466 @@ +{ + "api_calls": { + "redis_py": [ + { + "signature": "bless_scan(cursor: int, flag: BlessFlag, count: int | None = None, **kwargs)", + "params": [ + { + "name": "cursor", + "type": "int", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + }, + { + "name": "count", + "type": "int | None", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "tuple[int, list[bytes | str]]", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "blessScan(cursor: RedisArgument, flag: BlessFlag, options?: BlessScanOptions)", + "params": [ + { + "name": "cursor", + "type": "RedisArgument", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + }, + { + "name": "options?", + "type": "BlessScanOptions", + "description": "" + } + ], + "returns": { + "type": "{ cursor: BlobStringReply; keys: ArrayReply }", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "BlessScan(ctx context.Context, cursor uint64, flag BlessFlag, count int64) *ScanCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "cursor", + "type": "uint64", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + }, + { + "name": "count", + "type": "int64", + "description": "" + } + ], + "returns": { + "type": "*ScanCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "scan($cursor, string $flag, ?array $options = null)", + "params": [ + { + "name": "$cursor", + "type": "mixed", + "description": "" + }, + { + "name": "$flag", + "type": "string", + "description": "" + }, + { + "name": "$options", + "type": "?array", + "description": "" + } + ], + "returns": { + "type": "array|mixed", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "bless_scan(cursor, flag, count: nil)", + "params": [ + { + "name": "cursor", + "type": "String, Integer", + "description": "" + }, + { + "name": "flag", + "type": "String", + "description": "" + }, + { + "name": "count", + "type": "Integer", + "description": "" + } + ], + "returns": { + "type": "Array(String, Array)", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "KeyScanCursor blessScan(BlessFlag flag)", + "params": [ + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." + } + ], + "returns": { + "type": "KeyScanCursor", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "KeyScanCursor blessScan(BlessFlag flag, BlessScanArgs scanArgs)", + "params": [ + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." + }, + { + "name": "scanArgs", + "type": "BlessScanArgs", + "description": "scan arguments, can be null." + } + ], + "returns": { + "type": "KeyScanCursor", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "KeyScanCursor blessScan(ScanCursor scanCursor, BlessFlag flag)", + "params": [ + { + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan, must not be null." + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." + } + ], + "returns": { + "type": "KeyScanCursor", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "KeyScanCursor blessScan(ScanCursor scanCursor, BlessFlag flag, BlessScanArgs scanArgs)", + "params": [ + { + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan, must not be null." + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." + }, + { + "name": "scanArgs", + "type": "BlessScanArgs", + "description": "scan arguments, can be null." + } + ], + "returns": { + "type": "KeyScanCursor", + "description": "KeyScanCursor scan cursor." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> blessScan(BlessFlag flag)", + "params": [ + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "RedisFuture> blessScan(BlessFlag flag, BlessScanArgs scanArgs)", + "params": [ + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." + }, + { + "name": "scanArgs", + "type": "BlessScanArgs", + "description": "scan arguments, can be null." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "RedisFuture> blessScan(ScanCursor scanCursor, BlessFlag flag)", + "params": [ + { + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan, must not be null." + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "RedisFuture> blessScan(ScanCursor scanCursor, BlessFlag flag, BlessScanArgs scanArgs)", + "params": [ + { + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan, must not be null." + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." + }, + { + "name": "scanArgs", + "type": "BlessScanArgs", + "description": "scan arguments, can be null." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "KeyScanCursor scan cursor." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> blessScan(BlessFlag flag)", + "params": [ + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." + } + ], + "returns": { + "type": "Mono>", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "Mono> blessScan(BlessFlag flag, BlessScanArgs scanArgs)", + "params": [ + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." + }, + { + "name": "scanArgs", + "type": "BlessScanArgs", + "description": "scan arguments, can be null." + } + ], + "returns": { + "type": "Mono>", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "Mono> blessScan(ScanCursor scanCursor, BlessFlag flag)", + "params": [ + { + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan, must not be null." + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." + } + ], + "returns": { + "type": "Mono>", + "description": "KeyScanCursor scan cursor." + } + }, + { + "signature": "Mono> blessScan(ScanCursor scanCursor, BlessFlag flag, BlessScanArgs scanArgs)", + "params": [ + { + "name": "scanCursor", + "type": "ScanCursor", + "description": "cursor to resume from a previous scan, must not be null." + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to filter on, must not be null." + }, + { + "name": "scanArgs", + "type": "BlessScanArgs", + "description": "scan arguments, can be null." + } + ], + "returns": { + "type": "Mono>", + "description": "KeyScanCursor scan cursor." + } + } + ], + "jedis": [ + { + "signature": "ScanResult blessScan(byte[] cursor, BlessFlag flag)", + "params": [ + { + "name": "cursor", + "type": "byte[]", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + } + ], + "returns": { + "type": "ScanResult", + "description": "" + } + }, + { + "signature": "ScanResult blessScan(byte[] cursor, BlessFlag flag, int count)", + "params": [ + { + "name": "cursor", + "type": "byte[]", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + }, + { + "name": "count", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "ScanResult", + "description": "" + } + }, + { + "signature": "ScanResult blessScan(String cursor, BlessFlag flag)", + "params": [ + { + "name": "cursor", + "type": "String", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + } + ], + "returns": { + "type": "ScanResult", + "description": "" + } + }, + { + "signature": "ScanResult blessScan(String cursor, BlessFlag flag, int count)", + "params": [ + { + "name": "cursor", + "type": "String", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + }, + { + "name": "count", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "ScanResult", + "description": "" + } + } + ] + } +} diff --git a/data/command-api-mapping/BLESS SET.json b/data/command-api-mapping/BLESS SET.json new file mode 100644 index 0000000000..250bd1b956 --- /dev/null +++ b/data/command-api-mapping/BLESS SET.json @@ -0,0 +1,217 @@ +{ + "api_calls": { + "redis_py": [ + { + "signature": "bless_set(name: KeyT, flag: BlessFlag)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "blessSet(key: RedisArgument, flag: BlessFlag)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + } + ], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "BlessSet(ctx context.Context, key string, flag BlessFlag) *IntCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + } + ], + "returns": { + "type": "*IntCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "set(string $key, string $flag)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$flag", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "bless_set(key, flag)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "flag", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "Boolean", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Boolean blessSet(K key, BlessFlag flag)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key, must not be null." + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to turn on, must not be null." + } + ], + "returns": { + "type": "Boolean", + "description": "true if the flag was turned on, false if it was already set on key." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture blessSet(K key, BlessFlag flag)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key, must not be null." + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to turn on, must not be null." + } + ], + "returns": { + "type": "RedisFuture", + "description": "true if the flag was turned on, false if it was already set on key." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono blessSet(K key, BlessFlag flag)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key, must not be null." + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "the blessing flag to turn on, must not be null." + } + ], + "returns": { + "type": "Mono", + "description": "true if the flag was turned on, false if it was already set on key." + } + } + ], + "jedis": [ + { + "signature": "long blessSet(byte[] key, BlessFlag flag)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long blessSet(String key, BlessFlag flag)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "flag", + "type": "BlessFlag", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ] + } +} diff --git a/data/command-api-mapping/SADDEX.json b/data/command-api-mapping/SADDEX.json new file mode 100644 index 0000000000..5aa2c22cae --- /dev/null +++ b/data/command-api-mapping/SADDEX.json @@ -0,0 +1,590 @@ +{ + "api_calls": { + "redis_py": [ + { + "signature": "saddex(name: KeyT, *members: FieldT, ex: ExpiryT | str | None = None, px: ExpiryT | str | None = None, exat: AbsExpiryT | None = None, pxat: AbsExpiryT | None = None, data_persist_option: SetDataPersistOptions | None = None, keepttl: bool = False)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", + "description": "" + }, + { + "name": "ex", + "type": "ExpiryT | str | None", + "description": "" + }, + { + "name": "px", + "type": "ExpiryT | str | None", + "description": "" + }, + { + "name": "exat", + "type": "AbsExpiryT | None", + "description": "" + }, + { + "name": "pxat", + "type": "AbsExpiryT | None", + "description": "" + }, + { + "name": "data_persist_option", + "type": "SetDataPersistOptions | None", + "description": "" + }, + { + "name": "keepttl", + "type": "bool", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "sAddEx(key: RedisArgument, members: RedisVariadicArgument, options?: SAddExOptions)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + }, + { + "name": "options?", + "type": "SAddExOptions", + "description": "" + } + ], + "returns": { + "type": "NumberReply<0 | 1>", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "SAddEX(ctx context.Context, key string, members ...string) *IntCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntCmd", + "description": "" + } + }, + { + "signature": "SAddEXWithArgs(ctx context.Context, key string, options *SAddEXOptions, members ...string) *IntCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "options", + "type": "*SAddEXOptions", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "saddex(string $key, array $members, string $condition = SADDEX::COND_NULL, string $ttlModifier = SADDEX::TTL_NULL, int|bool $ttlModifierValue = false)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + }, + { + "name": "$condition", + "type": "string", + "description": "" + }, + { + "name": "$ttlModifier", + "type": "string", + "description": "" + }, + { + "name": "$ttlModifierValue", + "type": "int|bool", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "saddex(key, *members, mnx: nil, mxx: nil, ex: nil, px: nil, exat: nil, pxat: nil, keepttl: false)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "*members", + "type": "Array", + "description": "" + }, + { + "name": "mnx", + "type": "Boolean", + "description": "" + }, + { + "name": "mxx", + "type": "Boolean", + "description": "" + }, + { + "name": "ex", + "type": "Integer", + "description": "" + }, + { + "name": "px", + "type": "Integer", + "description": "" + }, + { + "name": "exat", + "type": "Integer", + "description": "" + }, + { + "name": "pxat", + "type": "Integer", + "description": "" + }, + { + "name": "keepttl", + "type": "Boolean", + "description": "" + } + ], + "returns": { + "type": "Integer", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Long saddex(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to add, must not be null or empty." + } + ], + "returns": { + "type": "Long", + "description": "1 if at least one member was added, updated or deleted; 0 if nothing changed." + } + }, + { + "signature": "Long saddex(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to add." + } + ], + "returns": { + "type": "Long", + "description": "1 if at least one member was added, updated or deleted; 0 if nothing changed." + } + }, + { + "signature": "Long saddex(K key, SAddExArgs sAddExArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "sAddExArgs", + "type": "SAddExArgs", + "description": "the command arguments, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to add, must not be null or empty." + } + ], + "returns": { + "type": "Long", + "description": "1 if at least one member was added, updated or deleted; 0 if the MNX or MXX condition was not met, or nothing changed." + } + }, + { + "signature": "Long saddex(K key, SAddExArgs sAddExArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "sAddExArgs", + "type": "SAddExArgs", + "description": "the command arguments, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to add." + } + ], + "returns": { + "type": "Long", + "description": "1 if at least one member was added, updated or deleted; 0 if the MNX or MXX condition was not met, or nothing changed." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture saddex(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to add, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture", + "description": "1 if at least one member was added, updated or deleted; 0 if nothing changed." + } + }, + { + "signature": "RedisFuture saddex(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to add." + } + ], + "returns": { + "type": "RedisFuture", + "description": "1 if at least one member was added, updated or deleted; 0 if nothing changed." + } + }, + { + "signature": "RedisFuture saddex(K key, SAddExArgs sAddExArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "sAddExArgs", + "type": "SAddExArgs", + "description": "the command arguments, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to add, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture", + "description": "1 if at least one member was added, updated or deleted; 0 if the MNX or MXX condition was not met, or nothing changed." + } + }, + { + "signature": "RedisFuture saddex(K key, SAddExArgs sAddExArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "sAddExArgs", + "type": "SAddExArgs", + "description": "the command arguments, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to add." + } + ], + "returns": { + "type": "RedisFuture", + "description": "1 if at least one member was added, updated or deleted; 0 if the MNX or MXX condition was not met, or nothing changed." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono saddex(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to add, must not be null or empty." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 1 if at least one member was added, updated or deleted; 0 if nothing changed." + } + }, + { + "signature": "Mono saddex(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to add." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 1 if at least one member was added, updated or deleted; 0 if nothing changed." + } + }, + { + "signature": "Mono saddex(K key, SAddExArgs sAddExArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "sAddExArgs", + "type": "SAddExArgs", + "description": "the command arguments, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to add, must not be null or empty." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 1 if at least one member was added, updated or deleted; 0 if the MNX or MXX condition was not met, or nothing changed." + } + }, + { + "signature": "Mono saddex(K key, SAddExArgs sAddExArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "sAddExArgs", + "type": "SAddExArgs", + "description": "the command arguments, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to add." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 1 if at least one member was added, updated or deleted; 0 if the MNX or MXX condition was not met, or nothing changed." + } + } + ], + "jedis": [ + { + "signature": "long saddex(byte[] key, SAddExParams params, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "params", + "type": "SAddExParams", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long saddex(byte[] key, SAddExParams params, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "params", + "type": "SAddExParams", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long saddex(String key, SAddExParams params, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "params", + "type": "SAddExParams", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long saddex(String key, SAddExParams params, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "params", + "type": "SAddExParams", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ] + } +} diff --git a/data/command-api-mapping/SEXPIRE.json b/data/command-api-mapping/SEXPIRE.json new file mode 100644 index 0000000000..2e76a9e78c --- /dev/null +++ b/data/command-api-mapping/SEXPIRE.json @@ -0,0 +1,1079 @@ +{ + "api_calls": { + "redis_py": [ + { + "signature": "sexpire(name: KeyT, seconds: ExpiryT, *members: FieldT, nx: bool = False, xx: bool = False, gt: bool = False, lt: bool = False)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "seconds", + "type": "ExpiryT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", + "description": "" + }, + { + "name": "nx", + "type": "bool", + "description": "" + }, + { + "name": "xx", + "type": "bool", + "description": "" + }, + { + "name": "gt", + "type": "bool", + "description": "" + }, + { + "name": "lt", + "type": "bool", + "description": "" + } + ], + "returns": { + "type": "list[int]", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "sExpire(key: RedisArgument, members: RedisVariadicArgument, seconds: number, mode?: 'NX' | 'XX' | 'GT' | 'LT')", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + }, + { + "name": "seconds", + "type": "number", + "description": "" + }, + { + "name": "mode?", + "type": "'NX' | 'XX' | 'GT' | 'LT'", + "description": "" + } + ], + "returns": { + "type": "ArrayReply>", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "SExpire(ctx context.Context, key string, expiration time.Duration, members ...string) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "expiration", + "type": "time.Duration", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + }, + { + "signature": "SExpireWithArgs(ctx context.Context, key string, expiration time.Duration, condition SExpireCondition, members ...string) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "expiration", + "type": "time.Duration", + "description": "" + }, + { + "name": "condition", + "type": "SExpireCondition", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "sexpire(string $key, int $seconds, array $members, ?string $flag = null)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$seconds", + "type": "int", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + }, + { + "name": "$flag", + "type": "?string", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "sexpire(key, ttl, *members, nx: nil, xx: nil, gt: nil, lt: nil)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "ttl", + "type": "Integer", + "description": "" + }, + { + "name": "*members", + "type": "Array", + "description": "" + }, + { + "name": "nx", + "type": "Boolean", + "description": "" + }, + { + "name": "xx", + "type": "Boolean", + "description": "" + }, + { + "name": "gt", + "type": "Boolean", + "description": "" + }, + { + "name": "lt", + "type": "Boolean", + "description": "" + } + ], + "returns": { + "type": "Array", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List sexpire(K key, long seconds, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long sexpire(K key, long seconds, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List sexpire(K key, long seconds, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long sexpire(K key, long seconds, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List sexpire(K key, Duration seconds, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long sexpire(K key, Duration seconds, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List sexpire(K key, Duration seconds, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long sexpire(K key, Duration seconds, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> sexpire(K key, long seconds, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture sexpire(K key, long seconds, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> sexpire(K key, long seconds, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture sexpire(K key, long seconds, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> sexpire(K key, Duration seconds, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture sexpire(K key, Duration seconds, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> sexpire(K key, Duration seconds, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture sexpire(K key, Duration seconds, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux sexpire(K key, long seconds, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono sexpire(K key, long seconds, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux sexpire(K key, long seconds, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono sexpire(K key, long seconds, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "long", + "description": "the time to live in seconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux sexpire(K key, Duration seconds, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono sexpire(K key, Duration seconds, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux sexpire(K key, Duration seconds, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono sexpire(K key, Duration seconds, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "seconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "jedis": [ + { + "signature": "List sexpire(byte[] key, long seconds, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "List sexpire(byte[] key, long seconds, ExpiryOption condition, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long sexpire(byte[] key, long seconds, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long sexpire(byte[] key, long seconds, ExpiryOption condition, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "List sexpire(String key, long seconds, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "List sexpire(String key, long seconds, ExpiryOption condition, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long sexpire(String key, long seconds, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long sexpire(String key, long seconds, ExpiryOption condition, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "seconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ] + } +} diff --git a/data/command-api-mapping/SEXPIREAT.json b/data/command-api-mapping/SEXPIREAT.json new file mode 100644 index 0000000000..677e12bc23 --- /dev/null +++ b/data/command-api-mapping/SEXPIREAT.json @@ -0,0 +1,1397 @@ +{ + "api_calls": { + "redis_py": [ + { + "signature": "sexpireat(name: KeyT, unix_time_seconds: AbsExpiryT, *members: FieldT, nx: bool = False, xx: bool = False, gt: bool = False, lt: bool = False)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "unix_time_seconds", + "type": "AbsExpiryT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", + "description": "" + }, + { + "name": "nx", + "type": "bool", + "description": "" + }, + { + "name": "xx", + "type": "bool", + "description": "" + }, + { + "name": "gt", + "type": "bool", + "description": "" + }, + { + "name": "lt", + "type": "bool", + "description": "" + } + ], + "returns": { + "type": "list[int]", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "sExpireAt(key: RedisArgument, members: RedisVariadicArgument, timestamp: number | Date, mode?: 'NX' | 'XX' | 'GT' | 'LT')", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + }, + { + "name": "timestamp", + "type": "number | Date", + "description": "" + }, + { + "name": "mode?", + "type": "'NX' | 'XX' | 'GT' | 'LT'", + "description": "" + } + ], + "returns": { + "type": "ArrayReply>", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "SExpireAt(ctx context.Context, key string, tm time.Time, members ...string) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "tm", + "type": "time.Time", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + }, + { + "signature": "SExpireAtWithArgs(ctx context.Context, key string, tm time.Time, condition SExpireCondition, members ...string) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "tm", + "type": "time.Time", + "description": "" + }, + { + "name": "condition", + "type": "SExpireCondition", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "sexpireat(string $key, int $unixTimeSeconds, array $members, ?string $flag = null)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$unixTimeSeconds", + "type": "int", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + }, + { + "name": "$flag", + "type": "?string", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "sexpireat(key, unix_time_seconds, *members, nx: nil, xx: nil, gt: nil, lt: nil)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "unix_time_seconds", + "type": "Integer", + "description": "" + }, + { + "name": "*members", + "type": "Array", + "description": "" + }, + { + "name": "nx", + "type": "Boolean", + "description": "" + }, + { + "name": "xx", + "type": "Boolean", + "description": "" + }, + { + "name": "gt", + "type": "Boolean", + "description": "" + }, + { + "name": "lt", + "type": "Boolean", + "description": "" + } + ], + "returns": { + "type": "Array", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List sexpireat(K key, long timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long sexpireat(K key, long timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List sexpireat(K key, long timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long sexpireat(K key, long timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List sexpireat(K key, Date timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long sexpireat(K key, Date timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List sexpireat(K key, Date timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long sexpireat(K key, Date timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List sexpireat(K key, Instant timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long sexpireat(K key, Instant timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List sexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long sexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> sexpireat(K key, long timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture sexpireat(K key, long timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> sexpireat(K key, long timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture sexpireat(K key, long timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> sexpireat(K key, Date timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture sexpireat(K key, Date timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> sexpireat(K key, Date timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture sexpireat(K key, Date timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> sexpireat(K key, Instant timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture sexpireat(K key, Instant timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> sexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture sexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux sexpireat(K key, long timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono sexpireat(K key, long timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux sexpireat(K key, long timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono sexpireat(K key, long timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in seconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux sexpireat(K key, Date timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono sexpireat(K key, Date timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux sexpireat(K key, Date timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono sexpireat(K key, Date timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux sexpireat(K key, Instant timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono sexpireat(K key, Instant timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux sexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono sexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null; truncated to whole seconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "jedis": [ + { + "signature": "List sexpireAt(byte[] key, long unixTimeSeconds, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "unixTimeSeconds", + "type": "long", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "List sexpireAt(byte[] key, long unixTimeSeconds, ExpiryOption condition, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "unixTimeSeconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long sexpireAt(byte[] key, long unixTimeSeconds, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "unixTimeSeconds", + "type": "long", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long sexpireAt(byte[] key, long unixTimeSeconds, ExpiryOption condition, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "unixTimeSeconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "List sexpireAt(String key, long unixTimeSeconds, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "unixTimeSeconds", + "type": "long", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "List sexpireAt(String key, long unixTimeSeconds, ExpiryOption condition, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "unixTimeSeconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long sexpireAt(String key, long unixTimeSeconds, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "unixTimeSeconds", + "type": "long", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long sexpireAt(String key, long unixTimeSeconds, ExpiryOption condition, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "unixTimeSeconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ] + } +} diff --git a/data/command-api-mapping/SEXPIRETIME.json b/data/command-api-mapping/SEXPIRETIME.json new file mode 100644 index 0000000000..b4141e5f13 --- /dev/null +++ b/data/command-api-mapping/SEXPIRETIME.json @@ -0,0 +1,312 @@ +{ + "api_calls": { + "redis_py": [ + { + "signature": "sexpiretime(name: KeyT, *members: FieldT)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", + "description": "" + } + ], + "returns": { + "type": "list[int]", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "sExpireTime(key: RedisArgument, members: RedisVariadicArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "SExpireTime(ctx context.Context, key string, members ...string) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "sexpiretime(string $key, array $members)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "sexpiretime(key, *members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "*members", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "Array", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List sexpiretime(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the expiration time for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: the Unix time in seconds at which the member expires, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long sexpiretime(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the expiration time for." + } + ], + "returns": { + "type": "Long", + "description": "the Unix time in seconds at which the member expires, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> sexpiretime(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the expiration time for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: the Unix time in seconds at which the member expires, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture sexpiretime(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the expiration time for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "the Unix time in seconds at which the member expires, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux sexpiretime(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the expiration time for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: the Unix time in seconds at which the member expires, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono sexpiretime(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the expiration time for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting the Unix time in seconds at which the member expires, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "jedis": [ + { + "signature": "List sexpireTime(byte[] key, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long sexpireTime(byte[] key, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "List sexpireTime(String key, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long sexpireTime(String key, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ] + } +} diff --git a/data/command-api-mapping/SPERSIST.json b/data/command-api-mapping/SPERSIST.json new file mode 100644 index 0000000000..cf76f953b5 --- /dev/null +++ b/data/command-api-mapping/SPERSIST.json @@ -0,0 +1,312 @@ +{ + "api_calls": { + "redis_py": [ + { + "signature": "spersist(name: KeyT, *members: FieldT)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", + "description": "" + } + ], + "returns": { + "type": "list[int]", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "sPersist(key: RedisArgument, members: RedisVariadicArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "SPersist(ctx context.Context, key string, members ...string) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "spersist(string $key, array $members)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "spersist(key, *members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "*members", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "Array", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List spersist(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to remove the expiration from, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 1 if the expiration was removed; -1 if the member exists but has no expiration; -2 if the member does not exist or key does not exist." + } + }, + { + "signature": "Long spersist(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to remove the expiration from." + } + ], + "returns": { + "type": "Long", + "description": "1 if the expiration was removed; -1 if the member exists but has no expiration; -2 if the member does not exist or key does not exist." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> spersist(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to remove the expiration from, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 1 if the expiration was removed; -1 if the member exists but has no expiration; -2 if the member does not exist or key does not exist." + } + }, + { + "signature": "RedisFuture spersist(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to remove the expiration from." + } + ], + "returns": { + "type": "RedisFuture", + "description": "1 if the expiration was removed; -1 if the member exists but has no expiration; -2 if the member does not exist or key does not exist." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux spersist(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to remove the expiration from, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 1 if the expiration was removed; -1 if the member exists but has no expiration; -2 if the member does not exist or key does not exist." + } + }, + { + "signature": "Mono spersist(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to remove the expiration from." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 1 if the expiration was removed; -1 if the member exists but has no expiration; -2 if the member does not exist or key does not exist." + } + } + ], + "jedis": [ + { + "signature": "List spersist(byte[] key, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long spersist(byte[] key, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "List spersist(String key, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long spersist(String key, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ] + } +} diff --git a/data/command-api-mapping/SPEXPIRE.json b/data/command-api-mapping/SPEXPIRE.json new file mode 100644 index 0000000000..c2835de7dc --- /dev/null +++ b/data/command-api-mapping/SPEXPIRE.json @@ -0,0 +1,1079 @@ +{ + "api_calls": { + "redis_py": [ + { + "signature": "spexpire(name: KeyT, milliseconds: ExpiryT, *members: FieldT, nx: bool = False, xx: bool = False, gt: bool = False, lt: bool = False)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "milliseconds", + "type": "ExpiryT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", + "description": "" + }, + { + "name": "nx", + "type": "bool", + "description": "" + }, + { + "name": "xx", + "type": "bool", + "description": "" + }, + { + "name": "gt", + "type": "bool", + "description": "" + }, + { + "name": "lt", + "type": "bool", + "description": "" + } + ], + "returns": { + "type": "list[int]", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "spExpire(key: RedisArgument, members: RedisVariadicArgument, ms: number, mode?: 'NX' | 'XX' | 'GT' | 'LT')", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + }, + { + "name": "ms", + "type": "number", + "description": "" + }, + { + "name": "mode?", + "type": "'NX' | 'XX' | 'GT' | 'LT'", + "description": "" + } + ], + "returns": { + "type": "ArrayReply>", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "SPExpire(ctx context.Context, key string, expiration time.Duration, members ...string) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "expiration", + "type": "time.Duration", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + }, + { + "signature": "SPExpireWithArgs(ctx context.Context, key string, expiration time.Duration, condition SExpireCondition, members ...string) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "expiration", + "type": "time.Duration", + "description": "" + }, + { + "name": "condition", + "type": "SExpireCondition", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "spexpire(string $key, int $milliseconds, array $members, ?string $flag = null)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$milliseconds", + "type": "int", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + }, + { + "name": "$flag", + "type": "?string", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "spexpire(key, ttl, *members, nx: nil, xx: nil, gt: nil, lt: nil)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "ttl", + "type": "Integer", + "description": "" + }, + { + "name": "*members", + "type": "Array", + "description": "" + }, + { + "name": "nx", + "type": "Boolean", + "description": "" + }, + { + "name": "xx", + "type": "Boolean", + "description": "" + }, + { + "name": "gt", + "type": "Boolean", + "description": "" + }, + { + "name": "lt", + "type": "Boolean", + "description": "" + } + ], + "returns": { + "type": "Array", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List spexpire(K key, long milliseconds, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long spexpire(K key, long milliseconds, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List spexpire(K key, long milliseconds, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long spexpire(K key, long milliseconds, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List spexpire(K key, Duration milliseconds, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long spexpire(K key, Duration milliseconds, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List spexpire(K key, Duration milliseconds, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long spexpire(K key, Duration milliseconds, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> spexpire(K key, long milliseconds, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture spexpire(K key, long milliseconds, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> spexpire(K key, long milliseconds, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture spexpire(K key, long milliseconds, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> spexpire(K key, Duration milliseconds, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture spexpire(K key, Duration milliseconds, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> spexpire(K key, Duration milliseconds, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture spexpire(K key, Duration milliseconds, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux spexpire(K key, long milliseconds, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono spexpire(K key, long milliseconds, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux spexpire(K key, long milliseconds, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono spexpire(K key, long milliseconds, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "long", + "description": "the time to live in milliseconds, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux spexpire(K key, Duration milliseconds, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono spexpire(K key, Duration milliseconds, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux spexpire(K key, Duration milliseconds, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono spexpire(K key, Duration milliseconds, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "milliseconds", + "type": "Duration", + "description": "the time to live, must not be null; truncated to whole milliseconds." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the time to live for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "jedis": [ + { + "signature": "List spexpire(byte[] key, long milliseconds, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "milliseconds", + "type": "long", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "List spexpire(byte[] key, long milliseconds, ExpiryOption condition, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "milliseconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long spexpire(byte[] key, long milliseconds, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "milliseconds", + "type": "long", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long spexpire(byte[] key, long milliseconds, ExpiryOption condition, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "milliseconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "List spexpire(String key, long milliseconds, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "milliseconds", + "type": "long", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "List spexpire(String key, long milliseconds, ExpiryOption condition, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "milliseconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long spexpire(String key, long milliseconds, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "milliseconds", + "type": "long", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long spexpire(String key, long milliseconds, ExpiryOption condition, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "milliseconds", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ] + } +} diff --git a/data/command-api-mapping/SPEXPIREAT.json b/data/command-api-mapping/SPEXPIREAT.json new file mode 100644 index 0000000000..7d1514da6e --- /dev/null +++ b/data/command-api-mapping/SPEXPIREAT.json @@ -0,0 +1,1397 @@ +{ + "api_calls": { + "redis_py": [ + { + "signature": "spexpireat(name: KeyT, unix_time_milliseconds: AbsExpiryT, *members: FieldT, nx: bool = False, xx: bool = False, gt: bool = False, lt: bool = False)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "unix_time_milliseconds", + "type": "AbsExpiryT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", + "description": "" + }, + { + "name": "nx", + "type": "bool", + "description": "" + }, + { + "name": "xx", + "type": "bool", + "description": "" + }, + { + "name": "gt", + "type": "bool", + "description": "" + }, + { + "name": "lt", + "type": "bool", + "description": "" + } + ], + "returns": { + "type": "list[int]", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "spExpireAt(key: RedisArgument, members: RedisVariadicArgument, timestamp: number | Date, mode?: 'NX' | 'XX' | 'GT' | 'LT')", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + }, + { + "name": "timestamp", + "type": "number | Date", + "description": "" + }, + { + "name": "mode?", + "type": "'NX' | 'XX' | 'GT' | 'LT'", + "description": "" + } + ], + "returns": { + "type": "ArrayReply>", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "SPExpireAt(ctx context.Context, key string, tm time.Time, members ...string) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "tm", + "type": "time.Time", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + }, + { + "signature": "SPExpireAtWithArgs(ctx context.Context, key string, tm time.Time, condition SExpireCondition, members ...string) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "tm", + "type": "time.Time", + "description": "" + }, + { + "name": "condition", + "type": "SExpireCondition", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "spexpireat(string $key, int $unixTimeMilliseconds, array $members, ?string $flag = null)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$unixTimeMilliseconds", + "type": "int", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + }, + { + "name": "$flag", + "type": "?string", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "spexpireat(key, unix_time_milliseconds, *members, nx: nil, xx: nil, gt: nil, lt: nil)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "unix_time_milliseconds", + "type": "Integer", + "description": "" + }, + { + "name": "*members", + "type": "Array", + "description": "" + }, + { + "name": "nx", + "type": "Boolean", + "description": "" + }, + { + "name": "xx", + "type": "Boolean", + "description": "" + }, + { + "name": "gt", + "type": "Boolean", + "description": "" + }, + { + "name": "lt", + "type": "Boolean", + "description": "" + } + ], + "returns": { + "type": "Array", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List spexpireat(K key, long timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long spexpireat(K key, long timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List spexpireat(K key, long timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long spexpireat(K key, long timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List spexpireat(K key, Date timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long spexpireat(K key, Date timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List spexpireat(K key, Date timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long spexpireat(K key, Date timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List spexpireat(K key, Instant timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long spexpireat(K key, Instant timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "List spexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long spexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Long", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> spexpireat(K key, long timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture spexpireat(K key, long timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> spexpireat(K key, long timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture spexpireat(K key, long timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> spexpireat(K key, Date timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture spexpireat(K key, Date timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> spexpireat(K key, Date timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture spexpireat(K key, Date timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> spexpireat(K key, Instant timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture spexpireat(K key, Instant timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture> spexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture spexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux spexpireat(K key, long timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono spexpireat(K key, long timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux spexpireat(K key, long timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono spexpireat(K key, long timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "long", + "description": "the Unix time in milliseconds at which the members expire, must not be negative." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux spexpireat(K key, Date timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono spexpireat(K key, Date timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux spexpireat(K key, Date timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono spexpireat(K key, Date timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Date", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux spexpireat(K key, Instant timestamp, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono spexpireat(K key, Instant timestamp, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Flux spexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to set the expiration for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono spexpireat(K key, Instant timestamp, ExpireArgs expireArgs, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "timestamp", + "type": "Instant", + "description": "the point in time at which the members expire, must not be null." + }, + { + "name": "expireArgs", + "type": "ExpireArgs", + "description": "the condition (NX, XX, GT or LT), must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to set the expiration for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting 2 if the member was deleted because the expiration is in the past; 1 if the expiration was set or updated; 0 if a NX, XX, GT or LT condition was not met; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "jedis": [ + { + "signature": "List spexpireAt(byte[] key, long unixTimeMillis, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "unixTimeMillis", + "type": "long", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "List spexpireAt(byte[] key, long unixTimeMillis, ExpiryOption condition, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "unixTimeMillis", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long spexpireAt(byte[] key, long unixTimeMillis, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "unixTimeMillis", + "type": "long", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long spexpireAt(byte[] key, long unixTimeMillis, ExpiryOption condition, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "unixTimeMillis", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "List spexpireAt(String key, long unixTimeMillis, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "unixTimeMillis", + "type": "long", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "List spexpireAt(String key, long unixTimeMillis, ExpiryOption condition, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "unixTimeMillis", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long spexpireAt(String key, long unixTimeMillis, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "unixTimeMillis", + "type": "long", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long spexpireAt(String key, long unixTimeMillis, ExpiryOption condition, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "unixTimeMillis", + "type": "long", + "description": "" + }, + { + "name": "condition", + "type": "ExpiryOption", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ] + } +} diff --git a/data/command-api-mapping/SPEXPIRETIME.json b/data/command-api-mapping/SPEXPIRETIME.json new file mode 100644 index 0000000000..82612e8498 --- /dev/null +++ b/data/command-api-mapping/SPEXPIRETIME.json @@ -0,0 +1,312 @@ +{ + "api_calls": { + "redis_py": [ + { + "signature": "spexpiretime(name: KeyT, *members: FieldT)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", + "description": "" + } + ], + "returns": { + "type": "list[int]", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "spExpireTime(key: RedisArgument, members: RedisVariadicArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "SPExpireTime(ctx context.Context, key string, members ...string) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "spexpiretime(string $key, array $members)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "spexpiretime(key, *members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "*members", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "Array", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List spexpiretime(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the expiration time for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: the Unix time in milliseconds at which the member expires; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long spexpiretime(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the expiration time for." + } + ], + "returns": { + "type": "Long", + "description": "the Unix time in milliseconds at which the member expires; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> spexpiretime(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the expiration time for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: the Unix time in milliseconds at which the member expires; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture spexpiretime(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the expiration time for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "the Unix time in milliseconds at which the member expires; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux spexpiretime(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the expiration time for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: the Unix time in milliseconds at which the member expires; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono spexpiretime(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the expiration time for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting the Unix time in milliseconds at which the member expires; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "jedis": [ + { + "signature": "List spexpireTime(byte[] key, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long spexpireTime(byte[] key, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "List spexpireTime(String key, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long spexpireTime(String key, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ] + } +} diff --git a/data/command-api-mapping/SPTTL.json b/data/command-api-mapping/SPTTL.json new file mode 100644 index 0000000000..6b7dd88566 --- /dev/null +++ b/data/command-api-mapping/SPTTL.json @@ -0,0 +1,312 @@ +{ + "api_calls": { + "redis_py": [ + { + "signature": "spttl(name: KeyT, *members: FieldT)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", + "description": "" + } + ], + "returns": { + "type": "list[int]", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "spTTL(key: RedisArgument, members: RedisVariadicArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "SPTTL(ctx context.Context, key string, members ...string) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "spttl(string $key, array $members)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "spttl(key, *members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "*members", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "Array", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List spttl(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: the remaining time to live in milliseconds, 0 if the member is expiring now; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long spttl(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the time to live for." + } + ], + "returns": { + "type": "Long", + "description": "the remaining time to live in milliseconds, 0 if the member is expiring now; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> spttl(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: the remaining time to live in milliseconds, 0 if the member is expiring now; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture spttl(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the time to live for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "the remaining time to live in milliseconds, 0 if the member is expiring now; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux spttl(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: the remaining time to live in milliseconds, 0 if the member is expiring now; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono spttl(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the time to live for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting the remaining time to live in milliseconds, 0 if the member is expiring now; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "jedis": [ + { + "signature": "List spttl(byte[] key, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long spttl(byte[] key, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "List spttl(String key, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long spttl(String key, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ] + } +} diff --git a/data/command-api-mapping/STTL.json b/data/command-api-mapping/STTL.json new file mode 100644 index 0000000000..b680265fc4 --- /dev/null +++ b/data/command-api-mapping/STTL.json @@ -0,0 +1,312 @@ +{ + "api_calls": { + "redis_py": [ + { + "signature": "sttl(name: KeyT, *members: FieldT)", + "params": [ + { + "name": "name", + "type": "KeyT", + "description": "" + }, + { + "name": "*members", + "type": "FieldT", + "description": "" + } + ], + "returns": { + "type": "list[int]", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "sTTL(key: RedisArgument, members: RedisVariadicArgument)", + "params": [ + { + "name": "key", + "type": "RedisArgument", + "description": "" + }, + { + "name": "members", + "type": "RedisVariadicArgument", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "STTL(ctx context.Context, key string, members ...string) *IntSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "" + }, + { + "name": "key", + "type": "string", + "description": "" + }, + { + "name": "members", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*IntSliceCmd", + "description": "" + } + } + ], + "php": [ + { + "signature": "sttl(string $key, array $members)", + "params": [ + { + "name": "$key", + "type": "string", + "description": "" + }, + { + "name": "$members", + "type": "array", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rb": [ + { + "signature": "sttl(key, *members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "*members", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "Array", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List sttl(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "List", + "description": "a list with one Long per member, in the order of members: the remaining time to live in seconds, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Long sttl(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the time to live for." + } + ], + "returns": { + "type": "Long", + "description": "the remaining time to live in seconds, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> sttl(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list with one Long per member, in the order of members: the remaining time to live in seconds, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "RedisFuture sttl(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the time to live for." + } + ], + "returns": { + "type": "RedisFuture", + "description": "the remaining time to live in seconds, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux sttl(K key, V... members)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "members", + "type": "V...", + "description": "the members to get the time to live for, must not be null or empty." + } + ], + "returns": { + "type": "Flux", + "description": "a Flux emitting one Long per member, in the order of members: the remaining time to live in seconds, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + }, + { + "signature": "Mono sttl(K key, V member)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the key of the set, must not be null." + }, + { + "name": "member", + "type": "V", + "description": "the member to get the time to live for." + } + ], + "returns": { + "type": "Mono", + "description": "a Mono emitting the remaining time to live in seconds, rounded up to the next second; -1 if the member exists but has no expiration; -2 if the member does not exist (a logically expired member does not exist) or key does not exist." + } + } + ], + "jedis": [ + { + "signature": "List sttl(byte[] key, byte[]... members)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "members", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long sttl(byte[] key, byte[] member)", + "params": [ + { + "name": "key", + "type": "byte[]", + "description": "" + }, + { + "name": "member", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "List sttl(String key, String... members)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "members", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + }, + { + "signature": "long sttl(String key, String member)", + "params": [ + { + "name": "key", + "type": "String", + "description": "" + }, + { + "name": "member", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ] + } +}