Skip to content

Commit 5ec6244

Browse files
cmilesbcmilesb
committed
Merge branch 'main' into DOC-5528 
2 parents 15dd50b + 4a98ea6 commit 5ec6244

31 files changed

+667
-476
lines changed

‎.github/workflows/autocomment.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ jobs:
5050
-H "Authorization: Bearer ${GITHUB_TOKEN}" \
5151
$FILES_URL \
5252
| jq -r --arg prefix $BRANCH_NAME/ '.[] | select(((.filename | test("content/(?!.*embed).*\\.md")) and .status != "removed")) | ($prefix + .filename)' \
53-
| sed -E -e 's|(^[^/]+/)([^/]+/)|\1|' -e 's|^|https://redis.io/docs/staging/|' -e 's|(_?index)?\.md||' \
53+
| sed -E -e 's|(^[^/]+/)([^/]+/)|\1|' -e 's|^|https://redis.io/docs/staging/|' -e 's|\/(_?index)?\.md|\/|' \
5454
| sort \
5555
| uniq)
5656

‎.github/workflows/autocomment_jira_link.yaml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: autocomment_jira_link
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- 'content/**'
7+
types:
8+
- opened
9+
permissions:
10+
pull-requests: write
11+
contents: read
12+
13+
jobs:
14+
auto-comment:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: 'Checkout'
18+
uses: 'actions/checkout@v3'
19+
20+
- name: Create Comment
21+
env:
22+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
23+
PR_NUMBER: ${{ github.event.pull_request.number }}
24+
REPO: ${{ github.repository }}
25+
BRANCH_NAME: ${{ github.event.pull_request.head.ref }}
26+
run: |
27+
set -e
28+
29+
CREATE_COMMENT_URL="https://api.github.com/repos/${REPO}/issues/${PR_NUMBER}/comments"
30+
31+
JIRA_TICKET=$(grep -Eo '^DOC-[0-9]+' <<< "$BRANCH_NAME")
32+
JIRA_LINK="https://redislabs.atlassian.net/browse/${JIRA_TICKET}"
33+
COMMENT="[${JIRA_TICKET}](${JIRA_LINK})"
34+
35+
generate_post_data()
36+
{
37+
cat <<EOF
38+
{
39+
"body": "$COMMENT"
40+
EOF
41+
}
42+
43+
if [[ "$BRANCH_NAME" == DOC-* ]]; then
44+
# Write comment on pull request
45+
curl -Ls \
46+
-X POST \
47+
-H "Accept: application/vnd.github+json" \
48+
-H "X-GitHub-Api-Version: 2022-11-28" \
49+
-H "Authorization: token ${GITHUB_TOKEN}" \
50+
$CREATE_COMMENT_URL \
51+
--data "$(generate_post_data)" 1>/dev/null
52+
53+
printf '%s\n' 'Comment written!'
54+
fi

‎content/commands/client-no-evict.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,23 @@ When turned on and client eviction is configured, the current connection will be
5050
When turned off, the current client will be re-included in the pool of potential clients to be evicted (and evicted if needed).
5151

5252
See [client eviction]({{< relref "/develop/reference/clients" >}}#client-eviction) for more details.
53+
54+
## Return information
55+
56+
{{< multitabs id="client-no-evict-return-info"
57+
tab1="RESP2"
58+
tab2="RESP3" >}}
59+
60+
One of the following:
61+
62+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if the command was successful.
63+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: wrong number of or invalid arguments.
64+
65+
-tab-sep-
66+
67+
One of the following:
68+
69+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if the command was successful.
70+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: wrong number of or invalid arguments.
71+
72+
{{< /multitabs >}}

‎content/commands/client-no-touch.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,23 @@ The `CLIENT NO-TOUCH` command controls whether commands sent by the client will
4747
When turned on, the current client will not change LFU/LRU stats, unless it sends the [`TOUCH`]({{< relref "/commands/touch" >}}) command.
4848

4949
When turned off, the client touches LFU/LRU stats just as a normal client.
50+
51+
## Return information
52+
53+
{{< multitabs id="client-no-touch-return-info"
54+
tab1="RESP2"
55+
tab2="RESP3" >}}
56+
57+
One of the following:
58+
59+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if the command was successful.
60+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: wrong number of or invalid arguments.
61+
62+
-tab-sep-
63+
64+
One of the following:
65+
66+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` if the command was successful.
67+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: wrong number of or invalid arguments.
68+
69+
{{< /multitabs >}}

‎content/commands/memory-malloc-stats.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,17 @@ the memory allocator.
3232

3333
This command is currently implemented only when using **jemalloc** as an
3434
allocator, and evaluates to a benign NOOP for all others.
35+
36+
## Return information
37+
38+
{{< multitabs id="memory-malloc-stats-return-info"
39+
tab1="RESP2"
40+
tab2="RESP3" >}}
41+
42+
[Bulk string reply](../../develop/reference/protocol-spec#bulk-strings): a long string of statistics.
43+
44+
-tab-sep-
45+
46+
[Verbatim string reply](../../develop/reference/protocol-spec#verbatim-strings): a long string of statistics.
47+
48+
{{< /multitabs >}}

‎content/commands/ts.add.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -213,13 +213,6 @@ Use it only if you are creating a new time series. It is ignored if you are addi
213213
- Setting `RETENTION` and `LABELS` introduces additional time complexity.
214214
</note>
215215

216-
## Return value
217-
218-
Returns one of these replies:
219-
220-
- [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) - the timestamp of the upserted sample. If the sample is ignored (See `IGNORE` in [`TS.CREATE`]({{< relref "commands/ts.create/" >}})), the reply will be the largest timestamp in the time series.
221-
- [] on error (invalid arguments, wrong key type, etc.), when duplication policy is `BLOCK`, or when `timestamp` is older than the retention period compared to the maximum existing timestamp
222-
223216
## Complexity
224217

225218
If a compaction rule exists on a time series, the performance of `TS.ADD` can be reduced.
@@ -246,6 +239,24 @@ Add a sample to the time series, setting the sample's timestamp to the current U
246239
{{< / highlight >}}
247240
</details>
248241

242+
## Return information
243+
244+
{{< multitabs id="ts-add-return-info"
245+
tab1="RESP2"
246+
tab2="RESP3" >}}
247+
248+
One of the following:
249+
* [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}): the timestamp of the upserted sample. If the sample is ignored (see `IGNORE` in [`TS.CREATE`]({{< relref "commands/ts.create/" >}})), the reply will be the largest timestamp in the time series.
250+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, duplication policy is `BLOCK`, or when `timestamp` is older than the retention period compared to the maximum existing timestamp.
251+
252+
-tab-sep-
253+
254+
One of the following:
255+
* [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}): the timestamp of the upserted sample. If the sample is ignored (see `IGNORE` in [`TS.CREATE`]({{< relref "commands/ts.create/" >}})), the reply will be the largest timestamp in the time series.
256+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, duplication policy is `BLOCK`, or when `timestamp` is older than the retention period compared to the maximum existing timestamp.
257+
258+
{{< /multitabs >}}
259+
249260
## See also
250261

251262
[`TS.CREATE`]({{< relref "commands/ts.create/" >}})

‎content/commands/ts.alter.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -119,13 +119,6 @@ is set of label-value pairs that represent metadata labels of the key and serve
119119
If `LABELS` is specified, the given label list is applied. Labels that are not present in the given list are removed implicitly. Specifying `LABELS` with no label-value pairs removes all existing labels. See `LABELS` in [`TS.CREATE`]({{< relref "commands/ts.create/" >}}).
120120
</details>
121121

122-
## Return value
123-
124-
Returns one of these replies:
125-
126-
- [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - `OK` if executed correctly
127-
- [] on error (invalid arguments, wrong key type, key does not exist, etc.)
128-
129122
## Examples
130123

131124
<details open><summary><b>Alter a temperature time series</b></summary>
@@ -145,6 +138,24 @@ OK
145138
{{< / highlight >}}
146139
</details>
147140

141+
## Return information
142+
143+
{{< multitabs id="ts-alter-return-info"
144+
tab1="RESP2"
145+
tab2="RESP3" >}}
146+
147+
One of the following:
148+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` when the time series is altered successfully.
149+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, key does not exist, etc.
150+
151+
-tab-sep-
152+
153+
One of the following:
154+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` when the time series is altered successfully.
155+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, key does not exist, etc.
156+
157+
{{< /multitabs >}}
158+
148159
## See also
149160

150161
[`TS.CREATE`]({{< relref "commands/ts.create/" >}})

‎content/commands/ts.create.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -180,14 +180,7 @@ is set of label-value pairs that represent metadata labels of the key and serve
180180
The [`TS.MGET`]({{< relref "commands/ts.mget/" >}}), [`TS.MRANGE`]({{< relref "commands/ts.mrange/" >}}), and [`TS.MREVRANGE`]({{< relref "commands/ts.mrevrange/" >}}) commands operate on multiple time series based on their labels. The [`TS.QUERYINDEX`]({{< relref "commands/ts.queryindex/" >}}) command returns all time series keys matching a given filter based on their labels.
181181
</details>
182182

183-
## Return value
184-
185-
Returns one of these replies:
186-
187-
- [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - `OK` if executed correctly
188-
- [] on error (invalid arguments, key already exists, etc.)
189-
190-
## Examples
183+
## Examples
191184

192185
<details open><summary><b>Create a temperature time series</b></summary>
193186

@@ -197,6 +190,24 @@ OK
197190
{{< / highlight >}}
198191
</details>
199192

193+
## Return information
194+
195+
{{< multitabs id="ts-create-return-info"
196+
tab1="RESP2"
197+
tab2="RESP3" >}}
198+
199+
One of the following:
200+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` when the time series is created successfully.
201+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, key already exists, etc.
202+
203+
-tab-sep-
204+
205+
One of the following:
206+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` when the time series is created successfully.
207+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, key already exists, etc.
208+
209+
{{< /multitabs >}}
210+
200211
## See also
201212

202213
[`TS.ADD`]({{< relref "commands/ts.add/" >}}) | [`TS.INCRBY`]({{< relref "commands/ts.incrby/" >}}) | [`TS.DECRBY`]({{< relref "commands/ts.decrby/" >}}) | [`TS.MGET`]({{< relref "commands/ts.mget/" >}}) | [`TS.MRANGE`]({{< relref "commands/ts.mrange/" >}}) | [`TS.MREVRANGE`]({{< relref "commands/ts.mrevrange/" >}}) | [`TS.QUERYINDEX`]({{< relref "commands/ts.queryindex/" >}})

‎content/commands/ts.createrule.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -151,13 +151,6 @@ ensures that there is a bucket that starts exactly at `alignTimestamp` and align
151151
For example, if `bucketDuration` is 24 hours (`24 * 3600 * 1000`), setting `alignTimestamp` to 6 hours after the Unix epoch (`6 * 3600 * 1000`) ensures that each bucket’s timeframe is `[06:00 .. 06:00)`.
152152
</details>
153153

154-
## Return value
155-
156-
Returns one of these replies:
157-
158-
- [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - `OK` if executed correctly
159-
- [] on error (invalid arguments, wrong key type, etc.), when `sourceKey` does not exist, when `destKey` does not exist, when `sourceKey` is already a destination of a compaction rule, when `destKey` is already a source or a destination of a compaction rule, or when `sourceKey` and `destKey` are identical
160-
161154
## Examples
162155

163156
<details open>
@@ -184,9 +177,27 @@ Now, also create a compacted time series named _dailyDiffTemp_. This time series
184177
127.0.0.1:6379> TS.CREATE dailyDiffTemp:TLV LABELS type temp location TLV
185178
127.0.0.1:6379> TS.CREATERULE temp:TLV dailyDiffTemp:TLV AGGREGATION range 86400000 21600000
186179
{{< / highlight >}}
187-
180+
188181
</details>
189182

183+
## Return information
184+
185+
{{< multitabs id="ts-createrule-return-info"
186+
tab1="RESP2"
187+
tab2="RESP3" >}}
188+
189+
One of the following:
190+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` when the compaction rule is created successfully.
191+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, `sourceKey` does not exist, `destKey` does not exist, `sourceKey` is already a destination of a compaction rule, `destKey` is already a source or a destination of a compaction rule, or `sourceKey` and `destKey` are identical.
192+
193+
-tab-sep-
194+
195+
One of the following:
196+
* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): `OK` when the compaction rule is created successfully.
197+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, `sourceKey` does not exist, `destKey` does not exist, `sourceKey` is already a destination of a compaction rule, `destKey` is already a source or a destination of a compaction rule, or `sourceKey` and `destKey` are identical.
198+
199+
{{< /multitabs >}}
200+
190201
## See also
191202

192203
[`TS.DELETERULE`]({{< relref "commands/ts.deleterule/" >}})

‎content/commands/ts.decrby.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,12 +173,23 @@ Use it only if you are creating a new time series. It is ignored if you are addi
173173
- Setting `RETENTION` and `LABELS` introduces additional time complexity.
174174
</note>
175175

176-
## Return value
176+
## Return information
177177

178-
Returns one of these replies:
178+
{{< multitabs id="ts-decrby-return-info"
179+
tab1="RESP2"
180+
tab2="RESP3" >}}
179181

180-
- [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}) - the timestamp of the upserted sample. If the sample is ignored (See `IGNORE` in [`TS.CREATE`]({{< relref "commands/ts.create/" >}})), the reply will be the largest timestamp in the time series.
181-
- [] on error (invalid arguments, wrong key type, etc.), or when `timestamp` is not equal to or higher than the maximum existing timestamp
182+
One of the following:
183+
* [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}): the timestamp of the upserted sample. If the sample is ignored (see `IGNORE` in [`TS.CREATE`]({{< relref "commands/ts.create/" >}})), the reply will be the largest timestamp in the time series.
184+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, or when `timestamp` is not equal to or higher than the maximum existing timestamp.
185+
186+
-tab-sep-
187+
188+
One of the following:
189+
* [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}): the timestamp of the upserted sample. If the sample is ignored (see `IGNORE` in [`TS.CREATE`]({{< relref "commands/ts.create/" >}})), the reply will be the largest timestamp in the time series.
190+
* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, or when `timestamp` is not equal to or higher than the maximum existing timestamp.
191+
192+
{{< /multitabs >}}
182193

183194
## See also
184195

0 commit comments

Comments
 (0)