Skip to content

Commit f0edf0f

Browse files
Update content/commands/ (#854)
Co-authored-by: redisdocsapp[bot] <177626021+redisdocsapp[bot]@users.noreply.github.com>
1 parent 1e9503a commit f0edf0f

File tree

24 files changed

+200
-132
lines changed

24 files changed

+200
-132
lines changed

content/commands/client-kill/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,12 @@ arguments:
7474
optional: true
7575
token: SKIPME
7676
type: oneof
77+
- display_text: maxage
78+
name: maxage
79+
optional: true
80+
since: 7.4.0
81+
token: MAXAGE
82+
type: integer
7783
multiple: true
7884
name: new-format
7985
type: oneof
@@ -110,6 +116,8 @@ history:
110116
- Replaced `slave` `TYPE` with `replica`. `slave` still supported for backward compatibility.
111117
- - 6.2.0
112118
- '`LADDR` option.'
119+
- - 7.4.0
120+
- '`MAXAGE` option.'
113121
linkTitle: CLIENT KILL
114122
since: 2.4.0
115123
summary: Terminates open connections.

content/commands/geodist/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ key_specs:
6767
linkTitle: GEODIST
6868
since: 3.2.0
6969
summary: Returns the distance between two members of a geospatial index.
70-
syntax_fmt: GEODIST key member1 member2 [m | km | ft | mi]
71-
syntax_str: member1 member2 [m | km | ft | mi]
70+
syntax_fmt: GEODIST key member1 member2 [M | KM | FT | MI]
71+
syntax_str: member1 member2 [M | KM | FT | MI]
7272
title: GEODIST
7373
---
7474
Return the distance between two members in the geospatial index represented by the sorted set.

content/commands/georadius/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,10 +166,10 @@ replaced_by: '[`GEOSEARCH`]({{< relref "/commands/geosearch" >}}) and [`GEOSEARC
166166
since: 3.2.0
167167
summary: Queries a geospatial index for members within a distance from a coordinate,
168168
optionally stores the result.
169-
syntax_fmt: "GEORADIUS key longitude latitude radius <m | km | ft | mi>\n [WITHCOORD]\
169+
syntax_fmt: "GEORADIUS key longitude latitude radius <M | KM | FT | MI>\n [WITHCOORD]\
170170
\ [WITHDIST] [WITHHASH] [COUNT\_count [ANY]] [ASC | DESC]\n [STORE\_key | STOREDIST\_\
171171
key]"
172-
syntax_str: "longitude latitude radius <m | km | ft | mi> [WITHCOORD] [WITHDIST] [WITHHASH]\
172+
syntax_str: "longitude latitude radius <M | KM | FT | MI> [WITHCOORD] [WITHDIST] [WITHHASH]\
173173
\ [COUNT\_count [ANY]] [ASC | DESC] [STORE\_key | STOREDIST\_key]"
174174
title: GEORADIUS
175175
---

content/commands/georadius_ro/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,8 @@ hidden: false
103103
history:
104104
- - 6.2.0
105105
- Added the `ANY` option for `COUNT`.
106+
- - 7.0.0
107+
- Added support for uppercase unit names.
106108
key_specs:
107109
- RO: true
108110
access: true
@@ -122,9 +124,9 @@ replaced_by: '[`GEOSEARCH`]({{< relref "/commands/geosearch" >}}) with the `BYRA
122124
since: 3.2.10
123125
summary: Returns members from a geospatial index that are within a distance from a
124126
coordinate.
125-
syntax_fmt: "GEORADIUS_RO key longitude latitude radius <m | km | ft | mi>\n [WITHCOORD]\
127+
syntax_fmt: "GEORADIUS_RO key longitude latitude radius <M | KM | FT | MI>\n [WITHCOORD]\
126128
\ [WITHDIST] [WITHHASH] [COUNT\_count [ANY]] [ASC | DESC]"
127-
syntax_str: "longitude latitude radius <m | km | ft | mi> [WITHCOORD] [WITHDIST] [WITHHASH]\
129+
syntax_str: "longitude latitude radius <M | KM | FT | MI> [WITHCOORD] [WITHDIST] [WITHHASH]\
128130
\ [COUNT\_count [ANY]] [ASC | DESC]"
129131
title: GEORADIUS_RO
130132
---

content/commands/georadiusbymember/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,8 @@ doc_flags:
113113
group: geo
114114
hidden: false
115115
history:
116+
- - 6.2.0
117+
- Added the `ANY` option for `COUNT`.
116118
- - 7.0.0
117119
- Added support for uppercase unit names.
118120
key_specs:
@@ -160,10 +162,10 @@ replaced_by: '[`GEOSEARCH`]({{< relref "/commands/geosearch" >}}) and [`GEOSEARC
160162
since: 3.2.0
161163
summary: Queries a geospatial index for members within a distance from a member, optionally
162164
stores the result.
163-
syntax_fmt: "GEORADIUSBYMEMBER key member radius <m | km | ft | mi> [WITHCOORD]\n\
165+
syntax_fmt: "GEORADIUSBYMEMBER key member radius <M | KM | FT | MI> [WITHCOORD]\n\
164166
\ [WITHDIST] [WITHHASH] [COUNT\_count [ANY]] [ASC | DESC] [STORE\_key\n | STOREDIST\_\
165167
key]"
166-
syntax_str: "member radius <m | km | ft | mi> [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT\_\
168+
syntax_str: "member radius <M | KM | FT | MI> [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT\_\
167169
count [ANY]] [ASC | DESC] [STORE\_key | STOREDIST\_key]"
168170
title: GEORADIUSBYMEMBER
169171
---

