From 5e1a72df09c4c2e85bf470823048850c01b4e590 Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Thu, 5 Nov 2026 11:18:54 +0000 Subject: [PATCH] DOC-7263 Fill missing client signatures in the command-API mapping Classified all 1,495 empty signature lists across 14 client IDs against the released clients, then filled the 448 that were real gaps: redis_py 35, node_redis 63, go-redis 23, jedis 20, php 20, lettuce 47 per variant, nredisstack 46 per variant, redis_rs 26 sync and 28 async. 1,047 stay empty on purpose: 782 are reachable only through a generic call, 180 are unsupported or client-managed, 77 were skipped deliberately (bare container rows and 35 ioredis gaps the tab never renders), and 8 are other cases found while authoring. The skill and its client-quirks reference now record the classification rules and the non-obvious receivers. Every filled signature was checked against the released artifact: inspect.signature for redis-py 8.1.0, javac against Lettuce 7.9.0 and Jedis 8.0.2, go vet against go-redis v9.23.0 and v9.22.0, dotnet build against StackExchange.Redis 3.3.1 and 3.4.31, cargo check against redis 1.8.1 and 1.6.0, PHP reflection on Predis v3.7.1 and v3.5.1. node-redis was checked by loading the installed 6.3.1 package and running each command's parseCommand; tsc was not available. The classification pass first used name matching and was wrong often enough to matter: the earlier pass called SSUBSCRIBE unsupported in NRedisStack (it works through RedisChannel.Sharded), treated SlaveOf and ReplicaOf as callable (both are obsolete errors in StackExchange.Redis), and put CLIENT SETINFO on go-redis Cmdable (it is on StatefulCmdable). Reading the method, not the name, is what caught these. A missing client key and an empty list render the same "No method signature available" text, so deleting keys would change nothing. The unsupported and generic-only rows need a per-client note in the tab, which is a template change and was left out of scope. The tab also lists a fixed set of clients: ioredis, RedisVL and Ruby never render, so their 97 empties were not filled. Fragments were applied by script that only replaced lists that were already [], refused any file that did not round-trip through json.dumps(indent=2), and kept each file's trailing whitespace, so the diff is the 448 new lists and nothing else. Learned: name matching misclassifies; read the method and its receiver before calling a gap Constraint: only replace lists that are currently [], so existing entries are never overwritten Directive: do not delete empty client keys to tidy the tab, it renders identically and loses the record Gaps: generic-only and unsupported verdicts rest on finding no method, none were run against a server Gaps: node-redis signatures were not type-checked with tsc Recheck: when the tab gets a per-client note, revisit the 751 generic-only and 174 unsupported rows Ticket: DOC-7263 Co-Authored-By: Claude Sonnet 5.5 --- .claude/skills/command-api-mapping/SKILL.md | 29 + .../reference/client-quirks.md | 26 + data/command-api-mapping.json | 11277 ++++++++++++++-- data/command-api-mapping/ACL CAT.json | 50 +- data/command-api-mapping/ACL DELUSER.json | 34 +- data/command-api-mapping/ACL DRYRUN.json | 241 +- data/command-api-mapping/ACL GENPASS.json | 50 +- data/command-api-mapping/ACL GETUSER.json | 34 +- data/command-api-mapping/ACL HELP.json | 39 +- data/command-api-mapping/ACL LIST.json | 22 +- data/command-api-mapping/ACL LOAD.json | 22 +- data/command-api-mapping/ACL LOG.json | 125 +- data/command-api-mapping/ACL SAVE.json | 22 +- data/command-api-mapping/ACL SETUSER.json | 72 +- data/command-api-mapping/ACL USERS.json | 22 +- data/command-api-mapping/ACL WHOAMI.json | 22 +- data/command-api-mapping/BGREWRITEAOF.json | 44 +- data/command-api-mapping/BGSAVE.json | 44 +- data/command-api-mapping/CLIENT CACHING.json | 17 +- data/command-api-mapping/CLIENT GETNAME.json | 22 +- data/command-api-mapping/CLIENT GETREDIR.json | 11 +- data/command-api-mapping/CLIENT ID.json | 33 +- data/command-api-mapping/CLIENT KILL.json | 150 +- data/command-api-mapping/CLIENT LIST.json | 34 +- data/command-api-mapping/CLIENT NO-EVICT.json | 68 +- data/command-api-mapping/CLIENT NO-TOUCH.json | 68 +- data/command-api-mapping/CLIENT PAUSE.json | 22 +- data/command-api-mapping/CLIENT SETINFO.json | 44 +- data/command-api-mapping/CLIENT SETNAME.json | 34 +- data/command-api-mapping/CLIENT TRACKING.json | 49 +- .../CLIENT TRACKINGINFO.json | 11 +- data/command-api-mapping/CLIENT UNBLOCK.json | 22 +- data/command-api-mapping/CLIENT UNPAUSE.json | 11 +- .../command-api-mapping/CLUSTER ADDSLOTS.json | 22 +- .../CLUSTER ADDSLOTSRANGE.json | 56 +- .../CLUSTER BUMPEPOCH.json | 22 +- .../CLUSTER COUNT-FAILURE-REPORTS.json | 73 +- .../CLUSTER COUNTKEYSINSLOT.json | 73 +- .../command-api-mapping/CLUSTER DELSLOTS.json | 34 +- .../CLUSTER DELSLOTSRANGE.json | 51 +- .../command-api-mapping/CLUSTER FAILOVER.json | 39 +- .../CLUSTER FLUSHSLOTS.json | 22 +- .../CLUSTER GETKEYSINSLOT.json | 22 +- data/command-api-mapping/CLUSTER HELP.json | 27 +- data/command-api-mapping/CLUSTER INFO.json | 17 +- data/command-api-mapping/CLUSTER KEYSLOT.json | 17 +- data/command-api-mapping/CLUSTER LINKS.json | 67 +- data/command-api-mapping/CLUSTER MEET.json | 27 +- data/command-api-mapping/CLUSTER MYID.json | 28 +- .../CLUSTER MYSHARDID.json | 56 +- data/command-api-mapping/CLUSTER NODES.json | 73 +- .../command-api-mapping/CLUSTER REPLICAS.json | 56 +- .../CLUSTER REPLICATE.json | 22 +- data/command-api-mapping/CLUSTER RESET.json | 39 +- .../CLUSTER SAVECONFIG.json | 28 +- .../CLUSTER SET-CONFIG-EPOCH.json | 56 +- data/command-api-mapping/CLUSTER SETSLOT.json | 133 +- data/command-api-mapping/CLUSTER SHARDS.json | 56 +- data/command-api-mapping/CLUSTER SLAVES.json | 90 +- data/command-api-mapping/CLUSTER SLOTS.json | 56 +- data/command-api-mapping/COMMAND COUNT.json | 34 +- data/command-api-mapping/COMMAND DOCS.json | 17 +- data/command-api-mapping/COMMAND GETKEYS.json | 61 +- .../COMMAND GETKEYSANDFLAGS.json | 39 +- data/command-api-mapping/COMMAND LIST.json | 103 +- data/command-api-mapping/CONFIG GET.json | 44 +- .../command-api-mapping/CONFIG RESETSTAT.json | 34 +- data/command-api-mapping/CONFIG REWRITE.json | 34 +- data/command-api-mapping/CONFIG SET.json | 54 +- data/command-api-mapping/DBSIZE.json | 44 +- data/command-api-mapping/ECHO.json | 51 +- data/command-api-mapping/FLUSHALL.json | 84 +- data/command-api-mapping/FLUSHDB.json | 94 +- data/command-api-mapping/FT.AGGREGATE.json | 138 +- data/command-api-mapping/FT.ALIASADD.json | 66 +- data/command-api-mapping/FT.ALIASDEL.json | 51 +- data/command-api-mapping/FT.ALIASUPDATE.json | 66 +- data/command-api-mapping/FT.ALTER.json | 138 +- data/command-api-mapping/FT.CREATE.json | 138 +- data/command-api-mapping/FT.CURSOR DEL.json | 66 +- data/command-api-mapping/FT.CURSOR READ.json | 138 +- data/command-api-mapping/FT.DICTADD.json | 66 +- data/command-api-mapping/FT.DICTDEL.json | 66 +- data/command-api-mapping/FT.DICTDUMP.json | 51 +- data/command-api-mapping/FT.DROPINDEX.json | 108 +- data/command-api-mapping/FT.EXPLAIN.json | 138 +- data/command-api-mapping/FT.HYBRID.json | 213 +- data/command-api-mapping/FT.SEARCH.json | 138 +- data/command-api-mapping/FT.SPELLCHECK.json | 138 +- data/command-api-mapping/FT.SUGADD.json | 168 +- data/command-api-mapping/FT.SUGDEL.json | 66 +- data/command-api-mapping/FT.SUGGET.json | 138 +- data/command-api-mapping/FT.SUGLEN.json | 51 +- data/command-api-mapping/FT.SYNDUMP.json | 51 +- data/command-api-mapping/FT.SYNUPDATE.json | 168 +- data/command-api-mapping/FT.TAGVALS.json | 66 +- data/command-api-mapping/FT._LIST.json | 33 +- data/command-api-mapping/FUNCTION DELETE.json | 17 +- data/command-api-mapping/FUNCTION DUMP.json | 22 +- data/command-api-mapping/FUNCTION FLUSH.json | 17 +- data/command-api-mapping/FUNCTION KILL.json | 11 +- data/command-api-mapping/FUNCTION LIST.json | 22 +- data/command-api-mapping/FUNCTION LOAD.json | 22 +- .../command-api-mapping/FUNCTION RESTORE.json | 22 +- data/command-api-mapping/FUNCTION STATS.json | 11 +- data/command-api-mapping/HELLO.json | 59 +- data/command-api-mapping/HOTKEYS.json | 312 +- data/command-api-mapping/INFO.json | 82 +- data/command-api-mapping/LASTSAVE.json | 34 +- data/command-api-mapping/LATENCY DOCTOR.json | 34 +- .../LATENCY HISTOGRAM.json | 17 +- data/command-api-mapping/LATENCY HISTORY.json | 44 +- data/command-api-mapping/LATENCY LATEST.json | 34 +- data/command-api-mapping/LATENCY RESET.json | 44 +- data/command-api-mapping/LOLWUT.json | 22 +- data/command-api-mapping/MEMORY DOCTOR.json | 45 +- .../MEMORY MALLOC-STATS.json | 45 +- data/command-api-mapping/MEMORY PURGE.json | 45 +- data/command-api-mapping/MEMORY STATS.json | 34 +- data/command-api-mapping/MODULE LIST.json | 11 +- data/command-api-mapping/MODULE LOAD.json | 22 +- data/command-api-mapping/MODULE LOADEX.json | 22 +- data/command-api-mapping/MODULE UNLOAD.json | 17 +- data/command-api-mapping/MONITOR.json | 39 +- data/command-api-mapping/PING.json | 117 +- data/command-api-mapping/PSUBSCRIBE.json | 303 +- data/command-api-mapping/PSYNC.json | 22 +- data/command-api-mapping/PUBLISH.json | 132 +- data/command-api-mapping/PUBSUB CHANNELS.json | 136 +- data/command-api-mapping/PUBSUB HELP.json | 22 +- data/command-api-mapping/PUBSUB NUMPAT.json | 78 +- data/command-api-mapping/PUBSUB NUMSUB.json | 112 +- .../PUBSUB SHARDCHANNELS.json | 92 +- .../PUBSUB SHARDNUMSUB.json | 68 +- data/command-api-mapping/PUNSUBSCRIBE.json | 289 +- data/command-api-mapping/QUIT.json | 55 +- data/command-api-mapping/REPLICAOF.json | 44 +- data/command-api-mapping/RESET.json | 22 +- data/command-api-mapping/RESTORE-ASKING.json | 11 +- data/command-api-mapping/ROLE.json | 34 +- data/command-api-mapping/SAVE.json | 44 +- data/command-api-mapping/SCRIPT EXISTS.json | 82 +- data/command-api-mapping/SCRIPT FLUSH.json | 34 +- data/command-api-mapping/SCRIPT HELP.json | 22 +- data/command-api-mapping/SCRIPT LOAD.json | 116 +- data/command-api-mapping/SELECT.json | 68 +- data/command-api-mapping/SHUTDOWN.json | 22 +- data/command-api-mapping/SLOWLOG GET.json | 44 +- data/command-api-mapping/SLOWLOG RESET.json | 34 +- data/command-api-mapping/SPUBLISH.json | 227 +- data/command-api-mapping/SSUBSCRIBE.json | 296 +- data/command-api-mapping/SUBSCRIBE.json | 303 +- data/command-api-mapping/SUNSUBSCRIBE.json | 232 +- data/command-api-mapping/SWAPDB.json | 76 +- data/command-api-mapping/SYNC.json | 11 +- data/command-api-mapping/TIME.json | 34 +- data/command-api-mapping/UNSUBSCRIBE.json | 289 +- 157 files changed, 20444 insertions(+), 1319 deletions(-) diff --git a/.claude/skills/command-api-mapping/SKILL.md b/.claude/skills/command-api-mapping/SKILL.md index c287b343f6..7f16dbabbf 100644 --- a/.claude/skills/command-api-mapping/SKILL.md +++ b/.claude/skills/command-api-mapping/SKILL.md @@ -76,6 +76,35 @@ For each command in the set you're mapping: ``` Spot-check one command in the rendered table if you can run the site. +## Sweeping empty lists (DOC-7263) + +An empty list (`"redis_py": []`) renders "No method signature available for this client." +A missing key renders the same text, so removing a key changes nothing on the page. The tab +only lists the clients in `$clientOrder` in `api-methods-tab.html`: ioredis, RedisVL and +Ruby never render, so filling them has no visible effect. + +Classify each empty (command, client) against the **released** client, not the file: + +- `real_gap`: a typed method exists but the mapping has no signature. Fill it. +- `generic_only`: reachable only through `execute_command`, `call`, `Do`, `sendCommand`, + `executeRaw`, `redis::cmd` or container magic dispatch with no typed `@method`. Leave empty. +- `unsupported`: no way to call it, the method throws or panics (`Quit`/`Sync` in go-redis, + `memory_doctor` in redis-py), it is `[Obsolete(error: true)]` (SE.Redis `SlaveOf`), or it + is client-side and sends no command (`SELECT` as `GetDatabase`, `CLUSTER KEYSLOT`). +- Bare container rows (`ACL`, `CLIENT`, `CLUSTER`, `CONFIG`, `LATENCY`, `MEMORY`, `MODULE`, + `SLOWLOG`, `FUNCTION`, `SCRIPT`, `PUBSUB`) stay empty: the subcommand rows carry the + signatures. `HOTKEYS` is not one: check whether its subcommand files already exist. + +A name match is a hypothesis. Read the method, and check a sample of hits before trusting a +count. Typed methods on a non-obvious receiver (`StatefulCmdable`, `IServer`, a `PubSub` +object, a callback object) still count as `real_gap`: cite the receiver in your report. + +To fill many at once, write one fragment per client (`{command: [signatures]}`) outside the +repo, verify every signature by compiling or reflecting against the released artifact, then +apply with a script that replaces only lists that are currently `[]`, refuses any file that +does not round-trip through `json.dumps(indent=2, ensure_ascii=False)`, and keeps each +file's trailing whitespace. Assert the before and after empty counts. + ## Guardrails - **Match the live client IDs exactly**, including `go-redis` (hyphen) and `node_redis`, diff --git a/.claude/skills/command-api-mapping/reference/client-quirks.md b/.claude/skills/command-api-mapping/reference/client-quirks.md index d25e66c693..b18c06f210 100644 --- a/.claude/skills/command-api-mapping/reference/client-quirks.md +++ b/.claude/skills/command-api-mapping/reference/client-quirks.md @@ -151,6 +151,32 @@ Translation rules: - Return type is generally `RedisResult` (sync) / a future of it (async). - `///` doc comments → descriptions when present. +## Receivers that aren't the obvious client (DOC-7263) +- **redis_py:** `cluster_*` methods exist only on `RedisCluster`; subscribe methods are on the + `PubSub` object (`r.pubsub()`); FT.HYBRID is `r.ft(...).hybrid_search`. Some methods are + stubs that raise `NotImplementedError`. Read the body, not the name. +- **node_redis:** `select`, `quit`, `reset`, `monitor` and the subscribe family are methods on + `RedisClient`, not command files, and are `undefined` on a cluster client. `LOLWUT` is + registered uppercase only. Commands in `@redis/search` and similar need that package. +- **go-redis:** `CLIENT SETINFO` and `HELLO` are on `StatefulCmdable`/`*Conn`, not `Cmdable`. + `HotKeys*` is on `*Client` only. `Monitor` is on the `cmdable` struct but not the + `Cmdable` interface. Subscribe methods return `*PubSub`; unsubscribe is on `*PubSub`. +- **jedis:** `cluster*` methods are on `Jedis` only (not `UnifiedJedis` or `RedisClient`). + `unsubscribe`/`punsubscribe`/`sunsubscribe` are on the callback objects + (`JedisPubSubBase`, `JedisShardedPubSubBase`), `ssubscribe`/`spublish` on the cluster clients. +- **lettuce:** subscribe methods are on the pub/sub connection interfaces. `RediSearchCommands` + takes only `K` (no `V`). +- **nredisstack:** server commands are on `IServer` (`FooAsync` twins), subscribe on + `ISubscriber`, sharded pub/sub through `RedisChannel.Sharded(...)`. `Save(SaveType)` covers + SAVE, BGSAVE and BGREWRITEAOF. +- **php (predis):** a container subcommand reached only through `__call` (no `@method` in + `src/Command/Container/*.php`) is `generic_only`, not a typed method. Consumer methods + (`pubSubLoop()`) are the typed home for PSUBSCRIBE/PUNSUBSCRIBE. +- **redis_rs:** methods come from `implement_commands!` and are generated for four traits. + `HotkeysCommands`/`AsyncHotkeysCommands` are separate traits. Some methods need a feature + (`acl`, `script` default on; `search_unfinished` is not stable). Async cluster connections + carry SSUBSCRIBE/SUNSUBSCRIBE. + ## General - **Never invent descriptions.** Empty string beats a plausible-but-unverified sentence. - **Confirm the command exists** in the client before adding it; preview commands may be diff --git a/data/command-api-mapping.json b/data/command-api-mapping.json index be2885e63b..744d87be8a 100644 --- a/data/command-api-mapping.json +++ b/data/command-api-mapping.json @@ -178,8 +178,54 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_cat()", + "params": [], + "returns": { + "type": "(HashSet)", + "description": "" + } + }, + { + "signature": "acl_cat_categoryname(categoryname: K)", + "params": [ + { + "name": "categoryname", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(HashSet)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_cat()", + "params": [], + "returns": { + "type": "(HashSet)", + "description": "" + } + }, + { + "signature": "acl_cat_categoryname(categoryname: K)", + "params": [ + { + "name": "categoryname", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(HashSet)", + "description": "" + } + } + ] } }, "ACL DELUSER": { @@ -390,8 +436,38 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_deluser(usernames: &'a [K])", + "params": [ + { + "name": "usernames", + "type": "&'a [K]", + "description": "" + } + ], + "returns": { + "type": "(usize)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_deluser(usernames: &'a [K])", + "params": [ + { + "name": "usernames", + "type": "&'a [K]", + "description": "" + } + ], + "returns": { + "type": "(usize)", + "description": "" + } + } + ] } }, "ACL DRYRUN": { @@ -443,11 +519,188 @@ } } ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "go-redis": [ + { + "signature": "ACLDryRun(ctx context.Context, username string, command ...interface{}) *StringCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "username", + "type": "string", + "description": "" + }, + { + "name": "command", + "type": "...interface{}", + "description": "" + } + ], + "returns": { + "type": "*StringCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "aclDryRun(username: RedisArgument, command: Array)", + "params": [ + { + "name": "username", + "type": "RedisArgument", + "description": "" + }, + { + "name": "command", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'> | BlobStringReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "String aclDryRun(String username, String command, String... args)", + "params": [ + { + "name": "username", + "type": "String", + "description": "the specified username" + }, + { + "name": "command", + "type": "String", + "description": "the specified command" + }, + { + "name": "args", + "type": "String...", + "description": "the specified args of command" + } + ], + "returns": { + "type": "String", + "description": "String reply: OK on success." + } + }, + { + "signature": "String aclDryRun(String username, RedisCommand command)", + "params": [ + { + "name": "username", + "type": "String", + "description": "the specified username" + }, + { + "name": "command", + "type": "RedisCommand", + "description": "the specified command to inspect" + } + ], + "returns": { + "type": "String", + "description": "String reply: OK on success." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture aclDryRun(String username, String command, String... args)", + "params": [ + { + "name": "username", + "type": "String", + "description": "the specified username" + }, + { + "name": "command", + "type": "String", + "description": "the specified command" + }, + { + "name": "args", + "type": "String...", + "description": "the specified args of command" + } + ], + "returns": { + "type": "RedisFuture", + "description": "String reply: OK on success." + } + }, + { + "signature": "RedisFuture aclDryRun(String username, RedisCommand command)", + "params": [ + { + "name": "username", + "type": "String", + "description": "the specified username" + }, + { + "name": "command", + "type": "RedisCommand", + "description": "the specified command to inspect" + } + ], + "returns": { + "type": "RedisFuture", + "description": "String reply: OK on success." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono aclDryRun(String username, String command, String... args)", + "params": [ + { + "name": "username", + "type": "String", + "description": "the specified username" + }, + { + "name": "command", + "type": "String", + "description": "the specified command" + }, + { + "name": "args", + "type": "String...", + "description": "the specified args of command" + } + ], + "returns": { + "type": "Mono", + "description": "String reply: OK on success." + } + }, + { + "signature": "Mono aclDryRun(String username, RedisCommand command)", + "params": [ + { + "name": "username", + "type": "String", + "description": "the specified username" + }, + { + "name": "command", + "type": "RedisCommand", + "description": "the specified command to inspect" + } + ], + "returns": { + "type": "Mono", + "description": "String reply: OK on success." + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], "php": [ @@ -471,8 +724,58 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_dryrun(username: K, command: C, args: A)", + "params": [ + { + "name": "username", + "type": "K", + "description": "" + }, + { + "name": "command", + "type": "C", + "description": "" + }, + { + "name": "args", + "type": "A", + "description": "" + } + ], + "returns": { + "type": "(String)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_dryrun(username: K, command: C, args: A)", + "params": [ + { + "name": "username", + "type": "K", + "description": "" + }, + { + "name": "command", + "type": "C", + "description": "" + }, + { + "name": "args", + "type": "A", + "description": "" + } + ], + "returns": { + "type": "(String)", + "description": "" + } + } + ] } }, "ACL GENPASS": { @@ -654,8 +957,54 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_genpass()", + "params": [], + "returns": { + "type": "(String)", + "description": "" + } + }, + { + "signature": "acl_genpass_bits(bits: isize)", + "params": [ + { + "name": "bits", + "type": "isize", + "description": "" + } + ], + "returns": { + "type": "(String)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_genpass()", + "params": [], + "returns": { + "type": "(String)", + "description": "" + } + }, + { + "signature": "acl_genpass_bits(bits: isize)", + "params": [ + { + "name": "bits", + "type": "isize", + "description": "" + } + ], + "returns": { + "type": "(String)", + "description": "" + } + } + ] } }, "ACL GETUSER": { @@ -805,13 +1154,58 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_getuser(username: K)", + "params": [ + { + "name": "username", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(Option)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_getuser(username: K)", + "params": [ + { + "name": "username", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(Option)", + "description": "" + } + } + ] } }, "ACL HELP": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "acl_help(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "list[bytes | str]", + "description": "" + } + } + ], "jedis": [], "go-redis": [], "node_redis": [], @@ -841,8 +1235,26 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_help()", + "params": [], + "returns": { + "type": "(Vec)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_help()", + "params": [], + "returns": { + "type": "(Vec)", + "description": "" + } + } + ] } }, "ACL LIST": { @@ -952,8 +1364,26 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_list()", + "params": [], + "returns": { + "type": "(Vec)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_list()", + "params": [], + "returns": { + "type": "(Vec)", + "description": "" + } + } + ] } }, "ACL LOAD": { @@ -1063,8 +1493,26 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_load()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_load()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + } + ] } }, "ACL LOG": { @@ -1151,9 +1599,78 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "List> aclLog()", + "params": [], + "returns": { + "type": "List>", + "description": "List> list of security events." + } + }, + { + "signature": "List> aclLog(int count)", + "params": [ + { + "name": "count", + "type": "int", + "description": "max count of events" + } + ], + "returns": { + "type": "List>", + "description": "List> list of security events." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture>> aclLog()", + "params": [], + "returns": { + "type": "RedisFuture>>", + "description": "List> list of security events." + } + }, + { + "signature": "RedisFuture>> aclLog(int count)", + "params": [ + { + "name": "count", + "type": "int", + "description": "max count of events" + } + ], + "returns": { + "type": "RedisFuture>>", + "description": "List> list of security events." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux> aclLog()", + "params": [], + "returns": { + "type": "Flux>", + "description": "Map list of security events." + } + }, + { + "signature": "Flux> aclLog(int count)", + "params": [ + { + "name": "count", + "type": "int", + "description": "max count of events" + } + ], + "returns": { + "type": "Flux>", + "description": "Map list of security events." + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], "php": [ @@ -1177,8 +1694,54 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_log(count: isize)", + "params": [ + { + "name": "count", + "type": "isize", + "description": "" + } + ], + "returns": { + "type": "(Vec)", + "description": "" + } + }, + { + "signature": "acl_log_reset()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_log(count: isize)", + "params": [ + { + "name": "count", + "type": "isize", + "description": "" + } + ], + "returns": { + "type": "(Vec)", + "description": "" + } + }, + { + "signature": "acl_log_reset()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + } + ] } }, "ACL SAVE": { @@ -1288,8 +1851,26 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_save()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_save()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + } + ] } }, "ACL SETUSER": { @@ -1534,126 +2115,83 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "ACL USERS": { - "api_calls": { - "redis_py": [ + "redis_rs_sync": [ { - "signature": "acl_users(**kwargs)", + "signature": "acl_setuser(username: K)", "params": [ { - "name": "**kwargs", - "type": "Any", + "name": "username", + "type": "K", "description": "" } ], "returns": { - "type": "list", - "description": "" - } - } - ], - "jedis": [ - { - "signature": "List aclUsers()", - "params": [], - "returns": { - "type": "List", + "type": "()", "description": "" } - } - ], - "go-redis": [ + }, { - "signature": "ACLUsers(ctx context.Context) *StringSliceCmd", + "signature": "acl_setuser_rules(username: K, rules: &'a [acl::Rule])", "params": [ { - "name": "ctx", - "type": "context.Context", - "description": "Context" + "name": "username", + "type": "K", + "description": "" + }, + { + "name": "rules", + "type": "&'a [acl::Rule]", + "description": "" } ], "returns": { - "type": "*StringSliceCmd", - "description": "" - } - } - ], - "node_redis": [ - { - "signature": "aclUsers()", - "params": [], - "returns": { - "type": "Array", - "description": "" - } - } - ], - "lettuce_sync": [ - { - "signature": "List aclUsers()", - "params": [], - "returns": { - "type": "List", - "description": "" - } - } - ], - "lettuce_async": [ - { - "signature": "RedisFuture> aclUsers()", - "params": [], - "returns": { - "type": "RedisFuture>", + "type": "()", "description": "" } } ], - "lettuce_reactive": [ + "redis_rs_async": [ { - "signature": "Flux aclUsers()", - "params": [], + "signature": "acl_setuser(username: K)", + "params": [ + { + "name": "username", + "type": "K", + "description": "" + } + ], "returns": { - "type": "Flux", + "type": "()", "description": "" } - } - ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + }, { - "signature": "acl(string $subcommand, ...$args)", + "signature": "acl_setuser_rules(username: K, rules: &'a [acl::Rule])", "params": [ { - "name": "$subcommand", - "type": "string", + "name": "username", + "type": "K", "description": "" }, { - "name": "$args", - "type": "mixed", + "name": "rules", + "type": "&'a [acl::Rule]", "description": "" } ], "returns": { - "type": "array", + "type": "()", "description": "" } } - ], - "redis_rs_sync": [], - "redis_rs_async": [] + ] } }, - "ACL WHOAMI": { + "ACL USERS": { "api_calls": { "redis_py": [ { - "signature": "acl_whoami(**kwargs)", + "signature": "acl_users(**kwargs)", "params": [ { "name": "**kwargs", @@ -1662,24 +2200,24 @@ } ], "returns": { - "type": "str", + "type": "list", "description": "" } } ], "jedis": [ { - "signature": "String aclWhoAmI()", + "signature": "List aclUsers()", "params": [], "returns": { - "type": "String", + "type": "List", "description": "" } } ], "go-redis": [ { - "signature": "ACLWhoAmI(ctx context.Context) *StringCmd", + "signature": "ACLUsers(ctx context.Context) *StringSliceCmd", "params": [ { "name": "ctx", @@ -1688,47 +2226,176 @@ } ], "returns": { - "type": "*StringCmd", + "type": "*StringSliceCmd", "description": "" } } ], "node_redis": [ { - "signature": "aclWhoAmI()", + "signature": "aclUsers()", "params": [], "returns": { - "type": "BlobStringReply", + "type": "Array", "description": "" } } ], "lettuce_sync": [ { - "signature": "String aclWhoami()", + "signature": "List aclUsers()", "params": [], "returns": { - "type": "String", + "type": "List", "description": "" } } ], "lettuce_async": [ { - "signature": "RedisFuture aclWhoami()", + "signature": "RedisFuture> aclUsers()", "params": [], "returns": { - "type": "RedisFuture", + "type": "RedisFuture>", "description": "" } } ], "lettuce_reactive": [ { - "signature": "Mono aclWhoami()", + "signature": "Flux aclUsers()", "params": [], "returns": { - "type": "Mono", + "type": "Flux", + "description": "" + } + } + ], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "acl(string $subcommand, ...$args)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rs_sync": [ + { + "signature": "acl_users()", + "params": [], + "returns": { + "type": "(Vec)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_users()", + "params": [], + "returns": { + "type": "(Vec)", + "description": "" + } + } + ] + } + }, + "ACL WHOAMI": { + "api_calls": { + "redis_py": [ + { + "signature": "acl_whoami(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "str", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String aclWhoAmI()", + "params": [], + "returns": { + "type": "String", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ACLWhoAmI(ctx context.Context) *StringCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*StringCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "aclWhoAmI()", + "params": [], + "returns": { + "type": "BlobStringReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "String aclWhoami()", + "params": [], + "returns": { + "type": "String", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture aclWhoami()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono aclWhoami()", + "params": [], + "returns": { + "type": "Mono", "description": "" } } @@ -1756,8 +2423,26 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_whoami()", + "params": [], + "returns": { + "type": "(String)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_whoami()", + "params": [], + "returns": { + "type": "(String)", + "description": "" + } + } + ] } }, "ACL": { @@ -9114,8 +9799,48 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void Save(SaveType type, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "type", + "type": "SaveType", + "description": "The method of the save (e.g. background or foreground)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SaveAsync(SaveType type, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "type", + "type": "SaveType", + "description": "The method of the save (e.g. background or foreground)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "bgrewriteaof()", @@ -9233,8 +9958,48 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void Save(SaveType type, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "type", + "type": "SaveType", + "description": "The method of the save (e.g. background or foreground)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SaveAsync(SaveType type, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "type", + "type": "SaveType", + "description": "The method of the save (e.g. background or foreground)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "bgsave()", @@ -19526,7 +20291,22 @@ } ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clientCaching(value: boolean)", + "params": [ + { + "name": "value", + "type": "boolean", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clientCaching(boolean enabled)", @@ -19709,8 +20489,26 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "client_getname()", + "params": [], + "returns": { + "type": "(Option)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "client_getname()", + "params": [], + "returns": { + "type": "(Option)", + "description": "" + } + } + ] } }, "CLIENT GETREDIR": { @@ -19742,7 +20540,16 @@ } ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clientGetRedir()", + "params": [], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "Long clientGetredir()", @@ -19860,7 +20667,16 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clientId()", + "params": [], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "Long clientId()", @@ -19914,8 +20730,26 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "client_id()", + "params": [], + "returns": { + "type": "(isize)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "client_id()", + "params": [], + "returns": { + "type": "(isize)", + "description": "" + } + } + ] } }, "CLIENT INFO": { @@ -20272,8 +21106,154 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void ClientKill(EndPoint endpoint, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "endpoint", + "type": "EndPoint", + "description": "The endpoint of the client to kill." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "long ClientKill(long? id = null, ClientType? clientType = null, EndPoint? endpoint = null, bool skipMe = true, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "id", + "type": "long?", + "description": "The ID of the client to kill." + }, + { + "name": "clientType", + "type": "ClientType?", + "description": "The type of client." + }, + { + "name": "endpoint", + "type": "EndPoint?", + "description": "The endpoint to kill." + }, + { + "name": "skipMe", + "type": "bool", + "description": "Whether to skip the current connection." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "long", + "description": "the number of clients killed." + } + }, + { + "signature": "long ClientKill(ClientKillFilter filter, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "filter", + "type": "ClientKillFilter", + "description": "The filter to use in choosing which clients to kill." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "long", + "description": "the number of clients killed." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ClientKillAsync(EndPoint endpoint, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "endpoint", + "type": "EndPoint", + "description": "The endpoint of the client to kill." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task ClientKillAsync(long? id = null, ClientType? clientType = null, EndPoint? endpoint = null, bool skipMe = true, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "id", + "type": "long?", + "description": "The ID of the client to kill." + }, + { + "name": "clientType", + "type": "ClientType?", + "description": "The type of client." + }, + { + "name": "endpoint", + "type": "EndPoint?", + "description": "The endpoint to kill." + }, + { + "name": "skipMe", + "type": "bool", + "description": "Whether to skip the current connection." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "the number of clients killed." + } + }, + { + "signature": "Task ClientKillAsync(ClientKillFilter filter, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "filter", + "type": "ClientKillFilter", + "description": "The filter to use in choosing which clients to kill." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "the number of clients killed." + } + } + ], "php": [ { "signature": "client(string $subcommand, ...$args)", @@ -20413,6 +21393,167 @@ } } ], + "nredisstack_sync": [ + { + "signature": "ClientInfo[] ClientList(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "ClientInfo[]", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ClientListAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], + "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 NO-EVICT": { + "api_calls": { + "redis_py": [ + { + "signature": "client_no_evict(mode: str, **kwargs)", + "params": [ + { + "name": "mode", + "type": "str", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "str", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String clientNoEvict(boolean on)", + "params": [ + { + "name": "on", + "type": "boolean", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "" + } + } + ], + "go-redis": [], + "node_redis": [ + { + "signature": "clientNoEvict(value: boolean)", + "params": [ + { + "name": "value", + "type": "boolean", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "String clientNoEvict(boolean on)", + "params": [ + { + "name": "on", + "type": "boolean", + "description": "true will turn eviction mode on, and false will turn it off." + } + ], + "returns": { + "type": "String", + "description": "String simple-string-reply OK." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture clientNoEvict(boolean on)", + "params": [ + { + "name": "on", + "type": "boolean", + "description": "true will turn eviction mode on, and false will turn it off." + } + ], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply OK." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono clientNoEvict(boolean on)", + "params": [ + { + "name": "on", + "type": "boolean", + "description": "true will turn eviction mode on, and false will turn it off." + } + ], + "returns": { + "type": "Mono", + "description": "String simple-string-reply OK." + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], "php": [ @@ -20440,11 +21581,11 @@ "redis_rs_async": [] } }, - "CLIENT NO-EVICT": { + "CLIENT NO-TOUCH": { "api_calls": { "redis_py": [ { - "signature": "client_no_evict(mode: str, **kwargs)", + "signature": "client_no_touch(mode: str, **kwargs)", "params": [ { "name": "mode", @@ -20465,7 +21606,7 @@ ], "jedis": [ { - "signature": "String clientNoEvict(boolean on)", + "signature": "String clientNoTouch(boolean on)", "params": [ { "name": "on", @@ -20480,81 +21621,70 @@ } ], "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + "node_redis": [ { - "signature": "client(string $subcommand, ...$args)", + "signature": "clientNoTouch(value: boolean)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" - }, - { - "name": "$args", - "type": "mixed", + "name": "value", + "type": "boolean", "description": "" } ], "returns": { - "type": "string", + "type": "SimpleStringReply<'OK'>", "description": "" } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "CLIENT NO-TOUCH": { - "api_calls": { - "redis_py": [ + "lettuce_sync": [ { - "signature": "client_no_touch(mode: str, **kwargs)", + "signature": "String clientNoTouch(boolean on)", "params": [ { - "name": "mode", - "type": "str", - "description": "" - }, + "name": "on", + "type": "boolean", + "description": "true will turn no-touch mode on, and false will turn it off." + } + ], + "returns": { + "type": "String", + "description": "String simple-string-reply OK." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture clientNoTouch(boolean on)", + "params": [ { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "on", + "type": "boolean", + "description": "true will turn no-touch mode on, and false will turn it off." } ], "returns": { - "type": "str", - "description": "" + "type": "RedisFuture", + "description": "String simple-string-reply OK." } } ], - "jedis": [ + "lettuce_reactive": [ { - "signature": "String clientNoTouch(boolean on)", + "signature": "Mono clientNoTouch(boolean on)", "params": [ { "name": "on", "type": "boolean", - "description": "" + "description": "true will turn no-touch mode on, and false will turn it off." } ], "returns": { - "type": "String", - "description": "" + "type": "Mono", + "description": "String simple-string-reply OK." } } ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], "nredisstack_sync": [], "nredisstack_async": [], "php": [ @@ -20647,7 +21777,27 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clientPause(timeout: number, mode?: 'WRITE' | 'ALL')", + "params": [ + { + "name": "timeout", + "type": "number", + "description": "" + }, + { + "name": "mode", + "type": "'WRITE' | 'ALL'", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clientPause(long timeout)", @@ -20843,7 +21993,27 @@ } } ], - "go-redis": [], + "go-redis": [ + { + "signature": "ClientSetInfo(ctx context.Context, info LibraryInfo) *StatusCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "info", + "type": "LibraryInfo", + "description": "" + } + ], + "returns": { + "type": "*StatusCmd", + "description": "" + } + } + ], "node_redis": [], "lettuce_sync": [ { @@ -20910,7 +22080,27 @@ ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], + "php": [ + { + "signature": "setInfo(string $modifier = null, string $value = null)", + "params": [ + { + "name": "$modifier", + "type": "string", + "description": "" + }, + { + "name": "$value", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "Status", + "description": "" + } + } + ], "redis_rs_sync": [], "redis_rs_async": [] } @@ -21062,8 +22252,38 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "client_setname(connection_name: K)", + "params": [ + { + "name": "connection_name", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(())", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "client_setname(connection_name: K)", + "params": [ + { + "name": "connection_name", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(())", + "description": "" + } + } + ] } }, "CLIENT TRACKING": { @@ -21135,8 +22355,53 @@ } } ], - "go-redis": [], - "node_redis": [], + "go-redis": [ + { + "signature": "ClientTracking(ctx context.Context, on bool, opt *ClientTrackingOptions) *StatusCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "on", + "type": "bool", + "description": "" + }, + { + "name": "opt", + "type": "*ClientTrackingOptions", + "description": "" + } + ], + "returns": { + "type": "*StatusCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "clientTracking(mode: M, options?: M extends true ? ClientTrackingOptions : never)", + "params": [ + { + "name": "mode", + "type": "M", + "description": "" + }, + { + "name": "options", + "type": "M extends true ? ClientTrackingOptions : never", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clientTracking(TrackingArgs args)", @@ -21241,7 +22506,16 @@ } ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clientTrackingInfo()", + "params": [], + "returns": { + "type": "TrackingInfo", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "TrackingInfo clientTrackinginfo()", @@ -21382,7 +22656,27 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clientUnblock(clientId: number | `${number}`, mode?: ClientUnblockMode)", + "params": [ + { + "name": "clientId", + "type": "number | `${number}`", + "description": "" + }, + { + "name": "mode", + "type": "ClientUnblockMode", + "description": "" + } + ], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "Long clientUnblock(long id, UnblockType type)", @@ -21497,7 +22791,16 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clientUnpause()", + "params": [], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clientUnpause()", @@ -21573,7 +22876,27 @@ }, "CLUSTER ADDSLOTS": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_addslots(target_node: TargetNodesT, *slots: EncodableT)", + "params": [ + { + "name": "target_node", + "type": "TargetNodesT", + "description": "" + }, + { + "name": "*slots", + "type": "EncodableT", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterAddSlots(final int... slots)", @@ -21689,7 +23012,27 @@ }, "CLUSTER ADDSLOTSRANGE": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_addslotsrange(target_node: TargetNodesT, *slots: EncodableT)", + "params": [ + { + "name": "target_node", + "type": "TargetNodesT", + "description": "" + }, + { + "name": "*slots", + "type": "EncodableT", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterAddSlotsRange(int... ranges)", @@ -21732,7 +23075,22 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterAddSlotsRange(ranges: SlotRange | Array)", + "params": [ + { + "name": "ranges", + "type": "SlotRange | Array", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterAddSlotsRange(Range... ranges)", @@ -21783,7 +23141,22 @@ ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], + "php": [ + { + "signature": "addSlotsRange(int ...$startEndSlots)", + "params": [ + { + "name": "$startEndSlots", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "Status", + "description": "" + } + } + ], "redis_rs_sync": [], "redis_rs_async": [] } @@ -21791,9 +23164,27 @@ "CLUSTER BUMPEPOCH": { "api_calls": { "redis_py": [], - "jedis": [], + "jedis": [ + { + "signature": "String clusterBumpEpoch()", + "params": [], + "returns": { + "type": "String", + "description": "BUMPED if the epoch was incremented, or STILL if the node already has the greatest config epoch in the cluster." + } + } + ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterBumpEpoch()", + "params": [], + "returns": { + "type": "SimpleStringReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterBumpepoch()", @@ -21833,10 +23224,75 @@ }, "CLUSTER COUNT-FAILURE-REPORTS": { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], + "redis_py": [ + { + "signature": "cluster_count_failure_report(node_id: str)", + "params": [ + { + "name": "node_id", + "type": "str", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "long clusterCountFailureReports(String nodeId)", + "params": [ + { + "name": "nodeId", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ClusterCountFailureReports(ctx context.Context, nodeID string) *IntCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "nodeID", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "*IntCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "clusterCountFailureReports(nodeId: RedisArgument)", + "params": [ + { + "name": "nodeId", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "Long clusterCountFailureReports(String nodeId)", @@ -21894,10 +23350,75 @@ }, "CLUSTER COUNTKEYSINSLOT": { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], + "redis_py": [ + { + "signature": "cluster_countkeysinslot(slot_id: int)", + "params": [ + { + "name": "slot_id", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "long clusterCountKeysInSlot(int slot)", + "params": [ + { + "name": "slot", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ClusterCountKeysInSlot(ctx context.Context, slot int) *IntCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "slot", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "*IntCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "clusterCountKeysInSlot(slot: number)", + "params": [ + { + "name": "slot", + "type": "number", + "description": "" + } + ], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "Long clusterCountKeysInSlot(int slot)", @@ -21955,7 +23476,22 @@ }, "CLUSTER DELSLOTS": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_delslots(*slots: EncodableT)", + "params": [ + { + "name": "*slots", + "type": "EncodableT", + "description": "" + } + ], + "returns": { + "type": "List[bool]", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterDelSlots(final int... slots)", @@ -21993,7 +23529,22 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterDelSlots(slots: number | Array)", + "params": [ + { + "name": "slots", + "type": "number | Array", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterDelSlots(int... slots)", @@ -22051,7 +23602,22 @@ }, "CLUSTER DELSLOTSRANGE": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_delslotsrange(*slots: EncodableT)", + "params": [ + { + "name": "*slots", + "type": "EncodableT", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterDelSlotsRange(int... ranges)", @@ -22094,7 +23660,22 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterDelSlotsRange(ranges: SlotRange | Array)", + "params": [ + { + "name": "ranges", + "type": "SlotRange | Array", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterDelSlotsRange(Range... ranges)", @@ -22145,14 +23726,49 @@ ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], + "php": [ + { + "signature": "delSlotsRange(int ...$startEndSlots)", + "params": [ + { + "name": "$startEndSlots", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "Status", + "description": "" + } + } + ], "redis_rs_sync": [], "redis_rs_async": [] } }, "CLUSTER FAILOVER": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_failover(target_node: TargetNodesT, option: str | None = None)", + "params": [ + { + "name": "target_node", + "type": "TargetNodesT", + "description": "" + }, + { + "name": "option", + "type": "str | None = None", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterFailover()", @@ -22193,7 +23809,22 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterFailover(options?: ClusterFailoverOptions)", + "params": [ + { + "name": "options", + "type": "ClusterFailoverOptions", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterFailover(boolean force)", @@ -22252,9 +23883,27 @@ "CLUSTER FLUSHSLOTS": { "api_calls": { "redis_py": [], - "jedis": [], + "jedis": [ + { + "signature": "String clusterFlushSlots()", + "params": [], + "returns": { + "type": "String", + "description": "" + } + } + ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterFlushSlots()", + "params": [], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterFlushslots()", @@ -22410,7 +24059,27 @@ }, "CLUSTER GETKEYSINSLOT": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_get_keys_in_slot(slot: int, num_keys: int)", + "params": [ + { + "name": "slot", + "type": "int", + "description": "" + }, + { + "name": "num_keys", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "list[bytes | str]", + "description": "" + } + } + ], "jedis": [ { "signature": "List clusterGetKeysInSlot(final int slot, final int count)", @@ -22556,7 +24225,32 @@ }, "CLUSTER HELP": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster(cluster_arg, *args, **kwargs)", + "params": [ + { + "name": "cluster_arg", + "type": "Any", + "description": "" + }, + { + "name": "*args", + "type": "Any", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], "jedis": [], "go-redis": [], "node_redis": [], @@ -22572,7 +24266,22 @@ }, "CLUSTER INFO": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_info(target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "dict[str, str]", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterInfo()", @@ -22654,7 +24363,22 @@ }, "CLUSTER KEYSLOT": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_keyslot(key: str)", + "params": [ + { + "name": "key", + "type": "str", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], "jedis": [ { "signature": "long clusterKeySlot(final String key)", @@ -22770,10 +24494,58 @@ }, "CLUSTER LINKS": { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], + "redis_py": [ + { + "signature": "cluster_links(target_node: TargetNodesT)", + "params": [ + { + "name": "target_node", + "type": "TargetNodesT", + "description": "" + } + ], + "returns": { + "type": "ClusterLinksResponse", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "List> clusterLinks()", + "params": [], + "returns": { + "type": "List>", + "description": "the information of all such peer links as an array" + } + } + ], + "go-redis": [ + { + "signature": "ClusterLinks(ctx context.Context) *ClusterLinksCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*ClusterLinksCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "clusterLinks()", + "params": [], + "returns": { + "type": "ClusterLinksReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "List clusterLinks()", @@ -22806,14 +24578,48 @@ ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], + "php": [ + { + "signature": "links()", + "params": [], + "returns": { + "type": "array", + "description": "" + } + } + ], "redis_rs_sync": [], "redis_rs_async": [] } }, "CLUSTER MEET": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_meet(host: str, port: int, target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "host", + "type": "str", + "description": "" + }, + { + "name": "port", + "type": "int", + "description": "" + }, + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterMeet(final String ip, final int port)", @@ -22975,7 +24781,22 @@ }, "CLUSTER MYID": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_myid(target_node: TargetNodesT)", + "params": [ + { + "name": "target_node", + "type": "TargetNodesT", + "description": "" + } + ], + "returns": { + "type": "bytes | str", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterMyId()", @@ -23002,7 +24823,16 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterMyId()", + "params": [], + "returns": { + "type": "BlobStringReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterMyId()", @@ -23042,10 +24872,58 @@ }, "CLUSTER MYSHARDID": { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], + "redis_py": [ + { + "signature": "cluster_myshardid(target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "bytes | str", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String clusterMyShardId()", + "params": [], + "returns": { + "type": "String", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ClusterMyShardID(ctx context.Context) *StringCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*StringCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "clusterMyShardId()", + "params": [], + "returns": { + "type": "BlobStringReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterMyShardId()", @@ -23085,7 +24963,16 @@ }, "CLUSTER NODES": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_nodes()", + "params": [], + "returns": { + "type": "dict[str, ClusterNodeDetail]", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterNodes()", @@ -23158,8 +25045,66 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "ClusterConfiguration? ClusterNodes(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "ClusterConfiguration?", + "description": "" + } + }, + { + "signature": "string? ClusterNodesRaw(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "string?", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ClusterNodesAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task ClusterNodesRawAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [], "redis_rs_sync": [], "redis_rs_async": [] @@ -23167,10 +25112,60 @@ }, "CLUSTER REPLICAS": { "api_calls": { - "redis_py": [], - "jedis": [], + "redis_py": [ + { + "signature": "cluster_replicas(node_id: str, target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "node_id", + "type": "str", + "description": "" + }, + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "dict[str, ClusterNodeDetail]", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "List clusterReplicas(String nodeId)", + "params": [ + { + "name": "nodeId", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + } + ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterReplicas(nodeId: RedisArgument)", + "params": [ + { + "name": "nodeId", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterReplicas(String nodeId)", @@ -23228,7 +25223,27 @@ }, "CLUSTER REPLICATE": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_replicate(target_nodes: TargetNodesT, node_id: str)", + "params": [ + { + "name": "target_nodes", + "type": "TargetNodesT", + "description": "" + }, + { + "name": "node_id", + "type": "str", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterReplicate(final String nodeId)", @@ -23344,7 +25359,27 @@ }, "CLUSTER RESET": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_reset(soft: bool = True, target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "soft", + "type": "bool = True", + "description": "" + }, + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterReset()", @@ -23399,7 +25434,22 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterReset(options?: ClusterResetOptions)", + "params": [ + { + "name": "options", + "type": "ClusterResetOptions", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterReset(boolean hard)", @@ -23457,7 +25507,22 @@ }, "CLUSTER SAVECONFIG": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_save_config(target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterSaveConfig()", @@ -23484,7 +25549,16 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterSaveConfig()", + "params": [], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterSaveconfig()", @@ -23524,10 +25598,60 @@ }, "CLUSTER SET-CONFIG-EPOCH": { "api_calls": { - "redis_py": [], - "jedis": [], + "redis_py": [ + { + "signature": "cluster_set_config_epoch(epoch: int, target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "epoch", + "type": "int", + "description": "" + }, + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String clusterSetConfigEpoch(long configEpoch)", + "params": [ + { + "name": "configEpoch", + "type": "long", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "OK" + } + } + ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterSetConfigEpoch(configEpoch: number)", + "params": [ + { + "name": "configEpoch", + "type": "number", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterSetConfigEpoch(long configEpoch)", @@ -23585,10 +25709,137 @@ }, "CLUSTER SETSLOT": { "api_calls": { - "redis_py": [], - "jedis": [], + "redis_py": [ + { + "signature": "cluster_setslot(target_node: TargetNodesT, node_id: str, slot_id: int, state: str)", + "params": [ + { + "name": "target_node", + "type": "TargetNodesT", + "description": "" + }, + { + "name": "node_id", + "type": "str", + "description": "" + }, + { + "name": "slot_id", + "type": "int", + "description": "" + }, + { + "name": "state", + "type": "str", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String clusterSetSlotNode(int slot, String nodeId)", + "params": [ + { + "name": "slot", + "type": "int", + "description": "" + }, + { + "name": "nodeId", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "" + } + }, + { + "signature": "String clusterSetSlotMigrating(int slot, String nodeId)", + "params": [ + { + "name": "slot", + "type": "int", + "description": "" + }, + { + "name": "nodeId", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "" + } + }, + { + "signature": "String clusterSetSlotImporting(int slot, String nodeId)", + "params": [ + { + "name": "slot", + "type": "int", + "description": "" + }, + { + "name": "nodeId", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "" + } + }, + { + "signature": "String clusterSetSlotStable(int slot)", + "params": [ + { + "name": "slot", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "" + } + } + ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterSetSlot(slot: number, state: ClusterSlotState, nodeId?: RedisArgument)", + "params": [ + { + "name": "slot", + "type": "number", + "description": "" + }, + { + "name": "state", + "type": "ClusterSlotState", + "description": "" + }, + { + "name": "nodeId", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterSetSlotImporting(int slot, String nodeId)", @@ -23817,9 +26068,48 @@ }, "CLUSTER SHARDS": { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], + "redis_py": [ + { + "signature": "cluster_shards(target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "ClusterShardsResponse", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "List clusterShards()", + "params": [], + "returns": { + "type": "List", + "description": "a list of shards, with each shard containing two objects, 'slots' and 'nodes'." + } + } + ], + "go-redis": [ + { + "signature": "ClusterShards(ctx context.Context) *ClusterShardsCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*ClusterShardsCmd", + "description": "" + } + } + ], "node_redis": [], "lettuce_sync": [ { @@ -23853,7 +26143,16 @@ ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], + "php": [ + { + "signature": "shards()", + "params": [], + "returns": { + "type": "array", + "description": "" + } + } + ], "redis_rs_sync": [], "redis_rs_async": [] } @@ -23861,12 +26160,92 @@ "CLUSTER SLAVES": { "api_calls": { "redis_py": [], - "jedis": [], - "go-redis": [], + "jedis": [ + { + "signature": "List clusterSlaves(String nodeId)", + "params": [ + { + "name": "nodeId", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ClusterSlaves(ctx context.Context, nodeID string) *StringSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "nodeID", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "*StringSliceCmd", + "description": "" + } + } + ], "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "List clusterSlaves(String nodeId)", + "params": [ + { + "name": "nodeId", + "type": "String", + "description": "node id of the master node" + } + ], + "returns": { + "type": "List", + "description": "List array-reply list of replicas. The command returns data in the same format as clusterNodes() but one line per replica." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> clusterSlaves(String nodeId)", + "params": [ + { + "name": "nodeId", + "type": "String", + "description": "node id of the master node" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "List array-reply list of replicas. The command returns data in the same format as clusterNodes() but one line per replica." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux clusterSlaves(String nodeId)", + "params": [ + { + "name": "nodeId", + "type": "String", + "description": "node id of the master node" + } + ], + "returns": { + "type": "Flux", + "description": "List array-reply list of replicas. The command returns data in the same format as clusterNodes() but one line per replica." + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], "php": [], @@ -23892,10 +26271,58 @@ }, "CLUSTER SLOTS": { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], + "redis_py": [ + { + "signature": "cluster_slots(target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "list[Any]", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "List clusterSlots()", + "params": [], + "returns": { + "type": "List", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ClusterSlots(ctx context.Context) *ClusterSlotsCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*ClusterSlotsCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "clusterSlots()", + "params": [], + "returns": { + "type": "Array<{ from: NumberReply, to: NumberReply, master: ClusterSlotsNode, replicas: Array }>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "List clusterSlots()", @@ -25070,8 +27497,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "long CommandCount(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task CommandCountAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "command(string $subcommand, ...$args)", @@ -25137,7 +27594,22 @@ } ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "commandDocs(commands?: RedisVariadicArgument)", + "params": [ + { + "name": "commands", + "type": "RedisVariadicArgument", + "description": "" + } + ], + "returns": { + "type": "CommandDocsReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], @@ -25233,7 +27705,22 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "commandGetKeys(args: Array)", + "params": [ + { + "name": "args", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "List commandGetkeys(String... args)", @@ -25282,84 +27769,159 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + "nredisstack_sync": [ { - "signature": "command(string $subcommand, ...$args)", + "signature": "RedisKey[] CommandGetKeys(RedisValue[] command, CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" + "name": "command", + "type": "RedisValue[]", + "description": "The command to get keys from." }, { - "name": "$args", - "type": "mixed", - "description": "" + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." } ], "returns": { - "type": "array", + "type": "RedisKey[]", "description": "" } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "COMMAND GETKEYSANDFLAGS": { - "api_calls": { - "redis_py": [ + "nredisstack_async": [ { - "signature": "command_getkeysandflags(command: str, *args, **kwargs)", + "signature": "Task CommandGetKeysAsync(RedisValue[] command, CommandFlags flags = CommandFlags.None)", "params": [ { "name": "command", - "type": "str", - "description": "" - }, - { - "name": "*args", - "type": "Any", - "description": "" + "type": "RedisValue[]", + "description": "The command to get keys from." }, { - "name": "**kwargs", - "type": "Any", - "description": "" - } - ], - "returns": { - "type": "list", - "description": "" - } - } - ], - "jedis": [ - { - "signature": "List commandGetKeysAndFlags(String... args)", - "params": [ - { - "name": "args", - "type": "String...", - "description": "" + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." } ], "returns": { - "type": "List", + "type": "Task", "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 GETKEYSANDFLAGS": { + "api_calls": { + "redis_py": [ + { + "signature": "command_getkeysandflags(command: str, *args, **kwargs)", + "params": [ + { + "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": "List", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "CommandGetKeysAndFlags(ctx context.Context, commands ...interface{}) *KeyFlagsCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "commands", + "type": "...interface{}", + "description": "" + } + ], + "returns": { + "type": "*KeyFlagsCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "commandGetKeysAndFlags(args: Array)", + "params": [ + { + "name": "args", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "Array<{ key: BlobStringReply, flags: SetReply }>", + "description": "" + } + } + ], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], "php": [ { "signature": "command(string $subcommand, ...$args)", @@ -25629,13 +28191,108 @@ } } ], - "go-redis": [], - "node_redis": [], + "go-redis": [ + { + "signature": "CommandList(ctx context.Context, filter *FilterBy) *StringSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "filter", + "type": "*FilterBy", + "description": "" + } + ], + "returns": { + "type": "*StringSliceCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "commandList(options?: CommandListOptions)", + "params": [ + { + "name": "options", + "type": "CommandListOptions", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "string[] CommandList(RedisValue? moduleName = null, RedisValue? category = null, RedisValue? pattern = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "moduleName", + "type": "RedisValue?", + "description": "The module name to filter the command list by." + }, + { + "name": "category", + "type": "RedisValue?", + "description": "The category to filter the command list by." + }, + { + "name": "pattern", + "type": "RedisValue?", + "description": "The pattern to filter the command list by." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "string[]", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task CommandListAsync(RedisValue? moduleName = null, RedisValue? category = null, RedisValue? pattern = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "moduleName", + "type": "RedisValue?", + "description": "The module name to filter the command list by." + }, + { + "name": "category", + "type": "RedisValue?", + "description": "The category to filter the command list by." + }, + { + "name": "pattern", + "type": "RedisValue?", + "description": "The pattern to filter the command list by." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "command(string $subcommand, ...$args)", @@ -25957,8 +28614,48 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "KeyValuePair[] ConfigGet(RedisValue pattern = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "pattern", + "type": "RedisValue", + "description": "The pattern of config values to get." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "KeyValuePair[]", + "description": "All matching configuration parameters." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task[]> ConfigGetAsync(RedisValue pattern = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "pattern", + "type": "RedisValue", + "description": "The pattern of config values to get." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task[]>", + "description": "All matching configuration parameters." + } + } + ], "php": [ { "signature": "config($subcommand, $argument = null)", @@ -26104,8 +28801,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void ConfigResetStatistics(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ConfigResetStatisticsAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "config($subcommand, $argument = null)", @@ -26215,8 +28942,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void ConfigRewrite(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ConfigRewriteAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "config($subcommand, $argument = null)", @@ -26490,8 +29247,58 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void ConfigSet(RedisValue setting, RedisValue value, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "setting", + "type": "RedisValue", + "description": "The setting name." + }, + { + "name": "value", + "type": "RedisValue", + "description": "The new setting value." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ConfigSetAsync(RedisValue setting, RedisValue value, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "setting", + "type": "RedisValue", + "description": "The setting name." + }, + { + "name": "value", + "type": "RedisValue", + "description": "The new setting value." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "config($subcommand, $argument = null)", @@ -27048,8 +29855,48 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "long DatabaseSize(int database = -1, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "database", + "type": "int", + "description": "The database ID." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task DatabaseSizeAsync(int database = -1, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "database", + "type": "int", + "description": "The database ID." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "dbsize()", @@ -29516,9 +32363,54 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "V echo(V msg)", + "params": [ + { + "name": "msg", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "V", + "description": "V bulk-string-reply." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture echo(V msg)", + "params": [ + { + "name": "msg", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "RedisFuture", + "description": "V bulk-string-reply." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono echo(V msg)", + "params": [ + { + "name": "msg", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "Mono", + "description": "V bulk-string-reply." + } + } + ], "nredisstack_sync": [ { "signature": "RedisValue Echo(RedisValue message, CommandFlags flags = CommandFlags.None)", @@ -33948,8 +36840,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void FlushAllDatabases(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task FlushAllDatabasesAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "flushall()", @@ -33960,8 +36882,54 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "flushall()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + }, + { + "signature": "flushall_options(options: &'a FlushAllOptions)", + "params": [ + { + "name": "options", + "type": "&'a FlushAllOptions", + "description": "" + } + ], + "returns": { + "type": "()", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "flushall()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + }, + { + "signature": "flushall_options(options: &'a FlushAllOptions)", + "params": [ + { + "name": "options", + "type": "&'a FlushAllOptions", + "description": "" + } + ], + "returns": { + "type": "()", + "description": "" + } + } + ] } }, "FLUSHDB": { @@ -34139,8 +37107,48 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void FlushDatabase(int database = -1, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "database", + "type": "int", + "description": "The database ID." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task FlushDatabaseAsync(int database = -1, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "database", + "type": "int", + "description": "The database ID." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "flushdb()", @@ -34151,8 +37159,54 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "flushdb()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + }, + { + "signature": "flushdb_options(options: &'a FlushDbOptions)", + "params": [ + { + "name": "options", + "type": "&'a FlushDbOptions", + "description": "" + } + ], + "returns": { + "type": "()", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "flushdb()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + }, + { + "signature": "flushdb_options(options: &'a FlushDbOptions)", + "params": [ + { + "name": "options", + "type": "&'a FlushDbOptions", + "description": "" + } + ], + "returns": { + "type": "()", + "description": "" + } + } + ] } }, "FT.AGGREGATE": { @@ -34199,9 +37253,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "AggregationReply ftAggregate(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the base filtering query that retrieves documents for aggregation" + } + ], + "returns": { + "type": "AggregationReply", + "description": "the result of the aggregate command containing processed results, see SearchReply" + } + }, + { + "signature": "AggregationReply ftAggregate(String index, String query, AggregateArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the base filtering query that retrieves documents for aggregation" + }, + { + "name": "args", + "type": "AggregateArgs", + "description": "the aggregate arguments defining the processing pipeline and operations" + } + ], + "returns": { + "type": "AggregationReply", + "description": "the result of the aggregate command containing processed and transformed results, see SearchReply" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftAggregate(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the base filtering query that retrieves documents for aggregation" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the result of the aggregate command containing processed results, see SearchReply" + } + }, + { + "signature": "RedisFuture> ftAggregate(String index, String query, AggregateArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the base filtering query that retrieves documents for aggregation" + }, + { + "name": "args", + "type": "AggregateArgs", + "description": "the aggregate arguments defining the processing pipeline and operations" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the result of the aggregate command containing processed and transformed results, see SearchReply" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> ftAggregate(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the base filtering query that retrieves documents for aggregation" + } + ], + "returns": { + "type": "Mono>", + "description": "the result of the aggregate command containing processed results, see SearchReply" + } + }, + { + "signature": "Mono> ftAggregate(String index, String query, AggregateArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the base filtering query that retrieves documents for aggregation" + }, + { + "name": "args", + "type": "AggregateArgs", + "description": "the aggregate arguments defining the processing pipeline and operations" + } + ], + "returns": { + "type": "Mono>", + "description": "the result of the aggregate command containing processed and transformed results, see SearchReply" + } + } + ], "go-redis": [ { "signature": "FTAggregate(ctx context.Context, index string, query string)", @@ -34440,9 +37626,69 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftAliasadd(String alias, String index)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to create" + }, + { + "name": "index", + "type": "String", + "description": "the target index name that the alias will point to" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the alias was successfully created" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftAliasadd(String alias, String index)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to create" + }, + { + "name": "index", + "type": "String", + "description": "the target index name that the alias will point to" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the alias was successfully created" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftAliasadd(String alias, String index)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to create" + }, + { + "name": "index", + "type": "String", + "description": "the target index name that the alias will point to" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the alias was successfully created" + } + } + ], "go-redis": [ { "signature": "FTAliasAdd(ctx context.Context, index string, alias string)", @@ -34613,9 +37859,54 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftAliasdel(String alias)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to remove" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the alias was successfully removed" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftAliasdel(String alias)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to remove" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the alias was successfully removed" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftAliasdel(String alias)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to remove" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the alias was successfully removed" + } + } + ], "go-redis": [ { "signature": "FTAliasDel(ctx context.Context, alias string)", @@ -34761,9 +38052,69 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftAliasupdate(String alias, String index)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to update or create" + }, + { + "name": "index", + "type": "String", + "description": "the target index name that the alias will point to" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the alias was successfully updated" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftAliasupdate(String alias, String index)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to update or create" + }, + { + "name": "index", + "type": "String", + "description": "the target index name that the alias will point to" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the alias was successfully updated" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftAliasupdate(String alias, String index)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to update or create" + }, + { + "name": "index", + "type": "String", + "description": "the target index name that the alias will point to" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the alias was successfully updated" + } + } + ], "go-redis": [ { "signature": "FTAliasUpdate(ctx context.Context, index string, alias string)", @@ -34958,9 +38309,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftAlter(String index, boolean skipInitialScan, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "skipInitialScan", + "type": "boolean", + "description": "if true, skip scanning and indexing existing documents; if false, scan and index existing documents with the new attributes" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the new searchable fields and their types to add" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the index was successfully altered" + } + }, + { + "signature": "String ftAlter(String index, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the new searchable fields and their types to add" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the index was successfully altered" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftAlter(String index, boolean skipInitialScan, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "skipInitialScan", + "type": "boolean", + "description": "if true, skip scanning and indexing existing documents; if false, scan and index existing documents with the new attributes" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the new searchable fields and their types to add" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the index was successfully altered" + } + }, + { + "signature": "RedisFuture ftAlter(String index, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the new searchable fields and their types to add" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the index was successfully altered" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftAlter(String index, boolean skipInitialScan, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "skipInitialScan", + "type": "boolean", + "description": "if true, skip scanning and indexing existing documents; if false, scan and index existing documents with the new attributes" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the new searchable fields and their types to add" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the index was successfully altered" + } + }, + { + "signature": "Mono ftAlter(String index, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the new searchable fields and their types to add" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the index was successfully altered" + } + } + ], "go-redis": [ { "signature": "FTAlter(ctx context.Context, index string, skipInitialScan bool, definition []interface{})", @@ -35190,9 +38673,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftCreate(String index, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the searchable fields and their types" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the index was created successfully" + } + }, + { + "signature": "String ftCreate(String index, CreateArgs arguments, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "arguments", + "type": "CreateArgs", + "description": "the index CreateArgs containing configuration options" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the searchable fields and their types" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the index was created successfully" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftCreate(String index, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the searchable fields and their types" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the index was created successfully" + } + }, + { + "signature": "RedisFuture ftCreate(String index, CreateArgs arguments, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "arguments", + "type": "CreateArgs", + "description": "the index CreateArgs containing configuration options" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the searchable fields and their types" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the index was created successfully" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftCreate(String index, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the searchable fields and their types" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the index was created successfully" + } + }, + { + "signature": "Mono ftCreate(String index, CreateArgs arguments, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "arguments", + "type": "CreateArgs", + "description": "the index CreateArgs containing configuration options" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the searchable fields and their types" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the index was created successfully" + } + } + ], "go-redis": [ { "signature": "FTCreate(ctx context.Context, index string, options *FTCreateOptions, schema ...*FieldSchema)", @@ -35535,9 +39150,69 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftCursordel(String index, Cursor cursor)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the cursor was successfully deleted" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftCursordel(String index, Cursor cursor)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the cursor was successfully deleted" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftCursordel(String index, Cursor cursor)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the cursor was successfully deleted" + } + } + ], "go-redis": [ { "signature": "FTCursorDel(ctx context.Context, index string, cursorId int)", @@ -35713,9 +39388,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "AggregationReply ftCursorread(String index, Cursor cursor, int count)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + }, + { + "name": "count", + "type": "int", + "description": "the number of results to read; overrides the COUNT from FT.AGGREGATE" + } + ], + "returns": { + "type": "AggregationReply", + "description": "the next batch of results; see AggregationReply" + } + }, + { + "signature": "AggregationReply ftCursorread(String index, Cursor cursor)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + } + ], + "returns": { + "type": "AggregationReply", + "description": "the next batch of results; see AggregationReply" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftCursorread(String index, Cursor cursor, int count)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + }, + { + "name": "count", + "type": "int", + "description": "the number of results to read; overrides the COUNT from FT.AGGREGATE" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the next batch of results; see AggregationReply" + } + }, + { + "signature": "RedisFuture> ftCursorread(String index, Cursor cursor)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the next batch of results; see AggregationReply" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> ftCursorread(String index, Cursor cursor, int count)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + }, + { + "name": "count", + "type": "int", + "description": "the number of results to read; overrides the COUNT from FT.AGGREGATE" + } + ], + "returns": { + "type": "Mono>", + "description": "the next batch of results; see AggregationReply" + } + }, + { + "signature": "Mono> ftCursorread(String index, Cursor cursor)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + } + ], + "returns": { + "type": "Mono>", + "description": "the next batch of results; see AggregationReply" + } + } + ], "go-redis": [ { "signature": "FTCursorRead(ctx context.Context, index string, cursorId int, count int)", @@ -35911,9 +39718,69 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "Long ftDictadd(String dict, String... terms)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the dictionary" + } + ], + "returns": { + "type": "Long", + "description": "the number of new terms that were added" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftDictadd(String dict, String... terms)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the dictionary" + } + ], + "returns": { + "type": "RedisFuture", + "description": "the number of new terms that were added" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftDictadd(String dict, String... terms)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the dictionary" + } + ], + "returns": { + "type": "Mono", + "description": "the number of new terms that were added" + } + } + ], "go-redis": [ { "signature": "FTDictAdd(ctx context.Context, dict string, terms ...interface{})", @@ -36094,9 +39961,69 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "Long ftDictdel(String dict, String... terms)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to delete from the dictionary" + } + ], + "returns": { + "type": "Long", + "description": "the number of terms that were deleted" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftDictdel(String dict, String... terms)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to delete from the dictionary" + } + ], + "returns": { + "type": "RedisFuture", + "description": "the number of terms that were deleted" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftDictdel(String dict, String... terms)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to delete from the dictionary" + } + ], + "returns": { + "type": "Mono", + "description": "the number of terms that were deleted" + } + } + ], "go-redis": [ { "signature": "FTDictDel(ctx context.Context, dict string, terms ...interface{})", @@ -36267,9 +40194,54 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "List ftDictdump(String dict)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + } + ], + "returns": { + "type": "List", + "description": "a list of all terms in the dictionary" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftDictdump(String dict)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list of all terms in the dictionary" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux ftDictdump(String dict)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + } + ], + "returns": { + "type": "Flux", + "description": "a list of all terms in the dictionary" + } + } + ], "go-redis": [ { "signature": "FTDictDump(ctx context.Context, dict string)", @@ -36424,9 +40396,111 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftDropindex(String index)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the index was successfully dropped" + } + }, + { + "signature": "String ftDropindex(String index, boolean deleteDocuments)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "deleteDocuments", + "type": "boolean", + "description": "if true, delete the indexed documents as well; if false, preserve documents" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the index was successfully dropped" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftDropindex(String index)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the index was successfully dropped" + } + }, + { + "signature": "RedisFuture ftDropindex(String index, boolean deleteDocuments)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "deleteDocuments", + "type": "boolean", + "description": "if true, delete the indexed documents as well; if false, preserve documents" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the index was successfully dropped" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftDropindex(String index)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the index was successfully dropped" + } + }, + { + "signature": "Mono ftDropindex(String index, boolean deleteDocuments)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "deleteDocuments", + "type": "boolean", + "description": "if true, delete the indexed documents as well; if false, preserve documents" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the index was successfully dropped" + } + } + ], "go-redis": [ { "signature": "FTDropIndex(ctx context.Context, index string)", @@ -36635,9 +40709,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftExplain(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "query", + "type": "String", + "description": "the search query to explain" + } + ], + "returns": { + "type": "String", + "description": "the execution plan as a string" + } + }, + { + "signature": "String ftExplain(String index, String query, ExplainArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "query", + "type": "String", + "description": "the search query to explain" + }, + { + "name": "args", + "type": "ExplainArgs", + "description": "the explain arguments (dialect)" + } + ], + "returns": { + "type": "String", + "description": "the execution plan as a string" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftExplain(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "query", + "type": "String", + "description": "the search query to explain" + } + ], + "returns": { + "type": "RedisFuture", + "description": "the execution plan as a string" + } + }, + { + "signature": "RedisFuture ftExplain(String index, String query, ExplainArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "query", + "type": "String", + "description": "the search query to explain" + }, + { + "name": "args", + "type": "ExplainArgs", + "description": "the explain arguments (dialect)" + } + ], + "returns": { + "type": "RedisFuture", + "description": "the execution plan as a string" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftExplain(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "query", + "type": "String", + "description": "the search query to explain" + } + ], + "returns": { + "type": "Mono", + "description": "the execution plan as a string" + } + }, + { + "signature": "Mono ftExplain(String index, String query, ExplainArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "query", + "type": "String", + "description": "the search query to explain" + }, + { + "name": "args", + "type": "ExplainArgs", + "description": "the explain arguments (dialect)" + } + ], + "returns": { + "type": "Mono", + "description": "the execution plan as a string" + } + } + ], "go-redis": [ { "signature": "FTExplain(ctx context.Context, index string, query string)", @@ -36948,13 +41154,212 @@ }, "FT.HYBRID": { "api_calls": { - "redis_py": [], - "jedis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "go-redis": [], - "node_redis": [], + "redis_py": [ + { + "signature": "hybrid_search(query: HybridQuery, combine_method: Optional[CombineResultsMethod] = None, post_processing: Optional[HybridPostProcessingConfig] = None, params_substitution: Optional[Dict[str, Union[str, int, float, bytes]]] = None, timeout: Optional[int] = None, cursor: Optional[HybridCursorQuery] = None)", + "params": [ + { + "name": "query", + "type": "HybridQuery", + "description": "" + }, + { + "name": "combine_method", + "type": "Optional[CombineResultsMethod] = None", + "description": "" + }, + { + "name": "post_processing", + "type": "Optional[HybridPostProcessingConfig] = None", + "description": "" + }, + { + "name": "params_substitution", + "type": "Optional[Dict[str, Union[str, int, float, bytes]]] = None", + "description": "" + }, + { + "name": "timeout", + "type": "Optional[int] = None", + "description": "" + }, + { + "name": "cursor", + "type": "Optional[HybridCursorQuery] = None", + "description": "" + } + ], + "returns": { + "type": "Union[HybridResult, HybridCursorResult, Pipeline]", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "HybridResult ftHybrid(String indexName, FTHybridParams hybridParams)", + "params": [ + { + "name": "indexName", + "type": "String", + "description": "the index name" + }, + { + "name": "hybridParams", + "type": "FTHybridParams", + "description": "the hybrid query arguments" + } + ], + "returns": { + "type": "HybridResult", + "description": "the hybrid search results" + } + } + ], + "lettuce_sync": [ + { + "signature": "HybridReply ftHybrid(String index, HybridArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "args", + "type": "HybridArgs", + "description": "the hybrid query arguments" + } + ], + "returns": { + "type": "HybridReply", + "description": "the hybrid search results" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftHybrid(String index, HybridArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "args", + "type": "HybridArgs", + "description": "the hybrid query arguments" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the hybrid search results" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> ftHybrid(String index, HybridArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "args", + "type": "HybridArgs", + "description": "the hybrid query arguments" + } + ], + "returns": { + "type": "Mono>", + "description": "the hybrid search results" + } + } + ], + "go-redis": [ + { + "signature": "FTHybrid(ctx context.Context, index string, searchExpr string, vectorField string, vectorData Vector) *FTHybridCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "index", + "type": "string", + "description": "" + }, + { + "name": "searchExpr", + "type": "string", + "description": "" + }, + { + "name": "vectorField", + "type": "string", + "description": "" + }, + { + "name": "vectorData", + "type": "Vector", + "description": "" + } + ], + "returns": { + "type": "*FTHybridCmd", + "description": "" + } + }, + { + "signature": "FTHybridWithArgs(ctx context.Context, index string, options *FTHybridOptions) *FTHybridCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "index", + "type": "string", + "description": "" + }, + { + "name": "options", + "type": "*FTHybridOptions", + "description": "" + } + ], + "returns": { + "type": "*FTHybridCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "client.ft.hybrid(index: RedisArgument, options: FtHybridOptions)", + "params": [ + { + "name": "index", + "type": "RedisArgument", + "description": "" + }, + { + "name": "options", + "type": "FtHybridOptions", + "description": "" + } + ], + "returns": { + "type": "HybridSearchResult", + "description": "" + } + } + ], "ioredis": [], "redis_rs_sync": [], "redis_rs_async": [], @@ -37598,9 +42003,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "SearchReply ftSearch(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the query string following RediSearch query syntax" + } + ], + "returns": { + "type": "SearchReply", + "description": "the result of the search command containing matching documents, see SearchReply" + } + }, + { + "signature": "SearchReply ftSearch(String index, String query, SearchArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the query string following RediSearch query syntax" + }, + { + "name": "args", + "type": "SearchArgs", + "description": "the search arguments containing advanced options and filters" + } + ], + "returns": { + "type": "SearchReply", + "description": "the result of the search command containing matching documents and metadata, see SearchReply" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftSearch(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the query string following RediSearch query syntax" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the result of the search command containing matching documents, see SearchReply" + } + }, + { + "signature": "RedisFuture> ftSearch(String index, String query, SearchArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the query string following RediSearch query syntax" + }, + { + "name": "args", + "type": "SearchArgs", + "description": "the search arguments containing advanced options and filters" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the result of the search command containing matching documents and metadata, see SearchReply" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> ftSearch(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the query string following RediSearch query syntax" + } + ], + "returns": { + "type": "Mono>", + "description": "the result of the search command containing matching documents, see SearchReply" + } + }, + { + "signature": "Mono> ftSearch(String index, String query, SearchArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the query string following RediSearch query syntax" + }, + { + "name": "args", + "type": "SearchArgs", + "description": "the search arguments containing advanced options and filters" + } + ], + "returns": { + "type": "Mono>", + "description": "the result of the search command containing matching documents and metadata, see SearchReply" + } + } + ], "go-redis": [ { "signature": "FTSearch(ctx context.Context, index string, query string)", @@ -37908,9 +42445,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "SpellCheckResult ftSpellcheck(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index with the indexed terms" + }, + { + "name": "query", + "type": "String", + "description": "the search query to check for spelling errors" + } + ], + "returns": { + "type": "SpellCheckResult", + "description": "spell check result containing misspelled terms and their suggestions" + } + }, + { + "signature": "SpellCheckResult ftSpellcheck(String index, String query, SpellCheckArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index with the indexed terms" + }, + { + "name": "query", + "type": "String", + "description": "the search query to check for spelling errors" + }, + { + "name": "args", + "type": "SpellCheckArgs", + "description": "the spellcheck arguments (distance, terms, dialect)" + } + ], + "returns": { + "type": "SpellCheckResult", + "description": "spell check result containing misspelled terms and their suggestions" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftSpellcheck(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index with the indexed terms" + }, + { + "name": "query", + "type": "String", + "description": "the search query to check for spelling errors" + } + ], + "returns": { + "type": "RedisFuture", + "description": "spell check result containing misspelled terms and their suggestions" + } + }, + { + "signature": "RedisFuture ftSpellcheck(String index, String query, SpellCheckArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index with the indexed terms" + }, + { + "name": "query", + "type": "String", + "description": "the search query to check for spelling errors" + }, + { + "name": "args", + "type": "SpellCheckArgs", + "description": "the spellcheck arguments (distance, terms, dialect)" + } + ], + "returns": { + "type": "RedisFuture", + "description": "spell check result containing misspelled terms and their suggestions" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftSpellcheck(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index with the indexed terms" + }, + { + "name": "query", + "type": "String", + "description": "the search query to check for spelling errors" + } + ], + "returns": { + "type": "Mono", + "description": "spell check result containing misspelled terms and their suggestions" + } + }, + { + "signature": "Mono ftSpellcheck(String index, String query, SpellCheckArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index with the indexed terms" + }, + { + "name": "query", + "type": "String", + "description": "the search query to check for spelling errors" + }, + { + "name": "args", + "type": "SpellCheckArgs", + "description": "the spellcheck arguments (distance, terms, dialect)" + } + ], + "returns": { + "type": "Mono", + "description": "spell check result containing misspelled terms and their suggestions" + } + } + ], "go-redis": [ { "signature": "FTSpellCheck(ctx context.Context, index string, query string)", @@ -38184,9 +42853,171 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "Long ftSugadd(K key, String suggestion, double score)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to index" + }, + { + "name": "score", + "type": "double", + "description": "the floating point number of the suggestion string's weight" + } + ], + "returns": { + "type": "Long", + "description": "the current size of the suggestion dictionary after adding the suggestion" + } + }, + { + "signature": "Long ftSugadd(K key, String suggestion, double score, SugAddArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to index" + }, + { + "name": "score", + "type": "double", + "description": "the floating point number of the suggestion string's weight" + }, + { + "name": "args", + "type": "SugAddArgs", + "description": "the suggestion add arguments (INCR, deprecated PAYLOAD)" + } + ], + "returns": { + "type": "Long", + "description": "the current size of the suggestion dictionary after adding the suggestion" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftSugadd(K key, String suggestion, double score)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to index" + }, + { + "name": "score", + "type": "double", + "description": "the floating point number of the suggestion string's weight" + } + ], + "returns": { + "type": "RedisFuture", + "description": "the current size of the suggestion dictionary after adding the suggestion" + } + }, + { + "signature": "RedisFuture ftSugadd(K key, String suggestion, double score, SugAddArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to index" + }, + { + "name": "score", + "type": "double", + "description": "the floating point number of the suggestion string's weight" + }, + { + "name": "args", + "type": "SugAddArgs", + "description": "the suggestion add arguments (INCR, deprecated PAYLOAD)" + } + ], + "returns": { + "type": "RedisFuture", + "description": "the current size of the suggestion dictionary after adding the suggestion" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftSugadd(K key, String suggestion, double score)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to index" + }, + { + "name": "score", + "type": "double", + "description": "the floating point number of the suggestion string's weight" + } + ], + "returns": { + "type": "Mono", + "description": "the current size of the suggestion dictionary after adding the suggestion" + } + }, + { + "signature": "Mono ftSugadd(K key, String suggestion, double score, SugAddArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to index" + }, + { + "name": "score", + "type": "double", + "description": "the floating point number of the suggestion string's weight" + }, + { + "name": "args", + "type": "SugAddArgs", + "description": "the suggestion add arguments (INCR, deprecated PAYLOAD)" + } + ], + "returns": { + "type": "Mono", + "description": "the current size of the suggestion dictionary after adding the suggestion" + } + } + ], "go-redis": [ { "signature": "FTSugAdd(ctx context.Context, key string, suggestion string, score float64)", @@ -38466,9 +43297,69 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "Boolean ftSugdel(K key, String suggestion)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to delete" + } + ], + "returns": { + "type": "Boolean", + "description": "true if the string was found and deleted, false otherwise" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftSugdel(K key, String suggestion)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to delete" + } + ], + "returns": { + "type": "RedisFuture", + "description": "true if the string was found and deleted, false otherwise" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftSugdel(K key, String suggestion)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to delete" + } + ], + "returns": { + "type": "Mono", + "description": "true if the string was found and deleted, false otherwise" + } + } + ], "go-redis": [ { "signature": "FTSugDel(ctx context.Context, key string, suggestion string)", @@ -38693,9 +43584,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "List ftSugget(K key, String prefix)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "prefix", + "type": "String", + "description": "the prefix to complete on" + } + ], + "returns": { + "type": "List", + "description": "a list of suggestions matching the prefix" + } + }, + { + "signature": "List ftSugget(K key, String prefix, SugGetArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "prefix", + "type": "String", + "description": "the prefix to complete on" + }, + { + "name": "args", + "type": "SugGetArgs", + "description": "the suggestion get arguments (FUZZY, WITHSCORES, deprecated WITHPAYLOADS, MAX)" + } + ], + "returns": { + "type": "List", + "description": "a list of suggestions matching the prefix, optionally with scores and payloads" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftSugget(K key, String prefix)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "prefix", + "type": "String", + "description": "the prefix to complete on" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list of suggestions matching the prefix" + } + }, + { + "signature": "RedisFuture> ftSugget(K key, String prefix, SugGetArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "prefix", + "type": "String", + "description": "the prefix to complete on" + }, + { + "name": "args", + "type": "SugGetArgs", + "description": "the suggestion get arguments (FUZZY, WITHSCORES, deprecated WITHPAYLOADS, MAX)" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list of suggestions matching the prefix, optionally with scores and payloads" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux ftSugget(K key, String prefix)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "prefix", + "type": "String", + "description": "the prefix to complete on" + } + ], + "returns": { + "type": "Flux", + "description": "a list of suggestions matching the prefix" + } + }, + { + "signature": "Flux ftSugget(K key, String prefix, SugGetArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "prefix", + "type": "String", + "description": "the prefix to complete on" + }, + { + "name": "args", + "type": "SugGetArgs", + "description": "the suggestion get arguments (FUZZY, WITHSCORES, deprecated WITHPAYLOADS, MAX)" + } + ], + "returns": { + "type": "Flux", + "description": "a list of suggestions matching the prefix, optionally with scores and payloads" + } + } + ], "go-redis": [ { "signature": "FTSugGet(ctx context.Context, key string, prefix string)", @@ -39008,9 +44031,54 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "Long ftSuglen(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + } + ], + "returns": { + "type": "Long", + "description": "the current size of the suggestion dictionary" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftSuglen(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + } + ], + "returns": { + "type": "RedisFuture", + "description": "the current size of the suggestion dictionary" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftSuglen(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + } + ], + "returns": { + "type": "Mono", + "description": "the current size of the suggestion dictionary" + } + } + ], "go-redis": [ { "signature": "FTSugLen(ctx context.Context, key string)", @@ -39145,9 +44213,54 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "Map> ftSyndump(String index)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + } + ], + "returns": { + "type": "Map>", + "description": "a map where keys are synonym terms and values are lists of group IDs containing that synonym" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture>> ftSyndump(String index)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + } + ], + "returns": { + "type": "RedisFuture>>", + "description": "a map where keys are synonym terms and values are lists of group IDs containing that synonym" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono>> ftSyndump(String index)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + } + ], + "returns": { + "type": "Mono>>", + "description": "a map where keys are synonym terms and values are lists of group IDs containing that synonym" + } + } + ], "go-redis": [ { "signature": "FTSynDump(ctx context.Context, index string)", @@ -39308,9 +44421,171 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftSynupdate(String index, String synonymGroupId, String... terms)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "synonymGroupId", + "type": "String", + "description": "the synonym group identifier" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the synonym group" + } + ], + "returns": { + "type": "String", + "description": "OK if executed correctly" + } + }, + { + "signature": "String ftSynupdate(String index, String synonymGroupId, SynUpdateArgs args, String... terms)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "synonymGroupId", + "type": "String", + "description": "the synonym group identifier" + }, + { + "name": "args", + "type": "SynUpdateArgs", + "description": "the synupdate arguments (skipInitialScan)" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the synonym group" + } + ], + "returns": { + "type": "String", + "description": "OK if executed correctly" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftSynupdate(String index, String synonymGroupId, String... terms)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "synonymGroupId", + "type": "String", + "description": "the synonym group identifier" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the synonym group" + } + ], + "returns": { + "type": "RedisFuture", + "description": "OK if executed correctly" + } + }, + { + "signature": "RedisFuture ftSynupdate(String index, String synonymGroupId, SynUpdateArgs args, String... terms)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "synonymGroupId", + "type": "String", + "description": "the synonym group identifier" + }, + { + "name": "args", + "type": "SynUpdateArgs", + "description": "the synupdate arguments (skipInitialScan)" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the synonym group" + } + ], + "returns": { + "type": "RedisFuture", + "description": "OK if executed correctly" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftSynupdate(String index, String synonymGroupId, String... terms)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "synonymGroupId", + "type": "String", + "description": "the synonym group identifier" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the synonym group" + } + ], + "returns": { + "type": "Mono", + "description": "OK if executed correctly" + } + }, + { + "signature": "Mono ftSynupdate(String index, String synonymGroupId, SynUpdateArgs args, String... terms)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "synonymGroupId", + "type": "String", + "description": "the synonym group identifier" + }, + { + "name": "args", + "type": "SynUpdateArgs", + "description": "the synupdate arguments (skipInitialScan)" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the synonym group" + } + ], + "returns": { + "type": "Mono", + "description": "OK if executed correctly" + } + } + ], "go-redis": [ { "signature": "FTSynUpdate(ctx context.Context, index string, synGroupId interface{}, terms ...interface{})", @@ -39541,9 +44816,69 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "List ftTagvals(String index, String fieldName)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name containing the tag field" + }, + { + "name": "fieldName", + "type": "String", + "description": "the name of the Tag field defined in the index schema" + } + ], + "returns": { + "type": "List", + "description": "a list of all distinct values indexed in the specified tag field. The list contains the raw tag values as they were indexed (lowercase, whitespace removed)." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftTagvals(String index, String fieldName)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name containing the tag field" + }, + { + "name": "fieldName", + "type": "String", + "description": "the name of the Tag field defined in the index schema" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list of all distinct values indexed in the specified tag field. The list contains the raw tag values as they were indexed (lowercase, whitespace removed)." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux ftTagvals(String index, String fieldName)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name containing the tag field" + }, + { + "name": "fieldName", + "type": "String", + "description": "the name of the Tag field defined in the index schema" + } + ], + "returns": { + "type": "Flux", + "description": "a list of all distinct values indexed in the specified tag field. The list contains the raw tag values as they were indexed (lowercase, whitespace removed)." + } + } + ], "go-redis": [ { "signature": "FTTagVals(ctx context.Context, index string, field string)", @@ -39702,9 +45037,36 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "List ftList()", + "params": [], + "returns": { + "type": "List", + "description": "a list of index names" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftList()", + "params": [], + "returns": { + "type": "RedisFuture>", + "description": "a list of index names" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux ftList()", + "params": [], + "returns": { + "type": "Flux", + "description": "a list of index names" + } + } + ], "go-redis": [ { "signature": "FT_List(ctx context.Context)", @@ -39846,7 +45208,22 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "delete(string $libraryName)", + "params": [ + { + "name": "$libraryName", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "Status", + "description": "" + } + } + ] } }, "FUNCTION DUMP": { @@ -39861,7 +45238,16 @@ } } ], - "jedis": [], + "jedis": [ + { + "signature": "byte[] functionDump()", + "params": [], + "returns": { + "type": "byte[]", + "description": "the serialized payload" + } + } + ], "go-redis": [ { "signature": "FunctionDump(ctx context.Context)", @@ -39924,7 +45310,16 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "dump()", + "params": [], + "returns": { + "type": "string", + "description": "" + } + } + ] } }, "FUNCTION FLUSH": { @@ -40055,7 +45450,22 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "flush(?string $mode = null)", + "params": [ + { + "name": "$mode", + "type": "?string", + "description": "" + } + ], + "returns": { + "type": "Status", + "description": "" + } + } + ] } }, "FUNCTION HELP": { @@ -40160,7 +45570,16 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "kill()", + "params": [], + "returns": { + "type": "Status", + "description": "" + } + } + ] } }, "FUNCTION LIST": { @@ -40347,7 +45766,27 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "list(string $libraryNamePattern = null, bool $withCode = false)", + "params": [ + { + "name": "$libraryNamePattern", + "type": "string", + "description": "" + }, + { + "name": "$withCode", + "type": "bool", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ] } }, "FUNCTION LOAD": { @@ -40575,7 +46014,27 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "load(string $functionCode, bool $replace = false)", + "params": [ + { + "name": "$functionCode", + "type": "string", + "description": "" + }, + { + "name": "$replace", + "type": "bool", + "description": "" + } + ], + "returns": { + "type": "string", + "description": "" + } + } + ] } }, "FUNCTION RESTORE": { @@ -40789,7 +46248,27 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "restore(string $value, string $policy = null)", + "params": [ + { + "name": "$value", + "type": "string", + "description": "" + }, + { + "name": "$policy", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "Status", + "description": "" + } + } + ] } }, "FUNCTION STATS": { @@ -40849,7 +46328,16 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "stats()", + "params": [], + "returns": { + "type": "array", + "description": "" + } + } + ] } }, "GEOADD": { @@ -51202,8 +56690,63 @@ } ], "jedis": [], - "go-redis": [], - "node_redis": [], + "go-redis": [ + { + "signature": "Hello(ctx context.Context, ver int, username, password, clientName string) *MapStringInterfaceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "ver", + "type": "int", + "description": "" + }, + { + "name": "username", + "type": "string", + "description": "" + }, + { + "name": "password", + "type": "string", + "description": "" + }, + { + "name": "clientName", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "*MapStringInterfaceCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "hello(protover?: RespVersions, options?: HelloOptions)", + "params": [ + { + "name": "protover", + "type": "RespVersions", + "description": "" + }, + { + "name": "options", + "type": "HelloOptions", + "description": "" + } + ], + "returns": { + "type": "HelloReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], @@ -60374,13 +65917,313 @@ }, "HOTKEYS": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "hotkeys_start(metrics: List[HotkeysMetricsTypes], count: int | None = None, duration: int | None = None, sample_ratio: int | None = None, slots: List[int] | None = None, **kwargs)", + "params": [ + { + "name": "metrics", + "type": "List[HotkeysMetricsTypes]", + "description": "" + }, + { + "name": "count", + "type": "int | None = None", + "description": "" + }, + { + "name": "duration", + "type": "int | None = None", + "description": "" + }, + { + "name": "sample_ratio", + "type": "int | None = None", + "description": "" + }, + { + "name": "slots", + "type": "List[int] | None = None", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "bytes | str", + "description": "" + } + }, + { + "signature": "hotkeys_stop(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "bytes | str", + "description": "" + } + }, + { + "signature": "hotkeys_reset(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "bytes | str", + "description": "" + } + }, + { + "signature": "hotkeys_get(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "list[dict[str | bytes, Any]]", + "description": "" + } + } + ], "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "go-redis": [ + { + "signature": "HotKeysStart(ctx context.Context, args *HotKeysStartArgs) *StatusCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "args", + "type": "*HotKeysStartArgs", + "description": "" + } + ], + "returns": { + "type": "*StatusCmd", + "description": "" + } + }, + { + "signature": "HotKeysStop(ctx context.Context) *StatusCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*StatusCmd", + "description": "" + } + }, + { + "signature": "HotKeysReset(ctx context.Context) *StatusCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*StatusCmd", + "description": "" + } + }, + { + "signature": "HotKeysGet(ctx context.Context) *HotKeysCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*HotKeysCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "hotkeysStart(options: HotkeysStartOptions)", + "params": [ + { + "name": "options", + "type": "HotkeysStartOptions", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + }, + { + "signature": "hotkeysStop()", + "params": [], + "returns": { + "type": "SimpleStringReply<'OK'> | NullReply", + "description": "" + } + }, + { + "signature": "hotkeysReset()", + "params": [], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + }, + { + "signature": "hotkeysGet()", + "params": [], + "returns": { + "type": "HotkeysGetReply | null", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "String hotkeysStart(HotkeysArgs args)", + "params": [ + { + "name": "args", + "type": "HotkeysArgs", + "description": "tracking arguments." + } + ], + "returns": { + "type": "String", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "String hotkeysStop()", + "params": [], + "returns": { + "type": "String", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "String hotkeysReset()", + "params": [], + "returns": { + "type": "String", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "HotkeysReply hotkeysGet()", + "params": [], + "returns": { + "type": "HotkeysReply", + "description": "HotkeysReply with tracking data, or null if no tracking session." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture hotkeysStart(HotkeysArgs args)", + "params": [ + { + "name": "args", + "type": "HotkeysArgs", + "description": "tracking arguments." + } + ], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "RedisFuture hotkeysStop()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "RedisFuture hotkeysReset()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "RedisFuture hotkeysGet()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "HotkeysReply with tracking data, or null if no tracking session." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono hotkeysStart(HotkeysArgs args)", + "params": [ + { + "name": "args", + "type": "HotkeysArgs", + "description": "tracking arguments." + } + ], + "returns": { + "type": "Mono", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "Mono hotkeysStop()", + "params": [], + "returns": { + "type": "Mono", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "Mono hotkeysReset()", + "params": [], + "returns": { + "type": "Mono", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "Mono hotkeysGet()", + "params": [], + "returns": { + "type": "Mono", + "description": "HotkeysReply with tracking data, or null if no tracking session." + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], "php": [], @@ -68778,8 +74621,86 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "IGrouping>[] Info(RedisValue section = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "section", + "type": "RedisValue", + "description": "The info section to get, if getting a specific one." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "IGrouping>[]", + "description": "A grouping of key/value pairs, grouped by their section header." + } + }, + { + "signature": "string? InfoRaw(RedisValue section = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "section", + "type": "RedisValue", + "description": "The info section to get, if getting a specific one." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "string?", + "description": "The entire raw INFO string." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task>[]> InfoAsync(RedisValue section = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "section", + "type": "RedisValue", + "description": "The info section to get, if getting a specific one." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task>[]>", + "description": "A grouping of key/value pairs, grouped by their section header." + } + }, + { + "signature": "Task InfoRawAsync(RedisValue section = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "section", + "type": "RedisValue", + "description": "The info section to get, if getting a specific one." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The entire raw INFO string." + } + } + ], "php": [ { "signature": "info(string ...$section = null)", @@ -77831,83 +83752,44 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ - { - "signature": "lastsave()", - "params": [], - "returns": { - "type": "int", - "description": "" - } - } - ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "LATENCY DOCTOR": { - "api_calls": { - "redis_py": [ + "nredisstack_sync": [ { - "signature": "latency_doctor(**kwargs)", + "signature": "DateTime LastSave(CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "**kwargs", - "type": "Any", - "description": "" + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." } ], "returns": { - "type": "str", - "description": "" - } - } - ], - "jedis": [ - { - "signature": "String latencyDoctor()", - "params": [], - "returns": { - "type": "String", - "description": "" + "type": "DateTime", + "description": "The last time a save was performed." } } ], - "go-redis": [], - "node_redis": [ + "nredisstack_async": [ { - "signature": "latencyDoctor()", - "params": [], + "signature": "Task LastSaveAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], "returns": { - "type": "BlobStringReply", - "description": "" + "type": "Task", + "description": "The last time a save was performed." } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], "php": [ { - "signature": "latency(string $subcommand, ...$args)", - "params": [ - { - "name": "$subcommand", - "type": "string", - "description": "" - }, - { - "name": "$args", - "type": "mixed", - "description": "" - } - ], + "signature": "lastsave()", + "params": [], "returns": { - "type": "string", + "type": "int", "description": "" } } @@ -77916,17 +83798,12 @@ "redis_rs_async": [] } }, - "LATENCY GRAPH": { + "LATENCY DOCTOR": { "api_calls": { "redis_py": [ { - "signature": "latency_graph(event: str, **kwargs)", + "signature": "latency_doctor(**kwargs)", "params": [ - { - "name": "event", - "type": "str", - "description": "" - }, { "name": "**kwargs", "type": "Any", @@ -77941,14 +83818,8 @@ ], "jedis": [ { - "signature": "String latencyGraph(String event)", - "params": [ - { - "name": "event", - "type": "String", - "description": "" - } - ], + "signature": "String latencyDoctor()", + "params": [], "returns": { "type": "String", "description": "" @@ -77958,14 +83829,8 @@ "go-redis": [], "node_redis": [ { - "signature": "latencyGraph(event: LatencyEvent)", - "params": [ - { - "name": "event", - "type": "LatencyEvent", - "description": "The latency event to get the graph for" - } - ], + "signature": "latencyDoctor()", + "params": [], "returns": { "type": "BlobStringReply", "description": "" @@ -77975,100 +83840,38 @@ "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ + "nredisstack_sync": [ { - "signature": "latency(string $subcommand, ...$args)", + "signature": "string LatencyDoctor(CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "$subcommand", - "type": "string", - "description": "" - }, - { - "name": "$args", - "type": "mixed", + "name": "flags", + "type": "CommandFlags", "description": "" } ], "returns": { "type": "string", - "description": "" - } - } - ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "LATENCY HELP": { - "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [ - { - "signature": "latency(string $subcommand, ...$args)", - "params": [ - { - "name": "$subcommand", - "type": "string", - "description": "" - }, - { - "name": "$args", - "type": "mixed", - "description": "" - } - ], - "returns": { - "type": "array", - "description": "" + "description": "The full text result of latency doctor." } } ], - "redis_rs_sync": [], - "redis_rs_async": [] - } - }, - "LATENCY HISTOGRAM": { - "api_calls": { - "redis_py": [ + "nredisstack_async": [ { - "signature": "latency_histogram(*events, **kwargs)", + "signature": "Task LatencyDoctorAsync(CommandFlags flags = CommandFlags.None)", "params": [ { - "name": "*events", - "type": "str", - "description": "" - }, - { - "name": "**kwargs", - "type": "Any", + "name": "flags", + "type": "CommandFlags", "description": "" } ], "returns": { - "type": "dict", - "description": "" + "type": "Task", + "description": "The full text result of latency doctor." } } ], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], "php": [ { "signature": "latency(string $subcommand, ...$args)", @@ -78085,7 +83888,7 @@ } ], "returns": { - "type": "array", + "type": "string", "description": "" } } @@ -78094,11 +83897,11 @@ "redis_rs_async": [] } }, - "LATENCY HISTORY": { + "LATENCY GRAPH": { "api_calls": { "redis_py": [ { - "signature": "latency_history(event: str, **kwargs)", + "signature": "latency_graph(event: str, **kwargs)", "params": [ { "name": "event", @@ -78112,14 +83915,14 @@ } ], "returns": { - "type": "list", + "type": "str", "description": "" } } ], "jedis": [ { - "signature": "List latencyHistory(String event)", + "signature": "String latencyGraph(String event)", "params": [ { "name": "event", @@ -78128,44 +83931,24 @@ } ], "returns": { - "type": "List", - "description": "" - } - } - ], - "go-redis": [ - { - "signature": "LatencyHistory(ctx context.Context, event string) *StringSliceCmd", - "params": [ - { - "name": "ctx", - "type": "context.Context", - "description": "Context" - }, - { - "name": "event", - "type": "string", - "description": "" - } - ], - "returns": { - "type": "*StringSliceCmd", + "type": "String", "description": "" } } ], + "go-redis": [], "node_redis": [ { - "signature": "latencyHistory(event: LatencyEventType)", + "signature": "latencyGraph(event: LatencyEvent)", "params": [ { "name": "event", - "type": "LatencyEventType", - "description": "The latency event to get the history for" + "type": "LatencyEvent", + "description": "The latency event to get the graph for" } ], "returns": { - "type": "Array<[NumberReply, NumberReply]>", + "type": "BlobStringReply", "description": "" } } @@ -78175,6 +83958,259 @@ "lettuce_reactive": [], "nredisstack_sync": [], "nredisstack_async": [], + "php": [ + { + "signature": "latency(string $subcommand, ...$args)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "string", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "LATENCY HELP": { + "api_calls": { + "redis_py": [], + "jedis": [], + "go-redis": [], + "node_redis": [], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "latency(string $subcommand, ...$args)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "LATENCY HISTOGRAM": { + "api_calls": { + "redis_py": [ + { + "signature": "latency_histogram(*events, **kwargs)", + "params": [ + { + "name": "*events", + "type": "str", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "dict", + "description": "" + } + } + ], + "jedis": [], + "go-redis": [], + "node_redis": [ + { + "signature": "latencyHistogram(...commands: string[])", + "params": [ + { + "name": "...commands", + "type": "string[]", + "description": "" + } + ], + "returns": { + "type": "Record }>", + "description": "" + } + } + ], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [], + "nredisstack_async": [], + "php": [ + { + "signature": "latency(string $subcommand, ...$args)", + "params": [ + { + "name": "$subcommand", + "type": "string", + "description": "" + }, + { + "name": "$args", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], + "redis_rs_sync": [], + "redis_rs_async": [] + } + }, + "LATENCY HISTORY": { + "api_calls": { + "redis_py": [ + { + "signature": "latency_history(event: str, **kwargs)", + "params": [ + { + "name": "event", + "type": "str", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "list", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "List latencyHistory(String event)", + "params": [ + { + "name": "event", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "LatencyHistory(ctx context.Context, event string) *StringSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "event", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "*StringSliceCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "latencyHistory(event: LatencyEventType)", + "params": [ + { + "name": "event", + "type": "LatencyEventType", + "description": "The latency event to get the history for" + } + ], + "returns": { + "type": "Array<[NumberReply, NumberReply]>", + "description": "" + } + } + ], + "lettuce_sync": [], + "lettuce_async": [], + "lettuce_reactive": [], + "nredisstack_sync": [ + { + "signature": "LatencyHistoryEntry[] LatencyHistory(string eventName, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "eventName", + "type": "string", + "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "LatencyHistoryEntry[]", + "description": "An array of latency history entries." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task LatencyHistoryAsync(string eventName, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "eventName", + "type": "string", + "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "An array of latency history entries." + } + } + ], "php": [ { "signature": "latency(string $subcommand, ...$args)", @@ -78257,8 +84293,38 @@ "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "LatencyLatestEntry[] LatencyLatest(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "LatencyLatestEntry[]", + "description": "An array of the latest latency history entries." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task LatencyLatestAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "An array of the latest latency history entries." + } + } + ], "php": [ { "signature": "latency(string $subcommand, ...$args)", @@ -78371,8 +84437,48 @@ "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "long LatencyReset(string[]? eventNames = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "eventNames", + "type": "string[]?", + "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "The number of events that were reset." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task LatencyResetAsync(string[]? eventNames = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "eventNames", + "type": "string[]?", + "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "The number of events that were reset." + } + } + ], "php": [ { "signature": "latency(string $subcommand, ...$args)", @@ -81318,7 +87424,27 @@ } ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "LOLWUT(version?: number, ...optionalArguments: Array)", + "params": [ + { + "name": "version", + "type": "number", + "description": "" + }, + { + "name": "...optionalArguments", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "BlobStringReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], @@ -85793,12 +91919,51 @@ } ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "memoryDoctor()", + "params": [], + "returns": { + "type": "BlobStringReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "string MemoryDoctor(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "string", + "description": "The full text result of memory doctor." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task MemoryDoctorAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "The full text result of memory doctor." + } + } + ], "php": [ { "signature": "memory(string $subcommand, ...$args)", @@ -85889,12 +92054,51 @@ } ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "memoryMallocStats()", + "params": [], + "returns": { + "type": "BlobStringReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "string? MemoryAllocatorStats(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "string?", + "description": "The full text result of memory allocation stats." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task MemoryAllocatorStatsAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "The full text result of memory allocation stats." + } + } + ], "php": [ { "signature": "memory(string $subcommand, ...$args)", @@ -85964,12 +92168,51 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "memoryPurge()", + "params": [], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void MemoryPurge(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task MemoryPurgeAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "memory(string $subcommand, ...$args)", @@ -86079,8 +92322,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "RedisResult MemoryStats(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "RedisResult", + "description": "An array reply of memory stat metrics and values." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task MemoryStatsAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "An array reply of memory stat metrics and values." + } + } + ], "php": [ { "signature": "memory(string $subcommand, ...$args)", @@ -87371,7 +93644,16 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "moduleList()", + "params": [], + "returns": { + "type": "ModuleListReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], @@ -87472,93 +93754,133 @@ } } ], - "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": [ + "node_redis": [ { - "signature": "String moduleLoadex(String path, ModuleLoadExParams params)", + "signature": "moduleLoad(path: RedisArgument, moduleArguments?: Array)", "params": [ { "name": "path", - "type": "String", + "type": "RedisArgument", "description": "" }, { - "name": "params", - "type": "ModuleLoadExParams", + "name": "moduleArguments", + "type": "Array", "description": "" } ], "returns": { - "type": "String", + "type": "SimpleStringReply<'OK'>", "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 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": [ + { + "signature": "ModuleLoadex(ctx context.Context, conf *ModuleLoadexConfig) *StringCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "conf", + "type": "*ModuleLoadexConfig", + "description": "" + } + ], + "returns": { + "type": "*StringCmd", + "description": "" + } + } + ], + "node_redis": [], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], @@ -87649,7 +93971,22 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "moduleUnload(name: RedisArgument)", + "params": [ + { + "name": "name", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], @@ -87744,8 +94081,43 @@ } } ], - "go-redis": [], - "node_redis": [], + "go-redis": [ + { + "signature": "Monitor(ctx context.Context, ch chan string) *MonitorCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "ch", + "type": "chan string", + "description": "" + } + ], + "returns": { + "type": "*MonitorCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "monitor(callback: MonitorCallback)", + "params": [ + { + "name": "callback", + "type": "MonitorCallback", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], @@ -91482,11 +97854,68 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "lettuce_sync": [ + { + "signature": "String ping()", + "params": [], + "returns": { + "type": "String", + "description": "String simple-string-reply." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ping()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ping()", + "params": [], + "returns": { + "type": "Mono", + "description": "String simple-string-reply." + } + } + ], + "nredisstack_sync": [ + { + "signature": "TimeSpan Ping(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use when pinging." + } + ], + "returns": { + "type": "TimeSpan", + "description": "The observed latency." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task PingAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The observed latency." + } + } + ], "php": [ { "signature": "ping(?string $message = null)", @@ -91503,8 +97932,54 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "ping()", + "params": [], + "returns": { + "type": "(String)", + "description": "" + } + }, + { + "signature": "ping_message(message: K)", + "params": [ + { + "name": "message", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(String)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "ping()", + "params": [], + "returns": { + "type": "(String)", + "description": "" + } + }, + { + "signature": "ping_message(message: K)", + "params": [ + { + "name": "message", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(String)", + "description": "" + } + } + ] } }, "PSETEX": { @@ -91828,7 +98303,27 @@ }, "PSUBSCRIBE": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "psubscribe(*args: ChannelT | Subscription, **kwargs: PubSubHandler)", + "params": [ + { + "name": "*args", + "type": "ChannelT | Subscription", + "description": "" + }, + { + "name": "**kwargs", + "type": "PubSubHandler", + "description": "" + } + ], + "returns": { + "type": "None", + "description": "" + } + } + ], "jedis": [ { "signature": "void psubscribe(BinaryJedisPubSub jedisPubSub, final byte[]... patterns)", @@ -91869,18 +98364,279 @@ } } ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "go-redis": [ + { + "signature": "(*Client).PSubscribe(ctx context.Context, channels ...string) *PubSub", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "channels", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*PubSub", + "description": "" + } + }, + { + "signature": "(*PubSub).PSubscribe(ctx context.Context, patterns ...string) error", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "patterns", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "error", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "pSubscribe(patterns: string | Array, listener: PubSubListener, bufferMode?: T)", + "params": [ + { + "name": "patterns", + "type": "string | Array", + "description": "" + }, + { + "name": "listener", + "type": "PubSubListener", + "description": "" + }, + { + "name": "bufferMode", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "void psubscribe(K... patterns)", + "params": [ + { + "name": "patterns", + "type": "K...", + "description": "the patterns" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture psubscribe(K... patterns)", + "params": [ + { + "name": "patterns", + "type": "K...", + "description": "the patterns" + } + ], + "returns": { + "type": "RedisFuture", + "description": "RedisFuture Future to synchronize psubscribe completion" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono psubscribe(K... patterns)", + "params": [ + { + "name": "patterns", + "type": "K...", + "description": "the patterns." + } + ], + "returns": { + "type": "Mono", + "description": "Mono Mono for psubscribe command." + } + } + ], "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_sync": [ + { + "signature": "psubscribe(pchannel: T)", + "params": [ + { + "name": "pchannel", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + }, + { + "signature": "psubscribe(pattern: P, func: F)", + "params": [ + { + "name": "pattern", + "type": "P", + "description": "" + }, + { + "name": "func", + "type": "F", + "description": "" + } + ], + "returns": { + "type": "RedisResult", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "psubscribe(channel_pattern: impl ToRedisArgs)", + "params": [ + { + "name": "channel_pattern", + "type": "impl ToRedisArgs", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], + "nredisstack_sync": [ + { + "signature": "void Subscribe(RedisChannel channel, Action handler, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to subscribe to." + }, + { + "name": "handler", + "type": "Action", + "description": "The handler to invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "ChannelMessageQueue Subscribe(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The redis channel to subscribe to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "ChannelMessageQueue", + "description": "A channel that represents this source." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SubscribeAsync(RedisChannel channel, Action handler, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to subscribe to." + }, + { + "name": "handler", + "type": "Action", + "description": "The handler to invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task SubscribeAsync(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The redis channel to subscribe to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "A channel that represents this source." + } + } + ], + "php": [ + { + "signature": "psubscribe(...$pattern)", + "params": [ + { + "name": "$pattern", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], "redis_rb": [ { "signature": "psubscribe(*channels, &block)", @@ -91901,7 +98657,27 @@ }, "PSYNC": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "psync(replicationid: str, offset: int)", + "params": [ + { + "name": "replicationid", + "type": "str", + "description": "" + }, + { + "name": "offset", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "bytes", + "description": "" + } + } + ], "jedis": [], "go-redis": [], "node_redis": [], @@ -92218,13 +98994,133 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "publish(channel: RedisArgument, message: RedisArgument)", + "params": [ + { + "name": "channel", + "type": "RedisArgument", + "description": "" + }, + { + "name": "message", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Long publish(K channel, V message)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "the channel type: key." + }, + { + "name": "message", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "Long", + "description": "Long integer-reply the number of clients that received the message." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture publish(K channel, V message)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "the channel type: key." + }, + { + "name": "message", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Long integer-reply the number of clients that received the message." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono publish(K channel, V message)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "the channel type: key." + }, + { + "name": "message", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "Mono", + "description": "Long integer-reply the number of clients that received the message." + } + } + ], "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_sync": [ + { + "signature": "publish(channel: K, message: E)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "" + }, + { + "name": "message", + "type": "E", + "description": "" + } + ], + "returns": { + "type": "(usize)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "publish(channel: K, message: E)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "" + }, + { + "name": "message", + "type": "E", + "description": "" + } + ], + "returns": { + "type": "(usize)", + "description": "" + } + } + ], "redisvl": [], "nredisstack_sync": [ { @@ -92390,16 +99286,140 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "pubSubChannels(pattern?: RedisArgument)", + "params": [ + { + "name": "pattern", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List pubsubChannels()", + "params": [], + "returns": { + "type": "List", + "description": "List array-reply a list of active channels, optionally matching the specified pattern." + } + }, + { + "signature": "List pubsubChannels(K channel)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "List", + "description": "List array-reply a list of active channels, optionally matching the specified pattern." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> pubsubChannels()", + "params": [], + "returns": { + "type": "RedisFuture>", + "description": "List array-reply a list of active channels, optionally matching the specified pattern." + } + }, + { + "signature": "RedisFuture> pubsubChannels(K channel)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "List array-reply a list of active channels, optionally matching the specified pattern." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux pubsubChannels()", + "params": [], + "returns": { + "type": "Flux", + "description": "K array-reply a list of active channels, optionally matching the specified pattern." + } + }, + { + "signature": "Flux pubsubChannels(K channel)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "Flux", + "description": "K array-reply a list of active channels, optionally matching the specified pattern." + } + } + ], "ioredis": [], "redis_rs_sync": [], "redis_rs_async": [], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "RedisChannel[] SubscriptionChannels(RedisChannel pattern = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "pattern", + "type": "RedisChannel", + "description": "The channel name pattern to get channels for." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "RedisChannel[]", + "description": "a list of active channels, optionally matching the specified pattern." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SubscriptionChannelsAsync(RedisChannel pattern = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "pattern", + "type": "RedisChannel", + "description": "The channel name pattern to get channels for." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "a list of active channels, optionally matching the specified pattern." + } + } + ], "php": [ { "signature": "pubsub($subcommand, $argument)", @@ -92438,7 +99458,27 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "pubsub($subcommand, $argument)", + "params": [ + { + "name": "$subcommand", + "type": "mixed", + "description": "" + }, + { + "name": "$argument", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "mixed", + "description": "" + } + } + ] } }, "PUBSUB NUMPAT": { @@ -92485,16 +99525,82 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "pubSubNumPat()", + "params": [], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Long pubsubNumpat()", + "params": [], + "returns": { + "type": "Long", + "description": "Long integer-reply the number of patterns all the clients are subscribed to." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture pubsubNumpat()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "Long integer-reply the number of patterns all the clients are subscribed to." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono pubsubNumpat()", + "params": [], + "returns": { + "type": "Mono", + "description": "Long integer-reply the number of patterns all the clients are subscribed to." + } + } + ], "ioredis": [], "redis_rs_sync": [], "redis_rs_async": [], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "long SubscriptionPatternCount(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "long", + "description": "the number of patterns all the clients are subscribed to." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SubscriptionPatternCountAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "the number of patterns all the clients are subscribed to." + } + } + ], "php": [ { "signature": "pubsub($subcommand, $argument)", @@ -92578,16 +99684,116 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "pubSubNumSub(channels?: RedisVariadicArgument)", + "params": [ + { + "name": "channels", + "type": "RedisVariadicArgument", + "description": "" + } + ], + "returns": { + "type": "Record", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Map pubsubNumsub(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "channel keys." + } + ], + "returns": { + "type": "Map", + "description": "array-reply a list of channels and number of subscribers for every channel." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> pubsubNumsub(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "channel keys." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "array-reply a list of channels and number of subscribers for every channel." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> pubsubNumsub(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "channel keys." + } + ], + "returns": { + "type": "Mono>", + "description": "array-reply a list of channels and number of subscribers for every channel." + } + } + ], "ioredis": [], "redis_rs_sync": [], "redis_rs_async": [], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "long SubscriptionSubscriberCount(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to get a subscriber count for." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "long", + "description": "The number of subscribers on this server." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SubscriptionSubscriberCountAsync(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to get a subscriber count for." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The number of subscribers on this server." + } + } + ], "php": [ { "signature": "pubsub($subcommand, $argument)", @@ -92679,10 +99885,94 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "pubSubShardChannels(pattern?: RedisArgument)", + "params": [ + { + "name": "pattern", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List pubsubShardChannels()", + "params": [], + "returns": { + "type": "List", + "description": "List array-reply a list of active channels." + } + }, + { + "signature": "List pubsubShardChannels(K pattern)", + "params": [ + { + "name": "pattern", + "type": "K", + "description": "the pattern type: patternkey (pattern)." + } + ], + "returns": { + "type": "List", + "description": "List array-reply a list of active channels, optionally matching the specified pattern." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> pubsubShardChannels()", + "params": [], + "returns": { + "type": "RedisFuture>", + "description": "List array-reply a list of active channels." + } + }, + { + "signature": "RedisFuture> pubsubShardChannels(K pattern)", + "params": [ + { + "name": "pattern", + "type": "K", + "description": "the pattern type: patternkey (pattern)." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "List array-reply a list of active channels, optionally matching the specified pattern." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux pubsubShardChannels()", + "params": [], + "returns": { + "type": "Flux", + "description": "K array-reply a list of active channels." + } + }, + { + "signature": "Flux pubsubShardChannels(K pattern)", + "params": [ + { + "name": "pattern", + "type": "K", + "description": "the pattern type: patternkey (pattern)." + } + ], + "returns": { + "type": "Flux", + "description": "K array-reply a list of active channels, optionally matching the specified pattern." + } + } + ], "ioredis": [], "redis_rs_sync": [], "redis_rs_async": [], @@ -92772,10 +100062,70 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "pubSubShardNumSub(channels?: RedisVariadicArgument)", + "params": [ + { + "name": "channels", + "type": "RedisVariadicArgument", + "description": "" + } + ], + "returns": { + "type": "Record", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Map pubsubShardNumsub(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "channel keys." + } + ], + "returns": { + "type": "Map", + "description": "array-reply a list of channels and number of subscribers for every channel." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> pubsubShardNumsub(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "channel keys." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "array-reply a list of channels and number of subscribers for every channel." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> pubsubShardNumsub(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "channel keys." + } + ], + "returns": { + "type": "Mono>", + "description": "array-reply a list of channels and number of subscribers for every channel." + } + } + ], "ioredis": [], "redis_rs_sync": [], "redis_rs_async": [], @@ -92807,20 +100157,285 @@ }, "PUNSUBSCRIBE": { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "redis_py": [ + { + "signature": "punsubscribe(*args)", + "params": [ + { + "name": "*args", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "None", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "void punsubscribe()", + "params": [], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void punsubscribe(byte[]... patterns)", + "params": [ + { + "name": "patterns", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void punsubscribe(String... patterns)", + "params": [ + { + "name": "patterns", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "(*PubSub).PUnsubscribe(ctx context.Context, patterns ...string) error", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "patterns", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "error", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "pUnsubscribe(patterns?: string | Array, listener?: PubSubListener, bufferMode?: T)", + "params": [ + { + "name": "patterns", + "type": "string | Array", + "description": "" + }, + { + "name": "listener", + "type": "PubSubListener", + "description": "" + }, + { + "name": "bufferMode", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "void punsubscribe(K... patterns)", + "params": [ + { + "name": "patterns", + "type": "K...", + "description": "the patterns" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture punsubscribe(K... patterns)", + "params": [ + { + "name": "patterns", + "type": "K...", + "description": "the patterns" + } + ], + "returns": { + "type": "RedisFuture", + "description": "RedisFuture Future to synchronize punsubscribe completion" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono punsubscribe(K... patterns)", + "params": [ + { + "name": "patterns", + "type": "K...", + "description": "the patterns." + } + ], + "returns": { + "type": "Mono", + "description": "Mono Mono for punsubscribe command." + } + } + ], "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_sync": [ + { + "signature": "punsubscribe(pchannel: T)", + "params": [ + { + "name": "pchannel", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "punsubscribe(channel_pattern: impl ToRedisArgs)", + "params": [ + { + "name": "channel_pattern", + "type": "impl ToRedisArgs", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], + "nredisstack_sync": [ + { + "signature": "void Unsubscribe(RedisChannel channel, Action? handler = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel that was subscribed to." + }, + { + "name": "handler", + "type": "Action?", + "description": "The handler to no longer invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void UnsubscribeAll(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task UnsubscribeAsync(RedisChannel channel, Action? handler = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel that was subscribed to." + }, + { + "name": "handler", + "type": "Action?", + "description": "The handler to no longer invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task UnsubscribeAllAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], + "php": [ + { + "signature": "punsubscribe(...$pattern)", + "params": [ + { + "name": "$pattern", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], "redis_rb": [ { "signature": "punsubscribe(*channels)", @@ -92868,13 +100483,58 @@ } ], "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "quit()", + "params": [], + "returns": { + "type": "string", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "String quit()", + "params": [], + "returns": { + "type": "String", + "description": "String simple-string-reply always OK." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture quit()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply always OK." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono quit()", + "params": [], + "returns": { + "type": "Mono", + "description": "String simple-string-reply always OK." + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], + "php": [ + { + "signature": "quit()", + "params": [], + "returns": { + "type": "void", + "description": "" + } + } + ], "redis_rs_sync": [], "redis_rs_async": [] } @@ -93860,7 +101520,27 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "replicaOf(host: string, port: number)", + "params": [ + { + "name": "host", + "type": "string", + "description": "" + }, + { + "name": "port", + "type": "number", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String replicaof(String host, int port)", @@ -93949,7 +101629,27 @@ } ], "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_async": [ + { + "signature": "Task ReplicaOfAsync(EndPoint master, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "master", + "type": "EndPoint", + "description": "Endpoint of the new primary to replicate from." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "replicaof(string $host, int $port)", @@ -93993,9 +101693,27 @@ } } ], - "jedis": [], + "jedis": [ + { + "signature": "String reset()", + "params": [], + "returns": { + "type": "String", + "description": "" + } + } + ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "reset()", + "params": [], + "returns": { + "type": "void", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], @@ -94011,7 +101729,16 @@ "redis_py": [], "jedis": [], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "restoreAsking()", + "params": [], + "returns": { + "type": "SimpleStringReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], @@ -94686,8 +102413,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "Role Role(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Role", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task RoleAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "role()", @@ -97006,8 +104763,48 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void Save(SaveType type, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "type", + "type": "SaveType", + "description": "The method of the save (e.g. background or foreground)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SaveAsync(SaveType type, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "type", + "type": "SaveType", + "description": "The method of the save (e.g. background or foreground)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "save()", @@ -98002,8 +105799,86 @@ "redis_rs_sync": [], "redis_rs_async": [], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "bool ScriptExists(string script, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "script", + "type": "string", + "description": "The text of the script to check for on the server." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "bool", + "description": "" + } + }, + { + "signature": "bool ScriptExists(byte[] sha1, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "sha1", + "type": "byte[]", + "description": "The SHA1 of the script to check for on the server." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ScriptExistsAsync(string script, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "script", + "type": "string", + "description": "The text of the script to check for on the server." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task ScriptExistsAsync(byte[] sha1, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "sha1", + "type": "byte[]", + "description": "The SHA1 of the script to check for on the server." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "script($subcommand, $argument = null)", @@ -98177,8 +106052,38 @@ "redis_rs_sync": [], "redis_rs_async": [], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void ScriptFlush(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ScriptFlushAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "script($subcommand, $argument = null)", @@ -98217,7 +106122,27 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "script($subcommand, $argument = null)", + "params": [ + { + "name": "$subcommand", + "type": "mixed", + "description": "" + }, + { + "name": "$argument", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "mixed", + "description": "" + } + } + ] } }, "SCRIPT KILL": { @@ -98489,11 +106414,119 @@ } ], "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_sync": [ + { + "signature": "load_script(script: &'a crate::Script)", + "params": [ + { + "name": "script", + "type": "&'a crate::Script", + "description": "" + } + ], + "returns": { + "type": "Generic", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "load_script(script: &'a crate::Script)", + "params": [ + { + "name": "script", + "type": "&'a crate::Script", + "description": "" + } + ], + "returns": { + "type": "Generic", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "byte[] ScriptLoad(string script, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "script", + "type": "string", + "description": "The script to load." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "byte[]", + "description": "The SHA1 of the loaded script." + } + }, + { + "signature": "LoadedLuaScript ScriptLoad(LuaScript script, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "script", + "type": "LuaScript", + "description": "The script to load." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "LoadedLuaScript", + "description": "The loaded script, ready for rapid reuse based on the SHA1." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ScriptLoadAsync(string script, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "script", + "type": "string", + "description": "The script to load." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The SHA1 of the loaded script." + } + }, + { + "signature": "Task ScriptLoadAsync(LuaScript script, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "script", + "type": "LuaScript", + "description": "The script to load." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The loaded script, ready for rapid reuse based on the SHA1." + } + } + ], "php": [ { "signature": "script($subcommand, $argument = null)", @@ -99653,10 +107686,70 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "select(db: number)", + "params": [ + { + "name": "db", + "type": "number", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "String select(int db)", + "params": [ + { + "name": "db", + "type": "int", + "description": "the database number" + } + ], + "returns": { + "type": "String", + "description": "String simple-string-reply" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture select(int db)", + "params": [ + { + "name": "db", + "type": "int", + "description": "the database number" + } + ], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono select(int db)", + "params": [ + { + "name": "db", + "type": "int", + "description": "the database number" + } + ], + "returns": { + "type": "Mono", + "description": "String simple-string-reply" + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], "php": [ @@ -102739,7 +110832,27 @@ } } ], - "nredisstack_sync": [], + "nredisstack_sync": [ + { + "signature": "void Shutdown(ShutdownMode shutdownMode = ShutdownMode.Default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "shutdownMode", + "type": "ShutdownMode", + "description": "The mode of the shutdown." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], "nredisstack_async": [], "php": [ { @@ -105129,8 +113242,48 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "CommandTrace[] SlowlogGet(int count = 0, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "count", + "type": "int", + "description": "The count of items to get." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "CommandTrace[]", + "description": "The slow command traces as recorded by the Redis server." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SlowlogGetAsync(int count = 0, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "count", + "type": "int", + "description": "The count of items to get." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The slow command traces as recorded by the Redis server." + } + } + ], "php": [ { "signature": "slowlog(string $operation, ?int $length = null)", @@ -105369,8 +113522,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void SlowlogReset(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SlowlogResetAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "slowlog(string $operation, ?int $length = null)", @@ -108387,7 +116570,46 @@ } } ], - "jedis": [], + "jedis": [ + { + "signature": "long spublish(byte[] channel, byte[] message)", + "params": [ + { + "name": "channel", + "type": "byte[]", + "description": "" + }, + { + "name": "message", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long spublish(String channel, String message)", + "params": [ + { + "name": "channel", + "type": "String", + "description": "" + }, + { + "name": "message", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ], "go-redis": [ { "signature": "SPublish(ctx context.Context, channel string, message interface{})", @@ -108414,16 +116636,186 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "sPublish(channel: RedisArgument, message: RedisArgument)", + "params": [ + { + "name": "channel", + "type": "RedisArgument", + "description": "" + }, + { + "name": "message", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Long spublish(K shardChannel, V message)", + "params": [ + { + "name": "shardChannel", + "type": "K", + "description": "the shard channel type: key." + }, + { + "name": "message", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "Long", + "description": "Long integer-reply the number of clients that received the message." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture spublish(K shardChannel, V message)", + "params": [ + { + "name": "shardChannel", + "type": "K", + "description": "the shard channel type: key." + }, + { + "name": "message", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Long integer-reply the number of clients that received the message." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono spublish(K shardChannel, V message)", + "params": [ + { + "name": "shardChannel", + "type": "K", + "description": "the shard channel type: key." + }, + { + "name": "message", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "Mono", + "description": "Long integer-reply the number of clients that received the message." + } + } + ], "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_sync": [ + { + "signature": "spublish(channel: K, message: E)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "" + }, + { + "name": "message", + "type": "E", + "description": "" + } + ], + "returns": { + "type": "(usize)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "spublish(channel: K, message: E)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "" + }, + { + "name": "message", + "type": "E", + "description": "" + } + ], + "returns": { + "type": "(usize)", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "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*, note that this doesn't mean much in a cluster as clients can get the message through other nodes." + } + } + ], + "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 publish." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The number of clients that received the message *on the destination server*, note that this doesn't mean much in a cluster as clients can get the message through other nodes." + } + } + ], "php": [ { "signature": "spublish(string $shardChannel, string $message)", @@ -110149,19 +118541,295 @@ }, "SSUBSCRIBE": { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "redis_py": [ + { + "signature": "ssubscribe(*args: ChannelT | Subscription, target_node: Any = None, **kwargs: PubSubHandler)", + "params": [ + { + "name": "*args", + "type": "ChannelT | Subscription", + "description": "" + }, + { + "name": "target_node", + "type": "Any = None", + "description": "" + }, + { + "name": "**kwargs", + "type": "PubSubHandler", + "description": "" + } + ], + "returns": { + "type": "None", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "void ssubscribe(BinaryJedisShardedPubSub jedisPubSub, byte[]... channels)", + "params": [ + { + "name": "jedisPubSub", + "type": "BinaryJedisShardedPubSub", + "description": "" + }, + { + "name": "channels", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void ssubscribe(JedisShardedPubSub jedisPubSub, String... channels)", + "params": [ + { + "name": "jedisPubSub", + "type": "JedisShardedPubSub", + "description": "" + }, + { + "name": "channels", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "(*Client).SSubscribe(ctx context.Context, channels ...string) *PubSub", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "channels", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*PubSub", + "description": "" + } + }, + { + "signature": "(*PubSub).SSubscribe(ctx context.Context, channels ...string) error", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "channels", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "error", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "sSubscribe(channels: string | Array, listener: PubSubListener, bufferMode?: T)", + "params": [ + { + "name": "channels", + "type": "string | Array", + "description": "" + }, + { + "name": "listener", + "type": "PubSubListener", + "description": "" + }, + { + "name": "bufferMode", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "void ssubscribe(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "the channels" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ssubscribe(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "the shard channels" + } + ], + "returns": { + "type": "RedisFuture", + "description": "RedisFuture Future to synchronize subscribe completion" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ssubscribe(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "the channels." + } + ], + "returns": { + "type": "Mono", + "description": "Mono Mono for subscribe command." + } + } + ], "ioredis": [], "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_async": [ + { + "signature": "ssubscribe(channel_name: impl ToRedisArgs)", + "params": [ + { + "name": "channel_name", + "type": "impl ToRedisArgs", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void Subscribe(RedisChannel channel, Action handler, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to subscribe to." + }, + { + "name": "handler", + "type": "Action", + "description": "The handler to invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "ChannelMessageQueue Subscribe(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The redis channel to subscribe to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "ChannelMessageQueue", + "description": "A channel that represents this source." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SubscribeAsync(RedisChannel channel, Action handler, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to subscribe to." + }, + { + "name": "handler", + "type": "Action", + "description": "The handler to invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task SubscribeAsync(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The redis channel to subscribe to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "A channel that represents this source." + } + } + ], "php": [ { "signature": "ssubscribe(string ...$shardChannels)", @@ -110599,7 +119267,27 @@ }, "SUBSCRIBE": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "subscribe(*args: ChannelT | Subscription, **kwargs: PubSubHandler)", + "params": [ + { + "name": "*args", + "type": "ChannelT | Subscription", + "description": "" + }, + { + "name": "**kwargs", + "type": "PubSubHandler", + "description": "" + } + ], + "returns": { + "type": "None", + "description": "" + } + } + ], "jedis": [ { "signature": "void subscribe(BinaryJedisPubSub jedisPubSub, final byte[]... channels)", @@ -110640,18 +119328,279 @@ } } ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "go-redis": [ + { + "signature": "(*Client).Subscribe(ctx context.Context, channels ...string) *PubSub", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "channels", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*PubSub", + "description": "" + } + }, + { + "signature": "(*PubSub).Subscribe(ctx context.Context, channels ...string) error", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "channels", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "error", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "subscribe(channels: string | Array, listener: PubSubListener, bufferMode?: T)", + "params": [ + { + "name": "channels", + "type": "string | Array", + "description": "" + }, + { + "name": "listener", + "type": "PubSubListener", + "description": "" + }, + { + "name": "bufferMode", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "void subscribe(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "the channels" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture subscribe(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "the channels" + } + ], + "returns": { + "type": "RedisFuture", + "description": "RedisFuture Future to synchronize subscribe completion" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono subscribe(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "the channels." + } + ], + "returns": { + "type": "Mono", + "description": "Mono Mono for subscribe command." + } + } + ], "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_sync": [ + { + "signature": "subscribe(channel: T)", + "params": [ + { + "name": "channel", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + }, + { + "signature": "subscribe(channel: C, func: F)", + "params": [ + { + "name": "channel", + "type": "C", + "description": "" + }, + { + "name": "func", + "type": "F", + "description": "" + } + ], + "returns": { + "type": "RedisResult", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "subscribe(channel_name: impl ToRedisArgs)", + "params": [ + { + "name": "channel_name", + "type": "impl ToRedisArgs", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], + "nredisstack_sync": [ + { + "signature": "void Subscribe(RedisChannel channel, Action handler, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to subscribe to." + }, + { + "name": "handler", + "type": "Action", + "description": "The handler to invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "ChannelMessageQueue Subscribe(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The redis channel to subscribe to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "ChannelMessageQueue", + "description": "A channel that represents this source." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SubscribeAsync(RedisChannel channel, Action handler, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to subscribe to." + }, + { + "name": "handler", + "type": "Action", + "description": "The handler to invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task SubscribeAsync(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The redis channel to subscribe to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "A channel that represents this source." + } + } + ], + "php": [ + { + "signature": "subscribe(string ...$channels)", + "params": [ + { + "name": "$channels", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], "redis_rb": [ { "signature": "subscribe(*channels, &block)", @@ -112177,19 +121126,231 @@ }, "SUNSUBSCRIBE": { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "redis_py": [ + { + "signature": "sunsubscribe(*args, target_node=None)", + "params": [ + { + "name": "*args", + "type": "Any", + "description": "" + }, + { + "name": "target_node", + "type": "Any = None", + "description": "" + } + ], + "returns": { + "type": "None", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "void sunsubscribe()", + "params": [], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void sunsubscribe(byte[]... channels)", + "params": [ + { + "name": "channels", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void sunsubscribe(String... channels)", + "params": [ + { + "name": "channels", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "(*PubSub).SUnsubscribe(ctx context.Context, channels ...string) error", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "channels", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "error", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "sUnsubscribe(channels?: string | Array, listener?: PubSubListener, bufferMode?: T)", + "params": [ + { + "name": "channels", + "type": "string | Array", + "description": "" + }, + { + "name": "listener", + "type": "PubSubListener", + "description": "" + }, + { + "name": "bufferMode", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "void sunsubscribe(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "the channels" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture sunsubscribe(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "the shard channels" + } + ], + "returns": { + "type": "RedisFuture", + "description": "RedisFuture Future to synchronize unsubscribe completion." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono sunsubscribe(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "the channels." + } + ], + "returns": { + "type": "Mono", + "description": "Mono Mono for unsubscribe command." + } + } + ], "ioredis": [], "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_async": [ + { + "signature": "sunsubscribe(channel_name: impl ToRedisArgs)", + "params": [ + { + "name": "channel_name", + "type": "impl ToRedisArgs", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void Unsubscribe(RedisChannel channel, Action? handler = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel that was subscribed to." + }, + { + "name": "handler", + "type": "Action?", + "description": "The handler to no longer invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task UnsubscribeAsync(RedisChannel channel, Action? handler = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel that was subscribed to." + }, + { + "name": "handler", + "type": "Action?", + "description": "The handler to no longer invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "sunsubscribe(?string ...$shardChannels = null)", @@ -112299,7 +121460,27 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "swapDb(index1: number, index2: number)", + "params": [ + { + "name": "index1", + "type": "number", + "description": "" + }, + { + "name": "index2", + "type": "number", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String swapdb(int db1, int db2)", @@ -112363,8 +121544,58 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void SwapDatabases(int first, int second, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "first", + "type": "int", + "description": "The ID of the first database." + }, + { + "name": "second", + "type": "int", + "description": "The ID of the second database." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SwapDatabasesAsync(int first, int second, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "first", + "type": "int", + "description": "The ID of the first database." + }, + { + "name": "second", + "type": "int", + "description": "The ID of the second database." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "swapdb(int $db1, int $db2)", @@ -112392,7 +121623,16 @@ }, "SYNC": { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "sync()", + "params": [], + "returns": { + "type": "bytes", + "description": "" + } + } + ], "jedis": [], "go-redis": [], "node_redis": [], @@ -114503,8 +123743,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "DateTime Time(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "DateTime", + "description": "The server's current time." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task TimeAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The server's current time." + } + } + ], "php": [ { "signature": "time()", @@ -121324,20 +130594,285 @@ }, "UNSUBSCRIBE": { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "redis_py": [ + { + "signature": "unsubscribe(*args)", + "params": [ + { + "name": "*args", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "None", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "void unsubscribe()", + "params": [], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void unsubscribe(byte[]... channels)", + "params": [ + { + "name": "channels", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void unsubscribe(String... channels)", + "params": [ + { + "name": "channels", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "(*PubSub).Unsubscribe(ctx context.Context, channels ...string) error", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "channels", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "error", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "unsubscribe(channels?: string | Array, listener?: PubSubListener, bufferMode?: T)", + "params": [ + { + "name": "channels", + "type": "string | Array", + "description": "" + }, + { + "name": "listener", + "type": "PubSubListener", + "description": "" + }, + { + "name": "bufferMode", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "void unsubscribe(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "the channels" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture unsubscribe(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "the channels" + } + ], + "returns": { + "type": "RedisFuture", + "description": "RedisFuture Future to synchronize unsubscribe completion." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono unsubscribe(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "the channels." + } + ], + "returns": { + "type": "Mono", + "description": "Mono Mono for unsubscribe command." + } + } + ], "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_sync": [ + { + "signature": "unsubscribe(channel: T)", + "params": [ + { + "name": "channel", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "unsubscribe(channel_name: impl ToRedisArgs)", + "params": [ + { + "name": "channel_name", + "type": "impl ToRedisArgs", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], + "nredisstack_sync": [ + { + "signature": "void Unsubscribe(RedisChannel channel, Action? handler = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel that was subscribed to." + }, + { + "name": "handler", + "type": "Action?", + "description": "The handler to no longer invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void UnsubscribeAll(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task UnsubscribeAsync(RedisChannel channel, Action? handler = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel that was subscribed to." + }, + { + "name": "handler", + "type": "Action?", + "description": "The handler to no longer invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task UnsubscribeAllAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], + "php": [ + { + "signature": "unsubscribe(string ...$channels)", + "params": [ + { + "name": "$channels", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], "redis_rb": [ { "signature": "unsubscribe(*channels)", diff --git a/data/command-api-mapping/ACL CAT.json b/data/command-api-mapping/ACL CAT.json index a5ee9b3526..b88e91e04d 100644 --- a/data/command-api-mapping/ACL CAT.json +++ b/data/command-api-mapping/ACL CAT.json @@ -177,7 +177,53 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_cat()", + "params": [], + "returns": { + "type": "(HashSet)", + "description": "" + } + }, + { + "signature": "acl_cat_categoryname(categoryname: K)", + "params": [ + { + "name": "categoryname", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(HashSet)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_cat()", + "params": [], + "returns": { + "type": "(HashSet)", + "description": "" + } + }, + { + "signature": "acl_cat_categoryname(categoryname: K)", + "params": [ + { + "name": "categoryname", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(HashSet)", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/ACL DELUSER.json b/data/command-api-mapping/ACL DELUSER.json index 5a184694f1..67b26814c8 100644 --- a/data/command-api-mapping/ACL DELUSER.json +++ b/data/command-api-mapping/ACL DELUSER.json @@ -206,7 +206,37 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_deluser(usernames: &'a [K])", + "params": [ + { + "name": "usernames", + "type": "&'a [K]", + "description": "" + } + ], + "returns": { + "type": "(usize)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_deluser(usernames: &'a [K])", + "params": [ + { + "name": "usernames", + "type": "&'a [K]", + "description": "" + } + ], + "returns": { + "type": "(usize)", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/ACL DRYRUN.json b/data/command-api-mapping/ACL DRYRUN.json index 4365bd4faa..f1fc7a2150 100644 --- a/data/command-api-mapping/ACL DRYRUN.json +++ b/data/command-api-mapping/ACL DRYRUN.json @@ -47,11 +47,188 @@ } } ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "go-redis": [ + { + "signature": "ACLDryRun(ctx context.Context, username string, command ...interface{}) *StringCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "username", + "type": "string", + "description": "" + }, + { + "name": "command", + "type": "...interface{}", + "description": "" + } + ], + "returns": { + "type": "*StringCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "aclDryRun(username: RedisArgument, command: Array)", + "params": [ + { + "name": "username", + "type": "RedisArgument", + "description": "" + }, + { + "name": "command", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'> | BlobStringReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "String aclDryRun(String username, String command, String... args)", + "params": [ + { + "name": "username", + "type": "String", + "description": "the specified username" + }, + { + "name": "command", + "type": "String", + "description": "the specified command" + }, + { + "name": "args", + "type": "String...", + "description": "the specified args of command" + } + ], + "returns": { + "type": "String", + "description": "String reply: OK on success." + } + }, + { + "signature": "String aclDryRun(String username, RedisCommand command)", + "params": [ + { + "name": "username", + "type": "String", + "description": "the specified username" + }, + { + "name": "command", + "type": "RedisCommand", + "description": "the specified command to inspect" + } + ], + "returns": { + "type": "String", + "description": "String reply: OK on success." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture aclDryRun(String username, String command, String... args)", + "params": [ + { + "name": "username", + "type": "String", + "description": "the specified username" + }, + { + "name": "command", + "type": "String", + "description": "the specified command" + }, + { + "name": "args", + "type": "String...", + "description": "the specified args of command" + } + ], + "returns": { + "type": "RedisFuture", + "description": "String reply: OK on success." + } + }, + { + "signature": "RedisFuture aclDryRun(String username, RedisCommand command)", + "params": [ + { + "name": "username", + "type": "String", + "description": "the specified username" + }, + { + "name": "command", + "type": "RedisCommand", + "description": "the specified command to inspect" + } + ], + "returns": { + "type": "RedisFuture", + "description": "String reply: OK on success." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono aclDryRun(String username, String command, String... args)", + "params": [ + { + "name": "username", + "type": "String", + "description": "the specified username" + }, + { + "name": "command", + "type": "String", + "description": "the specified command" + }, + { + "name": "args", + "type": "String...", + "description": "the specified args of command" + } + ], + "returns": { + "type": "Mono", + "description": "String reply: OK on success." + } + }, + { + "signature": "Mono aclDryRun(String username, RedisCommand command)", + "params": [ + { + "name": "username", + "type": "String", + "description": "the specified username" + }, + { + "name": "command", + "type": "RedisCommand", + "description": "the specified command to inspect" + } + ], + "returns": { + "type": "Mono", + "description": "String reply: OK on success." + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], "php": [ @@ -75,7 +252,57 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_dryrun(username: K, command: C, args: A)", + "params": [ + { + "name": "username", + "type": "K", + "description": "" + }, + { + "name": "command", + "type": "C", + "description": "" + }, + { + "name": "args", + "type": "A", + "description": "" + } + ], + "returns": { + "type": "(String)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_dryrun(username: K, command: C, args: A)", + "params": [ + { + "name": "username", + "type": "K", + "description": "" + }, + { + "name": "command", + "type": "C", + "description": "" + }, + { + "name": "args", + "type": "A", + "description": "" + } + ], + "returns": { + "type": "(String)", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/ACL GENPASS.json b/data/command-api-mapping/ACL GENPASS.json index 2b23df8fba..283be26bdf 100644 --- a/data/command-api-mapping/ACL GENPASS.json +++ b/data/command-api-mapping/ACL GENPASS.json @@ -177,7 +177,53 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_genpass()", + "params": [], + "returns": { + "type": "(String)", + "description": "" + } + }, + { + "signature": "acl_genpass_bits(bits: isize)", + "params": [ + { + "name": "bits", + "type": "isize", + "description": "" + } + ], + "returns": { + "type": "(String)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_genpass()", + "params": [], + "returns": { + "type": "(String)", + "description": "" + } + }, + { + "signature": "acl_genpass_bits(bits: isize)", + "params": [ + { + "name": "bits", + "type": "isize", + "description": "" + } + ], + "returns": { + "type": "(String)", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/ACL GETUSER.json b/data/command-api-mapping/ACL GETUSER.json index f1c54ca270..b0bc67009d 100644 --- a/data/command-api-mapping/ACL GETUSER.json +++ b/data/command-api-mapping/ACL GETUSER.json @@ -145,7 +145,37 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_getuser(username: K)", + "params": [ + { + "name": "username", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(Option)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_getuser(username: K)", + "params": [ + { + "name": "username", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(Option)", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/ACL HELP.json b/data/command-api-mapping/ACL HELP.json index 9d958e542e..d652300074 100644 --- a/data/command-api-mapping/ACL HELP.json +++ b/data/command-api-mapping/ACL HELP.json @@ -1,6 +1,21 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "acl_help(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "list[bytes | str]", + "description": "" + } + } + ], "jedis": [], "go-redis": [], "node_redis": [], @@ -30,7 +45,25 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_help()", + "params": [], + "returns": { + "type": "(Vec)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_help()", + "params": [], + "returns": { + "type": "(Vec)", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/ACL LIST.json b/data/command-api-mapping/ACL LIST.json index 24fcd2f517..edd3f35d3a 100644 --- a/data/command-api-mapping/ACL LIST.json +++ b/data/command-api-mapping/ACL LIST.json @@ -105,7 +105,25 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_list()", + "params": [], + "returns": { + "type": "(Vec)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_list()", + "params": [], + "returns": { + "type": "(Vec)", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/ACL LOAD.json b/data/command-api-mapping/ACL LOAD.json index 9969c3fb8b..64a64a50ef 100644 --- a/data/command-api-mapping/ACL LOAD.json +++ b/data/command-api-mapping/ACL LOAD.json @@ -105,7 +105,25 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_load()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_load()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/ACL LOG.json b/data/command-api-mapping/ACL LOG.json index 762d319f10..f8d3854ad2 100644 --- a/data/command-api-mapping/ACL LOG.json +++ b/data/command-api-mapping/ACL LOG.json @@ -82,9 +82,78 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "List> aclLog()", + "params": [], + "returns": { + "type": "List>", + "description": "List> list of security events." + } + }, + { + "signature": "List> aclLog(int count)", + "params": [ + { + "name": "count", + "type": "int", + "description": "max count of events" + } + ], + "returns": { + "type": "List>", + "description": "List> list of security events." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture>> aclLog()", + "params": [], + "returns": { + "type": "RedisFuture>>", + "description": "List> list of security events." + } + }, + { + "signature": "RedisFuture>> aclLog(int count)", + "params": [ + { + "name": "count", + "type": "int", + "description": "max count of events" + } + ], + "returns": { + "type": "RedisFuture>>", + "description": "List> list of security events." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux> aclLog()", + "params": [], + "returns": { + "type": "Flux>", + "description": "Map list of security events." + } + }, + { + "signature": "Flux> aclLog(int count)", + "params": [ + { + "name": "count", + "type": "int", + "description": "max count of events" + } + ], + "returns": { + "type": "Flux>", + "description": "Map list of security events." + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], "php": [ @@ -108,7 +177,53 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_log(count: isize)", + "params": [ + { + "name": "count", + "type": "isize", + "description": "" + } + ], + "returns": { + "type": "(Vec)", + "description": "" + } + }, + { + "signature": "acl_log_reset()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_log(count: isize)", + "params": [ + { + "name": "count", + "type": "isize", + "description": "" + } + ], + "returns": { + "type": "(Vec)", + "description": "" + } + }, + { + "signature": "acl_log_reset()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/ACL SAVE.json b/data/command-api-mapping/ACL SAVE.json index 255be787ed..14cc10091f 100644 --- a/data/command-api-mapping/ACL SAVE.json +++ b/data/command-api-mapping/ACL SAVE.json @@ -105,7 +105,25 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_save()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_save()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/ACL SETUSER.json b/data/command-api-mapping/ACL SETUSER.json index a1d87e2549..fb6775db1c 100644 --- a/data/command-api-mapping/ACL SETUSER.json +++ b/data/command-api-mapping/ACL SETUSER.json @@ -240,7 +240,75 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_setuser(username: K)", + "params": [ + { + "name": "username", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "()", + "description": "" + } + }, + { + "signature": "acl_setuser_rules(username: K, rules: &'a [acl::Rule])", + "params": [ + { + "name": "username", + "type": "K", + "description": "" + }, + { + "name": "rules", + "type": "&'a [acl::Rule]", + "description": "" + } + ], + "returns": { + "type": "()", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_setuser(username: K)", + "params": [ + { + "name": "username", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "()", + "description": "" + } + }, + { + "signature": "acl_setuser_rules(username: K, rules: &'a [acl::Rule])", + "params": [ + { + "name": "username", + "type": "K", + "description": "" + }, + { + "name": "rules", + "type": "&'a [acl::Rule]", + "description": "" + } + ], + "returns": { + "type": "()", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/ACL USERS.json b/data/command-api-mapping/ACL USERS.json index 1904ccf1f3..29d09c02e4 100644 --- a/data/command-api-mapping/ACL USERS.json +++ b/data/command-api-mapping/ACL USERS.json @@ -105,7 +105,25 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_users()", + "params": [], + "returns": { + "type": "(Vec)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_users()", + "params": [], + "returns": { + "type": "(Vec)", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/ACL WHOAMI.json b/data/command-api-mapping/ACL WHOAMI.json index 32d0001e4f..44cced349a 100644 --- a/data/command-api-mapping/ACL WHOAMI.json +++ b/data/command-api-mapping/ACL WHOAMI.json @@ -105,7 +105,25 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "acl_whoami()", + "params": [], + "returns": { + "type": "(String)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "acl_whoami()", + "params": [], + "returns": { + "type": "(String)", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/BGREWRITEAOF.json b/data/command-api-mapping/BGREWRITEAOF.json index e8cff09a24..9c363fc1b3 100644 --- a/data/command-api-mapping/BGREWRITEAOF.json +++ b/data/command-api-mapping/BGREWRITEAOF.json @@ -82,8 +82,48 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void Save(SaveType type, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "type", + "type": "SaveType", + "description": "The method of the save (e.g. background or foreground)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SaveAsync(SaveType type, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "type", + "type": "SaveType", + "description": "The method of the save (e.g. background or foreground)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "bgrewriteaof()", diff --git a/data/command-api-mapping/BGSAVE.json b/data/command-api-mapping/BGSAVE.json index 0789579fb4..c7f81b5138 100644 --- a/data/command-api-mapping/BGSAVE.json +++ b/data/command-api-mapping/BGSAVE.json @@ -101,8 +101,48 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void Save(SaveType type, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "type", + "type": "SaveType", + "description": "The method of the save (e.g. background or foreground)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SaveAsync(SaveType type, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "type", + "type": "SaveType", + "description": "The method of the save (e.g. background or foreground)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "bgsave()", diff --git a/data/command-api-mapping/CLIENT CACHING.json b/data/command-api-mapping/CLIENT CACHING.json index 9390aadfd0..acbc4d7d6d 100644 --- a/data/command-api-mapping/CLIENT CACHING.json +++ b/data/command-api-mapping/CLIENT CACHING.json @@ -38,7 +38,22 @@ } ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clientCaching(value: boolean)", + "params": [ + { + "name": "value", + "type": "boolean", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clientCaching(boolean enabled)", diff --git a/data/command-api-mapping/CLIENT GETNAME.json b/data/command-api-mapping/CLIENT GETNAME.json index 6d26193d1f..fe18ecaca5 100644 --- a/data/command-api-mapping/CLIENT GETNAME.json +++ b/data/command-api-mapping/CLIENT GETNAME.json @@ -105,7 +105,25 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "client_getname()", + "params": [], + "returns": { + "type": "(Option)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "client_getname()", + "params": [], + "returns": { + "type": "(Option)", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/CLIENT GETREDIR.json b/data/command-api-mapping/CLIENT GETREDIR.json index 388c054648..062711eba9 100644 --- a/data/command-api-mapping/CLIENT GETREDIR.json +++ b/data/command-api-mapping/CLIENT GETREDIR.json @@ -27,7 +27,16 @@ } ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clientGetRedir()", + "params": [], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "Long clientGetredir()", diff --git a/data/command-api-mapping/CLIENT ID.json b/data/command-api-mapping/CLIENT ID.json index f3e66fd396..0af5b80d4f 100644 --- a/data/command-api-mapping/CLIENT ID.json +++ b/data/command-api-mapping/CLIENT ID.json @@ -42,7 +42,16 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clientId()", + "params": [], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "Long clientId()", @@ -96,7 +105,25 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "client_id()", + "params": [], + "returns": { + "type": "(isize)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "client_id()", + "params": [], + "returns": { + "type": "(isize)", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/CLIENT KILL.json b/data/command-api-mapping/CLIENT KILL.json index 542d84ae24..4da60a9724 100644 --- a/data/command-api-mapping/CLIENT KILL.json +++ b/data/command-api-mapping/CLIENT KILL.json @@ -241,8 +241,154 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void ClientKill(EndPoint endpoint, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "endpoint", + "type": "EndPoint", + "description": "The endpoint of the client to kill." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "long ClientKill(long? id = null, ClientType? clientType = null, EndPoint? endpoint = null, bool skipMe = true, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "id", + "type": "long?", + "description": "The ID of the client to kill." + }, + { + "name": "clientType", + "type": "ClientType?", + "description": "The type of client." + }, + { + "name": "endpoint", + "type": "EndPoint?", + "description": "The endpoint to kill." + }, + { + "name": "skipMe", + "type": "bool", + "description": "Whether to skip the current connection." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "long", + "description": "the number of clients killed." + } + }, + { + "signature": "long ClientKill(ClientKillFilter filter, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "filter", + "type": "ClientKillFilter", + "description": "The filter to use in choosing which clients to kill." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "long", + "description": "the number of clients killed." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ClientKillAsync(EndPoint endpoint, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "endpoint", + "type": "EndPoint", + "description": "The endpoint of the client to kill." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task ClientKillAsync(long? id = null, ClientType? clientType = null, EndPoint? endpoint = null, bool skipMe = true, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "id", + "type": "long?", + "description": "The ID of the client to kill." + }, + { + "name": "clientType", + "type": "ClientType?", + "description": "The type of client." + }, + { + "name": "endpoint", + "type": "EndPoint?", + "description": "The endpoint to kill." + }, + { + "name": "skipMe", + "type": "bool", + "description": "Whether to skip the current connection." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "the number of clients killed." + } + }, + { + "signature": "Task ClientKillAsync(ClientKillFilter filter, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "filter", + "type": "ClientKillFilter", + "description": "The filter to use in choosing which clients to kill." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "the number of clients killed." + } + } + ], "php": [ { "signature": "client(string $subcommand, ...$args)", diff --git a/data/command-api-mapping/CLIENT LIST.json b/data/command-api-mapping/CLIENT LIST.json index 866d399196..8bf71a02d9 100644 --- a/data/command-api-mapping/CLIENT LIST.json +++ b/data/command-api-mapping/CLIENT LIST.json @@ -112,8 +112,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "ClientInfo[] ClientList(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "ClientInfo[]", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ClientListAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "client(string $subcommand, ...$args)", diff --git a/data/command-api-mapping/CLIENT NO-EVICT.json b/data/command-api-mapping/CLIENT NO-EVICT.json index d4a73f1699..10e620977a 100644 --- a/data/command-api-mapping/CLIENT NO-EVICT.json +++ b/data/command-api-mapping/CLIENT NO-EVICT.json @@ -38,10 +38,70 @@ } ], "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "clientNoEvict(value: boolean)", + "params": [ + { + "name": "value", + "type": "boolean", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "String clientNoEvict(boolean on)", + "params": [ + { + "name": "on", + "type": "boolean", + "description": "true will turn eviction mode on, and false will turn it off." + } + ], + "returns": { + "type": "String", + "description": "String simple-string-reply OK." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture clientNoEvict(boolean on)", + "params": [ + { + "name": "on", + "type": "boolean", + "description": "true will turn eviction mode on, and false will turn it off." + } + ], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply OK." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono clientNoEvict(boolean on)", + "params": [ + { + "name": "on", + "type": "boolean", + "description": "true will turn eviction mode on, and false will turn it off." + } + ], + "returns": { + "type": "Mono", + "description": "String simple-string-reply OK." + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], "php": [ diff --git a/data/command-api-mapping/CLIENT NO-TOUCH.json b/data/command-api-mapping/CLIENT NO-TOUCH.json index b203b15861..07d47da9fc 100644 --- a/data/command-api-mapping/CLIENT NO-TOUCH.json +++ b/data/command-api-mapping/CLIENT NO-TOUCH.json @@ -38,10 +38,70 @@ } ], "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "clientNoTouch(value: boolean)", + "params": [ + { + "name": "value", + "type": "boolean", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "String clientNoTouch(boolean on)", + "params": [ + { + "name": "on", + "type": "boolean", + "description": "true will turn no-touch mode on, and false will turn it off." + } + ], + "returns": { + "type": "String", + "description": "String simple-string-reply OK." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture clientNoTouch(boolean on)", + "params": [ + { + "name": "on", + "type": "boolean", + "description": "true will turn no-touch mode on, and false will turn it off." + } + ], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply OK." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono clientNoTouch(boolean on)", + "params": [ + { + "name": "on", + "type": "boolean", + "description": "true will turn no-touch mode on, and false will turn it off." + } + ], + "returns": { + "type": "Mono", + "description": "String simple-string-reply OK." + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], "php": [ diff --git a/data/command-api-mapping/CLIENT PAUSE.json b/data/command-api-mapping/CLIENT PAUSE.json index dcbb5404a3..fe635dbe9b 100644 --- a/data/command-api-mapping/CLIENT PAUSE.json +++ b/data/command-api-mapping/CLIENT PAUSE.json @@ -63,7 +63,27 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clientPause(timeout: number, mode?: 'WRITE' | 'ALL')", + "params": [ + { + "name": "timeout", + "type": "number", + "description": "" + }, + { + "name": "mode", + "type": "'WRITE' | 'ALL'", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clientPause(long timeout)", diff --git a/data/command-api-mapping/CLIENT SETINFO.json b/data/command-api-mapping/CLIENT SETINFO.json index 3bb39cb90e..dbae11ce1b 100644 --- a/data/command-api-mapping/CLIENT SETINFO.json +++ b/data/command-api-mapping/CLIENT SETINFO.json @@ -47,7 +47,27 @@ } } ], - "go-redis": [], + "go-redis": [ + { + "signature": "ClientSetInfo(ctx context.Context, info LibraryInfo) *StatusCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "info", + "type": "LibraryInfo", + "description": "" + } + ], + "returns": { + "type": "*StatusCmd", + "description": "" + } + } + ], "node_redis": [], "lettuce_sync": [ { @@ -114,7 +134,27 @@ ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], + "php": [ + { + "signature": "setInfo(string $modifier = null, string $value = null)", + "params": [ + { + "name": "$modifier", + "type": "string", + "description": "" + }, + { + "name": "$value", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "Status", + "description": "" + } + } + ], "redis_rs_sync": [], "redis_rs_async": [] } diff --git a/data/command-api-mapping/CLIENT SETNAME.json b/data/command-api-mapping/CLIENT SETNAME.json index 1a047884b0..3498df3bed 100644 --- a/data/command-api-mapping/CLIENT SETNAME.json +++ b/data/command-api-mapping/CLIENT SETNAME.json @@ -145,7 +145,37 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "client_setname(connection_name: K)", + "params": [ + { + "name": "connection_name", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(())", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "client_setname(connection_name: K)", + "params": [ + { + "name": "connection_name", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(())", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/CLIENT TRACKING.json b/data/command-api-mapping/CLIENT TRACKING.json index f5d6953f16..fe2a1c3038 100644 --- a/data/command-api-mapping/CLIENT TRACKING.json +++ b/data/command-api-mapping/CLIENT TRACKING.json @@ -67,8 +67,53 @@ } } ], - "go-redis": [], - "node_redis": [], + "go-redis": [ + { + "signature": "ClientTracking(ctx context.Context, on bool, opt *ClientTrackingOptions) *StatusCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "on", + "type": "bool", + "description": "" + }, + { + "name": "opt", + "type": "*ClientTrackingOptions", + "description": "" + } + ], + "returns": { + "type": "*StatusCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "clientTracking(mode: M, options?: M extends true ? ClientTrackingOptions : never)", + "params": [ + { + "name": "mode", + "type": "M", + "description": "" + }, + { + "name": "options", + "type": "M extends true ? ClientTrackingOptions : never", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clientTracking(TrackingArgs args)", diff --git a/data/command-api-mapping/CLIENT TRACKINGINFO.json b/data/command-api-mapping/CLIENT TRACKINGINFO.json index 1f3f52d1ce..0af231daeb 100644 --- a/data/command-api-mapping/CLIENT TRACKINGINFO.json +++ b/data/command-api-mapping/CLIENT TRACKINGINFO.json @@ -27,7 +27,16 @@ } ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clientTrackingInfo()", + "params": [], + "returns": { + "type": "TrackingInfo", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "TrackingInfo clientTrackinginfo()", diff --git a/data/command-api-mapping/CLIENT UNBLOCK.json b/data/command-api-mapping/CLIENT UNBLOCK.json index 18ffdd8fc7..680b1643bf 100644 --- a/data/command-api-mapping/CLIENT UNBLOCK.json +++ b/data/command-api-mapping/CLIENT UNBLOCK.json @@ -101,7 +101,27 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clientUnblock(clientId: number | `${number}`, mode?: ClientUnblockMode)", + "params": [ + { + "name": "clientId", + "type": "number | `${number}`", + "description": "" + }, + { + "name": "mode", + "type": "ClientUnblockMode", + "description": "" + } + ], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "Long clientUnblock(long id, UnblockType type)", diff --git a/data/command-api-mapping/CLIENT UNPAUSE.json b/data/command-api-mapping/CLIENT UNPAUSE.json index 0bc625e9fd..32db0f8819 100644 --- a/data/command-api-mapping/CLIENT UNPAUSE.json +++ b/data/command-api-mapping/CLIENT UNPAUSE.json @@ -42,7 +42,16 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clientUnpause()", + "params": [], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clientUnpause()", diff --git a/data/command-api-mapping/CLUSTER ADDSLOTS.json b/data/command-api-mapping/CLUSTER ADDSLOTS.json index 0c728c8acf..1862b6ab85 100644 --- a/data/command-api-mapping/CLUSTER ADDSLOTS.json +++ b/data/command-api-mapping/CLUSTER ADDSLOTS.json @@ -1,6 +1,26 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_addslots(target_node: TargetNodesT, *slots: EncodableT)", + "params": [ + { + "name": "target_node", + "type": "TargetNodesT", + "description": "" + }, + { + "name": "*slots", + "type": "EncodableT", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterAddSlots(final int... slots)", diff --git a/data/command-api-mapping/CLUSTER ADDSLOTSRANGE.json b/data/command-api-mapping/CLUSTER ADDSLOTSRANGE.json index c237ea3da3..0b9378c139 100644 --- a/data/command-api-mapping/CLUSTER ADDSLOTSRANGE.json +++ b/data/command-api-mapping/CLUSTER ADDSLOTSRANGE.json @@ -1,6 +1,26 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_addslotsrange(target_node: TargetNodesT, *slots: EncodableT)", + "params": [ + { + "name": "target_node", + "type": "TargetNodesT", + "description": "" + }, + { + "name": "*slots", + "type": "EncodableT", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterAddSlotsRange(int... ranges)", @@ -43,7 +63,22 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterAddSlotsRange(ranges: SlotRange | Array)", + "params": [ + { + "name": "ranges", + "type": "SlotRange | Array", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterAddSlotsRange(Range... ranges)", @@ -94,7 +129,22 @@ ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], + "php": [ + { + "signature": "addSlotsRange(int ...$startEndSlots)", + "params": [ + { + "name": "$startEndSlots", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "Status", + "description": "" + } + } + ], "redis_rs_sync": [], "redis_rs_async": [] } diff --git a/data/command-api-mapping/CLUSTER BUMPEPOCH.json b/data/command-api-mapping/CLUSTER BUMPEPOCH.json index 9fdf7a299f..5147290dd0 100644 --- a/data/command-api-mapping/CLUSTER BUMPEPOCH.json +++ b/data/command-api-mapping/CLUSTER BUMPEPOCH.json @@ -1,9 +1,27 @@ { "api_calls": { "redis_py": [], - "jedis": [], + "jedis": [ + { + "signature": "String clusterBumpEpoch()", + "params": [], + "returns": { + "type": "String", + "description": "BUMPED if the epoch was incremented, or STILL if the node already has the greatest config epoch in the cluster." + } + } + ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterBumpEpoch()", + "params": [], + "returns": { + "type": "SimpleStringReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterBumpepoch()", diff --git a/data/command-api-mapping/CLUSTER COUNT-FAILURE-REPORTS.json b/data/command-api-mapping/CLUSTER COUNT-FAILURE-REPORTS.json index 3fb855bc16..f28df0569c 100644 --- a/data/command-api-mapping/CLUSTER COUNT-FAILURE-REPORTS.json +++ b/data/command-api-mapping/CLUSTER COUNT-FAILURE-REPORTS.json @@ -1,9 +1,74 @@ { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], + "redis_py": [ + { + "signature": "cluster_count_failure_report(node_id: str)", + "params": [ + { + "name": "node_id", + "type": "str", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "long clusterCountFailureReports(String nodeId)", + "params": [ + { + "name": "nodeId", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ClusterCountFailureReports(ctx context.Context, nodeID string) *IntCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "nodeID", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "*IntCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "clusterCountFailureReports(nodeId: RedisArgument)", + "params": [ + { + "name": "nodeId", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "Long clusterCountFailureReports(String nodeId)", diff --git a/data/command-api-mapping/CLUSTER COUNTKEYSINSLOT.json b/data/command-api-mapping/CLUSTER COUNTKEYSINSLOT.json index e2de369ffe..9c52ffea3c 100644 --- a/data/command-api-mapping/CLUSTER COUNTKEYSINSLOT.json +++ b/data/command-api-mapping/CLUSTER COUNTKEYSINSLOT.json @@ -1,9 +1,74 @@ { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], + "redis_py": [ + { + "signature": "cluster_countkeysinslot(slot_id: int)", + "params": [ + { + "name": "slot_id", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "long clusterCountKeysInSlot(int slot)", + "params": [ + { + "name": "slot", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ClusterCountKeysInSlot(ctx context.Context, slot int) *IntCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "slot", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "*IntCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "clusterCountKeysInSlot(slot: number)", + "params": [ + { + "name": "slot", + "type": "number", + "description": "" + } + ], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "Long clusterCountKeysInSlot(int slot)", diff --git a/data/command-api-mapping/CLUSTER DELSLOTS.json b/data/command-api-mapping/CLUSTER DELSLOTS.json index 1bda44c69d..3fe5d27d20 100644 --- a/data/command-api-mapping/CLUSTER DELSLOTS.json +++ b/data/command-api-mapping/CLUSTER DELSLOTS.json @@ -1,6 +1,21 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_delslots(*slots: EncodableT)", + "params": [ + { + "name": "*slots", + "type": "EncodableT", + "description": "" + } + ], + "returns": { + "type": "List[bool]", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterDelSlots(final int... slots)", @@ -38,7 +53,22 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterDelSlots(slots: number | Array)", + "params": [ + { + "name": "slots", + "type": "number | Array", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterDelSlots(int... slots)", diff --git a/data/command-api-mapping/CLUSTER DELSLOTSRANGE.json b/data/command-api-mapping/CLUSTER DELSLOTSRANGE.json index 23b96861b0..d8e3ffdfb9 100644 --- a/data/command-api-mapping/CLUSTER DELSLOTSRANGE.json +++ b/data/command-api-mapping/CLUSTER DELSLOTSRANGE.json @@ -1,6 +1,21 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_delslotsrange(*slots: EncodableT)", + "params": [ + { + "name": "*slots", + "type": "EncodableT", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterDelSlotsRange(int... ranges)", @@ -43,7 +58,22 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterDelSlotsRange(ranges: SlotRange | Array)", + "params": [ + { + "name": "ranges", + "type": "SlotRange | Array", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterDelSlotsRange(Range... ranges)", @@ -94,7 +124,22 @@ ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], + "php": [ + { + "signature": "delSlotsRange(int ...$startEndSlots)", + "params": [ + { + "name": "$startEndSlots", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "Status", + "description": "" + } + } + ], "redis_rs_sync": [], "redis_rs_async": [] } diff --git a/data/command-api-mapping/CLUSTER FAILOVER.json b/data/command-api-mapping/CLUSTER FAILOVER.json index 43887fe9f2..e37f8587bf 100644 --- a/data/command-api-mapping/CLUSTER FAILOVER.json +++ b/data/command-api-mapping/CLUSTER FAILOVER.json @@ -1,6 +1,26 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_failover(target_node: TargetNodesT, option: str | None = None)", + "params": [ + { + "name": "target_node", + "type": "TargetNodesT", + "description": "" + }, + { + "name": "option", + "type": "str | None = None", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterFailover()", @@ -41,7 +61,22 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterFailover(options?: ClusterFailoverOptions)", + "params": [ + { + "name": "options", + "type": "ClusterFailoverOptions", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterFailover(boolean force)", diff --git a/data/command-api-mapping/CLUSTER FLUSHSLOTS.json b/data/command-api-mapping/CLUSTER FLUSHSLOTS.json index 50e6f1b065..885d720490 100644 --- a/data/command-api-mapping/CLUSTER FLUSHSLOTS.json +++ b/data/command-api-mapping/CLUSTER FLUSHSLOTS.json @@ -1,9 +1,27 @@ { "api_calls": { "redis_py": [], - "jedis": [], + "jedis": [ + { + "signature": "String clusterFlushSlots()", + "params": [], + "returns": { + "type": "String", + "description": "" + } + } + ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterFlushSlots()", + "params": [], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterFlushslots()", diff --git a/data/command-api-mapping/CLUSTER GETKEYSINSLOT.json b/data/command-api-mapping/CLUSTER GETKEYSINSLOT.json index 7923a47a35..aec827e786 100644 --- a/data/command-api-mapping/CLUSTER GETKEYSINSLOT.json +++ b/data/command-api-mapping/CLUSTER GETKEYSINSLOT.json @@ -1,6 +1,26 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_get_keys_in_slot(slot: int, num_keys: int)", + "params": [ + { + "name": "slot", + "type": "int", + "description": "" + }, + { + "name": "num_keys", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "list[bytes | str]", + "description": "" + } + } + ], "jedis": [ { "signature": "List clusterGetKeysInSlot(final int slot, final int count)", diff --git a/data/command-api-mapping/CLUSTER HELP.json b/data/command-api-mapping/CLUSTER HELP.json index bd88aa6294..75fa84c8bf 100644 --- a/data/command-api-mapping/CLUSTER HELP.json +++ b/data/command-api-mapping/CLUSTER HELP.json @@ -1,6 +1,31 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster(cluster_arg, *args, **kwargs)", + "params": [ + { + "name": "cluster_arg", + "type": "Any", + "description": "" + }, + { + "name": "*args", + "type": "Any", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "Any", + "description": "" + } + } + ], "jedis": [], "go-redis": [], "node_redis": [], diff --git a/data/command-api-mapping/CLUSTER INFO.json b/data/command-api-mapping/CLUSTER INFO.json index de188fd961..bcdc01733e 100644 --- a/data/command-api-mapping/CLUSTER INFO.json +++ b/data/command-api-mapping/CLUSTER INFO.json @@ -1,6 +1,21 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_info(target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "dict[str, str]", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterInfo()", diff --git a/data/command-api-mapping/CLUSTER KEYSLOT.json b/data/command-api-mapping/CLUSTER KEYSLOT.json index f09ca1c075..2d4a7dbc0b 100644 --- a/data/command-api-mapping/CLUSTER KEYSLOT.json +++ b/data/command-api-mapping/CLUSTER KEYSLOT.json @@ -1,6 +1,21 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_keyslot(key: str)", + "params": [ + { + "name": "key", + "type": "str", + "description": "" + } + ], + "returns": { + "type": "int", + "description": "" + } + } + ], "jedis": [ { "signature": "long clusterKeySlot(final String key)", diff --git a/data/command-api-mapping/CLUSTER LINKS.json b/data/command-api-mapping/CLUSTER LINKS.json index 6cd3456836..971b80abc1 100644 --- a/data/command-api-mapping/CLUSTER LINKS.json +++ b/data/command-api-mapping/CLUSTER LINKS.json @@ -1,9 +1,57 @@ { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], + "redis_py": [ + { + "signature": "cluster_links(target_node: TargetNodesT)", + "params": [ + { + "name": "target_node", + "type": "TargetNodesT", + "description": "" + } + ], + "returns": { + "type": "ClusterLinksResponse", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "List> clusterLinks()", + "params": [], + "returns": { + "type": "List>", + "description": "the information of all such peer links as an array" + } + } + ], + "go-redis": [ + { + "signature": "ClusterLinks(ctx context.Context) *ClusterLinksCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*ClusterLinksCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "clusterLinks()", + "params": [], + "returns": { + "type": "ClusterLinksReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "List clusterLinks()", @@ -36,7 +84,16 @@ ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], + "php": [ + { + "signature": "links()", + "params": [], + "returns": { + "type": "array", + "description": "" + } + } + ], "redis_rs_sync": [], "redis_rs_async": [] } diff --git a/data/command-api-mapping/CLUSTER MEET.json b/data/command-api-mapping/CLUSTER MEET.json index 989a48c5c3..070c2b55f7 100644 --- a/data/command-api-mapping/CLUSTER MEET.json +++ b/data/command-api-mapping/CLUSTER MEET.json @@ -1,6 +1,31 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_meet(host: str, port: int, target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "host", + "type": "str", + "description": "" + }, + { + "name": "port", + "type": "int", + "description": "" + }, + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterMeet(final String ip, final int port)", diff --git a/data/command-api-mapping/CLUSTER MYID.json b/data/command-api-mapping/CLUSTER MYID.json index 3f485d7258..e14fc86563 100644 --- a/data/command-api-mapping/CLUSTER MYID.json +++ b/data/command-api-mapping/CLUSTER MYID.json @@ -1,6 +1,21 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_myid(target_node: TargetNodesT)", + "params": [ + { + "name": "target_node", + "type": "TargetNodesT", + "description": "" + } + ], + "returns": { + "type": "bytes | str", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterMyId()", @@ -27,7 +42,16 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterMyId()", + "params": [], + "returns": { + "type": "BlobStringReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterMyId()", diff --git a/data/command-api-mapping/CLUSTER MYSHARDID.json b/data/command-api-mapping/CLUSTER MYSHARDID.json index 4d3fdc958d..d9e3fd28aa 100644 --- a/data/command-api-mapping/CLUSTER MYSHARDID.json +++ b/data/command-api-mapping/CLUSTER MYSHARDID.json @@ -1,9 +1,57 @@ { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], + "redis_py": [ + { + "signature": "cluster_myshardid(target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "bytes | str", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String clusterMyShardId()", + "params": [], + "returns": { + "type": "String", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ClusterMyShardID(ctx context.Context) *StringCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*StringCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "clusterMyShardId()", + "params": [], + "returns": { + "type": "BlobStringReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterMyShardId()", diff --git a/data/command-api-mapping/CLUSTER NODES.json b/data/command-api-mapping/CLUSTER NODES.json index 75b89d0d2e..19ae51d132 100644 --- a/data/command-api-mapping/CLUSTER NODES.json +++ b/data/command-api-mapping/CLUSTER NODES.json @@ -1,6 +1,15 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_nodes()", + "params": [], + "returns": { + "type": "dict[str, ClusterNodeDetail]", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterNodes()", @@ -73,8 +82,66 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "ClusterConfiguration? ClusterNodes(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "ClusterConfiguration?", + "description": "" + } + }, + { + "signature": "string? ClusterNodesRaw(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "string?", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ClusterNodesAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task ClusterNodesRawAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [], "redis_rs_sync": [], "redis_rs_async": [] diff --git a/data/command-api-mapping/CLUSTER REPLICAS.json b/data/command-api-mapping/CLUSTER REPLICAS.json index 7d2a80f4f2..437689dc02 100644 --- a/data/command-api-mapping/CLUSTER REPLICAS.json +++ b/data/command-api-mapping/CLUSTER REPLICAS.json @@ -1,9 +1,59 @@ { "api_calls": { - "redis_py": [], - "jedis": [], + "redis_py": [ + { + "signature": "cluster_replicas(node_id: str, target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "node_id", + "type": "str", + "description": "" + }, + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "dict[str, ClusterNodeDetail]", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "List clusterReplicas(String nodeId)", + "params": [ + { + "name": "nodeId", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + } + ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterReplicas(nodeId: RedisArgument)", + "params": [ + { + "name": "nodeId", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterReplicas(String nodeId)", diff --git a/data/command-api-mapping/CLUSTER REPLICATE.json b/data/command-api-mapping/CLUSTER REPLICATE.json index 5cdb506b7f..5ab3b1a561 100644 --- a/data/command-api-mapping/CLUSTER REPLICATE.json +++ b/data/command-api-mapping/CLUSTER REPLICATE.json @@ -1,6 +1,26 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_replicate(target_nodes: TargetNodesT, node_id: str)", + "params": [ + { + "name": "target_nodes", + "type": "TargetNodesT", + "description": "" + }, + { + "name": "node_id", + "type": "str", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterReplicate(final String nodeId)", diff --git a/data/command-api-mapping/CLUSTER RESET.json b/data/command-api-mapping/CLUSTER RESET.json index 722551a9ca..0754825710 100644 --- a/data/command-api-mapping/CLUSTER RESET.json +++ b/data/command-api-mapping/CLUSTER RESET.json @@ -1,6 +1,26 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_reset(soft: bool = True, target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "soft", + "type": "bool = True", + "description": "" + }, + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterReset()", @@ -55,7 +75,22 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterReset(options?: ClusterResetOptions)", + "params": [ + { + "name": "options", + "type": "ClusterResetOptions", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterReset(boolean hard)", diff --git a/data/command-api-mapping/CLUSTER SAVECONFIG.json b/data/command-api-mapping/CLUSTER SAVECONFIG.json index 1b58da8299..9e5bd22175 100644 --- a/data/command-api-mapping/CLUSTER SAVECONFIG.json +++ b/data/command-api-mapping/CLUSTER SAVECONFIG.json @@ -1,6 +1,21 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "cluster_save_config(target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], "jedis": [ { "signature": "String clusterSaveConfig()", @@ -27,7 +42,16 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterSaveConfig()", + "params": [], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterSaveconfig()", diff --git a/data/command-api-mapping/CLUSTER SET-CONFIG-EPOCH.json b/data/command-api-mapping/CLUSTER SET-CONFIG-EPOCH.json index 8fc6982e9d..420b4e8ef5 100644 --- a/data/command-api-mapping/CLUSTER SET-CONFIG-EPOCH.json +++ b/data/command-api-mapping/CLUSTER SET-CONFIG-EPOCH.json @@ -1,9 +1,59 @@ { "api_calls": { - "redis_py": [], - "jedis": [], + "redis_py": [ + { + "signature": "cluster_set_config_epoch(epoch: int, target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "epoch", + "type": "int", + "description": "" + }, + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String clusterSetConfigEpoch(long configEpoch)", + "params": [ + { + "name": "configEpoch", + "type": "long", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "OK" + } + } + ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterSetConfigEpoch(configEpoch: number)", + "params": [ + { + "name": "configEpoch", + "type": "number", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterSetConfigEpoch(long configEpoch)", diff --git a/data/command-api-mapping/CLUSTER SETSLOT.json b/data/command-api-mapping/CLUSTER SETSLOT.json index 4bcdcc3eb1..07420f3ef2 100644 --- a/data/command-api-mapping/CLUSTER SETSLOT.json +++ b/data/command-api-mapping/CLUSTER SETSLOT.json @@ -1,9 +1,136 @@ { "api_calls": { - "redis_py": [], - "jedis": [], + "redis_py": [ + { + "signature": "cluster_setslot(target_node: TargetNodesT, node_id: str, slot_id: int, state: str)", + "params": [ + { + "name": "target_node", + "type": "TargetNodesT", + "description": "" + }, + { + "name": "node_id", + "type": "str", + "description": "" + }, + { + "name": "slot_id", + "type": "int", + "description": "" + }, + { + "name": "state", + "type": "str", + "description": "" + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "String clusterSetSlotNode(int slot, String nodeId)", + "params": [ + { + "name": "slot", + "type": "int", + "description": "" + }, + { + "name": "nodeId", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "" + } + }, + { + "signature": "String clusterSetSlotMigrating(int slot, String nodeId)", + "params": [ + { + "name": "slot", + "type": "int", + "description": "" + }, + { + "name": "nodeId", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "" + } + }, + { + "signature": "String clusterSetSlotImporting(int slot, String nodeId)", + "params": [ + { + "name": "slot", + "type": "int", + "description": "" + }, + { + "name": "nodeId", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "" + } + }, + { + "signature": "String clusterSetSlotStable(int slot)", + "params": [ + { + "name": "slot", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "String", + "description": "" + } + } + ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "clusterSetSlot(slot: number, state: ClusterSlotState, nodeId?: RedisArgument)", + "params": [ + { + "name": "slot", + "type": "number", + "description": "" + }, + { + "name": "state", + "type": "ClusterSlotState", + "description": "" + }, + { + "name": "nodeId", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String clusterSetSlotImporting(int slot, String nodeId)", diff --git a/data/command-api-mapping/CLUSTER SHARDS.json b/data/command-api-mapping/CLUSTER SHARDS.json index e894cd5a59..2053931dfd 100644 --- a/data/command-api-mapping/CLUSTER SHARDS.json +++ b/data/command-api-mapping/CLUSTER SHARDS.json @@ -1,8 +1,47 @@ { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], + "redis_py": [ + { + "signature": "cluster_shards(target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "ClusterShardsResponse", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "List clusterShards()", + "params": [], + "returns": { + "type": "List", + "description": "a list of shards, with each shard containing two objects, 'slots' and 'nodes'." + } + } + ], + "go-redis": [ + { + "signature": "ClusterShards(ctx context.Context) *ClusterShardsCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*ClusterShardsCmd", + "description": "" + } + } + ], "node_redis": [], "lettuce_sync": [ { @@ -36,7 +75,16 @@ ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], + "php": [ + { + "signature": "shards()", + "params": [], + "returns": { + "type": "array", + "description": "" + } + } + ], "redis_rs_sync": [], "redis_rs_async": [] } diff --git a/data/command-api-mapping/CLUSTER SLAVES.json b/data/command-api-mapping/CLUSTER SLAVES.json index bd88aa6294..2b4b2de82c 100644 --- a/data/command-api-mapping/CLUSTER SLAVES.json +++ b/data/command-api-mapping/CLUSTER SLAVES.json @@ -1,12 +1,92 @@ { "api_calls": { "redis_py": [], - "jedis": [], - "go-redis": [], + "jedis": [ + { + "signature": "List clusterSlaves(String nodeId)", + "params": [ + { + "name": "nodeId", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "List", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ClusterSlaves(ctx context.Context, nodeID string) *StringSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "nodeID", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "*StringSliceCmd", + "description": "" + } + } + ], "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "List clusterSlaves(String nodeId)", + "params": [ + { + "name": "nodeId", + "type": "String", + "description": "node id of the master node" + } + ], + "returns": { + "type": "List", + "description": "List array-reply list of replicas. The command returns data in the same format as clusterNodes() but one line per replica." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> clusterSlaves(String nodeId)", + "params": [ + { + "name": "nodeId", + "type": "String", + "description": "node id of the master node" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "List array-reply list of replicas. The command returns data in the same format as clusterNodes() but one line per replica." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux clusterSlaves(String nodeId)", + "params": [ + { + "name": "nodeId", + "type": "String", + "description": "node id of the master node" + } + ], + "returns": { + "type": "Flux", + "description": "List array-reply list of replicas. The command returns data in the same format as clusterNodes() but one line per replica." + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], "php": [], diff --git a/data/command-api-mapping/CLUSTER SLOTS.json b/data/command-api-mapping/CLUSTER SLOTS.json index df18c745b8..abf6615c30 100644 --- a/data/command-api-mapping/CLUSTER SLOTS.json +++ b/data/command-api-mapping/CLUSTER SLOTS.json @@ -1,9 +1,57 @@ { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], + "redis_py": [ + { + "signature": "cluster_slots(target_nodes: TargetNodesT | None = None)", + "params": [ + { + "name": "target_nodes", + "type": "TargetNodesT | None = None", + "description": "" + } + ], + "returns": { + "type": "list[Any]", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "List clusterSlots()", + "params": [], + "returns": { + "type": "List", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "ClusterSlots(ctx context.Context) *ClusterSlotsCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*ClusterSlotsCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "clusterSlots()", + "params": [], + "returns": { + "type": "Array<{ from: NumberReply, to: NumberReply, master: ClusterSlotsNode, replicas: Array }>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "List clusterSlots()", diff --git a/data/command-api-mapping/COMMAND COUNT.json b/data/command-api-mapping/COMMAND COUNT.json index ad93195bf4..c0120f8cf3 100644 --- a/data/command-api-mapping/COMMAND COUNT.json +++ b/data/command-api-mapping/COMMAND COUNT.json @@ -82,8 +82,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "long CommandCount(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task CommandCountAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "command(string $subcommand, ...$args)", diff --git a/data/command-api-mapping/COMMAND DOCS.json b/data/command-api-mapping/COMMAND DOCS.json index 186956b935..758c061cf2 100644 --- a/data/command-api-mapping/COMMAND DOCS.json +++ b/data/command-api-mapping/COMMAND DOCS.json @@ -38,7 +38,22 @@ } ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "commandDocs(commands?: RedisVariadicArgument)", + "params": [ + { + "name": "commands", + "type": "RedisVariadicArgument", + "description": "" + } + ], + "returns": { + "type": "CommandDocsReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], diff --git a/data/command-api-mapping/COMMAND GETKEYS.json b/data/command-api-mapping/COMMAND GETKEYS.json index 73629ab434..56f14a510d 100644 --- a/data/command-api-mapping/COMMAND GETKEYS.json +++ b/data/command-api-mapping/COMMAND GETKEYS.json @@ -63,7 +63,22 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "commandGetKeys(args: Array)", + "params": [ + { + "name": "args", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "List commandGetkeys(String... args)", @@ -112,8 +127,48 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "RedisKey[] CommandGetKeys(RedisValue[] command, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "command", + "type": "RedisValue[]", + "description": "The command to get keys from." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "RedisKey[]", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task CommandGetKeysAsync(RedisValue[] command, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "command", + "type": "RedisValue[]", + "description": "The command to get keys from." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "command(string $subcommand, ...$args)", diff --git a/data/command-api-mapping/COMMAND GETKEYSANDFLAGS.json b/data/command-api-mapping/COMMAND GETKEYSANDFLAGS.json index 8bb0cf2e71..8290658fe4 100644 --- a/data/command-api-mapping/COMMAND GETKEYSANDFLAGS.json +++ b/data/command-api-mapping/COMMAND GETKEYSANDFLAGS.json @@ -42,8 +42,43 @@ } } ], - "go-redis": [], - "node_redis": [], + "go-redis": [ + { + "signature": "CommandGetKeysAndFlags(ctx context.Context, commands ...interface{}) *KeyFlagsCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "commands", + "type": "...interface{}", + "description": "" + } + ], + "returns": { + "type": "*KeyFlagsCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "commandGetKeysAndFlags(args: Array)", + "params": [ + { + "name": "args", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "Array<{ key: BlobStringReply, flags: SetReply }>", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], diff --git a/data/command-api-mapping/COMMAND LIST.json b/data/command-api-mapping/COMMAND LIST.json index 4fc0d2bc17..8a3202f36b 100644 --- a/data/command-api-mapping/COMMAND LIST.json +++ b/data/command-api-mapping/COMMAND LIST.json @@ -55,13 +55,108 @@ } } ], - "go-redis": [], - "node_redis": [], + "go-redis": [ + { + "signature": "CommandList(ctx context.Context, filter *FilterBy) *StringSliceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "filter", + "type": "*FilterBy", + "description": "" + } + ], + "returns": { + "type": "*StringSliceCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "commandList(options?: CommandListOptions)", + "params": [ + { + "name": "options", + "type": "CommandListOptions", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "string[] CommandList(RedisValue? moduleName = null, RedisValue? category = null, RedisValue? pattern = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "moduleName", + "type": "RedisValue?", + "description": "The module name to filter the command list by." + }, + { + "name": "category", + "type": "RedisValue?", + "description": "The category to filter the command list by." + }, + { + "name": "pattern", + "type": "RedisValue?", + "description": "The pattern to filter the command list by." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "string[]", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task CommandListAsync(RedisValue? moduleName = null, RedisValue? category = null, RedisValue? pattern = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "moduleName", + "type": "RedisValue?", + "description": "The module name to filter the command list by." + }, + { + "name": "category", + "type": "RedisValue?", + "description": "The category to filter the command list by." + }, + { + "name": "pattern", + "type": "RedisValue?", + "description": "The pattern to filter the command list by." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "command(string $subcommand, ...$args)", diff --git a/data/command-api-mapping/CONFIG GET.json b/data/command-api-mapping/CONFIG GET.json index 7adf3fc9bf..08fbcf0dbb 100644 --- a/data/command-api-mapping/CONFIG GET.json +++ b/data/command-api-mapping/CONFIG GET.json @@ -183,8 +183,48 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "KeyValuePair[] ConfigGet(RedisValue pattern = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "pattern", + "type": "RedisValue", + "description": "The pattern of config values to get." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "KeyValuePair[]", + "description": "All matching configuration parameters." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task[]> ConfigGetAsync(RedisValue pattern = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "pattern", + "type": "RedisValue", + "description": "The pattern of config values to get." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task[]>", + "description": "All matching configuration parameters." + } + } + ], "php": [ { "signature": "config($subcommand, $argument = null)", diff --git a/data/command-api-mapping/CONFIG RESETSTAT.json b/data/command-api-mapping/CONFIG RESETSTAT.json index bc13f79afb..0f0bb87334 100644 --- a/data/command-api-mapping/CONFIG RESETSTAT.json +++ b/data/command-api-mapping/CONFIG RESETSTAT.json @@ -82,8 +82,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void ConfigResetStatistics(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ConfigResetStatisticsAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "config($subcommand, $argument = null)", diff --git a/data/command-api-mapping/CONFIG REWRITE.json b/data/command-api-mapping/CONFIG REWRITE.json index dbd8b3577a..5cfcb80586 100644 --- a/data/command-api-mapping/CONFIG REWRITE.json +++ b/data/command-api-mapping/CONFIG REWRITE.json @@ -82,8 +82,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void ConfigRewrite(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ConfigRewriteAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "config($subcommand, $argument = null)", diff --git a/data/command-api-mapping/CONFIG SET.json b/data/command-api-mapping/CONFIG SET.json index 52306b698c..f9a06144c1 100644 --- a/data/command-api-mapping/CONFIG SET.json +++ b/data/command-api-mapping/CONFIG SET.json @@ -246,8 +246,58 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void ConfigSet(RedisValue setting, RedisValue value, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "setting", + "type": "RedisValue", + "description": "The setting name." + }, + { + "name": "value", + "type": "RedisValue", + "description": "The new setting value." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ConfigSetAsync(RedisValue setting, RedisValue value, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "setting", + "type": "RedisValue", + "description": "The setting name." + }, + { + "name": "value", + "type": "RedisValue", + "description": "The new setting value." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "config($subcommand, $argument = null)", diff --git a/data/command-api-mapping/DBSIZE.json b/data/command-api-mapping/DBSIZE.json index 76fa81e9ce..8c96a76526 100644 --- a/data/command-api-mapping/DBSIZE.json +++ b/data/command-api-mapping/DBSIZE.json @@ -82,8 +82,48 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "long DatabaseSize(int database = -1, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "database", + "type": "int", + "description": "The database ID." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task DatabaseSizeAsync(int database = -1, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "database", + "type": "int", + "description": "The database ID." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "dbsize()", diff --git a/data/command-api-mapping/ECHO.json b/data/command-api-mapping/ECHO.json index 084fcdd0ac..4c1a282236 100644 --- a/data/command-api-mapping/ECHO.json +++ b/data/command-api-mapping/ECHO.json @@ -79,9 +79,54 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "V echo(V msg)", + "params": [ + { + "name": "msg", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "V", + "description": "V bulk-string-reply." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture echo(V msg)", + "params": [ + { + "name": "msg", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "RedisFuture", + "description": "V bulk-string-reply." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono echo(V msg)", + "params": [ + { + "name": "msg", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "Mono", + "description": "V bulk-string-reply." + } + } + ], "nredisstack_sync": [ { "signature": "RedisValue Echo(RedisValue message, CommandFlags flags = CommandFlags.None)", diff --git a/data/command-api-mapping/FLUSHALL.json b/data/command-api-mapping/FLUSHALL.json index 0669094cfd..2b0cca4212 100644 --- a/data/command-api-mapping/FLUSHALL.json +++ b/data/command-api-mapping/FLUSHALL.json @@ -173,8 +173,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void FlushAllDatabases(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task FlushAllDatabasesAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "flushall()", @@ -185,7 +215,53 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "flushall()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + }, + { + "signature": "flushall_options(options: &'a FlushAllOptions)", + "params": [ + { + "name": "options", + "type": "&'a FlushAllOptions", + "description": "" + } + ], + "returns": { + "type": "()", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "flushall()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + }, + { + "signature": "flushall_options(options: &'a FlushAllOptions)", + "params": [ + { + "name": "options", + "type": "&'a FlushAllOptions", + "description": "" + } + ], + "returns": { + "type": "()", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/FLUSHDB.json b/data/command-api-mapping/FLUSHDB.json index b7733133f9..5f8728079d 100644 --- a/data/command-api-mapping/FLUSHDB.json +++ b/data/command-api-mapping/FLUSHDB.json @@ -173,8 +173,48 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void FlushDatabase(int database = -1, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "database", + "type": "int", + "description": "The database ID." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task FlushDatabaseAsync(int database = -1, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "database", + "type": "int", + "description": "The database ID." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "flushdb()", @@ -185,7 +225,53 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "flushdb()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + }, + { + "signature": "flushdb_options(options: &'a FlushDbOptions)", + "params": [ + { + "name": "options", + "type": "&'a FlushDbOptions", + "description": "" + } + ], + "returns": { + "type": "()", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "flushdb()", + "params": [], + "returns": { + "type": "()", + "description": "" + } + }, + { + "signature": "flushdb_options(options: &'a FlushDbOptions)", + "params": [ + { + "name": "options", + "type": "&'a FlushDbOptions", + "description": "" + } + ], + "returns": { + "type": "()", + "description": "" + } + } + ] } } \ No newline at end of file diff --git a/data/command-api-mapping/FT.AGGREGATE.json b/data/command-api-mapping/FT.AGGREGATE.json index ebdae48ebf..c44173f1ab 100644 --- a/data/command-api-mapping/FT.AGGREGATE.json +++ b/data/command-api-mapping/FT.AGGREGATE.json @@ -42,9 +42,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "AggregationReply ftAggregate(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the base filtering query that retrieves documents for aggregation" + } + ], + "returns": { + "type": "AggregationReply", + "description": "the result of the aggregate command containing processed results, see SearchReply" + } + }, + { + "signature": "AggregationReply ftAggregate(String index, String query, AggregateArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the base filtering query that retrieves documents for aggregation" + }, + { + "name": "args", + "type": "AggregateArgs", + "description": "the aggregate arguments defining the processing pipeline and operations" + } + ], + "returns": { + "type": "AggregationReply", + "description": "the result of the aggregate command containing processed and transformed results, see SearchReply" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftAggregate(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the base filtering query that retrieves documents for aggregation" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the result of the aggregate command containing processed results, see SearchReply" + } + }, + { + "signature": "RedisFuture> ftAggregate(String index, String query, AggregateArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the base filtering query that retrieves documents for aggregation" + }, + { + "name": "args", + "type": "AggregateArgs", + "description": "the aggregate arguments defining the processing pipeline and operations" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the result of the aggregate command containing processed and transformed results, see SearchReply" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> ftAggregate(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the base filtering query that retrieves documents for aggregation" + } + ], + "returns": { + "type": "Mono>", + "description": "the result of the aggregate command containing processed results, see SearchReply" + } + }, + { + "signature": "Mono> ftAggregate(String index, String query, AggregateArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the base filtering query that retrieves documents for aggregation" + }, + { + "name": "args", + "type": "AggregateArgs", + "description": "the aggregate arguments defining the processing pipeline and operations" + } + ], + "returns": { + "type": "Mono>", + "description": "the result of the aggregate command containing processed and transformed results, see SearchReply" + } + } + ], "go-redis": [ { "signature": "FTAggregate(ctx context.Context, index string, query string)", diff --git a/data/command-api-mapping/FT.ALIASADD.json b/data/command-api-mapping/FT.ALIASADD.json index a9ac38b5ed..d4931144d7 100644 --- a/data/command-api-mapping/FT.ALIASADD.json +++ b/data/command-api-mapping/FT.ALIASADD.json @@ -37,9 +37,69 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftAliasadd(String alias, String index)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to create" + }, + { + "name": "index", + "type": "String", + "description": "the target index name that the alias will point to" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the alias was successfully created" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftAliasadd(String alias, String index)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to create" + }, + { + "name": "index", + "type": "String", + "description": "the target index name that the alias will point to" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the alias was successfully created" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftAliasadd(String alias, String index)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to create" + }, + { + "name": "index", + "type": "String", + "description": "the target index name that the alias will point to" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the alias was successfully created" + } + } + ], "go-redis": [ { "signature": "FTAliasAdd(ctx context.Context, index string, alias string)", diff --git a/data/command-api-mapping/FT.ALIASDEL.json b/data/command-api-mapping/FT.ALIASDEL.json index 32fc16ba03..76ec474d53 100644 --- a/data/command-api-mapping/FT.ALIASDEL.json +++ b/data/command-api-mapping/FT.ALIASDEL.json @@ -32,9 +32,54 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftAliasdel(String alias)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to remove" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the alias was successfully removed" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftAliasdel(String alias)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to remove" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the alias was successfully removed" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftAliasdel(String alias)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to remove" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the alias was successfully removed" + } + } + ], "go-redis": [ { "signature": "FTAliasDel(ctx context.Context, alias string)", diff --git a/data/command-api-mapping/FT.ALIASUPDATE.json b/data/command-api-mapping/FT.ALIASUPDATE.json index f0bbfaff50..0fb6afcf32 100644 --- a/data/command-api-mapping/FT.ALIASUPDATE.json +++ b/data/command-api-mapping/FT.ALIASUPDATE.json @@ -37,9 +37,69 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftAliasupdate(String alias, String index)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to update or create" + }, + { + "name": "index", + "type": "String", + "description": "the target index name that the alias will point to" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the alias was successfully updated" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftAliasupdate(String alias, String index)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to update or create" + }, + { + "name": "index", + "type": "String", + "description": "the target index name that the alias will point to" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the alias was successfully updated" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftAliasupdate(String alias, String index)", + "params": [ + { + "name": "alias", + "type": "String", + "description": "the alias name to update or create" + }, + { + "name": "index", + "type": "String", + "description": "the target index name that the alias will point to" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the alias was successfully updated" + } + } + ], "go-redis": [ { "signature": "FTAliasUpdate(ctx context.Context, index string, alias string)", diff --git a/data/command-api-mapping/FT.ALTER.json b/data/command-api-mapping/FT.ALTER.json index 6f213e11a9..396d9ff5c8 100644 --- a/data/command-api-mapping/FT.ALTER.json +++ b/data/command-api-mapping/FT.ALTER.json @@ -56,9 +56,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftAlter(String index, boolean skipInitialScan, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "skipInitialScan", + "type": "boolean", + "description": "if true, skip scanning and indexing existing documents; if false, scan and index existing documents with the new attributes" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the new searchable fields and their types to add" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the index was successfully altered" + } + }, + { + "signature": "String ftAlter(String index, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the new searchable fields and their types to add" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the index was successfully altered" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftAlter(String index, boolean skipInitialScan, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "skipInitialScan", + "type": "boolean", + "description": "if true, skip scanning and indexing existing documents; if false, scan and index existing documents with the new attributes" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the new searchable fields and their types to add" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the index was successfully altered" + } + }, + { + "signature": "RedisFuture ftAlter(String index, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the new searchable fields and their types to add" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the index was successfully altered" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftAlter(String index, boolean skipInitialScan, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "skipInitialScan", + "type": "boolean", + "description": "if true, skip scanning and indexing existing documents; if false, scan and index existing documents with the new attributes" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the new searchable fields and their types to add" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the index was successfully altered" + } + }, + { + "signature": "Mono ftAlter(String index, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the new searchable fields and their types to add" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the index was successfully altered" + } + } + ], "go-redis": [ { "signature": "FTAlter(ctx context.Context, index string, skipInitialScan bool, definition []interface{})", diff --git a/data/command-api-mapping/FT.CREATE.json b/data/command-api-mapping/FT.CREATE.json index 40bda2461c..807443d8ee 100644 --- a/data/command-api-mapping/FT.CREATE.json +++ b/data/command-api-mapping/FT.CREATE.json @@ -71,9 +71,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftCreate(String index, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the searchable fields and their types" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the index was created successfully" + } + }, + { + "signature": "String ftCreate(String index, CreateArgs arguments, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "arguments", + "type": "CreateArgs", + "description": "the index CreateArgs containing configuration options" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the searchable fields and their types" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the index was created successfully" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftCreate(String index, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the searchable fields and their types" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the index was created successfully" + } + }, + { + "signature": "RedisFuture ftCreate(String index, CreateArgs arguments, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "arguments", + "type": "CreateArgs", + "description": "the index CreateArgs containing configuration options" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the searchable fields and their types" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the index was created successfully" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftCreate(String index, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the searchable fields and their types" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the index was created successfully" + } + }, + { + "signature": "Mono ftCreate(String index, CreateArgs arguments, List fieldArgs)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "arguments", + "type": "CreateArgs", + "description": "the index CreateArgs containing configuration options" + }, + { + "name": "fieldArgs", + "type": "List", + "description": "the FieldArgs list defining the searchable fields and their types" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the index was created successfully" + } + } + ], "go-redis": [ { "signature": "FTCreate(ctx context.Context, index string, options *FTCreateOptions, schema ...*FieldSchema)", diff --git a/data/command-api-mapping/FT.CURSOR DEL.json b/data/command-api-mapping/FT.CURSOR DEL.json index 2b2b2ab316..84dcf2fd03 100644 --- a/data/command-api-mapping/FT.CURSOR DEL.json +++ b/data/command-api-mapping/FT.CURSOR DEL.json @@ -37,9 +37,69 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftCursordel(String index, Cursor cursor)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the cursor was successfully deleted" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftCursordel(String index, Cursor cursor)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the cursor was successfully deleted" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftCursordel(String index, Cursor cursor)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the cursor was successfully deleted" + } + } + ], "go-redis": [ { "signature": "FTCursorDel(ctx context.Context, index string, cursorId int)", diff --git a/data/command-api-mapping/FT.CURSOR READ.json b/data/command-api-mapping/FT.CURSOR READ.json index 62bcf9f702..95ee31bab7 100644 --- a/data/command-api-mapping/FT.CURSOR READ.json +++ b/data/command-api-mapping/FT.CURSOR READ.json @@ -47,9 +47,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "AggregationReply ftCursorread(String index, Cursor cursor, int count)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + }, + { + "name": "count", + "type": "int", + "description": "the number of results to read; overrides the COUNT from FT.AGGREGATE" + } + ], + "returns": { + "type": "AggregationReply", + "description": "the next batch of results; see AggregationReply" + } + }, + { + "signature": "AggregationReply ftCursorread(String index, Cursor cursor)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + } + ], + "returns": { + "type": "AggregationReply", + "description": "the next batch of results; see AggregationReply" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftCursorread(String index, Cursor cursor, int count)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + }, + { + "name": "count", + "type": "int", + "description": "the number of results to read; overrides the COUNT from FT.AGGREGATE" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the next batch of results; see AggregationReply" + } + }, + { + "signature": "RedisFuture> ftCursorread(String index, Cursor cursor)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the next batch of results; see AggregationReply" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> ftCursorread(String index, Cursor cursor, int count)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + }, + { + "name": "count", + "type": "int", + "description": "the number of results to read; overrides the COUNT from FT.AGGREGATE" + } + ], + "returns": { + "type": "Mono>", + "description": "the next batch of results; see AggregationReply" + } + }, + { + "signature": "Mono> ftCursorread(String index, Cursor cursor)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "cursor", + "type": "Cursor", + "description": "the cursor obtained from a previous FT.AGGREGATE or FT.CURSOR READ command" + } + ], + "returns": { + "type": "Mono>", + "description": "the next batch of results; see AggregationReply" + } + } + ], "go-redis": [ { "signature": "FTCursorRead(ctx context.Context, index string, cursorId int, count int)", diff --git a/data/command-api-mapping/FT.DICTADD.json b/data/command-api-mapping/FT.DICTADD.json index 40ed927d7f..4ff8b8ac9b 100644 --- a/data/command-api-mapping/FT.DICTADD.json +++ b/data/command-api-mapping/FT.DICTADD.json @@ -42,9 +42,69 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "Long ftDictadd(String dict, String... terms)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the dictionary" + } + ], + "returns": { + "type": "Long", + "description": "the number of new terms that were added" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftDictadd(String dict, String... terms)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the dictionary" + } + ], + "returns": { + "type": "RedisFuture", + "description": "the number of new terms that were added" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftDictadd(String dict, String... terms)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the dictionary" + } + ], + "returns": { + "type": "Mono", + "description": "the number of new terms that were added" + } + } + ], "go-redis": [ { "signature": "FTDictAdd(ctx context.Context, dict string, terms ...interface{})", diff --git a/data/command-api-mapping/FT.DICTDEL.json b/data/command-api-mapping/FT.DICTDEL.json index 036eb29189..ff8308fe51 100644 --- a/data/command-api-mapping/FT.DICTDEL.json +++ b/data/command-api-mapping/FT.DICTDEL.json @@ -42,9 +42,69 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "Long ftDictdel(String dict, String... terms)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to delete from the dictionary" + } + ], + "returns": { + "type": "Long", + "description": "the number of terms that were deleted" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftDictdel(String dict, String... terms)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to delete from the dictionary" + } + ], + "returns": { + "type": "RedisFuture", + "description": "the number of terms that were deleted" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftDictdel(String dict, String... terms)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to delete from the dictionary" + } + ], + "returns": { + "type": "Mono", + "description": "the number of terms that were deleted" + } + } + ], "go-redis": [ { "signature": "FTDictDel(ctx context.Context, dict string, terms ...interface{})", diff --git a/data/command-api-mapping/FT.DICTDUMP.json b/data/command-api-mapping/FT.DICTDUMP.json index c703e1b3eb..161c2ba714 100644 --- a/data/command-api-mapping/FT.DICTDUMP.json +++ b/data/command-api-mapping/FT.DICTDUMP.json @@ -32,9 +32,54 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "List ftDictdump(String dict)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + } + ], + "returns": { + "type": "List", + "description": "a list of all terms in the dictionary" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftDictdump(String dict)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list of all terms in the dictionary" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux ftDictdump(String dict)", + "params": [ + { + "name": "dict", + "type": "String", + "description": "the dictionary name" + } + ], + "returns": { + "type": "Flux", + "description": "a list of all terms in the dictionary" + } + } + ], "go-redis": [ { "signature": "FTDictDump(ctx context.Context, dict string)", diff --git a/data/command-api-mapping/FT.DROPINDEX.json b/data/command-api-mapping/FT.DROPINDEX.json index f7dc73e0d7..11101fe27b 100644 --- a/data/command-api-mapping/FT.DROPINDEX.json +++ b/data/command-api-mapping/FT.DROPINDEX.json @@ -46,9 +46,111 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftDropindex(String index)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the index was successfully dropped" + } + }, + { + "signature": "String ftDropindex(String index, boolean deleteDocuments)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "deleteDocuments", + "type": "boolean", + "description": "if true, delete the indexed documents as well; if false, preserve documents" + } + ], + "returns": { + "type": "String", + "description": "\"OK\" if the index was successfully dropped" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftDropindex(String index)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the index was successfully dropped" + } + }, + { + "signature": "RedisFuture ftDropindex(String index, boolean deleteDocuments)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "deleteDocuments", + "type": "boolean", + "description": "if true, delete the indexed documents as well; if false, preserve documents" + } + ], + "returns": { + "type": "RedisFuture", + "description": "\"OK\" if the index was successfully dropped" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftDropindex(String index)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the index was successfully dropped" + } + }, + { + "signature": "Mono ftDropindex(String index, boolean deleteDocuments)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "deleteDocuments", + "type": "boolean", + "description": "if true, delete the indexed documents as well; if false, preserve documents" + } + ], + "returns": { + "type": "Mono", + "description": "\"OK\" if the index was successfully dropped" + } + } + ], "go-redis": [ { "signature": "FTDropIndex(ctx context.Context, index string)", diff --git a/data/command-api-mapping/FT.EXPLAIN.json b/data/command-api-mapping/FT.EXPLAIN.json index ea2d5b0149..c0d472bcd2 100644 --- a/data/command-api-mapping/FT.EXPLAIN.json +++ b/data/command-api-mapping/FT.EXPLAIN.json @@ -37,9 +37,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftExplain(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "query", + "type": "String", + "description": "the search query to explain" + } + ], + "returns": { + "type": "String", + "description": "the execution plan as a string" + } + }, + { + "signature": "String ftExplain(String index, String query, ExplainArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "query", + "type": "String", + "description": "the search query to explain" + }, + { + "name": "args", + "type": "ExplainArgs", + "description": "the explain arguments (dialect)" + } + ], + "returns": { + "type": "String", + "description": "the execution plan as a string" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftExplain(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "query", + "type": "String", + "description": "the search query to explain" + } + ], + "returns": { + "type": "RedisFuture", + "description": "the execution plan as a string" + } + }, + { + "signature": "RedisFuture ftExplain(String index, String query, ExplainArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "query", + "type": "String", + "description": "the search query to explain" + }, + { + "name": "args", + "type": "ExplainArgs", + "description": "the explain arguments (dialect)" + } + ], + "returns": { + "type": "RedisFuture", + "description": "the execution plan as a string" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftExplain(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "query", + "type": "String", + "description": "the search query to explain" + } + ], + "returns": { + "type": "Mono", + "description": "the execution plan as a string" + } + }, + { + "signature": "Mono ftExplain(String index, String query, ExplainArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "query", + "type": "String", + "description": "the search query to explain" + }, + { + "name": "args", + "type": "ExplainArgs", + "description": "the explain arguments (dialect)" + } + ], + "returns": { + "type": "Mono", + "description": "the execution plan as a string" + } + } + ], "go-redis": [ { "signature": "FTExplain(ctx context.Context, index string, query string)", diff --git a/data/command-api-mapping/FT.HYBRID.json b/data/command-api-mapping/FT.HYBRID.json index 7c189e7d8f..538dcf8f98 100644 --- a/data/command-api-mapping/FT.HYBRID.json +++ b/data/command-api-mapping/FT.HYBRID.json @@ -1,12 +1,211 @@ { "api_calls": { - "redis_py": [], - "jedis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "go-redis": [], - "node_redis": [], + "redis_py": [ + { + "signature": "hybrid_search(query: HybridQuery, combine_method: Optional[CombineResultsMethod] = None, post_processing: Optional[HybridPostProcessingConfig] = None, params_substitution: Optional[Dict[str, Union[str, int, float, bytes]]] = None, timeout: Optional[int] = None, cursor: Optional[HybridCursorQuery] = None)", + "params": [ + { + "name": "query", + "type": "HybridQuery", + "description": "" + }, + { + "name": "combine_method", + "type": "Optional[CombineResultsMethod] = None", + "description": "" + }, + { + "name": "post_processing", + "type": "Optional[HybridPostProcessingConfig] = None", + "description": "" + }, + { + "name": "params_substitution", + "type": "Optional[Dict[str, Union[str, int, float, bytes]]] = None", + "description": "" + }, + { + "name": "timeout", + "type": "Optional[int] = None", + "description": "" + }, + { + "name": "cursor", + "type": "Optional[HybridCursorQuery] = None", + "description": "" + } + ], + "returns": { + "type": "Union[HybridResult, HybridCursorResult, Pipeline]", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "HybridResult ftHybrid(String indexName, FTHybridParams hybridParams)", + "params": [ + { + "name": "indexName", + "type": "String", + "description": "the index name" + }, + { + "name": "hybridParams", + "type": "FTHybridParams", + "description": "the hybrid query arguments" + } + ], + "returns": { + "type": "HybridResult", + "description": "the hybrid search results" + } + } + ], + "lettuce_sync": [ + { + "signature": "HybridReply ftHybrid(String index, HybridArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "args", + "type": "HybridArgs", + "description": "the hybrid query arguments" + } + ], + "returns": { + "type": "HybridReply", + "description": "the hybrid search results" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftHybrid(String index, HybridArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "args", + "type": "HybridArgs", + "description": "the hybrid query arguments" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the hybrid search results" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> ftHybrid(String index, HybridArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "args", + "type": "HybridArgs", + "description": "the hybrid query arguments" + } + ], + "returns": { + "type": "Mono>", + "description": "the hybrid search results" + } + } + ], + "go-redis": [ + { + "signature": "FTHybrid(ctx context.Context, index string, searchExpr string, vectorField string, vectorData Vector) *FTHybridCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "index", + "type": "string", + "description": "" + }, + { + "name": "searchExpr", + "type": "string", + "description": "" + }, + { + "name": "vectorField", + "type": "string", + "description": "" + }, + { + "name": "vectorData", + "type": "Vector", + "description": "" + } + ], + "returns": { + "type": "*FTHybridCmd", + "description": "" + } + }, + { + "signature": "FTHybridWithArgs(ctx context.Context, index string, options *FTHybridOptions) *FTHybridCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "index", + "type": "string", + "description": "" + }, + { + "name": "options", + "type": "*FTHybridOptions", + "description": "" + } + ], + "returns": { + "type": "*FTHybridCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "client.ft.hybrid(index: RedisArgument, options: FtHybridOptions)", + "params": [ + { + "name": "index", + "type": "RedisArgument", + "description": "" + }, + { + "name": "options", + "type": "FtHybridOptions", + "description": "" + } + ], + "returns": { + "type": "HybridSearchResult", + "description": "" + } + } + ], "ioredis": [], "redis_rs_sync": [], "redis_rs_async": [], diff --git a/data/command-api-mapping/FT.SEARCH.json b/data/command-api-mapping/FT.SEARCH.json index 3ecb272f73..8abc00d41f 100644 --- a/data/command-api-mapping/FT.SEARCH.json +++ b/data/command-api-mapping/FT.SEARCH.json @@ -66,9 +66,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "SearchReply ftSearch(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the query string following RediSearch query syntax" + } + ], + "returns": { + "type": "SearchReply", + "description": "the result of the search command containing matching documents, see SearchReply" + } + }, + { + "signature": "SearchReply ftSearch(String index, String query, SearchArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the query string following RediSearch query syntax" + }, + { + "name": "args", + "type": "SearchArgs", + "description": "the search arguments containing advanced options and filters" + } + ], + "returns": { + "type": "SearchReply", + "description": "the result of the search command containing matching documents and metadata, see SearchReply" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftSearch(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the query string following RediSearch query syntax" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the result of the search command containing matching documents, see SearchReply" + } + }, + { + "signature": "RedisFuture> ftSearch(String index, String query, SearchArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the query string following RediSearch query syntax" + }, + { + "name": "args", + "type": "SearchArgs", + "description": "the search arguments containing advanced options and filters" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "the result of the search command containing matching documents and metadata, see SearchReply" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> ftSearch(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the query string following RediSearch query syntax" + } + ], + "returns": { + "type": "Mono>", + "description": "the result of the search command containing matching documents, see SearchReply" + } + }, + { + "signature": "Mono> ftSearch(String index, String query, SearchArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name, as a key" + }, + { + "name": "query", + "type": "String", + "description": "the query string following RediSearch query syntax" + }, + { + "name": "args", + "type": "SearchArgs", + "description": "the search arguments containing advanced options and filters" + } + ], + "returns": { + "type": "Mono>", + "description": "the result of the search command containing matching documents and metadata, see SearchReply" + } + } + ], "go-redis": [ { "signature": "FTSearch(ctx context.Context, index string, query string)", diff --git a/data/command-api-mapping/FT.SPELLCHECK.json b/data/command-api-mapping/FT.SPELLCHECK.json index e360296de0..7165626a88 100644 --- a/data/command-api-mapping/FT.SPELLCHECK.json +++ b/data/command-api-mapping/FT.SPELLCHECK.json @@ -76,9 +76,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "SpellCheckResult ftSpellcheck(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index with the indexed terms" + }, + { + "name": "query", + "type": "String", + "description": "the search query to check for spelling errors" + } + ], + "returns": { + "type": "SpellCheckResult", + "description": "spell check result containing misspelled terms and their suggestions" + } + }, + { + "signature": "SpellCheckResult ftSpellcheck(String index, String query, SpellCheckArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index with the indexed terms" + }, + { + "name": "query", + "type": "String", + "description": "the search query to check for spelling errors" + }, + { + "name": "args", + "type": "SpellCheckArgs", + "description": "the spellcheck arguments (distance, terms, dialect)" + } + ], + "returns": { + "type": "SpellCheckResult", + "description": "spell check result containing misspelled terms and their suggestions" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftSpellcheck(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index with the indexed terms" + }, + { + "name": "query", + "type": "String", + "description": "the search query to check for spelling errors" + } + ], + "returns": { + "type": "RedisFuture", + "description": "spell check result containing misspelled terms and their suggestions" + } + }, + { + "signature": "RedisFuture ftSpellcheck(String index, String query, SpellCheckArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index with the indexed terms" + }, + { + "name": "query", + "type": "String", + "description": "the search query to check for spelling errors" + }, + { + "name": "args", + "type": "SpellCheckArgs", + "description": "the spellcheck arguments (distance, terms, dialect)" + } + ], + "returns": { + "type": "RedisFuture", + "description": "spell check result containing misspelled terms and their suggestions" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftSpellcheck(String index, String query)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index with the indexed terms" + }, + { + "name": "query", + "type": "String", + "description": "the search query to check for spelling errors" + } + ], + "returns": { + "type": "Mono", + "description": "spell check result containing misspelled terms and their suggestions" + } + }, + { + "signature": "Mono ftSpellcheck(String index, String query, SpellCheckArgs args)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index with the indexed terms" + }, + { + "name": "query", + "type": "String", + "description": "the search query to check for spelling errors" + }, + { + "name": "args", + "type": "SpellCheckArgs", + "description": "the spellcheck arguments (distance, terms, dialect)" + } + ], + "returns": { + "type": "Mono", + "description": "spell check result containing misspelled terms and their suggestions" + } + } + ], "go-redis": [ { "signature": "FTSpellCheck(ctx context.Context, index string, query string)", diff --git a/data/command-api-mapping/FT.SUGADD.json b/data/command-api-mapping/FT.SUGADD.json index d8b782b926..7650e0b317 100644 --- a/data/command-api-mapping/FT.SUGADD.json +++ b/data/command-api-mapping/FT.SUGADD.json @@ -71,9 +71,171 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "Long ftSugadd(K key, String suggestion, double score)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to index" + }, + { + "name": "score", + "type": "double", + "description": "the floating point number of the suggestion string's weight" + } + ], + "returns": { + "type": "Long", + "description": "the current size of the suggestion dictionary after adding the suggestion" + } + }, + { + "signature": "Long ftSugadd(K key, String suggestion, double score, SugAddArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to index" + }, + { + "name": "score", + "type": "double", + "description": "the floating point number of the suggestion string's weight" + }, + { + "name": "args", + "type": "SugAddArgs", + "description": "the suggestion add arguments (INCR, deprecated PAYLOAD)" + } + ], + "returns": { + "type": "Long", + "description": "the current size of the suggestion dictionary after adding the suggestion" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftSugadd(K key, String suggestion, double score)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to index" + }, + { + "name": "score", + "type": "double", + "description": "the floating point number of the suggestion string's weight" + } + ], + "returns": { + "type": "RedisFuture", + "description": "the current size of the suggestion dictionary after adding the suggestion" + } + }, + { + "signature": "RedisFuture ftSugadd(K key, String suggestion, double score, SugAddArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to index" + }, + { + "name": "score", + "type": "double", + "description": "the floating point number of the suggestion string's weight" + }, + { + "name": "args", + "type": "SugAddArgs", + "description": "the suggestion add arguments (INCR, deprecated PAYLOAD)" + } + ], + "returns": { + "type": "RedisFuture", + "description": "the current size of the suggestion dictionary after adding the suggestion" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftSugadd(K key, String suggestion, double score)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to index" + }, + { + "name": "score", + "type": "double", + "description": "the floating point number of the suggestion string's weight" + } + ], + "returns": { + "type": "Mono", + "description": "the current size of the suggestion dictionary after adding the suggestion" + } + }, + { + "signature": "Mono ftSugadd(K key, String suggestion, double score, SugAddArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to index" + }, + { + "name": "score", + "type": "double", + "description": "the floating point number of the suggestion string's weight" + }, + { + "name": "args", + "type": "SugAddArgs", + "description": "the suggestion add arguments (INCR, deprecated PAYLOAD)" + } + ], + "returns": { + "type": "Mono", + "description": "the current size of the suggestion dictionary after adding the suggestion" + } + } + ], "go-redis": [ { "signature": "FTSugAdd(ctx context.Context, key string, suggestion string, score float64)", diff --git a/data/command-api-mapping/FT.SUGDEL.json b/data/command-api-mapping/FT.SUGDEL.json index cc9e54e38c..4d5ebb262b 100644 --- a/data/command-api-mapping/FT.SUGDEL.json +++ b/data/command-api-mapping/FT.SUGDEL.json @@ -42,9 +42,69 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "Boolean ftSugdel(K key, String suggestion)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to delete" + } + ], + "returns": { + "type": "Boolean", + "description": "true if the string was found and deleted, false otherwise" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftSugdel(K key, String suggestion)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to delete" + } + ], + "returns": { + "type": "RedisFuture", + "description": "true if the string was found and deleted, false otherwise" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftSugdel(K key, String suggestion)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "suggestion", + "type": "String", + "description": "the suggestion string to delete" + } + ], + "returns": { + "type": "Mono", + "description": "true if the string was found and deleted, false otherwise" + } + } + ], "go-redis": [ { "signature": "FTSugDel(ctx context.Context, key string, suggestion string)", diff --git a/data/command-api-mapping/FT.SUGGET.json b/data/command-api-mapping/FT.SUGGET.json index 5abf3638af..d2497ddc35 100644 --- a/data/command-api-mapping/FT.SUGGET.json +++ b/data/command-api-mapping/FT.SUGGET.json @@ -86,9 +86,141 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "List ftSugget(K key, String prefix)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "prefix", + "type": "String", + "description": "the prefix to complete on" + } + ], + "returns": { + "type": "List", + "description": "a list of suggestions matching the prefix" + } + }, + { + "signature": "List ftSugget(K key, String prefix, SugGetArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "prefix", + "type": "String", + "description": "the prefix to complete on" + }, + { + "name": "args", + "type": "SugGetArgs", + "description": "the suggestion get arguments (FUZZY, WITHSCORES, deprecated WITHPAYLOADS, MAX)" + } + ], + "returns": { + "type": "List", + "description": "a list of suggestions matching the prefix, optionally with scores and payloads" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftSugget(K key, String prefix)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "prefix", + "type": "String", + "description": "the prefix to complete on" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list of suggestions matching the prefix" + } + }, + { + "signature": "RedisFuture> ftSugget(K key, String prefix, SugGetArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "prefix", + "type": "String", + "description": "the prefix to complete on" + }, + { + "name": "args", + "type": "SugGetArgs", + "description": "the suggestion get arguments (FUZZY, WITHSCORES, deprecated WITHPAYLOADS, MAX)" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list of suggestions matching the prefix, optionally with scores and payloads" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux ftSugget(K key, String prefix)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "prefix", + "type": "String", + "description": "the prefix to complete on" + } + ], + "returns": { + "type": "Flux", + "description": "a list of suggestions matching the prefix" + } + }, + { + "signature": "Flux ftSugget(K key, String prefix, SugGetArgs args)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + }, + { + "name": "prefix", + "type": "String", + "description": "the prefix to complete on" + }, + { + "name": "args", + "type": "SugGetArgs", + "description": "the suggestion get arguments (FUZZY, WITHSCORES, deprecated WITHPAYLOADS, MAX)" + } + ], + "returns": { + "type": "Flux", + "description": "a list of suggestions matching the prefix, optionally with scores and payloads" + } + } + ], "go-redis": [ { "signature": "FTSugGet(ctx context.Context, key string, prefix string)", diff --git a/data/command-api-mapping/FT.SUGLEN.json b/data/command-api-mapping/FT.SUGLEN.json index 859803fcfa..405c628369 100644 --- a/data/command-api-mapping/FT.SUGLEN.json +++ b/data/command-api-mapping/FT.SUGLEN.json @@ -32,9 +32,54 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "Long ftSuglen(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + } + ], + "returns": { + "type": "Long", + "description": "the current size of the suggestion dictionary" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftSuglen(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + } + ], + "returns": { + "type": "RedisFuture", + "description": "the current size of the suggestion dictionary" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftSuglen(K key)", + "params": [ + { + "name": "key", + "type": "K", + "description": "the suggestion dictionary key" + } + ], + "returns": { + "type": "Mono", + "description": "the current size of the suggestion dictionary" + } + } + ], "go-redis": [ { "signature": "FTSugLen(ctx context.Context, key string)", diff --git a/data/command-api-mapping/FT.SYNDUMP.json b/data/command-api-mapping/FT.SYNDUMP.json index fcd04ee5a4..468a1b8c74 100644 --- a/data/command-api-mapping/FT.SYNDUMP.json +++ b/data/command-api-mapping/FT.SYNDUMP.json @@ -26,9 +26,54 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "Map> ftSyndump(String index)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + } + ], + "returns": { + "type": "Map>", + "description": "a map where keys are synonym terms and values are lists of group IDs containing that synonym" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture>> ftSyndump(String index)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + } + ], + "returns": { + "type": "RedisFuture>>", + "description": "a map where keys are synonym terms and values are lists of group IDs containing that synonym" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono>> ftSyndump(String index)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + } + ], + "returns": { + "type": "Mono>>", + "description": "a map where keys are synonym terms and values are lists of group IDs containing that synonym" + } + } + ], "go-redis": [ { "signature": "FTSynDump(ctx context.Context, index string)", diff --git a/data/command-api-mapping/FT.SYNUPDATE.json b/data/command-api-mapping/FT.SYNUPDATE.json index 1a3e63a9db..85825327c0 100644 --- a/data/command-api-mapping/FT.SYNUPDATE.json +++ b/data/command-api-mapping/FT.SYNUPDATE.json @@ -52,9 +52,171 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "String ftSynupdate(String index, String synonymGroupId, String... terms)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "synonymGroupId", + "type": "String", + "description": "the synonym group identifier" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the synonym group" + } + ], + "returns": { + "type": "String", + "description": "OK if executed correctly" + } + }, + { + "signature": "String ftSynupdate(String index, String synonymGroupId, SynUpdateArgs args, String... terms)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "synonymGroupId", + "type": "String", + "description": "the synonym group identifier" + }, + { + "name": "args", + "type": "SynUpdateArgs", + "description": "the synupdate arguments (skipInitialScan)" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the synonym group" + } + ], + "returns": { + "type": "String", + "description": "OK if executed correctly" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ftSynupdate(String index, String synonymGroupId, String... terms)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "synonymGroupId", + "type": "String", + "description": "the synonym group identifier" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the synonym group" + } + ], + "returns": { + "type": "RedisFuture", + "description": "OK if executed correctly" + } + }, + { + "signature": "RedisFuture ftSynupdate(String index, String synonymGroupId, SynUpdateArgs args, String... terms)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "synonymGroupId", + "type": "String", + "description": "the synonym group identifier" + }, + { + "name": "args", + "type": "SynUpdateArgs", + "description": "the synupdate arguments (skipInitialScan)" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the synonym group" + } + ], + "returns": { + "type": "RedisFuture", + "description": "OK if executed correctly" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ftSynupdate(String index, String synonymGroupId, String... terms)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "synonymGroupId", + "type": "String", + "description": "the synonym group identifier" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the synonym group" + } + ], + "returns": { + "type": "Mono", + "description": "OK if executed correctly" + } + }, + { + "signature": "Mono ftSynupdate(String index, String synonymGroupId, SynUpdateArgs args, String... terms)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name" + }, + { + "name": "synonymGroupId", + "type": "String", + "description": "the synonym group identifier" + }, + { + "name": "args", + "type": "SynUpdateArgs", + "description": "the synupdate arguments (skipInitialScan)" + }, + { + "name": "terms", + "type": "String...", + "description": "the terms to add to the synonym group" + } + ], + "returns": { + "type": "Mono", + "description": "OK if executed correctly" + } + } + ], "go-redis": [ { "signature": "FTSynUpdate(ctx context.Context, index string, synGroupId interface{}, terms ...interface{})", diff --git a/data/command-api-mapping/FT.TAGVALS.json b/data/command-api-mapping/FT.TAGVALS.json index 2838253513..9bf28b9cd2 100644 --- a/data/command-api-mapping/FT.TAGVALS.json +++ b/data/command-api-mapping/FT.TAGVALS.json @@ -37,9 +37,69 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "List ftTagvals(String index, String fieldName)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name containing the tag field" + }, + { + "name": "fieldName", + "type": "String", + "description": "the name of the Tag field defined in the index schema" + } + ], + "returns": { + "type": "List", + "description": "a list of all distinct values indexed in the specified tag field. The list contains the raw tag values as they were indexed (lowercase, whitespace removed)." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftTagvals(String index, String fieldName)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name containing the tag field" + }, + { + "name": "fieldName", + "type": "String", + "description": "the name of the Tag field defined in the index schema" + } + ], + "returns": { + "type": "RedisFuture>", + "description": "a list of all distinct values indexed in the specified tag field. The list contains the raw tag values as they were indexed (lowercase, whitespace removed)." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux ftTagvals(String index, String fieldName)", + "params": [ + { + "name": "index", + "type": "String", + "description": "the index name containing the tag field" + }, + { + "name": "fieldName", + "type": "String", + "description": "the name of the Tag field defined in the index schema" + } + ], + "returns": { + "type": "Flux", + "description": "a list of all distinct values indexed in the specified tag field. The list contains the raw tag values as they were indexed (lowercase, whitespace removed)." + } + } + ], "go-redis": [ { "signature": "FTTagVals(ctx context.Context, index string, field string)", diff --git a/data/command-api-mapping/FT._LIST.json b/data/command-api-mapping/FT._LIST.json index 1e7a5b935c..8d0db295ee 100644 --- a/data/command-api-mapping/FT._LIST.json +++ b/data/command-api-mapping/FT._LIST.json @@ -20,9 +20,36 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "lettuce_sync": [ + { + "signature": "List ftList()", + "params": [], + "returns": { + "type": "List", + "description": "a list of index names" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> ftList()", + "params": [], + "returns": { + "type": "RedisFuture>", + "description": "a list of index names" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux ftList()", + "params": [], + "returns": { + "type": "Flux", + "description": "a list of index names" + } + } + ], "go-redis": [ { "signature": "FT_List(ctx context.Context)", diff --git a/data/command-api-mapping/FUNCTION DELETE.json b/data/command-api-mapping/FUNCTION DELETE.json index 78a6bffd52..df0a275637 100644 --- a/data/command-api-mapping/FUNCTION DELETE.json +++ b/data/command-api-mapping/FUNCTION DELETE.json @@ -78,7 +78,22 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "delete(string $libraryName)", + "params": [ + { + "name": "$libraryName", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "Status", + "description": "" + } + } + ] } } diff --git a/data/command-api-mapping/FUNCTION DUMP.json b/data/command-api-mapping/FUNCTION DUMP.json index 548a6995e6..7f7895e786 100644 --- a/data/command-api-mapping/FUNCTION DUMP.json +++ b/data/command-api-mapping/FUNCTION DUMP.json @@ -10,7 +10,16 @@ } } ], - "jedis": [], + "jedis": [ + { + "signature": "byte[] functionDump()", + "params": [], + "returns": { + "type": "byte[]", + "description": "the serialized payload" + } + } + ], "go-redis": [ { "signature": "FunctionDump(ctx context.Context)", @@ -73,7 +82,16 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "dump()", + "params": [], + "returns": { + "type": "string", + "description": "" + } + } + ] } } diff --git a/data/command-api-mapping/FUNCTION FLUSH.json b/data/command-api-mapping/FUNCTION FLUSH.json index 2178831771..0e73519c0d 100644 --- a/data/command-api-mapping/FUNCTION FLUSH.json +++ b/data/command-api-mapping/FUNCTION FLUSH.json @@ -126,7 +126,22 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "flush(?string $mode = null)", + "params": [ + { + "name": "$mode", + "type": "?string", + "description": "" + } + ], + "returns": { + "type": "Status", + "description": "" + } + } + ] } } diff --git a/data/command-api-mapping/FUNCTION KILL.json b/data/command-api-mapping/FUNCTION KILL.json index 80d77a3886..080167caa8 100644 --- a/data/command-api-mapping/FUNCTION KILL.json +++ b/data/command-api-mapping/FUNCTION KILL.json @@ -82,7 +82,16 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "kill()", + "params": [], + "returns": { + "type": "Status", + "description": "" + } + } + ] } } diff --git a/data/command-api-mapping/FUNCTION LIST.json b/data/command-api-mapping/FUNCTION LIST.json index a7d7cb9f60..a3976febc7 100644 --- a/data/command-api-mapping/FUNCTION LIST.json +++ b/data/command-api-mapping/FUNCTION LIST.json @@ -182,7 +182,27 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "list(string $libraryNamePattern = null, bool $withCode = false)", + "params": [ + { + "name": "$libraryNamePattern", + "type": "string", + "description": "" + }, + { + "name": "$withCode", + "type": "bool", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ] } } diff --git a/data/command-api-mapping/FUNCTION LOAD.json b/data/command-api-mapping/FUNCTION LOAD.json index 4f1a11387a..a7e7329d9c 100644 --- a/data/command-api-mapping/FUNCTION LOAD.json +++ b/data/command-api-mapping/FUNCTION LOAD.json @@ -223,7 +223,27 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "load(string $functionCode, bool $replace = false)", + "params": [ + { + "name": "$functionCode", + "type": "string", + "description": "" + }, + { + "name": "$replace", + "type": "bool", + "description": "" + } + ], + "returns": { + "type": "string", + "description": "" + } + } + ] } } diff --git a/data/command-api-mapping/FUNCTION RESTORE.json b/data/command-api-mapping/FUNCTION RESTORE.json index 84bc0cc9f4..a3b1554141 100644 --- a/data/command-api-mapping/FUNCTION RESTORE.json +++ b/data/command-api-mapping/FUNCTION RESTORE.json @@ -209,7 +209,27 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "restore(string $value, string $policy = null)", + "params": [ + { + "name": "$value", + "type": "string", + "description": "" + }, + { + "name": "$policy", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "Status", + "description": "" + } + } + ] } } diff --git a/data/command-api-mapping/FUNCTION STATS.json b/data/command-api-mapping/FUNCTION STATS.json index 1189998acb..4d94fbad97 100644 --- a/data/command-api-mapping/FUNCTION STATS.json +++ b/data/command-api-mapping/FUNCTION STATS.json @@ -55,7 +55,16 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "stats()", + "params": [], + "returns": { + "type": "array", + "description": "" + } + } + ] } } diff --git a/data/command-api-mapping/HELLO.json b/data/command-api-mapping/HELLO.json index c8a4323e00..3d2f8f38ce 100644 --- a/data/command-api-mapping/HELLO.json +++ b/data/command-api-mapping/HELLO.json @@ -32,8 +32,63 @@ } ], "jedis": [], - "go-redis": [], - "node_redis": [], + "go-redis": [ + { + "signature": "Hello(ctx context.Context, ver int, username, password, clientName string) *MapStringInterfaceCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "ver", + "type": "int", + "description": "" + }, + { + "name": "username", + "type": "string", + "description": "" + }, + { + "name": "password", + "type": "string", + "description": "" + }, + { + "name": "clientName", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "*MapStringInterfaceCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "hello(protover?: RespVersions, options?: HelloOptions)", + "params": [ + { + "name": "protover", + "type": "RespVersions", + "description": "" + }, + { + "name": "options", + "type": "HelloOptions", + "description": "" + } + ], + "returns": { + "type": "HelloReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], diff --git a/data/command-api-mapping/HOTKEYS.json b/data/command-api-mapping/HOTKEYS.json index 270392c116..579a13d744 100644 --- a/data/command-api-mapping/HOTKEYS.json +++ b/data/command-api-mapping/HOTKEYS.json @@ -1,12 +1,312 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "hotkeys_start(metrics: List[HotkeysMetricsTypes], count: int | None = None, duration: int | None = None, sample_ratio: int | None = None, slots: List[int] | None = None, **kwargs)", + "params": [ + { + "name": "metrics", + "type": "List[HotkeysMetricsTypes]", + "description": "" + }, + { + "name": "count", + "type": "int | None = None", + "description": "" + }, + { + "name": "duration", + "type": "int | None = None", + "description": "" + }, + { + "name": "sample_ratio", + "type": "int | None = None", + "description": "" + }, + { + "name": "slots", + "type": "List[int] | None = None", + "description": "" + }, + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "bytes | str", + "description": "" + } + }, + { + "signature": "hotkeys_stop(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "bytes | str", + "description": "" + } + }, + { + "signature": "hotkeys_reset(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "bytes | str", + "description": "" + } + }, + { + "signature": "hotkeys_get(**kwargs)", + "params": [ + { + "name": "**kwargs", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "list[dict[str | bytes, Any]]", + "description": "" + } + } + ], "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "go-redis": [ + { + "signature": "HotKeysStart(ctx context.Context, args *HotKeysStartArgs) *StatusCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "args", + "type": "*HotKeysStartArgs", + "description": "" + } + ], + "returns": { + "type": "*StatusCmd", + "description": "" + } + }, + { + "signature": "HotKeysStop(ctx context.Context) *StatusCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*StatusCmd", + "description": "" + } + }, + { + "signature": "HotKeysReset(ctx context.Context) *StatusCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*StatusCmd", + "description": "" + } + }, + { + "signature": "HotKeysGet(ctx context.Context) *HotKeysCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + } + ], + "returns": { + "type": "*HotKeysCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "hotkeysStart(options: HotkeysStartOptions)", + "params": [ + { + "name": "options", + "type": "HotkeysStartOptions", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + }, + { + "signature": "hotkeysStop()", + "params": [], + "returns": { + "type": "SimpleStringReply<'OK'> | NullReply", + "description": "" + } + }, + { + "signature": "hotkeysReset()", + "params": [], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + }, + { + "signature": "hotkeysGet()", + "params": [], + "returns": { + "type": "HotkeysGetReply | null", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "String hotkeysStart(HotkeysArgs args)", + "params": [ + { + "name": "args", + "type": "HotkeysArgs", + "description": "tracking arguments." + } + ], + "returns": { + "type": "String", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "String hotkeysStop()", + "params": [], + "returns": { + "type": "String", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "String hotkeysReset()", + "params": [], + "returns": { + "type": "String", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "HotkeysReply hotkeysGet()", + "params": [], + "returns": { + "type": "HotkeysReply", + "description": "HotkeysReply with tracking data, or null if no tracking session." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture hotkeysStart(HotkeysArgs args)", + "params": [ + { + "name": "args", + "type": "HotkeysArgs", + "description": "tracking arguments." + } + ], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "RedisFuture hotkeysStop()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "RedisFuture hotkeysReset()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "RedisFuture hotkeysGet()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "HotkeysReply with tracking data, or null if no tracking session." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono hotkeysStart(HotkeysArgs args)", + "params": [ + { + "name": "args", + "type": "HotkeysArgs", + "description": "tracking arguments." + } + ], + "returns": { + "type": "Mono", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "Mono hotkeysStop()", + "params": [], + "returns": { + "type": "Mono", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "Mono hotkeysReset()", + "params": [], + "returns": { + "type": "Mono", + "description": "String simple-string-reply OK." + } + }, + { + "signature": "Mono hotkeysGet()", + "params": [], + "returns": { + "type": "Mono", + "description": "HotkeysReply with tracking data, or null if no tracking session." + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], "php": [], diff --git a/data/command-api-mapping/INFO.json b/data/command-api-mapping/INFO.json index 929e2e52b0..8991d4ce3e 100644 --- a/data/command-api-mapping/INFO.json +++ b/data/command-api-mapping/INFO.json @@ -159,8 +159,86 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "IGrouping>[] Info(RedisValue section = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "section", + "type": "RedisValue", + "description": "The info section to get, if getting a specific one." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "IGrouping>[]", + "description": "A grouping of key/value pairs, grouped by their section header." + } + }, + { + "signature": "string? InfoRaw(RedisValue section = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "section", + "type": "RedisValue", + "description": "The info section to get, if getting a specific one." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "string?", + "description": "The entire raw INFO string." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task>[]> InfoAsync(RedisValue section = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "section", + "type": "RedisValue", + "description": "The info section to get, if getting a specific one." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task>[]>", + "description": "A grouping of key/value pairs, grouped by their section header." + } + }, + { + "signature": "Task InfoRawAsync(RedisValue section = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "section", + "type": "RedisValue", + "description": "The info section to get, if getting a specific one." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The entire raw INFO string." + } + } + ], "php": [ { "signature": "info(string ...$section = null)", diff --git a/data/command-api-mapping/LASTSAVE.json b/data/command-api-mapping/LASTSAVE.json index 50983c5e2a..ada67eabe4 100644 --- a/data/command-api-mapping/LASTSAVE.json +++ b/data/command-api-mapping/LASTSAVE.json @@ -82,8 +82,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "DateTime LastSave(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "DateTime", + "description": "The last time a save was performed." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task LastSaveAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The last time a save was performed." + } + } + ], "php": [ { "signature": "lastsave()", diff --git a/data/command-api-mapping/LATENCY DOCTOR.json b/data/command-api-mapping/LATENCY DOCTOR.json index 339fdcf6a4..332287b965 100644 --- a/data/command-api-mapping/LATENCY DOCTOR.json +++ b/data/command-api-mapping/LATENCY DOCTOR.json @@ -40,8 +40,38 @@ "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "string LatencyDoctor(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "string", + "description": "The full text result of latency doctor." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task LatencyDoctorAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "The full text result of latency doctor." + } + } + ], "php": [ { "signature": "latency(string $subcommand, ...$args)", diff --git a/data/command-api-mapping/LATENCY HISTOGRAM.json b/data/command-api-mapping/LATENCY HISTOGRAM.json index 0895728053..878e571a6c 100644 --- a/data/command-api-mapping/LATENCY HISTOGRAM.json +++ b/data/command-api-mapping/LATENCY HISTOGRAM.json @@ -23,7 +23,22 @@ ], "jedis": [], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "latencyHistogram(...commands: string[])", + "params": [ + { + "name": "...commands", + "type": "string[]", + "description": "" + } + ], + "returns": { + "type": "Record }>", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], diff --git a/data/command-api-mapping/LATENCY HISTORY.json b/data/command-api-mapping/LATENCY HISTORY.json index c55dbda97d..59a6e4ec7f 100644 --- a/data/command-api-mapping/LATENCY HISTORY.json +++ b/data/command-api-mapping/LATENCY HISTORY.json @@ -77,8 +77,48 @@ "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "LatencyHistoryEntry[] LatencyHistory(string eventName, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "eventName", + "type": "string", + "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "LatencyHistoryEntry[]", + "description": "An array of latency history entries." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task LatencyHistoryAsync(string eventName, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "eventName", + "type": "string", + "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "An array of latency history entries." + } + } + ], "php": [ { "signature": "latency(string $subcommand, ...$args)", diff --git a/data/command-api-mapping/LATENCY LATEST.json b/data/command-api-mapping/LATENCY LATEST.json index 206fcd1e16..e5a0603fee 100644 --- a/data/command-api-mapping/LATENCY LATEST.json +++ b/data/command-api-mapping/LATENCY LATEST.json @@ -55,8 +55,38 @@ "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "LatencyLatestEntry[] LatencyLatest(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "LatencyLatestEntry[]", + "description": "An array of the latest latency history entries." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task LatencyLatestAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "An array of the latest latency history entries." + } + } + ], "php": [ { "signature": "latency(string $subcommand, ...$args)", diff --git a/data/command-api-mapping/LATENCY RESET.json b/data/command-api-mapping/LATENCY RESET.json index f45203ea17..d257b00d97 100644 --- a/data/command-api-mapping/LATENCY RESET.json +++ b/data/command-api-mapping/LATENCY RESET.json @@ -85,8 +85,48 @@ "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "long LatencyReset(string[]? eventNames = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "eventNames", + "type": "string[]?", + "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "The number of events that were reset." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task LatencyResetAsync(string[]? eventNames = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "eventNames", + "type": "string[]?", + "description": "" + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "The number of events that were reset." + } + } + ], "php": [ { "signature": "latency(string $subcommand, ...$args)", diff --git a/data/command-api-mapping/LOLWUT.json b/data/command-api-mapping/LOLWUT.json index 4e22ffc5b9..f8a591f6cd 100644 --- a/data/command-api-mapping/LOLWUT.json +++ b/data/command-api-mapping/LOLWUT.json @@ -56,7 +56,27 @@ } ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "LOLWUT(version?: number, ...optionalArguments: Array)", + "params": [ + { + "name": "version", + "type": "number", + "description": "" + }, + { + "name": "...optionalArguments", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "BlobStringReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], diff --git a/data/command-api-mapping/MEMORY DOCTOR.json b/data/command-api-mapping/MEMORY DOCTOR.json index 6b2e6f78f3..f878d2d0ac 100644 --- a/data/command-api-mapping/MEMORY DOCTOR.json +++ b/data/command-api-mapping/MEMORY DOCTOR.json @@ -27,12 +27,51 @@ } ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "memoryDoctor()", + "params": [], + "returns": { + "type": "BlobStringReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "string MemoryDoctor(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "string", + "description": "The full text result of memory doctor." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task MemoryDoctorAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "The full text result of memory doctor." + } + } + ], "php": [ { "signature": "memory(string $subcommand, ...$args)", diff --git a/data/command-api-mapping/MEMORY MALLOC-STATS.json b/data/command-api-mapping/MEMORY MALLOC-STATS.json index 1d0b9c569d..2a8ab337c7 100644 --- a/data/command-api-mapping/MEMORY MALLOC-STATS.json +++ b/data/command-api-mapping/MEMORY MALLOC-STATS.json @@ -27,12 +27,51 @@ } ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "memoryMallocStats()", + "params": [], + "returns": { + "type": "BlobStringReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "string? MemoryAllocatorStats(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "string?", + "description": "The full text result of memory allocation stats." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task MemoryAllocatorStatsAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "The full text result of memory allocation stats." + } + } + ], "php": [ { "signature": "memory(string $subcommand, ...$args)", diff --git a/data/command-api-mapping/MEMORY PURGE.json b/data/command-api-mapping/MEMORY PURGE.json index 8613cc9e80..fe7e0743ff 100644 --- a/data/command-api-mapping/MEMORY PURGE.json +++ b/data/command-api-mapping/MEMORY PURGE.json @@ -42,12 +42,51 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "memoryPurge()", + "params": [], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void MemoryPurge(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task MemoryPurgeAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "memory(string $subcommand, ...$args)", diff --git a/data/command-api-mapping/MEMORY STATS.json b/data/command-api-mapping/MEMORY STATS.json index 0802d1dbf5..e5a0d1ce2e 100644 --- a/data/command-api-mapping/MEMORY STATS.json +++ b/data/command-api-mapping/MEMORY STATS.json @@ -82,8 +82,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "RedisResult MemoryStats(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "RedisResult", + "description": "An array reply of memory stat metrics and values." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task MemoryStatsAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "An array reply of memory stat metrics and values." + } + } + ], "php": [ { "signature": "memory(string $subcommand, ...$args)", diff --git a/data/command-api-mapping/MODULE LIST.json b/data/command-api-mapping/MODULE LIST.json index 6433a1c3fd..998fe5f0cf 100644 --- a/data/command-api-mapping/MODULE LIST.json +++ b/data/command-api-mapping/MODULE LIST.json @@ -42,7 +42,16 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "moduleList()", + "params": [], + "returns": { + "type": "ModuleListReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], diff --git a/data/command-api-mapping/MODULE LOAD.json b/data/command-api-mapping/MODULE LOAD.json index 9ca27db414..255ea0fd51 100644 --- a/data/command-api-mapping/MODULE LOAD.json +++ b/data/command-api-mapping/MODULE LOAD.json @@ -68,7 +68,27 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "moduleLoad(path: RedisArgument, moduleArguments?: Array)", + "params": [ + { + "name": "path", + "type": "RedisArgument", + "description": "" + }, + { + "name": "moduleArguments", + "type": "Array", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], diff --git a/data/command-api-mapping/MODULE LOADEX.json b/data/command-api-mapping/MODULE LOADEX.json index 7752ba73d2..8be16a589e 100644 --- a/data/command-api-mapping/MODULE LOADEX.json +++ b/data/command-api-mapping/MODULE LOADEX.json @@ -52,7 +52,27 @@ } } ], - "go-redis": [], + "go-redis": [ + { + "signature": "ModuleLoadex(ctx context.Context, conf *ModuleLoadexConfig) *StringCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "conf", + "type": "*ModuleLoadexConfig", + "description": "" + } + ], + "returns": { + "type": "*StringCmd", + "description": "" + } + } + ], "node_redis": [], "lettuce_sync": [], "lettuce_async": [], diff --git a/data/command-api-mapping/MODULE UNLOAD.json b/data/command-api-mapping/MODULE UNLOAD.json index ecb52f4096..e48c4636e3 100644 --- a/data/command-api-mapping/MODULE UNLOAD.json +++ b/data/command-api-mapping/MODULE UNLOAD.json @@ -58,7 +58,22 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "moduleUnload(name: RedisArgument)", + "params": [ + { + "name": "name", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], diff --git a/data/command-api-mapping/MONITOR.json b/data/command-api-mapping/MONITOR.json index 14aeea1b0a..b945100a8d 100644 --- a/data/command-api-mapping/MONITOR.json +++ b/data/command-api-mapping/MONITOR.json @@ -26,8 +26,43 @@ } } ], - "go-redis": [], - "node_redis": [], + "go-redis": [ + { + "signature": "Monitor(ctx context.Context, ch chan string) *MonitorCmd", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "ch", + "type": "chan string", + "description": "" + } + ], + "returns": { + "type": "*MonitorCmd", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "monitor(callback: MonitorCallback)", + "params": [ + { + "name": "callback", + "type": "MonitorCallback", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], diff --git a/data/command-api-mapping/PING.json b/data/command-api-mapping/PING.json index dd52e1e5c8..29a4dca867 100644 --- a/data/command-api-mapping/PING.json +++ b/data/command-api-mapping/PING.json @@ -77,11 +77,68 @@ } } ], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "lettuce_sync": [ + { + "signature": "String ping()", + "params": [], + "returns": { + "type": "String", + "description": "String simple-string-reply." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ping()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ping()", + "params": [], + "returns": { + "type": "Mono", + "description": "String simple-string-reply." + } + } + ], + "nredisstack_sync": [ + { + "signature": "TimeSpan Ping(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use when pinging." + } + ], + "returns": { + "type": "TimeSpan", + "description": "The observed latency." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task PingAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The observed latency." + } + } + ], "php": [ { "signature": "ping(?string $message = null)", @@ -98,8 +155,54 @@ } } ], - "redis_rs_sync": [], - "redis_rs_async": [] + "redis_rs_sync": [ + { + "signature": "ping()", + "params": [], + "returns": { + "type": "(String)", + "description": "" + } + }, + { + "signature": "ping_message(message: K)", + "params": [ + { + "name": "message", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(String)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "ping()", + "params": [], + "returns": { + "type": "(String)", + "description": "" + } + }, + { + "signature": "ping_message(message: K)", + "params": [ + { + "name": "message", + "type": "K", + "description": "" + } + ], + "returns": { + "type": "(String)", + "description": "" + } + } + ] } } diff --git a/data/command-api-mapping/PSUBSCRIBE.json b/data/command-api-mapping/PSUBSCRIBE.json index 1c5a0a515d..faac614a22 100644 --- a/data/command-api-mapping/PSUBSCRIBE.json +++ b/data/command-api-mapping/PSUBSCRIBE.json @@ -1,6 +1,26 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "psubscribe(*args: ChannelT | Subscription, **kwargs: PubSubHandler)", + "params": [ + { + "name": "*args", + "type": "ChannelT | Subscription", + "description": "" + }, + { + "name": "**kwargs", + "type": "PubSubHandler", + "description": "" + } + ], + "returns": { + "type": "None", + "description": "" + } + } + ], "jedis": [ { "signature": "void psubscribe(BinaryJedisPubSub jedisPubSub, final byte[]... patterns)", @@ -41,18 +61,279 @@ } } ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "go-redis": [ + { + "signature": "(*Client).PSubscribe(ctx context.Context, channels ...string) *PubSub", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "channels", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*PubSub", + "description": "" + } + }, + { + "signature": "(*PubSub).PSubscribe(ctx context.Context, patterns ...string) error", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "patterns", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "error", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "pSubscribe(patterns: string | Array, listener: PubSubListener, bufferMode?: T)", + "params": [ + { + "name": "patterns", + "type": "string | Array", + "description": "" + }, + { + "name": "listener", + "type": "PubSubListener", + "description": "" + }, + { + "name": "bufferMode", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "void psubscribe(K... patterns)", + "params": [ + { + "name": "patterns", + "type": "K...", + "description": "the patterns" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture psubscribe(K... patterns)", + "params": [ + { + "name": "patterns", + "type": "K...", + "description": "the patterns" + } + ], + "returns": { + "type": "RedisFuture", + "description": "RedisFuture Future to synchronize psubscribe completion" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono psubscribe(K... patterns)", + "params": [ + { + "name": "patterns", + "type": "K...", + "description": "the patterns." + } + ], + "returns": { + "type": "Mono", + "description": "Mono Mono for psubscribe command." + } + } + ], "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_sync": [ + { + "signature": "psubscribe(pchannel: T)", + "params": [ + { + "name": "pchannel", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + }, + { + "signature": "psubscribe(pattern: P, func: F)", + "params": [ + { + "name": "pattern", + "type": "P", + "description": "" + }, + { + "name": "func", + "type": "F", + "description": "" + } + ], + "returns": { + "type": "RedisResult", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "psubscribe(channel_pattern: impl ToRedisArgs)", + "params": [ + { + "name": "channel_pattern", + "type": "impl ToRedisArgs", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], + "nredisstack_sync": [ + { + "signature": "void Subscribe(RedisChannel channel, Action handler, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to subscribe to." + }, + { + "name": "handler", + "type": "Action", + "description": "The handler to invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "ChannelMessageQueue Subscribe(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The redis channel to subscribe to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "ChannelMessageQueue", + "description": "A channel that represents this source." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SubscribeAsync(RedisChannel channel, Action handler, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to subscribe to." + }, + { + "name": "handler", + "type": "Action", + "description": "The handler to invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task SubscribeAsync(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The redis channel to subscribe to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "A channel that represents this source." + } + } + ], + "php": [ + { + "signature": "psubscribe(...$pattern)", + "params": [ + { + "name": "$pattern", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], "redis_rb": [ { "signature": "psubscribe(*channels, &block)", diff --git a/data/command-api-mapping/PSYNC.json b/data/command-api-mapping/PSYNC.json index 270392c116..62f1356607 100644 --- a/data/command-api-mapping/PSYNC.json +++ b/data/command-api-mapping/PSYNC.json @@ -1,6 +1,26 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "psync(replicationid: str, offset: int)", + "params": [ + { + "name": "replicationid", + "type": "str", + "description": "" + }, + { + "name": "offset", + "type": "int", + "description": "" + } + ], + "returns": { + "type": "bytes", + "description": "" + } + } + ], "jedis": [], "go-redis": [], "node_redis": [], diff --git a/data/command-api-mapping/PUBLISH.json b/data/command-api-mapping/PUBLISH.json index 69a6bfb0f6..d6c53d0885 100644 --- a/data/command-api-mapping/PUBLISH.json +++ b/data/command-api-mapping/PUBLISH.json @@ -92,13 +92,133 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "publish(channel: RedisArgument, message: RedisArgument)", + "params": [ + { + "name": "channel", + "type": "RedisArgument", + "description": "" + }, + { + "name": "message", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Long publish(K channel, V message)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "the channel type: key." + }, + { + "name": "message", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "Long", + "description": "Long integer-reply the number of clients that received the message." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture publish(K channel, V message)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "the channel type: key." + }, + { + "name": "message", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Long integer-reply the number of clients that received the message." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono publish(K channel, V message)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "the channel type: key." + }, + { + "name": "message", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "Mono", + "description": "Long integer-reply the number of clients that received the message." + } + } + ], "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_sync": [ + { + "signature": "publish(channel: K, message: E)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "" + }, + { + "name": "message", + "type": "E", + "description": "" + } + ], + "returns": { + "type": "(usize)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "publish(channel: K, message: E)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "" + }, + { + "name": "message", + "type": "E", + "description": "" + } + ], + "returns": { + "type": "(usize)", + "description": "" + } + } + ], "redisvl": [], "nredisstack_sync": [ { diff --git a/data/command-api-mapping/PUBSUB CHANNELS.json b/data/command-api-mapping/PUBSUB CHANNELS.json index ddfc03caa2..dae72450f3 100644 --- a/data/command-api-mapping/PUBSUB CHANNELS.json +++ b/data/command-api-mapping/PUBSUB CHANNELS.json @@ -66,16 +66,140 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "pubSubChannels(pattern?: RedisArgument)", + "params": [ + { + "name": "pattern", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List pubsubChannels()", + "params": [], + "returns": { + "type": "List", + "description": "List array-reply a list of active channels, optionally matching the specified pattern." + } + }, + { + "signature": "List pubsubChannels(K channel)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "List", + "description": "List array-reply a list of active channels, optionally matching the specified pattern." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> pubsubChannels()", + "params": [], + "returns": { + "type": "RedisFuture>", + "description": "List array-reply a list of active channels, optionally matching the specified pattern." + } + }, + { + "signature": "RedisFuture> pubsubChannels(K channel)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "List array-reply a list of active channels, optionally matching the specified pattern." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux pubsubChannels()", + "params": [], + "returns": { + "type": "Flux", + "description": "K array-reply a list of active channels, optionally matching the specified pattern." + } + }, + { + "signature": "Flux pubsubChannels(K channel)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "the key." + } + ], + "returns": { + "type": "Flux", + "description": "K array-reply a list of active channels, optionally matching the specified pattern." + } + } + ], "ioredis": [], "redis_rs_sync": [], "redis_rs_async": [], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "RedisChannel[] SubscriptionChannels(RedisChannel pattern = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "pattern", + "type": "RedisChannel", + "description": "The channel name pattern to get channels for." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "RedisChannel[]", + "description": "a list of active channels, optionally matching the specified pattern." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SubscriptionChannelsAsync(RedisChannel pattern = default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "pattern", + "type": "RedisChannel", + "description": "The channel name pattern to get channels for." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "a list of active channels, optionally matching the specified pattern." + } + } + ], "php": [ { "signature": "pubsub($subcommand, $argument)", diff --git a/data/command-api-mapping/PUBSUB HELP.json b/data/command-api-mapping/PUBSUB HELP.json index d7735ee858..c82f9e2744 100644 --- a/data/command-api-mapping/PUBSUB HELP.json +++ b/data/command-api-mapping/PUBSUB HELP.json @@ -13,7 +13,27 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "pubsub($subcommand, $argument)", + "params": [ + { + "name": "$subcommand", + "type": "mixed", + "description": "" + }, + { + "name": "$argument", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "mixed", + "description": "" + } + } + ] } } diff --git a/data/command-api-mapping/PUBSUB NUMPAT.json b/data/command-api-mapping/PUBSUB NUMPAT.json index e009b8b6b9..e4ec0a1f29 100644 --- a/data/command-api-mapping/PUBSUB NUMPAT.json +++ b/data/command-api-mapping/PUBSUB NUMPAT.json @@ -42,16 +42,82 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "pubSubNumPat()", + "params": [], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Long pubsubNumpat()", + "params": [], + "returns": { + "type": "Long", + "description": "Long integer-reply the number of patterns all the clients are subscribed to." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture pubsubNumpat()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "Long integer-reply the number of patterns all the clients are subscribed to." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono pubsubNumpat()", + "params": [], + "returns": { + "type": "Mono", + "description": "Long integer-reply the number of patterns all the clients are subscribed to." + } + } + ], "ioredis": [], "redis_rs_sync": [], "redis_rs_async": [], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "long SubscriptionPatternCount(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "long", + "description": "the number of patterns all the clients are subscribed to." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SubscriptionPatternCountAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "the number of patterns all the clients are subscribed to." + } + } + ], "php": [ { "signature": "pubsub($subcommand, $argument)", diff --git a/data/command-api-mapping/PUBSUB NUMSUB.json b/data/command-api-mapping/PUBSUB NUMSUB.json index f6d181959b..ca0d5ce607 100644 --- a/data/command-api-mapping/PUBSUB NUMSUB.json +++ b/data/command-api-mapping/PUBSUB NUMSUB.json @@ -58,16 +58,116 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "pubSubNumSub(channels?: RedisVariadicArgument)", + "params": [ + { + "name": "channels", + "type": "RedisVariadicArgument", + "description": "" + } + ], + "returns": { + "type": "Record", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Map pubsubNumsub(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "channel keys." + } + ], + "returns": { + "type": "Map", + "description": "array-reply a list of channels and number of subscribers for every channel." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> pubsubNumsub(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "channel keys." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "array-reply a list of channels and number of subscribers for every channel." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> pubsubNumsub(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "channel keys." + } + ], + "returns": { + "type": "Mono>", + "description": "array-reply a list of channels and number of subscribers for every channel." + } + } + ], "ioredis": [], "redis_rs_sync": [], "redis_rs_async": [], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "long SubscriptionSubscriberCount(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to get a subscriber count for." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "long", + "description": "The number of subscribers on this server." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SubscriptionSubscriberCountAsync(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to get a subscriber count for." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The number of subscribers on this server." + } + } + ], "php": [ { "signature": "pubsub($subcommand, $argument)", diff --git a/data/command-api-mapping/PUBSUB SHARDCHANNELS.json b/data/command-api-mapping/PUBSUB SHARDCHANNELS.json index 38fa675237..7a7dcd21b2 100644 --- a/data/command-api-mapping/PUBSUB SHARDCHANNELS.json +++ b/data/command-api-mapping/PUBSUB SHARDCHANNELS.json @@ -66,10 +66,94 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "pubSubShardChannels(pattern?: RedisArgument)", + "params": [ + { + "name": "pattern", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "ArrayReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "List pubsubShardChannels()", + "params": [], + "returns": { + "type": "List", + "description": "List array-reply a list of active channels." + } + }, + { + "signature": "List pubsubShardChannels(K pattern)", + "params": [ + { + "name": "pattern", + "type": "K", + "description": "the pattern type: patternkey (pattern)." + } + ], + "returns": { + "type": "List", + "description": "List array-reply a list of active channels, optionally matching the specified pattern." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> pubsubShardChannels()", + "params": [], + "returns": { + "type": "RedisFuture>", + "description": "List array-reply a list of active channels." + } + }, + { + "signature": "RedisFuture> pubsubShardChannels(K pattern)", + "params": [ + { + "name": "pattern", + "type": "K", + "description": "the pattern type: patternkey (pattern)." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "List array-reply a list of active channels, optionally matching the specified pattern." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Flux pubsubShardChannels()", + "params": [], + "returns": { + "type": "Flux", + "description": "K array-reply a list of active channels." + } + }, + { + "signature": "Flux pubsubShardChannels(K pattern)", + "params": [ + { + "name": "pattern", + "type": "K", + "description": "the pattern type: patternkey (pattern)." + } + ], + "returns": { + "type": "Flux", + "description": "K array-reply a list of active channels, optionally matching the specified pattern." + } + } + ], "ioredis": [], "redis_rs_sync": [], "redis_rs_async": [], diff --git a/data/command-api-mapping/PUBSUB SHARDNUMSUB.json b/data/command-api-mapping/PUBSUB SHARDNUMSUB.json index d324fd38b3..39c2c13f0e 100644 --- a/data/command-api-mapping/PUBSUB SHARDNUMSUB.json +++ b/data/command-api-mapping/PUBSUB SHARDNUMSUB.json @@ -58,10 +58,70 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "pubSubShardNumSub(channels?: RedisVariadicArgument)", + "params": [ + { + "name": "channels", + "type": "RedisVariadicArgument", + "description": "" + } + ], + "returns": { + "type": "Record", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Map pubsubShardNumsub(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "channel keys." + } + ], + "returns": { + "type": "Map", + "description": "array-reply a list of channels and number of subscribers for every channel." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture> pubsubShardNumsub(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "channel keys." + } + ], + "returns": { + "type": "RedisFuture>", + "description": "array-reply a list of channels and number of subscribers for every channel." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono> pubsubShardNumsub(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "channel keys." + } + ], + "returns": { + "type": "Mono>", + "description": "array-reply a list of channels and number of subscribers for every channel." + } + } + ], "ioredis": [], "redis_rs_sync": [], "redis_rs_async": [], diff --git a/data/command-api-mapping/PUNSUBSCRIBE.json b/data/command-api-mapping/PUNSUBSCRIBE.json index eab9b8dcd2..7c3811b1bf 100644 --- a/data/command-api-mapping/PUNSUBSCRIBE.json +++ b/data/command-api-mapping/PUNSUBSCRIBE.json @@ -1,19 +1,284 @@ { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "redis_py": [ + { + "signature": "punsubscribe(*args)", + "params": [ + { + "name": "*args", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "None", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "void punsubscribe()", + "params": [], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void punsubscribe(byte[]... patterns)", + "params": [ + { + "name": "patterns", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void punsubscribe(String... patterns)", + "params": [ + { + "name": "patterns", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "(*PubSub).PUnsubscribe(ctx context.Context, patterns ...string) error", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "patterns", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "error", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "pUnsubscribe(patterns?: string | Array, listener?: PubSubListener, bufferMode?: T)", + "params": [ + { + "name": "patterns", + "type": "string | Array", + "description": "" + }, + { + "name": "listener", + "type": "PubSubListener", + "description": "" + }, + { + "name": "bufferMode", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "void punsubscribe(K... patterns)", + "params": [ + { + "name": "patterns", + "type": "K...", + "description": "the patterns" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture punsubscribe(K... patterns)", + "params": [ + { + "name": "patterns", + "type": "K...", + "description": "the patterns" + } + ], + "returns": { + "type": "RedisFuture", + "description": "RedisFuture Future to synchronize punsubscribe completion" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono punsubscribe(K... patterns)", + "params": [ + { + "name": "patterns", + "type": "K...", + "description": "the patterns." + } + ], + "returns": { + "type": "Mono", + "description": "Mono Mono for punsubscribe command." + } + } + ], "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_sync": [ + { + "signature": "punsubscribe(pchannel: T)", + "params": [ + { + "name": "pchannel", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "punsubscribe(channel_pattern: impl ToRedisArgs)", + "params": [ + { + "name": "channel_pattern", + "type": "impl ToRedisArgs", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], + "nredisstack_sync": [ + { + "signature": "void Unsubscribe(RedisChannel channel, Action? handler = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel that was subscribed to." + }, + { + "name": "handler", + "type": "Action?", + "description": "The handler to no longer invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void UnsubscribeAll(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task UnsubscribeAsync(RedisChannel channel, Action? handler = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel that was subscribed to." + }, + { + "name": "handler", + "type": "Action?", + "description": "The handler to no longer invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task UnsubscribeAllAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], + "php": [ + { + "signature": "punsubscribe(...$pattern)", + "params": [ + { + "name": "$pattern", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], "redis_rb": [ { "signature": "punsubscribe(*channels)", diff --git a/data/command-api-mapping/QUIT.json b/data/command-api-mapping/QUIT.json index 520fa22d4a..6fdff01143 100644 --- a/data/command-api-mapping/QUIT.json +++ b/data/command-api-mapping/QUIT.json @@ -27,13 +27,58 @@ } ], "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "quit()", + "params": [], + "returns": { + "type": "string", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "String quit()", + "params": [], + "returns": { + "type": "String", + "description": "String simple-string-reply always OK." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture quit()", + "params": [], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply always OK." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono quit()", + "params": [], + "returns": { + "type": "Mono", + "description": "String simple-string-reply always OK." + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], - "php": [], + "php": [ + { + "signature": "quit()", + "params": [], + "returns": { + "type": "void", + "description": "" + } + } + ], "redis_rs_sync": [], "redis_rs_async": [] } diff --git a/data/command-api-mapping/REPLICAOF.json b/data/command-api-mapping/REPLICAOF.json index 82b5767546..a933d6ff24 100644 --- a/data/command-api-mapping/REPLICAOF.json +++ b/data/command-api-mapping/REPLICAOF.json @@ -81,7 +81,27 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "replicaOf(host: string, port: number)", + "params": [ + { + "name": "host", + "type": "string", + "description": "" + }, + { + "name": "port", + "type": "number", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String replicaof(String host, int port)", @@ -170,7 +190,27 @@ } ], "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_async": [ + { + "signature": "Task ReplicaOfAsync(EndPoint master, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "master", + "type": "EndPoint", + "description": "Endpoint of the new primary to replicate from." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "replicaof(string $host, int $port)", diff --git a/data/command-api-mapping/RESET.json b/data/command-api-mapping/RESET.json index 2c0a3f1910..5e184eb756 100644 --- a/data/command-api-mapping/RESET.json +++ b/data/command-api-mapping/RESET.json @@ -16,9 +16,27 @@ } } ], - "jedis": [], + "jedis": [ + { + "signature": "String reset()", + "params": [], + "returns": { + "type": "String", + "description": "" + } + } + ], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "reset()", + "params": [], + "returns": { + "type": "void", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], diff --git a/data/command-api-mapping/RESTORE-ASKING.json b/data/command-api-mapping/RESTORE-ASKING.json index 270392c116..a052989472 100644 --- a/data/command-api-mapping/RESTORE-ASKING.json +++ b/data/command-api-mapping/RESTORE-ASKING.json @@ -3,7 +3,16 @@ "redis_py": [], "jedis": [], "go-redis": [], - "node_redis": [], + "node_redis": [ + { + "signature": "restoreAsking()", + "params": [], + "returns": { + "type": "SimpleStringReply", + "description": "" + } + } + ], "lettuce_sync": [], "lettuce_async": [], "lettuce_reactive": [], diff --git a/data/command-api-mapping/ROLE.json b/data/command-api-mapping/ROLE.json index e1bc3b7e79..ed8d4dc277 100644 --- a/data/command-api-mapping/ROLE.json +++ b/data/command-api-mapping/ROLE.json @@ -82,8 +82,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "Role Role(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Role", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task RoleAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "" + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "role()", diff --git a/data/command-api-mapping/SAVE.json b/data/command-api-mapping/SAVE.json index 2bffa5dd54..f0774bb8e2 100644 --- a/data/command-api-mapping/SAVE.json +++ b/data/command-api-mapping/SAVE.json @@ -82,8 +82,48 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void Save(SaveType type, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "type", + "type": "SaveType", + "description": "The method of the save (e.g. background or foreground)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SaveAsync(SaveType type, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "type", + "type": "SaveType", + "description": "The method of the save (e.g. background or foreground)." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "save()", diff --git a/data/command-api-mapping/SCRIPT EXISTS.json b/data/command-api-mapping/SCRIPT EXISTS.json index e7f9052035..7a670fe7c4 100644 --- a/data/command-api-mapping/SCRIPT EXISTS.json +++ b/data/command-api-mapping/SCRIPT EXISTS.json @@ -135,8 +135,86 @@ "redis_rs_sync": [], "redis_rs_async": [], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "bool ScriptExists(string script, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "script", + "type": "string", + "description": "The text of the script to check for on the server." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "bool", + "description": "" + } + }, + { + "signature": "bool ScriptExists(byte[] sha1, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "sha1", + "type": "byte[]", + "description": "The SHA1 of the script to check for on the server." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "bool", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ScriptExistsAsync(string script, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "script", + "type": "string", + "description": "The text of the script to check for on the server." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task ScriptExistsAsync(byte[] sha1, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "sha1", + "type": "byte[]", + "description": "The SHA1 of the script to check for on the server." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "script($subcommand, $argument = null)", diff --git a/data/command-api-mapping/SCRIPT FLUSH.json b/data/command-api-mapping/SCRIPT FLUSH.json index 2c76de8a3a..3684dd9847 100644 --- a/data/command-api-mapping/SCRIPT FLUSH.json +++ b/data/command-api-mapping/SCRIPT FLUSH.json @@ -148,8 +148,38 @@ "redis_rs_sync": [], "redis_rs_async": [], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void ScriptFlush(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ScriptFlushAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "script($subcommand, $argument = null)", diff --git a/data/command-api-mapping/SCRIPT HELP.json b/data/command-api-mapping/SCRIPT HELP.json index d7735ee858..d674d3c42b 100644 --- a/data/command-api-mapping/SCRIPT HELP.json +++ b/data/command-api-mapping/SCRIPT HELP.json @@ -13,7 +13,27 @@ "redisvl": [], "nredisstack_sync": [], "nredisstack_async": [], - "php": [] + "php": [ + { + "signature": "script($subcommand, $argument = null)", + "params": [ + { + "name": "$subcommand", + "type": "mixed", + "description": "" + }, + { + "name": "$argument", + "type": "mixed", + "description": "" + } + ], + "returns": { + "type": "mixed", + "description": "" + } + } + ] } } diff --git a/data/command-api-mapping/SCRIPT LOAD.json b/data/command-api-mapping/SCRIPT LOAD.json index ab0d7d56d6..33cd557e41 100644 --- a/data/command-api-mapping/SCRIPT LOAD.json +++ b/data/command-api-mapping/SCRIPT LOAD.json @@ -160,11 +160,119 @@ } ], "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_sync": [ + { + "signature": "load_script(script: &'a crate::Script)", + "params": [ + { + "name": "script", + "type": "&'a crate::Script", + "description": "" + } + ], + "returns": { + "type": "Generic", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "load_script(script: &'a crate::Script)", + "params": [ + { + "name": "script", + "type": "&'a crate::Script", + "description": "" + } + ], + "returns": { + "type": "Generic", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "byte[] ScriptLoad(string script, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "script", + "type": "string", + "description": "The script to load." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "byte[]", + "description": "The SHA1 of the loaded script." + } + }, + { + "signature": "LoadedLuaScript ScriptLoad(LuaScript script, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "script", + "type": "LuaScript", + "description": "The script to load." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "LoadedLuaScript", + "description": "The loaded script, ready for rapid reuse based on the SHA1." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task ScriptLoadAsync(string script, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "script", + "type": "string", + "description": "The script to load." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The SHA1 of the loaded script." + } + }, + { + "signature": "Task ScriptLoadAsync(LuaScript script, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "script", + "type": "LuaScript", + "description": "The script to load." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The loaded script, ready for rapid reuse based on the SHA1." + } + } + ], "php": [ { "signature": "script($subcommand, $argument = null)", diff --git a/data/command-api-mapping/SELECT.json b/data/command-api-mapping/SELECT.json index eac64fa579..635efde9bf 100644 --- a/data/command-api-mapping/SELECT.json +++ b/data/command-api-mapping/SELECT.json @@ -58,10 +58,70 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "select(db: number)", + "params": [ + { + "name": "db", + "type": "number", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "String select(int db)", + "params": [ + { + "name": "db", + "type": "int", + "description": "the database number" + } + ], + "returns": { + "type": "String", + "description": "String simple-string-reply" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture select(int db)", + "params": [ + { + "name": "db", + "type": "int", + "description": "the database number" + } + ], + "returns": { + "type": "RedisFuture", + "description": "String simple-string-reply" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono select(int db)", + "params": [ + { + "name": "db", + "type": "int", + "description": "the database number" + } + ], + "returns": { + "type": "Mono", + "description": "String simple-string-reply" + } + } + ], "nredisstack_sync": [], "nredisstack_async": [], "php": [ diff --git a/data/command-api-mapping/SHUTDOWN.json b/data/command-api-mapping/SHUTDOWN.json index 07fc8bccc7..d0c5552732 100644 --- a/data/command-api-mapping/SHUTDOWN.json +++ b/data/command-api-mapping/SHUTDOWN.json @@ -195,7 +195,27 @@ } } ], - "nredisstack_sync": [], + "nredisstack_sync": [ + { + "signature": "void Shutdown(ShutdownMode shutdownMode = ShutdownMode.Default, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "shutdownMode", + "type": "ShutdownMode", + "description": "The mode of the shutdown." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], "nredisstack_async": [], "php": [ { diff --git a/data/command-api-mapping/SLOWLOG GET.json b/data/command-api-mapping/SLOWLOG GET.json index a1d1ab5aae..72a4b624b7 100644 --- a/data/command-api-mapping/SLOWLOG GET.json +++ b/data/command-api-mapping/SLOWLOG GET.json @@ -139,8 +139,48 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "CommandTrace[] SlowlogGet(int count = 0, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "count", + "type": "int", + "description": "The count of items to get." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "CommandTrace[]", + "description": "The slow command traces as recorded by the Redis server." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SlowlogGetAsync(int count = 0, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "count", + "type": "int", + "description": "The count of items to get." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The slow command traces as recorded by the Redis server." + } + } + ], "php": [ { "signature": "slowlog(string $operation, ?int $length = null)", diff --git a/data/command-api-mapping/SLOWLOG RESET.json b/data/command-api-mapping/SLOWLOG RESET.json index 49997bc623..eb4a2b9a96 100644 --- a/data/command-api-mapping/SLOWLOG RESET.json +++ b/data/command-api-mapping/SLOWLOG RESET.json @@ -73,8 +73,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void SlowlogReset(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SlowlogResetAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "slowlog(string $operation, ?int $length = null)", diff --git a/data/command-api-mapping/SPUBLISH.json b/data/command-api-mapping/SPUBLISH.json index 83b1309c17..5d108761e9 100644 --- a/data/command-api-mapping/SPUBLISH.json +++ b/data/command-api-mapping/SPUBLISH.json @@ -21,7 +21,46 @@ } } ], - "jedis": [], + "jedis": [ + { + "signature": "long spublish(byte[] channel, byte[] message)", + "params": [ + { + "name": "channel", + "type": "byte[]", + "description": "" + }, + { + "name": "message", + "type": "byte[]", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + }, + { + "signature": "long spublish(String channel, String message)", + "params": [ + { + "name": "channel", + "type": "String", + "description": "" + }, + { + "name": "message", + "type": "String", + "description": "" + } + ], + "returns": { + "type": "long", + "description": "" + } + } + ], "go-redis": [ { "signature": "SPublish(ctx context.Context, channel string, message interface{})", @@ -48,16 +87,186 @@ } } ], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "node_redis": [ + { + "signature": "sPublish(channel: RedisArgument, message: RedisArgument)", + "params": [ + { + "name": "channel", + "type": "RedisArgument", + "description": "" + }, + { + "name": "message", + "type": "RedisArgument", + "description": "" + } + ], + "returns": { + "type": "NumberReply", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "Long spublish(K shardChannel, V message)", + "params": [ + { + "name": "shardChannel", + "type": "K", + "description": "the shard channel type: key." + }, + { + "name": "message", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "Long", + "description": "Long integer-reply the number of clients that received the message." + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture spublish(K shardChannel, V message)", + "params": [ + { + "name": "shardChannel", + "type": "K", + "description": "the shard channel type: key." + }, + { + "name": "message", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "RedisFuture", + "description": "Long integer-reply the number of clients that received the message." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono spublish(K shardChannel, V message)", + "params": [ + { + "name": "shardChannel", + "type": "K", + "description": "the shard channel type: key." + }, + { + "name": "message", + "type": "V", + "description": "the message type: value." + } + ], + "returns": { + "type": "Mono", + "description": "Long integer-reply the number of clients that received the message." + } + } + ], "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_sync": [ + { + "signature": "spublish(channel: K, message: E)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "" + }, + { + "name": "message", + "type": "E", + "description": "" + } + ], + "returns": { + "type": "(usize)", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "spublish(channel: K, message: E)", + "params": [ + { + "name": "channel", + "type": "K", + "description": "" + }, + { + "name": "message", + "type": "E", + "description": "" + } + ], + "returns": { + "type": "(usize)", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "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*, note that this doesn't mean much in a cluster as clients can get the message through other nodes." + } + } + ], + "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 publish." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The number of clients that received the message *on the destination server*, note that this doesn't mean much in a cluster as clients can get the message through other nodes." + } + } + ], "php": [ { "signature": "spublish(string $shardChannel, string $message)", diff --git a/data/command-api-mapping/SSUBSCRIBE.json b/data/command-api-mapping/SSUBSCRIBE.json index 110dfd20c5..1f1657d6af 100644 --- a/data/command-api-mapping/SSUBSCRIBE.json +++ b/data/command-api-mapping/SSUBSCRIBE.json @@ -1,18 +1,294 @@ { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "redis_py": [ + { + "signature": "ssubscribe(*args: ChannelT | Subscription, target_node: Any = None, **kwargs: PubSubHandler)", + "params": [ + { + "name": "*args", + "type": "ChannelT | Subscription", + "description": "" + }, + { + "name": "target_node", + "type": "Any = None", + "description": "" + }, + { + "name": "**kwargs", + "type": "PubSubHandler", + "description": "" + } + ], + "returns": { + "type": "None", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "void ssubscribe(BinaryJedisShardedPubSub jedisPubSub, byte[]... channels)", + "params": [ + { + "name": "jedisPubSub", + "type": "BinaryJedisShardedPubSub", + "description": "" + }, + { + "name": "channels", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void ssubscribe(JedisShardedPubSub jedisPubSub, String... channels)", + "params": [ + { + "name": "jedisPubSub", + "type": "JedisShardedPubSub", + "description": "" + }, + { + "name": "channels", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "(*Client).SSubscribe(ctx context.Context, channels ...string) *PubSub", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "channels", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*PubSub", + "description": "" + } + }, + { + "signature": "(*PubSub).SSubscribe(ctx context.Context, channels ...string) error", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "channels", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "error", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "sSubscribe(channels: string | Array, listener: PubSubListener, bufferMode?: T)", + "params": [ + { + "name": "channels", + "type": "string | Array", + "description": "" + }, + { + "name": "listener", + "type": "PubSubListener", + "description": "" + }, + { + "name": "bufferMode", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "void ssubscribe(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "the channels" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture ssubscribe(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "the shard channels" + } + ], + "returns": { + "type": "RedisFuture", + "description": "RedisFuture Future to synchronize subscribe completion" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono ssubscribe(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "the channels." + } + ], + "returns": { + "type": "Mono", + "description": "Mono Mono for subscribe command." + } + } + ], "ioredis": [], "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_async": [ + { + "signature": "ssubscribe(channel_name: impl ToRedisArgs)", + "params": [ + { + "name": "channel_name", + "type": "impl ToRedisArgs", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void Subscribe(RedisChannel channel, Action handler, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to subscribe to." + }, + { + "name": "handler", + "type": "Action", + "description": "The handler to invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "ChannelMessageQueue Subscribe(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The redis channel to subscribe to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "ChannelMessageQueue", + "description": "A channel that represents this source." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SubscribeAsync(RedisChannel channel, Action handler, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to subscribe to." + }, + { + "name": "handler", + "type": "Action", + "description": "The handler to invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task SubscribeAsync(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The redis channel to subscribe to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "A channel that represents this source." + } + } + ], "php": [ { "signature": "ssubscribe(string ...$shardChannels)", diff --git a/data/command-api-mapping/SUBSCRIBE.json b/data/command-api-mapping/SUBSCRIBE.json index 6dc63c8e9a..6a3c3ad434 100644 --- a/data/command-api-mapping/SUBSCRIBE.json +++ b/data/command-api-mapping/SUBSCRIBE.json @@ -1,6 +1,26 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "subscribe(*args: ChannelT | Subscription, **kwargs: PubSubHandler)", + "params": [ + { + "name": "*args", + "type": "ChannelT | Subscription", + "description": "" + }, + { + "name": "**kwargs", + "type": "PubSubHandler", + "description": "" + } + ], + "returns": { + "type": "None", + "description": "" + } + } + ], "jedis": [ { "signature": "void subscribe(BinaryJedisPubSub jedisPubSub, final byte[]... channels)", @@ -41,18 +61,279 @@ } } ], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "go-redis": [ + { + "signature": "(*Client).Subscribe(ctx context.Context, channels ...string) *PubSub", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "channels", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "*PubSub", + "description": "" + } + }, + { + "signature": "(*PubSub).Subscribe(ctx context.Context, channels ...string) error", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "channels", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "error", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "subscribe(channels: string | Array, listener: PubSubListener, bufferMode?: T)", + "params": [ + { + "name": "channels", + "type": "string | Array", + "description": "" + }, + { + "name": "listener", + "type": "PubSubListener", + "description": "" + }, + { + "name": "bufferMode", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "void subscribe(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "the channels" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture subscribe(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "the channels" + } + ], + "returns": { + "type": "RedisFuture", + "description": "RedisFuture Future to synchronize subscribe completion" + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono subscribe(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "the channels." + } + ], + "returns": { + "type": "Mono", + "description": "Mono Mono for subscribe command." + } + } + ], "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_sync": [ + { + "signature": "subscribe(channel: T)", + "params": [ + { + "name": "channel", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + }, + { + "signature": "subscribe(channel: C, func: F)", + "params": [ + { + "name": "channel", + "type": "C", + "description": "" + }, + { + "name": "func", + "type": "F", + "description": "" + } + ], + "returns": { + "type": "RedisResult", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "subscribe(channel_name: impl ToRedisArgs)", + "params": [ + { + "name": "channel_name", + "type": "impl ToRedisArgs", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], + "nredisstack_sync": [ + { + "signature": "void Subscribe(RedisChannel channel, Action handler, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to subscribe to." + }, + { + "name": "handler", + "type": "Action", + "description": "The handler to invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "ChannelMessageQueue Subscribe(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The redis channel to subscribe to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "ChannelMessageQueue", + "description": "A channel that represents this source." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SubscribeAsync(RedisChannel channel, Action handler, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel to subscribe to." + }, + { + "name": "handler", + "type": "Action", + "description": "The handler to invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task SubscribeAsync(RedisChannel channel, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The redis channel to subscribe to." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "A channel that represents this source." + } + } + ], + "php": [ + { + "signature": "subscribe(string ...$channels)", + "params": [ + { + "name": "$channels", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], "redis_rb": [ { "signature": "subscribe(*channels, &block)", diff --git a/data/command-api-mapping/SUNSUBSCRIBE.json b/data/command-api-mapping/SUNSUBSCRIBE.json index 0bb5cd2647..72c5e9bd9d 100644 --- a/data/command-api-mapping/SUNSUBSCRIBE.json +++ b/data/command-api-mapping/SUNSUBSCRIBE.json @@ -1,18 +1,230 @@ { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "redis_py": [ + { + "signature": "sunsubscribe(*args, target_node=None)", + "params": [ + { + "name": "*args", + "type": "Any", + "description": "" + }, + { + "name": "target_node", + "type": "Any = None", + "description": "" + } + ], + "returns": { + "type": "None", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "void sunsubscribe()", + "params": [], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void sunsubscribe(byte[]... channels)", + "params": [ + { + "name": "channels", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void sunsubscribe(String... channels)", + "params": [ + { + "name": "channels", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "(*PubSub).SUnsubscribe(ctx context.Context, channels ...string) error", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "channels", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "error", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "sUnsubscribe(channels?: string | Array, listener?: PubSubListener, bufferMode?: T)", + "params": [ + { + "name": "channels", + "type": "string | Array", + "description": "" + }, + { + "name": "listener", + "type": "PubSubListener", + "description": "" + }, + { + "name": "bufferMode", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "void sunsubscribe(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "the channels" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture sunsubscribe(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "the shard channels" + } + ], + "returns": { + "type": "RedisFuture", + "description": "RedisFuture Future to synchronize unsubscribe completion." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono sunsubscribe(K... shardChannels)", + "params": [ + { + "name": "shardChannels", + "type": "K...", + "description": "the channels." + } + ], + "returns": { + "type": "Mono", + "description": "Mono Mono for unsubscribe command." + } + } + ], "ioredis": [], "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_async": [ + { + "signature": "sunsubscribe(channel_name: impl ToRedisArgs)", + "params": [ + { + "name": "channel_name", + "type": "impl ToRedisArgs", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void Unsubscribe(RedisChannel channel, Action? handler = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel that was subscribed to." + }, + { + "name": "handler", + "type": "Action?", + "description": "The handler to no longer invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task UnsubscribeAsync(RedisChannel channel, Action? handler = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel that was subscribed to." + }, + { + "name": "handler", + "type": "Action?", + "description": "The handler to no longer invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "sunsubscribe(?string ...$shardChannels = null)", diff --git a/data/command-api-mapping/SWAPDB.json b/data/command-api-mapping/SWAPDB.json index 16d6f10f6a..c0489a7c66 100644 --- a/data/command-api-mapping/SWAPDB.json +++ b/data/command-api-mapping/SWAPDB.json @@ -73,7 +73,27 @@ } } ], - "node_redis": [], + "node_redis": [ + { + "signature": "swapDb(index1: number, index2: number)", + "params": [ + { + "name": "index1", + "type": "number", + "description": "" + }, + { + "name": "index2", + "type": "number", + "description": "" + } + ], + "returns": { + "type": "SimpleStringReply<'OK'>", + "description": "" + } + } + ], "lettuce_sync": [ { "signature": "String swapdb(int db1, int db2)", @@ -137,8 +157,58 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "void SwapDatabases(int first, int second, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "first", + "type": "int", + "description": "The ID of the first database." + }, + { + "name": "second", + "type": "int", + "description": "The ID of the second database." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task SwapDatabasesAsync(int first, int second, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "first", + "type": "int", + "description": "The ID of the first database." + }, + { + "name": "second", + "type": "int", + "description": "The ID of the second database." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], "php": [ { "signature": "swapdb(int $db1, int $db2)", diff --git a/data/command-api-mapping/SYNC.json b/data/command-api-mapping/SYNC.json index 270392c116..0fe6323649 100644 --- a/data/command-api-mapping/SYNC.json +++ b/data/command-api-mapping/SYNC.json @@ -1,6 +1,15 @@ { "api_calls": { - "redis_py": [], + "redis_py": [ + { + "signature": "sync()", + "params": [], + "returns": { + "type": "bytes", + "description": "" + } + } + ], "jedis": [], "go-redis": [], "node_redis": [], diff --git a/data/command-api-mapping/TIME.json b/data/command-api-mapping/TIME.json index 7adfe3284f..92c90eec22 100644 --- a/data/command-api-mapping/TIME.json +++ b/data/command-api-mapping/TIME.json @@ -82,8 +82,38 @@ } } ], - "nredisstack_sync": [], - "nredisstack_async": [], + "nredisstack_sync": [ + { + "signature": "DateTime Time(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "DateTime", + "description": "The server's current time." + } + } + ], + "nredisstack_async": [ + { + "signature": "Task TimeAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "The server's current time." + } + } + ], "php": [ { "signature": "time()", diff --git a/data/command-api-mapping/UNSUBSCRIBE.json b/data/command-api-mapping/UNSUBSCRIBE.json index 7ded2c07d9..aa09d1d6ea 100644 --- a/data/command-api-mapping/UNSUBSCRIBE.json +++ b/data/command-api-mapping/UNSUBSCRIBE.json @@ -1,19 +1,284 @@ { "api_calls": { - "redis_py": [], - "jedis": [], - "go-redis": [], - "node_redis": [], - "lettuce_sync": [], - "lettuce_async": [], - "lettuce_reactive": [], + "redis_py": [ + { + "signature": "unsubscribe(*args)", + "params": [ + { + "name": "*args", + "type": "Any", + "description": "" + } + ], + "returns": { + "type": "None", + "description": "" + } + } + ], + "jedis": [ + { + "signature": "void unsubscribe()", + "params": [], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void unsubscribe(byte[]... channels)", + "params": [ + { + "name": "channels", + "type": "byte[]...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void unsubscribe(String... channels)", + "params": [ + { + "name": "channels", + "type": "String...", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "go-redis": [ + { + "signature": "(*PubSub).Unsubscribe(ctx context.Context, channels ...string) error", + "params": [ + { + "name": "ctx", + "type": "context.Context", + "description": "Context" + }, + { + "name": "channels", + "type": "...string", + "description": "" + } + ], + "returns": { + "type": "error", + "description": "" + } + } + ], + "node_redis": [ + { + "signature": "unsubscribe(channels?: string | Array, listener?: PubSubListener, bufferMode?: T)", + "params": [ + { + "name": "channels", + "type": "string | Array", + "description": "" + }, + { + "name": "listener", + "type": "PubSubListener", + "description": "" + }, + { + "name": "bufferMode", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_sync": [ + { + "signature": "void unsubscribe(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "the channels" + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "lettuce_async": [ + { + "signature": "RedisFuture unsubscribe(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "the channels" + } + ], + "returns": { + "type": "RedisFuture", + "description": "RedisFuture Future to synchronize unsubscribe completion." + } + } + ], + "lettuce_reactive": [ + { + "signature": "Mono unsubscribe(K... channels)", + "params": [ + { + "name": "channels", + "type": "K...", + "description": "the channels." + } + ], + "returns": { + "type": "Mono", + "description": "Mono Mono for unsubscribe command." + } + } + ], "ioredis": [], - "redis_rs_sync": [], - "redis_rs_async": [], + "redis_rs_sync": [ + { + "signature": "unsubscribe(channel: T)", + "params": [ + { + "name": "channel", + "type": "T", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], + "redis_rs_async": [ + { + "signature": "unsubscribe(channel_name: impl ToRedisArgs)", + "params": [ + { + "name": "channel_name", + "type": "impl ToRedisArgs", + "description": "" + } + ], + "returns": { + "type": "RedisResult<()>", + "description": "" + } + } + ], "redisvl": [], - "nredisstack_sync": [], - "nredisstack_async": [], - "php": [], + "nredisstack_sync": [ + { + "signature": "void Unsubscribe(RedisChannel channel, Action? handler = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel that was subscribed to." + }, + { + "name": "handler", + "type": "Action?", + "description": "The handler to no longer invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + }, + { + "signature": "void UnsubscribeAll(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "void", + "description": "" + } + } + ], + "nredisstack_async": [ + { + "signature": "Task UnsubscribeAsync(RedisChannel channel, Action? handler = null, CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "channel", + "type": "RedisChannel", + "description": "The channel that was subscribed to." + }, + { + "name": "handler", + "type": "Action?", + "description": "The handler to no longer invoke when a message is received on channel." + }, + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + }, + { + "signature": "Task UnsubscribeAllAsync(CommandFlags flags = CommandFlags.None)", + "params": [ + { + "name": "flags", + "type": "CommandFlags", + "description": "The command flags to use." + } + ], + "returns": { + "type": "Task", + "description": "" + } + } + ], + "php": [ + { + "signature": "unsubscribe(string ...$channels)", + "params": [ + { + "name": "$channels", + "type": "string", + "description": "" + } + ], + "returns": { + "type": "array", + "description": "" + } + } + ], "redis_rb": [ { "signature": "unsubscribe(*channels)",