RED-28784 documentation for ALTER, MGET and QUERYINDEX #103
Conversation
docs/commands.md
Outdated
| @@ -259,6 +282,34 @@ TS.GET key | |||
| 2) "23" | |||
| ``` | |||
|
|
|||
| ### TS.MGET | |||
| Multi-get all timeseries matching the specific filter. | |||
There was a problem hiding this comment.
this should say "Get the last samples of timeseries matching the specific filter. " It's too confusing
There was a problem hiding this comment.
I agree it is confusing and was trying to hint what MGET stands for. Anyway, your phrasing is much better, so I will use it.
Also, the GET command says "Get the last sample", to be consistent we can write: "Get the last samples matching the specific filter. "
docs/commands.md
Outdated
| @@ -7,7 +7,7 @@ | |||
| Create a new time-series. | |||
|
|
|||
| ```sql | |||
| TS.CREATE key [RETENTION retentionSecs] [LABELS field value..] | |||
| TS.CREATE key [RETENTION retentionSecs] [CHUNK_SIZE maxSamplesPerChunk] [LABELS field value..] | |||
There was a problem hiding this comment.
We initially thought not to expose chunksize in the docs. If we specify this, we need a default documentation below (as retenionSecs) and I also wonder if it's not possible to do so in TS.ADD and TS.INCRBY/DECRBY.
Given that we had more PR's on adding this to the docs, I suggest we add it, but than all the way. @gkorland @danni-m
There was a problem hiding this comment.
Then we should remove CHUNK_SIZE from this PR, and after discussing add it in another PR.
docs/commands.md
Outdated
| @@ -17,6 +17,8 @@ Optional args: | |||
| * retentionSecs - Maximum age for samples compared to current time (in seconds) | |||
| * Default: The global retenion secs configuration of the database (by default, `0`) | |||
| * When set to 0, the series is not trimmed at all | |||
| * maxSamplesPerChunk - Maximum number of samples contained in each chunk. | |||
There was a problem hiding this comment.
Thanks for catching it, it is fixed now
No description provided.