models

Documentation

Overview

Provides a set of structures for passing data around Kapacitor.

Index

• func SortedFields(fields Fields) []string
• func SortedKeys(tags map[string]string) []string
• type Dimensions
  • func (d Dimensions) Copy() Dimensions
  • func (d Dimensions) Equal(o Dimensions) bool
  • func (d Dimensions) ToSet() map[string]bool
• type Fields
  • func (f Fields) Copy() Fields
• type GroupID
  • func ToGroupID(name string, tags map[string]string, dims Dimensions) GroupID
• type Result
  • func (r Result) String() string
  • func (r *Result) UnmarshalJSON(data []byte) error
• type Row
  • func (r *Row) UnmarshalJSON(data []byte) error
• type Rows
• type Tags
  • func (t Tags) Copy() Tags

Functions

func SortedFields

func SortedFields(fields Fields) []string

func SortedKeys

func SortedKeys(tags map[string]string) []string

Types

type Dimensions

type Dimensions struct {
	ByName   bool
	TagNames []string
}

func (Dimensions) Copy

func (d Dimensions) Copy() Dimensions

func (Dimensions) Equal

func (d Dimensions) Equal(o Dimensions) bool

func (Dimensions) ToSet

func (d Dimensions) ToSet() map[string]bool

type Fields

type Fields map[string]interface{}

func (Fields) Copy

func (f Fields) Copy() Fields

type GroupID

type GroupID string

const (
	NilGroup GroupID = ""
)

func ToGroupID

func ToGroupID(name string, tags map[string]string, dims Dimensions) GroupID

type Result

type Result struct {
	Series Rows  `json:"series"`
	Err    error `json:"error,omitempty"`
}

func (Result) String

func (r Result) String() string

func (*Result) UnmarshalJSON

func (r *Result) UnmarshalJSON(data []byte) error

type Row

type Row struct {
	Name    string            `json:"name,omitempty"`
	Tags    map[string]string `json:"tags,omitempty"`
	Columns []string          `json:"columns,omitempty"`
	Values  [][]interface{}   `json:"values,omitempty"`
}

Row represents a single row returned from the execution of a statement.

func (*Row) UnmarshalJSON

func (r *Row) UnmarshalJSON(data []byte) error

type Rows

type Rows []*Row

Rows represents a collection of rows. Rows implements sort.Interface.

type Tags

type Tags map[string]string

func (Tags) Copy

func (t Tags) Copy() Tags