content/commands/georadiusbymember_ro/index.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,11 @@ doc_flags:
9696
- deprecated
9797
group: geo
9898
hidden: false
99+
history:
100+
- - 6.2.0
101+
- Added the `ANY` option for `COUNT`.
102+
- - 7.0.0
103+
- Added support for uppercase unit names.
99104
key_specs:
100105
- RO: true
101106
access: true
@@ -115,9 +120,9 @@ replaced_by: '[`GEOSEARCH`]({{< relref "/commands/geosearch" >}}) with the `BYRA
115120
since: 3.2.10
116121
summary: Returns members from a geospatial index that are within a distance from a
117122
member.
118-
syntax_fmt: "GEORADIUSBYMEMBER_RO key member radius <m | km | ft | mi>\n [WITHCOORD]\
123+
syntax_fmt: "GEORADIUSBYMEMBER_RO key member radius <M | KM | FT | MI>\n [WITHCOORD]\
119124
\ [WITHDIST] [WITHHASH] [COUNT\_count [ANY]] [ASC | DESC]"
120-
syntax_str: "member radius <m | km | ft | mi> [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT\_\
125+
syntax_str: "member radius <M | KM | FT | MI> [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT\_\
121126
count [ANY]] [ASC | DESC]"
122127
title: GEORADIUSBYMEMBER_RO
123128
---

