Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

TS doc fix #207

Merged
merged 16 commits into from
May 14, 2024
Merged

TS doc fix #207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
c404f59
Update index.md
LiorKogan May 12, 2024
2133512
Update index.md
LiorKogan May 12, 2024
eaead57
Update index.md
LiorKogan May 12, 2024
afb1129
Update index.md
LiorKogan May 12, 2024
9a7b74d
Update index.md
LiorKogan May 12, 2024
38a6cf8
Update index.md
LiorKogan May 12, 2024
45dc5a5
Update index.md
LiorKogan May 12, 2024
eba1dee
Update index.md
LiorKogan May 12, 2024
5937377
Update index.md
LiorKogan May 12, 2024
009b13b
Update index.md
LiorKogan May 12, 2024
1984a8b
Update index.md
LiorKogan May 12, 2024
e8947f9
Update index.md
LiorKogan May 12, 2024
2091ef5
Update index.md
LiorKogan May 12, 2024
c1e84d7
Update index.md
LiorKogan May 12, 2024
104f00d
Update index.md
LiorKogan May 12, 2024
66cf8cc
Update index.md
LiorKogan May 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions content/commands/ts.add/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,14 @@ since: 1.0.0
stack_path: docs/data-types/timeseries
summary: Append a sample to a time series
syntax: "TS.ADD key timestamp value \n [RETENTION retentionPeriod] \n [ENCODING\
\ [COMPRESSED|UNCOMPRESSED]] \n [CHUNK_SIZE size] \n [ON_DUPLICATE policy] \n\
\ [LABELS {label value}...]\n"
\ <COMPRESSED|UNCOMPRESSED>] \n [CHUNK_SIZE size] \n [ON_DUPLICATE policy] \n\
\ [LABELS [label value ...]]\n"
syntax_fmt: "TS.ADD key timestamp value [RETENTION\_retentionPeriod]\n [ENCODING\_\
<UNCOMPRESSED | COMPRESSED>] [CHUNK_SIZE\_size]\n [ON_DUPLICATE\_<BLOCK | FIRST\
\ | LAST | MIN | MAX | SUM>]\n [LABELS\_label value [label value ...]]"
syntax_str: "timestamp value [RETENTION\_retentionPeriod] [ENCODING\_<UNCOMPRESSED\
\ | COMPRESSED>] [CHUNK_SIZE\_size] [ON_DUPLICATE\_<BLOCK | FIRST | LAST | MIN |\
\ MAX | SUM>] [LABELS\_label value [label value ...]]"
<COMPRESSED | UNCOMPRESSED>] [CHUNK_SIZE\_size]\n [ON_DUPLICATE\_<BLOCK | FIRST\
\ | LAST | MIN | MAX | SUM>]\n [LABELS\ [label value ...]]"
syntax_str: "timestamp value [RETENTION\_retentionPeriod] [ENCODING\_<COMPRESSED\
\ | UNCOMPRESSED>] [CHUNK_SIZE\_size] [ON_DUPLICATE\_<BLOCK | FIRST | LAST | MIN |\
\ MAX | SUM>] [LABELS\ [label value ...]]"
title: TS.ADD
---

Expand Down
6 changes: 3 additions & 3 deletions content/commands/ts.alter/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@ stack_path: docs/data-types/timeseries
summary: Update the retention, chunk size, duplicate policy, and labels of an existing
time serie
syntax: "TS.ALTER key \n [RETENTION retentionPeriod] \n [CHUNK_SIZE size] \n [DUPLICATE_POLICY\
\ policy] \n [LABELS {label value}...]\n"
\ policy] \n [LABELS [label value ...]]\n"
syntax_fmt: "TS.ALTER key [RETENTION\_retentionPeriod] [CHUNK_SIZE\_size]\n [DUPLICATE_POLICY\_\
<BLOCK | FIRST | LAST | MIN | MAX | SUM>]\n [LABELS\_label value [label value ...]]"
<BLOCK | FIRST | LAST | MIN | MAX | SUM>]\n [LABELS\ [label value ...]]"
syntax_str: "[RETENTION\_retentionPeriod] [CHUNK_SIZE\_size] [DUPLICATE_POLICY\_<BLOCK\
\ | FIRST | LAST | MIN | MAX | SUM>] [LABELS\_label value [label value ...]]"
\ | FIRST | LAST | MIN | MAX | SUM>] [LABELS\ [label value ...]]"
title: TS.ALTER
---

