tskv

README

go-tskv

Go library for Time Series Key Value storage.

Usage

package main

import (
	"fmt"

	"github.com/brimstone/go-tskv"
)

func main() {
	weight, err := tskv.New(tskv.Config{
		Duration:  time.Hour,
		Frequency: time.Minute,
	})
	if err != nil {
		panic(err)
	}
	weight.InsertNow(100)
	fmt.Println("Last weight:", weight.Last().Int())
}

Documentation

Index

• type Config
• type Element
  • func (e *Element) Int() int
  • func (e *Element) Value() interface{}
• type Tskv
  • func New(config Config) (*Tskv, error)
  • func (t *Tskv) GetInt() []int
  • func (t *Tskv) GetMap() map[time.Time]Element
  • func (t *Tskv) GetRaw() []Element
  • func (t *Tskv) GetSince(when time.Time) *Tskv
  • func (t *Tskv) Inc(when time.Time, value interface{}) error
  • func (t *Tskv) IncNow(value interface{}) error
  • func (t *Tskv) Last() *Element
  • func (t *Tskv) MarshalJSON() ([]byte, error)
  • func (t *Tskv) Oldest() *Element
  • func (t *Tskv) Set(when time.Time, value interface{}) error
  • func (t *Tskv) SetNow(value interface{}) error
  • func (t *Tskv) Subscribe() chan *Tskv

Types

type Config

type Config struct {
	Duration  time.Duration
	Frequency time.Duration
}

Config holds our main configuration information

type Element

type Element struct {
	// contains filtered or unexported fields
}

Element Smallest Atom

func (*Element) Int

func (e *Element) Int() int

Int returns integer form of Element

func (*Element) Value

func (e *Element) Value() interface{}

Value returns integer form of Element

type Tskv

type Tskv struct {
	// contains filtered or unexported fields
}

Tskv our main structure

func New

func New(config Config) (*Tskv, error)

New Returns a brand new Tskv object

func (*Tskv) GetInt

func (t *Tskv) GetInt() []int

GetInt returns and integer representation of the series

func (*Tskv) GetMap

func (t *Tskv) GetMap() map[time.Time]Element

GetMap returns an raw representation of the series

func (*Tskv) GetRaw

func (t *Tskv) GetRaw() []Element

GetRaw returns an raw representation of the series

func (*Tskv) GetSince

func (t *Tskv) GetSince(when time.Time) *Tskv

GetSince Returns all of the elements

func (*Tskv) Inc

func (t *Tskv) Inc(when time.Time, value interface{}) error

Inc increments an element to our tskv

func (*Tskv) IncNow

func (t *Tskv) IncNow(value interface{}) error

IncNow increments an element to our tskv, at the current time

func (*Tskv) Last

func (t *Tskv) Last() *Element

Last returns the youngest element in our tskv

func (*Tskv) MarshalJSON

func (t *Tskv) MarshalJSON() ([]byte, error)

MarshalJSON provides an interface for json.Marshal

func (*Tskv) Oldest

func (t *Tskv) Oldest() *Element

Oldest returns the oldest element in our tskv

func (*Tskv) Set

func (t *Tskv) Set(when time.Time, value interface{}) error

Set Sets an element to our tskv

func (*Tskv) SetNow

func (t *Tskv) SetNow(value interface{}) error

SetNow Sets an element to our tskv, at the current time

func (*Tskv) Subscribe

func (t *Tskv) Subscribe() chan *Tskv

Subscribe returns a new channel in which updates to the tskv are sent