Skip to content

Commit

Permalink
update command metadata and module API ref from 7.2.0 release (#2517)
Browse files Browse the repository at this point in the history
  • Loading branch information
@oranagra
oranagra authored Aug 15, 2023
1 parent 037fe9f commit 93e1b6f
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 30 deletions.
18 changes: 8 additions & 10 deletions commands.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2816,7 +2816,7 @@
"summary": "Lists the replica nodes of a master node.",
"since": "5.0.0",
"group": "cluster",
"complexity": "O(1)",
"complexity": "O(N) where N is the number of replicas.",
"acl_categories": [
"@admin",
"@slow",
Expand Down Expand Up @@ -3016,7 +3016,7 @@
"summary": "Lists the replica nodes of a master node.",
"since": "3.0.0",
"group": "cluster",
"complexity": "O(1)",
"complexity": "O(N) where N is the number of replicas.",
"deprecated_since": "5.0.0",
"replaced_by": "`CLUSTER REPLICAS`",
"acl_categories": [
Expand Down Expand Up @@ -5005,7 +5005,7 @@
"summary": "Returns the distance between two members of a geospatial index.",
"since": "3.2.0",
"group": "geo",
"complexity": "O(log(N))",
"complexity": "O(1)",
"acl_categories": [
"@read",
"@geo",
Expand Down Expand Up @@ -5089,7 +5089,7 @@
"summary": "Returns members from a geospatial index as geohash strings.",
"since": "3.2.0",
"group": "geo",
"complexity": "O(log(N)) for each member requested, where N is the number of elements in the sorted set.",
"complexity": "O(1) for each member requested.",
"acl_categories": [
"@read",
"@geo",
Expand Down Expand Up @@ -5139,7 +5139,7 @@
"summary": "Returns the longitude and latitude of members from a geospatial index.",
"since": "3.2.0",
"group": "geo",
"complexity": "O(N) where N is the number of members requested.",
"complexity": "O(1) for each member requested.",
"acl_categories": [
"@read",
"@geo",
Expand Down Expand Up @@ -9677,10 +9677,6 @@
"command_flags": [
"write",
"denyoom"
],
"hints": [
"request_policy:multi_shard",
"response_policy:agg_min"
]
},
"MULTI": {
Expand Down Expand Up @@ -10835,6 +10831,7 @@
],
"hints": [
"request_policy:all_shards",
"response_policy:special",
"nondeterministic_output"
]
},
Expand Down Expand Up @@ -11680,7 +11677,8 @@
],
"hints": [
"nondeterministic_output",
"request_policy:special"
"request_policy:special",
"response_policy:special"
]
},
"SCARD": {
Expand Down
40 changes: 20 additions & 20 deletions docs/reference/modules/modules-api-ref.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ Returns `REDISMODULE_OK` on success and `REDISMODULE_ERR` in case of the followi
int RedisModule_SetCommandACLCategories(RedisModuleCommand *command,
const char *aclflags);

**Available since:** unreleased
**Available since:** 7.2.0

[`RedisModule_SetCommandACLCategories`](#RedisModule_SetCommandACLCategories) can be used to set ACL categories to module
commands and subcommands. The set of ACL categories should be passed as
Expand Down Expand Up @@ -805,7 +805,7 @@ Return counter of micro-seconds relative to an arbitrary point in time.

ustime_t RedisModule_Microseconds(void);

**Available since:** unreleased
**Available since:** 7.2.0

Return the current UNIX time in microseconds

Expand All @@ -815,7 +815,7 @@ Return the current UNIX time in microseconds

ustime_t RedisModule_CachedMicroseconds(void);

**Available since:** unreleased
**Available since:** 7.2.0

Return the cached UNIX time in microseconds.
It is updated in the server cron job and before executing a command.
Expand Down Expand Up @@ -1422,7 +1422,7 @@ The function always returns `REDISMODULE_OK`.
const char *fmt,
...);

**Available since:** unreleased
**Available since:** 7.2.0

Reply with the error create from a printf format and arguments.

Expand Down Expand Up @@ -2233,7 +2233,7 @@ Extra flags that can be pass to the API under the mode argument:

int RedisModule_GetOpenKeyModesAll(void);

**Available since:** unreleased
**Available since:** 7.2.0


Returns the full OpenKey modes mask, using the return value
Expand Down Expand Up @@ -3565,7 +3565,7 @@ NULL if not required.
RedisModuleOnUnblocked on_unblock,
void *private_data);

**Available since:** unreleased
**Available since:** 7.2.0

Set unblock handler (callback and private data) on the given promise `RedisModuleCallReply`.
The given reply must be of promise type (`REDISMODULE_REPLY_PROMISE`).
Expand All @@ -3577,7 +3577,7 @@ The given reply must be of promise type (`REDISMODULE_REPLY_PROMISE`).
int RedisModule_CallReplyPromiseAbort(RedisModuleCallReply *reply,
void **private_data);

**Available since:** unreleased
**Available since:** 7.2.0

Abort the execution of a given promise `RedisModuleCallReply`.
return `REDMODULE_OK` in case the abort was done successfully and `REDISMODULE_ERR`
Expand Down Expand Up @@ -4432,7 +4432,7 @@ For a guide about blocking commands in modules, see
void RedisModule_RegisterAuthCallback(RedisModuleCtx *ctx,
RedisModuleAuthCallback cb);

**Available since:** unreleased
**Available since:** 7.2.0

This API registers a callback to execute in addition to normal password based authentication.
Multiple callbacks can be registered across different modules. When a Module is unloaded, all the
Expand Down Expand Up @@ -4544,7 +4544,7 @@ or multiple times within the blocking command background work.
RedisModuleAuthCallback reply_callback,
;

**Available since:** unreleased
**Available since:** 7.2.0

Block the current client for module authentication in the background. If module auth is not in
progress on the client, the API returns NULL. Otherwise, the client is blocked and the `RedisModule_BlockedClient`
Expand All @@ -4557,7 +4557,7 @@ Note: Only use this API from the context of a module auth callback.

void *RedisModule_BlockClientGetPrivateData(RedisModuleBlockedClient *blocked_client);

**Available since:** unreleased
**Available since:** 7.2.0

Get the private data that was previusely set on a blocked client

Expand All @@ -4568,7 +4568,7 @@ Get the private data that was previusely set on a blocked client
void RedisModule_BlockClientSetPrivateData(RedisModuleBlockedClient *blocked_client,
void *private_data);

**Available since:** unreleased
**Available since:** 7.2.0

Set private data on a blocked client

Expand Down Expand Up @@ -4648,7 +4648,7 @@ Note: Under normal circumstances [`RedisModule_UnblockClient`](#RedisModule_Unbl
RedisModuleCmdFunc reply_callback,
;

**Available since:** unreleased
**Available since:** 7.2.0

Same as [`RedisModule_BlockClientOnKeys`](#RedisModule_BlockClientOnKeys), but can take `REDISMODULE_BLOCK_`* flags
Can be either `REDISMODULE_BLOCK_UNBLOCK_DEFAULT`, which means default behavior (same
Expand Down Expand Up @@ -4988,7 +4988,7 @@ See [https://redis.io/topics/notifications](https://redis.io/topics/notification
void *privdata,
void (*free_privdata)(void*));

**Available since:** unreleased
**Available since:** 7.2.0

When running inside a key space notification callback, it is dangerous and highly discouraged to perform any write
operation (See [`RedisModule_SubscribeToKeyspaceEvents`](#RedisModule_SubscribeToKeyspaceEvents)). In order to still perform write actions in this scenario,
Expand Down Expand Up @@ -5562,7 +5562,7 @@ For more information about ACL log, please refer to [https://redis.io/commands/a
RedisModuleString *object,
RedisModuleACLLogEntryReason reason);

**Available since:** unreleased
**Available since:** 7.2.0

Adds a new entry in the ACL log with the `username` `RedisModuleString` provided.
Returns `REDISMODULE_OK` on success and `REDISMODULE_ERR` on error.
Expand Down Expand Up @@ -6490,7 +6490,7 @@ position.

unsigned long long RedisModule_CommandFilterGetClientId(RedisModuleCommandFilterCtx *fctx);

**Available since:** unreleased
**Available since:** 7.2.0

Get Client ID for client that issued the command we are filtering

Expand Down Expand Up @@ -7303,7 +7303,7 @@ or provided as startup arguments.

RedisModuleRdbStream *RedisModule_RdbStreamCreateFromFile(const char *filename);

**Available since:** unreleased
**Available since:** 7.2.0

Create a stream object to save/load RDB to/from a file.

Expand All @@ -7317,7 +7317,7 @@ the object.

void RedisModule_RdbStreamFree(RedisModuleRdbStream *stream);

**Available since:** unreleased
**Available since:** 7.2.0

Release an RDB stream object.

Expand All @@ -7329,7 +7329,7 @@ Release an RDB stream object.
RedisModuleRdbStream *stream,
int flags);

**Available since:** unreleased
**Available since:** 7.2.0

Load RDB file from the `stream`. Dataset will be cleared first and then RDB
file will be loaded.
Expand All @@ -7353,7 +7353,7 @@ Example:
RedisModuleRdbStream *stream,
int flags);

**Available since:** unreleased
**Available since:** 7.2.0

Save dataset to the RDB stream.

Expand Down Expand Up @@ -7433,7 +7433,7 @@ returns `REDISMODULE_OK` if when key is valid.

int RedisModule_GetModuleOptionsAll(void);

**Available since:** unreleased
**Available since:** 7.2.0


Returns the full module options flags mask, using the return value
Expand Down

0 comments on commit 93e1b6f

Please sign in to comment.