wolfwfr / redistimeseries-go

golang client lib for RedisTimeSeries

Disclaimer

This repository is not guaranteed to be actively maintained.
It was forked due to a current need for features that were missing in the parent repository.
The changes made are a best-effort attempt only and I do not take responsibility for any missing or broken features.

If you decide to use this repository and find an issue, feel free to report it, but please be aware of the above.

redistimeseries-go

Go client for RedisTimeSeries (https://github.com/RedisTimeSeries/redistimeseries), based on redigo.

Client and ConnPool based on the work of dvirsky and mnunberg on https://github.com/RediSearch/redisearch-go

Installing

$ go get github.com/WolfWFr/redistimeseries-go

Running tests

A simple test suite is provided, and can be run with:

$ go test

The tests expect a Redis server with the RedisTimeSeries module loaded to be available at localhost:6379

Example Code

package main 

import (
        "fmt"
        redistimeseries "github.com/WolfWFr/redistimeseries-go"
)

func main() {
		// Connect to localhost with no password
        var client = redistimeseries.NewClient("localhost:6379", "nohelp", nil)
        var keyname = "mytest"
        _, haveit := client.Info(keyname)
        if haveit != nil {
			client.CreateKeyWithOptions(keyname, redistimeseries.DefaultCreateOptions)
			client.CreateKeyWithOptions(keyname+"_avg", redistimeseries.DefaultCreateOptions)
			client.CreateRule(keyname, redistimeseries.AvgAggregation, 60, keyname+"_avg")
        }
		// Add sample with timestamp from server time and value 100
        // TS.ADD mytest * 100 
        _, err := client.AddAutoTs(keyname, 100)
        if err != nil {
                fmt.Println("Error:", err)
        }
}

Supported RedisTimeSeries Commands

Command	Recommended API and godoc
TS.CREATE	CreateKeyWithOptions
TS.ALTER	AlterKeyWithOptions
TS.ADD	Add AddAutoTs AddWithOptions AddAutoTsWithOptions
TS.MADD	MultiAdd
TS.INCRBY/TS.DECRBY	IncrBy / DecrBy
TS.CREATERULE	CreateRule
TS.DELETERULE	DeleteRule
TS.RANGE	RangeWithOptions
TS.REVRANGE	ReverseRangeWithOptions
TS.MRANGE	MultiRangeWithOptions
TS.MREVRANGE	MultiReverseRangeWithOptions
TS.GET	Get
TS.MGET	MultiGet MultiGetWithOptions
TS.INFO	Info
TS.QUERYINDEX	QueryIndex

License

redistimeseries-go is distributed under the Apache-2 license - see LICENSE