Expand Down
14 changes: 7 additions & 7 deletions content/commands/ts.create/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,14 @@ module: TimeSeries
since: 1.0.0
stack_path: docs/data-types/timeseries
summary: Create a new time series
syntax: "TS.CREATE key \n [RETENTION retentionPeriod] \n [ENCODING [UNCOMPRESSED|COMPRESSED]]\
\ \n [CHUNK_SIZE size] \n [DUPLICATE_POLICY policy] \n [LABELS {label value}...]\n"
syntax_fmt: "TS.CREATE key [RETENTION\_retentionPeriod] [ENCODING\_<UNCOMPRESSED |\n\
\ COMPRESSED>] [CHUNK_SIZE\_size] [DUPLICATE_POLICY\_<BLOCK | FIRST |\n LAST |\
\ MIN | MAX | SUM>] [LABELS\_label value [label value ...]]"
syntax_str: "[RETENTION\_retentionPeriod] [ENCODING\_<UNCOMPRESSED | COMPRESSED>]\
syntax: "TS.CREATE key \n [RETENTION retentionPeriod] \n [ENCODING <COMPRESSED|UNCOMPRESSED>]\
\ \n [CHUNK_SIZE size] \n [DUPLICATE_POLICY policy] \n [LABELS [label value ...]]\n"
syntax_fmt: "TS.CREATE key [RETENTION\_retentionPeriod] [ENCODING\_<COMPRESSED |\n\
\ UNCOMPRESSED>] [CHUNK_SIZE\_size] [DUPLICATE_POLICY\_<BLOCK | FIRST |\n LAST |\
\ MIN | MAX | SUM>] [LABELS\_[label value ...]]"
syntax_str: "[RETENTION\_retentionPeriod] [ENCODING\_<COMPRESSED | UNCOMPRESSED>]\
\ [CHUNK_SIZE\_size] [DUPLICATE_POLICY\_<BLOCK | FIRST | LAST | MIN | MAX | SUM>]\
\ [LABELS\_label value [label value ...]]"
\ [LABELS\_[label value ...]]"
title: TS.CREATE
---

Expand Down
6 changes: 3 additions & 3 deletions content/commands/ts.decrby/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ summary: Decrease the value of the sample with the maximum existing timestamp, o
create a new sample with a value equal to the value of the sample with the maximum
existing timestamp with a given decrement
syntax: "TS.DECRBY key subtrahend \n [TIMESTAMP timestamp] \n [RETENTION retentionPeriod]\
\ \n [UNCOMPRESSED] \n [CHUNK_SIZE size] \n [LABELS {label value}...]\n"
\ \n [UNCOMPRESSED] \n [CHUNK_SIZE size] \n [LABELS [label value ...]]\n"
syntax_fmt: "TS.DECRBY key value [TIMESTAMP\_timestamp]\n [RETENTION\_retentionPeriod]\
\ [UNCOMPRESSED] [CHUNK_SIZE\_size]\n [LABELS\_label value [label value ...]]"
\ [UNCOMPRESSED] [CHUNK_SIZE\_size]\n [LABELS\_[label value ...]]"
syntax_str: "value [TIMESTAMP\_timestamp] [RETENTION\_retentionPeriod] [UNCOMPRESSED]\
\ [CHUNK_SIZE\_size] [LABELS\_label value [label value ...]]"
\ [CHUNK_SIZE\_size] [LABELS\_[label value ...]]"
title: TS.DECRBY
---

Expand Down
6 changes: 3 additions & 3 deletions content/commands/ts.incrby/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ summary: Increase the value of the sample with the maximum existing timestamp, o
create a new sample with a value equal to the value of the sample with the maximum
existing timestamp with a given increment
syntax: "TS.INCRBY key addend \n [TIMESTAMP timestamp] \n [RETENTION retentionPeriod]\
\ \n [UNCOMPRESSED] \n [CHUNK_SIZE size] \n [LABELS {label value}...]\n"
\ \n [UNCOMPRESSED] \n [CHUNK_SIZE size] \n [LABELS [label value ...]]\n"
syntax_fmt: "TS.INCRBY key value [TIMESTAMP\_timestamp]\n [RETENTION\_retentionPeriod]\
\ [UNCOMPRESSED] [CHUNK_SIZE\_size]\n [LABELS\_label value [label value ...]]"
\ [UNCOMPRESSED] [CHUNK_SIZE\_size]\n [LABELS\_[label value ...]]"
syntax_str: "value [TIMESTAMP\_timestamp] [RETENTION\_retentionPeriod] [UNCOMPRESSED]\
\ [CHUNK_SIZE\_size] [LABELS\_label value [label value ...]]"
\ [CHUNK_SIZE\_size] [LABELS\_[label value ...]]"
title: TS.INCRBY
---

