1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
//! redis_ts proivdes a small trait with extension functions for the //! [redis](https://docs.rs/redis/0.16.0/redis) crate to allow //! working with redis time series data that can be installed as //! a [redis module](https://oss.redislabs.com/redistimeseries). Time //! series commands are available as synchronous and asynchronous versions. //! //! The crate is called `redis_ts` and you can depend on it via cargo. You will //! also need redis in your dependencies. //! //! ```ini //! [dependencies] //! redis = "0.16.0" //! redis_ts = "*" //! ``` //! //! Or via git: //! //! ```ini //! [dependencies.redis_ts] //! git = "https://github.com/tompro/redis_ts.git" //! ``` //! //! //! # Synchronous usage //! //! To enable redis time series commands you simply load the //! redis_ts::TsCommands into the scope. All redis time series //! commands will then be available on your redis connection. //! //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! use redis::Commands; //! use redis_ts::{TsCommands, TsOptions}; //! //! let client = redis::Client::open("redis://127.0.0.1/")?; //! let mut con = client.get_connection()?; //! //! let _:() = con.ts_create("my_ts", TsOptions::default())?; //! # Ok(()) } //! ``` //! //! //! # Asynchronous usage //! //! To enable redis time series async commands you simply load the //! redis_ts::TsAsyncCommands into the scope. All redis time series //! commands will then be available on your async redis connection. //! //! ```rust,no_run //! # async fn run() -> redis::RedisResult<()> { //! use redis::AsyncCommands; //! use redis_ts::{AsyncTsCommands, TsOptions}; //! //! let client = redis::Client::open("redis://127.0.0.1/")?; //! let mut con = client.get_async_connection().await?; //! //! let _:() = con.ts_create("my_ts", TsOptions::default()).await?; //! # Ok(()) } //! ``` //! //! # Supported commands //! //! The following examples work with the synchronous and asynchronous //! API. For simplicity all examples will use the synchronous API. To //! use them async simply run them whithin an async function and append //! the .await after the command call. //! //! ## TS.CREATE //! Creates new time series keys. TsOptions can help you build the time //! series configuration you want to have. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_ts::{TsCommands, TsOptions}; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! let my_opts = TsOptions::default() //! .retention_time(60000) //! .uncompressed(false) //! .label("component", "engine") //! .label("sensor", "temperature"); //! //! let _:() = con.ts_create("my_engine", my_opts)?; //! # Ok(()) } //! ``` //! //! ## TS.ALTER //! Modifies existing time series keys. Note: You can not modify the uncompressed //! option of an existing time series so the flag will be ignored. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_ts::{TsCommands, TsOptions}; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! let my_opts = TsOptions::default() //! .retention_time(600000) //! .label("component", "spark_plug") //! .label("sensor", "temperature"); //! //! let _:() = con.ts_alter("my_engine", my_opts)?; //! # Ok(()) } //! ``` //! //! ## TS.ADD //! Add a value to time series. When providing time series options with //! the add command the series will be created if it does not yet exist. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_ts::{TsCommands, TsOptions}; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! /// With a timestamp //! let ts:u64 = con.ts_add("my_engine", 123456789, 36.1)?; //! //! /// Auto redis timestamp //! let now:u64 = con.ts_add_now("my_engine", 36.2)?; //! //! /// Add with auto create. //! let my_opts = TsOptions::default() //! .retention_time(600000) //! .label("component", "spark_plug") //! .label("sensor", "temperature"); //! //! let create_ts:u64 = con.ts_add_create("my_engine", "*", 35.7, my_opts)?; //! # Ok(()) } //! ``` //! //! ## TS.MADD //! Add multiple values to one or multiple time series. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_ts::{TsCommands, TsOptions}; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! let r:Vec<u64> = con.ts_madd(&[ //! ("my_engine", 1234, 36.0), //! ("other_engine", 4321, 33.9) //! ])?; //! # Ok(()) } //! ``` //! //! ## TS.INCRBY //! Increment a time series value. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_ts::{TsCommands, TsOptions}; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! /// With a timestamp //! let ts:u64 = con.ts_incrby("my_engine", 123456789, 2)?; //! //! /// Auto redis timestamp //! let now:u64 = con.ts_incrby_now("my_engine", 7.0)?; //! //! /// With auto create. //! let my_opts = TsOptions::default() //! .retention_time(600000) //! .label("component", "spark_plug") //! .label("sensor", "temperature"); //! //! let create_ts:u64 = con.ts_incrby_create("my_engine", "*", 16.97, my_opts)?; //! # Ok(()) } //! ``` //! //! ## TS.DECRBY //! Decrement a time series value. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_ts::{TsCommands, TsOptions}; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! /// With a timestamp //! let ts:u64 = con.ts_decrby("my_engine", 123456789, 2)?; //! //! /// Auto redis timestamp //! let now:u64 = con.ts_decrby_now("my_engine", 7.0)?; //! //! /// With auto create. //! let my_opts = TsOptions::default() //! .retention_time(600000) //! .label("component", "spark_plug") //! .label("sensor", "temperature"); //! //! let create_ts:u64 = con.ts_decrby_create("my_engine", "*", 16.97, my_opts)?; //! # Ok(()) } //! ``` //! //! ## TS.CREATERULE //! Create time series compaction rules. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_ts::{TsCommands, TsAggregationType}; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! let _:() = con.ts_createrule("my_engine", "my_engine_avg", TsAggregationType::Avg(5000))?; //! # Ok(()) } //! ``` //! //! ## TS.DELETERULE //! Delete time series compaction rules. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_ts::{TsCommands, TsOptions}; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! let _:() = con.ts_deleterule("my_engine", "my_engine_avg")?; //! # Ok(()) } //! ``` //! //! ## TS.RANGE //! Query for a range of time series data. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_ts::{TsCommands, TsRange, TsAggregationType}; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! let first_three_avg:TsRange<u64,f64> = con.ts_range( //! "my_engine", "-", "+", Some(3), Some(TsAggregationType::Avg(5000)) //! )?; //! //! let range_raw:TsRange<u64,f64> = con.ts_range( //! "my_engine", 1234, 5678, None::<usize>, None //! )?; //! # Ok(()) } //! ``` //! //! ## TS.MRANGE //! Batch query multiple ranges of time series data. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_ts::{TsCommands, TsMrange, TsAggregationType, TsFilterOptions}; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! let first_three_avg:TsMrange<u64,f64> = con.ts_mrange( //! "-", "+", Some(3), Some(TsAggregationType::Avg(5000)), //! TsFilterOptions::default().equals("sensor", "temperature") //! )?; //! //! let range_raw:TsMrange<u64,f64> = con.ts_mrange( //! 1234, 5678, None::<usize>, None, //! TsFilterOptions::default().equals("sensor", "temperature") //! )?; //! # Ok(()) } //! ``` //! //! ## TS.GET //! Get the most recent value of a time series. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_ts::{TsCommands}; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! let latest:Option<(u64,f64)> = con.ts_get("my_engine")?; //! # Ok(()) } //! ``` //! //! ## TS.MGET //! Get the most recent value of multiple time series. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_ts::{TsCommands, TsMget, TsFilterOptions}; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! let temperature:TsMget<u64,f64> = con.ts_mget( //! TsFilterOptions::default().equals("sensor", "temperature").with_labels(true) //! )?; //! # Ok(()) } //! ``` //! //! ## TS.INFO //! Get information about a time series key. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_ts::{TsCommands,TsInfo}; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! let info:TsInfo = con.ts_info("my_engine")?; //! # Ok(()) } //! ``` //! //! ## TS.QUERYINDEX //! Get the keys of time series filtered by given filter. //! //! ```rust,no_run //! # fn run() -> redis::RedisResult<()> { //! # use redis::Commands; //! # use redis_ts::{TsCommands,TsFilterOptions}; //! # let client = redis::Client::open("redis://127.0.0.1/")?; //! # let mut con = client.get_connection()?; //! let index:Vec<String> = con.ts_queryindex( //! TsFilterOptions::default().equals("sensor", "temperature") //! )?; //! # Ok(()) } //! ``` //! pub use crate::async_commands::AsyncTsCommands; pub use crate::commands::TsCommands; pub use crate::types::{ TsAggregationType, TsFilterOptions, TsInfo, TsMget, TsMrange, TsOptions, TsRange, }; mod async_commands; mod commands; mod types;