summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorWen Hui <wen.hui.ware@gmail.com>2022-09-08 02:37:49 -0400
committerGitHub <noreply@github.com>2022-09-08 09:37:49 +0300
commit5389fa62a64ddb277a58db4b21934d47cd298028 (patch)
tree03261a55371e6da2167c7639a29081ece9dd0e35 /src
parente67d06ee6be9c93fe626ad19f11b2d572d58a0ba (diff)
downloadredis-5389fa62a64ddb277a58db4b21934d47cd298028.tar.gz
Update group and consumer description in json file for Unifying Stream command format (#11190)
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.
Diffstat (limited to 'src')
-rw-r--r--src/commands.c16
-rw-r--r--src/commands/xgroup-create.json2
-rw-r--r--src/commands/xgroup-createconsumer.json4
-rw-r--r--src/commands/xgroup-delconsumer.json4
-rw-r--r--src/commands/xgroup-destroy.json2
-rw-r--r--src/commands/xgroup-setid.json2
-rw-r--r--src/commands/xinfo-consumers.json2
7 files changed, 16 insertions, 16 deletions
diff --git a/src/commands.c b/src/commands.c
index 4bb753a01..0c06ee2c8 100644
--- a/src/commands.c
+++ b/src/commands.c
@@ -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}
};
diff --git a/src/commands/xgroup-create.json b/src/commands/xgroup-create.json
index 54aceb8f5..f099d90ce 100644
--- a/src/commands/xgroup-create.json
+++ b/src/commands/xgroup-create.json
@@ -47,7 +47,7 @@
"key_spec_index": 0
},
{
- "name": "groupname",
+ "name": "group",
"type": "string"
},
{
diff --git a/src/commands/xgroup-createconsumer.json b/src/commands/xgroup-createconsumer.json
index 30c450e63..c338d4af6 100644
--- a/src/commands/xgroup-createconsumer.json
+++ b/src/commands/xgroup-createconsumer.json
@@ -41,11 +41,11 @@
"key_spec_index": 0
},
{
- "name": "groupname",
+ "name": "group",
"type": "string"
},
{
- "name": "consumername",
+ "name": "consumer",
"type": "string"
}
]
diff --git a/src/commands/xgroup-delconsumer.json b/src/commands/xgroup-delconsumer.json
index e98c3bbc8..29d62912d 100644
--- a/src/commands/xgroup-delconsumer.json
+++ b/src/commands/xgroup-delconsumer.json
@@ -40,11 +40,11 @@
"key_spec_index": 0
},
{
- "name": "groupname",
+ "name": "group",
"type": "string"
},
{
- "name": "consumername",
+ "name": "consumer",
"type": "string"
}
]
diff --git a/src/commands/xgroup-destroy.json b/src/commands/xgroup-destroy.json
index 79be27abf..4a78f4c14 100644
--- a/src/commands/xgroup-destroy.json
+++ b/src/commands/xgroup-destroy.json
@@ -40,7 +40,7 @@
"key_spec_index": 0
},
{
- "name": "groupname",
+ "name": "group",
"type": "string"
}
]
diff --git a/src/commands/xgroup-setid.json b/src/commands/xgroup-setid.json
index a065f75fd..e7c41b3ab 100644
--- a/src/commands/xgroup-setid.json
+++ b/src/commands/xgroup-setid.json
@@ -46,7 +46,7 @@
"key_spec_index": 0
},
{
- "name": "groupname",
+ "name": "group",
"type": "string"
},
{
diff --git a/src/commands/xinfo-consumers.json b/src/commands/xinfo-consumers.json
index 634b52887..15fe5e1a2 100644
--- a/src/commands/xinfo-consumers.json
+++ b/src/commands/xinfo-consumers.json
@@ -43,7 +43,7 @@
"key_spec_index": 0
},
{
- "name": "groupname",
+ "name": "group",
"type": "string"
}
]