gvsafronov/futriix
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Update group and consumer description in json file for Unifying Stream command format (#11190)

Browse Source 
For the stream data type, some commands, such as **XGROUP CREATE, XGROUP DESTROY, XGROUP CREATECONSUMER, 
XGROUP DELCONSUMER and XINFO CONSUMERS** use groupname and consumername in the command description;

However, for the commands **XREADGROUP GROUP, XPENDING, XACK , XCLAIM  and XAUTOCLAIM**  use term "group and consumer", clients could be confused.

This PR goal is to unify all the commands to groupname and consumername.
This commit is contained in:
Wen Hui 2022-09-08 02:37:49 -04:00 committed by GitHub
parent e67d06ee6b
commit 5389fa62a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/commands.c
View File

@ -6276,7 +6276,7 @@ struct redisCommandArg XGROUP_CREATE_id_selector_Subargs[] = {
/* XGROUP CREATE argument table */
struct redisCommandArg XGROUP_CREATE_Args[] = {
{"key",ARG_TYPE_KEY,0,NULL,NULL,NULL,CMD_ARG_NONE},
{"groupname",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{"group",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{"id-selector",ARG_TYPE_ONEOF,-1,NULL,NULL,NULL,CMD_ARG_NONE,.subargs=XGROUP_CREATE_id_selector_Subargs},
{"mkstream",ARG_TYPE_PURE_TOKEN,-1,"MKSTREAM",NULL,NULL,CMD_ARG_OPTIONAL},
{"entries-read",ARG_TYPE_INTEGER,-1,"ENTRIESREAD",NULL,NULL,CMD_ARG_OPTIONAL},
@ -6294,8 +6294,8 @@ struct redisCommandArg XGROUP_CREATE_Args[] = {
/* XGROUP CREATECONSUMER argument table */
struct redisCommandArg XGROUP_CREATECONSUMER_Args[] = {
{"key",ARG_TYPE_KEY,0,NULL,NULL,NULL,CMD_ARG_NONE},
{"groupname",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{"consumername",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{"group",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{"consumer",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{0}
};
@ -6310,8 +6310,8 @@ struct redisCommandArg XGROUP_CREATECONSUMER_Args[] = {
/* XGROUP DELCONSUMER argument table */
struct redisCommandArg XGROUP_DELCONSUMER_Args[] = {
{"key",ARG_TYPE_KEY,0,NULL,NULL,NULL,CMD_ARG_NONE},
{"groupname",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{"consumername",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{"group",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{"consumer",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{0}
};
@ -6326,7 +6326,7 @@ struct redisCommandArg XGROUP_DELCONSUMER_Args[] = {
/* XGROUP DESTROY argument table */
struct redisCommandArg XGROUP_DESTROY_Args[] = {
{"key",ARG_TYPE_KEY,0,NULL,NULL,NULL,CMD_ARG_NONE},
{"groupname",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{"group",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{0}
};
@ -6359,7 +6359,7 @@ struct redisCommandArg XGROUP_SETID_id_selector_Subargs[] = {
/* XGROUP SETID argument table */
struct redisCommandArg XGROUP_SETID_Args[] = {
{"key",ARG_TYPE_KEY,0,NULL,NULL,NULL,CMD_ARG_NONE},
{"groupname",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{"group",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{"id-selector",ARG_TYPE_ONEOF,-1,NULL,NULL,NULL,CMD_ARG_NONE,.subargs=XGROUP_SETID_id_selector_Subargs},
{"entriesread",ARG_TYPE_INTEGER,-1,"ENTRIESREAD",NULL,NULL,CMD_ARG_OPTIONAL,.display_text="entries-read"},
{0}
@ -6398,7 +6398,7 @@ NULL
/* XINFO CONSUMERS argument table */
struct redisCommandArg XINFO_CONSUMERS_Args[] = {
{"key",ARG_TYPE_KEY,0,NULL,NULL,NULL,CMD_ARG_NONE},
{"groupname",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{"group",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_NONE},
{0}
};

2
src/commands/xgroup-create.json
View File

@ -47,7 +47,7 @@
"key_spec_index": 0
},
{
"name": "groupname",
"name": "group",
"type": "string"
},
{

4
src/commands/xgroup-createconsumer.json
View File

@ -41,11 +41,11 @@
"key_spec_index": 0
},
{
"name": "groupname",
"name": "group",
"type": "string"
},
{
"name": "consumername",
"name": "consumer",
"type": "string"
}
]

4
src/commands/xgroup-delconsumer.json
View File

@ -40,11 +40,11 @@
"key_spec_index": 0
},
{
"name": "groupname",
"name": "group",
"type": "string"
},
{
"name": "consumername",
"name": "consumer",
"type": "string"
}
]

2
src/commands/xgroup-destroy.json
View File

@ -40,7 +40,7 @@
"key_spec_index": 0
},
{
"name": "groupname",
"name": "group",
"type": "string"
}
]

2
src/commands/xgroup-setid.json
View File

@ -46,7 +46,7 @@
"key_spec_index": 0
},
{
"name": "groupname",
"name": "group",
"type": "string"
},
{

2
src/commands/xinfo-consumers.json
View File

@ -43,7 +43,7 @@
"key_spec_index": 0
},
{
"name": "groupname",
"name": "group",
"type": "string"
}
]