yaml

Documentation

Overview

Package yaml reads and writes artifacts that exactly mirror the internal representation

Index

• Variables
• type Dimension
• type Measure
• type MetricsView
• type Source

Variables

var ErrNotSupported = errors.New("yaml only supported for sources and dashboards")

Types

type Dimension

type Dimension struct {
	Label       string
	Property    string `copier:"Name"`
	Description string
	Ignore      bool `yaml:"ignore,omitempty"`
}

type Measure

type Measure struct {
	Label       string
	Expression  string
	Description string
	Format      string `yaml:"format_preset"`
	Ignore      bool   `yaml:"ignore,omitempty"`
}

type MetricsView

type MetricsView struct {
	Label            string `yaml:"display_name"`
	Description      string
	Model            string
	TimeDimension    string `yaml:"timeseries"`
	TimeGrains       []string
	DefaultTimeGrain string `yaml:"default_timegrain"`
	Dimensions       []*Dimension
	Measures         []*Measure
}

type Source

type Source struct {
	Type                  string
	Path                  string `yaml:"path,omitempty"`
	CsvDelimiter          string `yaml:"csv.delimiter,omitempty" mapstructure:"csv.delimiter,omitempty"`
	URI                   string `yaml:"uri,omitempty"`
	Region                string `yaml:"region,omitempty" mapstructure:"region,omitempty"`
	GlobMaxTotalSize      int64  `yaml:"glob.max_total_size,omitempty" mapstructure:"glob.max_total_size,omitempty"`
	GlobMaxObjectsMatched int    `yaml:"glob.max_objects_matched,omitempty" mapstructure:"glob.max_objects_matched,omitempty"`
	GlobMaxObjectsListed  int64  `yaml:"glob.max_objects_listed,omitempty" mapstructure:"glob.max_objects_listed,omitempty"`
	GlobPageSize          int    `yaml:"glob.page_size,omitempty" mapstructure:"glob.page_size,omitempty"`
}

*

• This file contains the mapping from CatalogObject to Yaml files