Skip to content

Commit f0e99b7

Browse files
author
alessandro
committed
Update README
1 parent 751b95f commit f0e99b7

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ Use [Redis Time Series](https://oss.redislabs.com/redistimeseries/) in PHP!
1717
### Requirements
1818
The library is tested against:
1919
- PHP 7.2, 7.3 and 7.4
20-
- RedisTimeSeries 1.2.7 and 1.4.2 (but it should work with any 1.2 and 1.4 version)
20+
- RedisTimeSeries 1.4.8 (but it should work with any 1.4 version)
21+
22+
In order to use RedisTimeSeries 1.2 please use version 2.1.1 of this library.
2123

2224
### Construct
2325
```
@@ -113,20 +115,26 @@ See https://oss.redislabs.com/redistimeseries/commands/#tsdeleterule.
113115

114116
### `range`
115117

116-
`TimeSeries::range(string $key, ?DateTimeInterface $from = null, ?DateTimeInterface $to = null, ?int $count = null, ?AggregationRule $rule = null): Sample[]`
118+
`TimeSeries::range(string $key, ?DateTimeInterface $from = null, ?DateTimeInterface $to = null, ?int $count = null, ?AggregationRule $rule = null, bool $reverse = false): Sample[]`
117119

118120
Retrieves samples from a key. It's possible to limit the query in a given time frame (passing `$from` and `$to`),
119121
to limit the retrieved amount of samples (passing `$count`), and also to pre-aggregate the results using a `$rule`.
120122

123+
The flag `$reverse` will return the results in reverse time order.
124+
121125
See https://oss.redislabs.com/redistimeseries/commands/#tsrange.
122126

123-
### `multiRange` and `multiRangeRaw`
127+
### `multiRange` and `multiRangeWithLabels`
128+
129+
`TimeSeries::multiRange(Filter $filter, ?DateTimeInterface $from = null, ?DateTimeInterface $to = null, ?int $count = null, ?AggregationRule $rule = null, bool $reverse = false): Sample[]`
130+
131+
`TimeSeries::multiRangeWithLabels(Filter $filter, ?DateTimeInterface $from = null, ?DateTimeInterface $to = null, ?int $count = null, ?AggregationRule $rule = null, bool $reverse = false): SampleWithLabels[]`
124132

125-
`TimeSeries::multiRange(Filter $filter, ?DateTimeInterface $from = null, ?DateTimeInterface $to = null, ?int $count = null, ?AggregationRule $rule = null): Sample[]`
133+
Similar to `range`, but instead of querying by key, queries for a specific set of labels specified in `$filter`.
126134

127-
`TimeSeries::multiRangeRaw(Filter $filter, ?DateTimeInterface $from = null, ?DateTimeInterface $to = null, ?int $count = null, ?AggregationRule $rule = null): array[]`
135+
`multiRangeWithLabels` will return an array of `SampleWithLabels` instead of simple `Sample`s.
128136

129-
Similar to `range`, but instead of querying by key, queries for a specific set of labels specified in `$filter`. `multiRangeRaw` will return the raw result from Redis, in order to preserve label information.
137+
The flag `$reverse` will return the results in reverse time order.
130138

131139
See https://oss.redislabs.com/redistimeseries/commands/#tsmrange.
132140

0 commit comments

Comments
 (0)