gormseries

README

gormseries

A timeseries extension for the Go ORM known as Gorm

Documentation

Index

• type SeriesDB
  • func NewSeriesDB(db gorm.DB) *SeriesDB
  • func (sdb *SeriesDB) BuildScope() *gorm.DB
  • func (sdb *SeriesDB) TimeSeries(series SeriesRange, args ...interface{}) *gorm.DB
• type SeriesRange

Types

type SeriesDB

type SeriesDB struct {
	gorm.DB
	// contains filtered or unexported fields
}

func NewSeriesDB

func NewSeriesDB(db gorm.DB) *SeriesDB

func (*SeriesDB) BuildScope

func (sdb *SeriesDB) BuildScope() *gorm.DB

func (*SeriesDB) TimeSeries

func (sdb *SeriesDB) TimeSeries(series SeriesRange, args ...interface{}) *gorm.DB

args:

1. No args .... default value: date_trunc('{time_unit}', created_at) = day
2. Simple On Clause ex 'day = created_at'

type SeriesRange

type SeriesRange interface {
	StartDate() string
	EndDate() string
	StepInterval() string
	StepName() string
	DefaultJoinCond() string
}

var (
	DaysYear   SeriesRange = new(daysYear)
	MonthsYear SeriesRange = new(monthsYear)
)