observation

Documentation

Index

• Variables
• type CompositeRowReader
  • func NewCompositeRowReader(readers ...StreamRowReader) *CompositeRowReader
  • func (c *CompositeRowReader) Close(ctx context.Context) error
  • func (c *CompositeRowReader) Read() (row string, err error)
• type Dimension
• type DimensionFilters
  • func (d DimensionFilters) IsEmpty() bool
• type Reader
  • func NewReader(csvRowReader StreamRowReader) *Reader
  • func (reader *Reader) Close(ctx context.Context) (err error)
  • func (reader *Reader) ObservationsCount() int32
  • func (reader *Reader) Read(p []byte) (n int, err error)
  • func (reader *Reader) TotalBytesRead() int64
• type StreamRowReader

Variables

var (
	Published   = true
	Unpublished = false
)

Boolean indicators for publish flag

var ErrNoDataReturned = errors.New("no data returned in this row")

ErrNoDataReturned is returned if no data was read.

var ErrNoInstanceFound = errors.New("no instance found in datastore")

ErrNoInstanceFound is returned if no instance exists

var ErrNoResultsFound = errors.New("the filter options created no results")

ErrNoResultsFound is returned if the selected filter options produce no results

var ErrUnrecognisedType = errors.New("the value returned was not a string")

ErrUnrecognisedType is returned if a row does not have the expected string value.

Types

type CompositeRowReader

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

CompositeRowReader abstracts multiple StreamRowReader's to act as one

func NewCompositeRowReader

func NewCompositeRowReader(readers ...StreamRowReader) *CompositeRowReader

func (*CompositeRowReader) Close

func (c *CompositeRowReader) Close(ctx context.Context) error

func (*CompositeRowReader) Read

func (c *CompositeRowReader) Read() (row string, err error)

type Dimension

type Dimension struct {
	Name    string
	Options []string
}

Dimension represents an object containing a list of dimension values and the dimension name

type DimensionFilters

type DimensionFilters struct {
	Dimensions []*Dimension
	Published  *bool
}

DimensionFilters represents a list of dimension filters

func (DimensionFilters) IsEmpty

func (d DimensionFilters) IsEmpty() bool

IsEmpty return true if DimensionFilters is nil, empty or contains only empty values

type Reader

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

Reader is an io.Reader implementation that wraps a csvRowReader

func NewReader

func NewReader(csvRowReader StreamRowReader) *Reader

NewReader returns a new io.Reader for the given csvRowReader.

func (*Reader) Close

func (reader *Reader) Close(ctx context.Context) (err error)

Close the reader.

func (*Reader) ObservationsCount

func (reader *Reader) ObservationsCount() int32

ObservationsCount returns the total number of rows read by this reader.

func (*Reader) Read

func (reader *Reader) Read(p []byte) (n int, err error)

Read bytes from the underlying csvRowReader

func (*Reader) TotalBytesRead

func (reader *Reader) TotalBytesRead() int64

TotalBytesRead returns the total number of bytes read by this reader.

type StreamRowReader

type StreamRowReader interface {
	Read() (string, error) // TODO: this should take context
	Close(context.Context) error
}

StreamRowReader provides a reader of individual rows (lines) of a CSV.