content/commands/geosearch/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -162,10 +162,10 @@ linkTitle: GEOSEARCH
162162
since: 6.2.0
163163
summary: Queries a geospatial index for members inside an area of a box or a circle.
164164
syntax_fmt: "GEOSEARCH key <FROMMEMBER\_member | FROMLONLAT\_longitude latitude>\n\
165-
\ <BYRADIUS\_radius <m | km | ft | mi> | BYBOX\_width height <m | km |\n ft |\
166-
\ mi>> [ASC | DESC] [COUNT\_count [ANY]] [WITHCOORD] [WITHDIST]\n [WITHHASH]"
165+
\ <BYRADIUS\_radius <M | KM | FT | MI> | BYBOX\_width height <M | KM |\n FT |\
166+
\ MI>> [ASC | DESC] [COUNT\_count [ANY]] [WITHCOORD] [WITHDIST]\n [WITHHASH]"
167167
syntax_str: "<FROMMEMBER\_member | FROMLONLAT\_longitude latitude> <BYRADIUS\_radius\
168-
\ <m | km | ft | mi> | BYBOX\_width height <m | km | ft | mi>> [ASC | DESC] [COUNT\_\
168+
\ <M | KM | FT | MI> | BYBOX\_width height <M | KM | FT | MI>> [ASC | DESC] [COUNT\_\
169169
count [ANY]] [WITHCOORD] [WITHDIST] [WITHHASH]"
170170
title: GEOSEARCH
171171
---

content/commands/geosearchstore/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -171,10 +171,10 @@ since: 6.2.0
171171
summary: Queries a geospatial index for members inside an area of a box or a circle,
172172
optionally stores the result.
173173
syntax_fmt: "GEOSEARCHSTORE destination source <FROMMEMBER\_member |\n FROMLONLAT\_\
174-
longitude latitude> <BYRADIUS\_radius <m | km | ft | mi>\n | BYBOX\_width height\
175-
\ <m | km | ft | mi>> [ASC | DESC] [COUNT\_count\n [ANY]] [STOREDIST]"
174+
longitude latitude> <BYRADIUS\_radius <M | KM | FT | MI>\n | BYBOX\_width height\
175+
\ <M | KM | FT | MI>> [ASC | DESC] [COUNT\_count\n [ANY]] [STOREDIST]"
176176
syntax_str: "source <FROMMEMBER\_member | FROMLONLAT\_longitude latitude> <BYRADIUS\_\
177-
radius <m | km | ft | mi> | BYBOX\_width height <m | km | ft | mi>> [ASC | DESC]\
177+
radius <M | KM | FT | MI> | BYBOX\_width height <M | KM | FT | MI>> [ASC | DESC]\
178178
\ [COUNT\_count [ANY]] [STOREDIST]"
179179
title: GEOSEARCHSTORE
180180
---

content/commands/hexpire/index.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,18 @@ arguments:
3131
name: condition
3232
optional: true
3333
type: oneof
34-
- display_text: numfields
35-
name: numfields
36-
type: integer
37-
- display_text: field
38-
multiple: true
39-
name: field
40-
type: string
41-
arity: -5
34+
- arguments:
35+
- display_text: numfields
36+
name: numfields
37+
type: integer
38+
- display_text: field
39+
multiple: true
40+
name: field
41+
type: string
42+
name: fields
43+
token: FIELDS
44+
type: block
45+
arity: -6
4246
categories:
4347
- docs
4448
- develop
@@ -53,7 +57,7 @@ command_flags:
5357
- write
5458
- denyoom
5559
- fast
56-
complexity: O(N) where N is the number of arguments to the command
60+
complexity: O(N) where N is the number of specified fields
5761
description: Set expiration for hash fields using relative time to expire (seconds)
5862
group: hash
5963
hidden: false
@@ -72,9 +76,10 @@ key_specs:
7276
update: true
7377
linkTitle: HEXPIRE
7478
since: 7.4.0
75-
summary: Set expiration for hash fields using relative time to expire in seconds
76-
syntax_fmt: "HEXPIRE key seconds [NX | XX | GT | LT] FIELDS numfields\n\ \ field [field ...]"
77-
syntax_str: seconds [NX | XX | GT | LT] FIELDS numfields field [field ...]
79+
summary: Set expiry for hash field using relative time to expire (seconds)
80+
syntax_fmt: "HEXPIRE key seconds [NX | XX | GT | LT] FIELDS\_numfields field\n [field\
81+
\ ...]"
82+
syntax_str: "seconds [NX | XX | GT | LT] FIELDS\_numfields field [field ...]"
7883
title: HEXPIRE
7984
---
8085
Set an expiration (TTL or time to live) on one or more fields of a given hash key. You must specify at least one field.

content/commands/hexpireat/index.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,18 @@ arguments:
3131
name: condition
3232
optional: true
3333
type: oneof
34-
- display_text: numfields
35-
name: numfields
36-
type: integer
37-
- display_text: field
38-
multiple: true
39-
name: field
40-
type: string
41-
arity: -5
34+
- arguments:
35+
- display_text: numfields
36+
name: numfields
37+
type: integer
38+
- display_text: field
39+
multiple: true
40+
name: field
41+
type: string
42+
name: fields
43+
token: FIELDS
44+
type: block
45+
arity: -6
4246
categories:
4347
- docs
4448
- develop
@@ -53,7 +57,7 @@ command_flags:
5357
- write
5458
- denyoom
5559
- fast
56-
complexity: O(N) where N is the number of arguments to the command
60+
complexity: O(N) where N is the number of specified fields
5761
description: Set expiration for hash fields using an absolute Unix timestamp (seconds)
5862
group: hash
5963
hidden: false
@@ -72,9 +76,11 @@ key_specs:
7276
update: true
7377
linkTitle: HEXPIREAT
7478
since: 7.4.0
75-
summary: Set expiration for hash fields using an absolute Unix timestamp in seconds
76-
syntax_fmt: "HEXPIREAT key unix-time-seconds [NX | XX | GT | LT] FIELDS numfields\n\ \ field [field ...]"
77-
syntax_str: unix-time-seconds [NX | XX | GT | LT] FIELDS numfields field [field ...]
79+
summary: Set expiry for hash field using an absolute Unix timestamp (seconds)
80+
syntax_fmt: "HEXPIREAT key unix-time-seconds [NX | XX | GT | LT] FIELDS\_numfields\n\
81+
\ field [field ...]"
82+
syntax_str: "unix-time-seconds [NX | XX | GT | LT] FIELDS\_numfields field [field\
83+
\ ...]"
7884
title: HEXPIREAT
7985
---
8086
`HEXPIREAT` has the same effect and semantics as [`HEXPIRE`]({{< relref "/commands/hexpire" >}}), but instead of

0 commit comments

Comments
 (0)