Expand Down
6 changes: 3 additions & 3 deletions content/commands/ts.mget/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,13 @@ since: 1.0.0
stack_path: docs/data-types/timeseries
summary: Get the sample with the highest timestamp from each time series matching
a specific filter
syntax: 'TS.MGET [LATEST] [WITHLABELS | SELECTED_LABELS label...] FILTER filterExpr...
syntax: 'TS.MGET [LATEST] [WITHLABELS | <SELECTED_LABELS label...>] FILTER filterExpr...

'
syntax_fmt: "TS.MGET [LATEST] [WITHLABELS | SELECTED_LABELS label1 [label1 ...]]\n\
syntax_fmt: "TS.MGET [LATEST] [WITHLABELS | <SELECTED_LABELS label1 [label1 ...]>]\n\
\ FILTER\_<l=v | l!=v | l= | l!= | l=(v1,v2,...) | l!=(v1,v2,...)\n [l=v | l!=v\
\ | l= | l!= | l=(v1,v2,...) | l!=(v1,v2,...) ...]>"
syntax_str: "[WITHLABELS | SELECTED_LABELS label1 [label1 ...]] FILTER\_<l=v | l!=v\
syntax_str: "[WITHLABELS | <SELECTED_LABELS label1 [label1 ...]>] FILTER\_<l=v | l!=v\
\ | l= | l!= | l=(v1,v2,...) | l!=(v1,v2,...) [l=v | l!=v | l= | l!= | l=(v1,v2,...)\
\ | l!=(v1,v2,...) ...]>"
title: TS.MGET
Expand Down
8 changes: 4 additions & 4 deletions content/commands/ts.mrange/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,18 +159,18 @@ since: 1.0.0
stack_path: docs/data-types/timeseries
summary: Query a range across multiple time series by filters in forward direction
syntax: "TS.MRANGE fromTimestamp toTimestamp\n [LATEST]\n [FILTER_BY_TS ts...]\n\
\ [FILTER_BY_VALUE min max]\n [WITHLABELS | SELECTED_LABELS label...]\n [COUNT\
\ [FILTER_BY_VALUE min max]\n [WITHLABELS | <SELECTED_LABELS label...>]\n [COUNT\
\ count]\n [[ALIGN align] AGGREGATION aggregator bucketDuration [BUCKETTIMESTAMP\
\ bt] [EMPTY]]\n FILTER filterExpr...\n [GROUPBY label REDUCE reducer]\n"
syntax_fmt: "TS.MRANGE fromTimestamp toTimestamp [LATEST] [FILTER_BY_TS\_Timestamp\n\
\ [Timestamp ...]] [FILTER_BY_VALUE min max] [WITHLABELS |\n SELECTED_LABELS label1\
\ [label1 ...]] [COUNT\_count] [[ALIGN\_value]\n AGGREGATION\_<AVG | FIRST | LAST\
\ [Timestamp ...]] [FILTER_BY_VALUE min max] [WITHLABELS |\n <SELECTED_LABELS label1\
\ [label1 ...]>] [COUNT\_count] [[ALIGN\_value]\n AGGREGATION\_<AVG | FIRST | LAST\
\ | MIN | MAX | SUM | RANGE | COUNT\n | STD.P | STD.S | VAR.P | VAR.S | TWA> bucketDuration\n\
\ [BUCKETTIMESTAMP] [EMPTY]] FILTER\_<l=v | l!=v | l= | l!= |\n l=(v1,v2,...)\
\ | l!=(v1,v2,...) [l=v | l!=v | l= | l!= |\n l=(v1,v2,...) | l!=(v1,v2,...) ...]>\
\ [GROUPBY label REDUCE\n reducer]"
syntax_str: "toTimestamp [LATEST] [FILTER_BY_TS\_Timestamp [Timestamp ...]] [FILTER_BY_VALUE\
\ min max] [WITHLABELS | SELECTED_LABELS label1 [label1 ...]] [COUNT\_count] [[ALIGN\_\
\ min max] [WITHLABELS | <SELECTED_LABELS label1 [label1 ...]>] [COUNT\_count] [[ALIGN\_\
value] AGGREGATION\_<AVG | FIRST | LAST | MIN | MAX | SUM | RANGE | COUNT | STD.P\
\ | STD.S | VAR.P | VAR.S | TWA> bucketDuration [BUCKETTIMESTAMP] [EMPTY]] FILTER\_\
<l=v | l!=v | l= | l!= | l=(v1,v2,...) | l!=(v1,v2,...) [l=v | l!=v | l= | l!= |\
Expand Down
10 changes: 5 additions & 5 deletions content/commands/ts.mrevrange/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,19 +158,19 @@ module: TimeSeries
since: 1.4.0
stack_path: docs/data-types/timeseries
summary: Query a range across multiple time-series by filters in reverse direction
syntax: "TS.MREVRANGE fromTimestamp toTimestamp\n [LATEST]\n [FILTER_BY_TS TS...]\n\
\ [FILTER_BY_VALUE min max]\n [WITHLABELS | SELECTED_LABELS label...]\n [COUNT\
syntax: "TS.MREVRANGE fromTimestamp toTimestamp\n [LATEST]\n [FILTER_BY_TS ts...]\n\
\ [FILTER_BY_VALUE min max]\n [WITHLABELS | <SELECTED_LABELS label...>]\n [COUNT\
\ count]\n [[ALIGN align] AGGREGATION aggregator bucketDuration [BUCKETTIMESTAMP\
\ bt] [EMPTY]]\n FILTER filterExpr...\n [GROUPBY label REDUCE reducer]\n"
syntax_fmt: "TS.MREVRANGE fromTimestamp toTimestamp [LATEST]\n [FILTER_BY_TS\_Timestamp\
\ [Timestamp ...]] [FILTER_BY_VALUE min max]\n [WITHLABELS | SELECTED_LABELS label1\
\ [label1 ...]] [COUNT\_count]\n [[ALIGN\_value] AGGREGATION\_<AVG | FIRST | LAST\
\ [Timestamp ...]] [FILTER_BY_VALUE min max]\n [WITHLABELS | <SELECTED_LABELS label1\
\ [label1 ...]>] [COUNT\_count]\n [[ALIGN\_value] AGGREGATION\_<AVG | FIRST | LAST\
\ | MIN | MAX | SUM |\n RANGE | COUNT | STD.P | STD.S | VAR.P | VAR.S | TWA>\n\
\ bucketDuration [BUCKETTIMESTAMP] [EMPTY]] FILTER\_<l=v | l!=v | l=\n | l!= |\
\ l=(v1,v2,...) | l!=(v1,v2,...) [l=v | l!=v | l= | l!= |\n l=(v1,v2,...) | l!=(v1,v2,...)\
\ ...]> [GROUPBY label REDUCE\n reducer]"
syntax_str: "toTimestamp [LATEST] [FILTER_BY_TS\_Timestamp [Timestamp ...]] [FILTER_BY_VALUE\
\ min max] [WITHLABELS | SELECTED_LABELS label1 [label1 ...]] [COUNT\_count] [[ALIGN\_\
\ min max] [WITHLABELS | <SELECTED_LABELS label1 [label1 ...]>] [COUNT\_count] [[ALIGN\_\
value] AGGREGATION\_<AVG | FIRST | LAST | MIN | MAX | SUM | RANGE | COUNT | STD.P\
\ | STD.S | VAR.P | VAR.S | TWA> bucketDuration [BUCKETTIMESTAMP] [EMPTY]] FILTER\_\
<l=v | l!=v | l= | l!= | l=(v1,v2,...) | l!=(v1,v2,...) [l=v | l!=v | l= | l!= |\
Expand Down
2 changes: 1 addition & 1 deletion content/commands/ts.revrange/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ module: TimeSeries
since: 1.4.0
stack_path: docs/data-types/timeseries
summary: Query a range in reverse direction
syntax: "TS.REVRANGE key fromTimestamp toTimestamp\n [LATEST]\n [FILTER_BY_TS TS...]\n\
syntax: "TS.REVRANGE key fromTimestamp toTimestamp\n [LATEST]\n [FILTER_BY_TS ts...]\n\
\ [FILTER_BY_VALUE min max]\n [COUNT count]\n [[ALIGN align] AGGREGATION aggregator\
\ bucketDuration [BUCKETTIMESTAMP bt] [EMPTY]]\n"
syntax_fmt: "TS.REVRANGE key fromTimestamp toTimestamp [LATEST]\n [FILTER_BY_TS\_\
Expand Down