yaml

Documentation

Overview

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

Index

• Variables
• type Dimension
• type ExtractConfig
• type ExtractPolicy
• 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 ExtractConfig

type ExtractConfig struct {
	Strategy string `yaml:"strategy,omitempty" mapstructure:"strategy,omitempty"`
	Size     string `yaml:"size,omitempty" mapstructure:"size,omitempty"`
}

type ExtractPolicy

type ExtractPolicy struct {
	Row  *ExtractConfig `yaml:"rows,omitempty" mapstructure:"rows,omitempty"`
	File *ExtractConfig `yaml:"files,omitempty" mapstructure:"files,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"`
	SmallestTimeGrain string `yaml:"smallest_time_grain"`
	DefaultTimeRange  string `yaml:"default_time_range"`
	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"`
	S3Endpoint            string         `yaml:"endpoint,omitempty" mapstructure:"endpoint,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"`
	HivePartition         *bool          `yaml:"hive_partitioning,omitempty" mapstructure:"hive_partitioning,omitempty"`
	Timeout               int32          `yaml:"timeout,omitempty"`
	ExtractPolicy         *ExtractPolicy `yaml:"extract,omitempty"`
	Format                string         `yaml:"format,omitempty" mapstructure:"format,omitempty"`
}

*

• This file contains the mapping from CatalogObject to Yaml files