models

Documentation

Index

• type DatasourceSettings
  • func LoadSettings(ctx backend.PluginContext) (*DatasourceSettings, error)
• type QueryModel
  • func GetQueryModel(query backend.DataQuery) (*QueryModel, error)

Types

type DatasourceSettings

type DatasourceSettings struct {
	InstanceSettings   backend.DataSourceInstanceSettings
	AuthType           string `json:"authType"` // jwt | key | gce
	APIKey             string `json:"apiKey"`
	DefaultProject     string `json:"defaultProject"`
	JWT                string `json:"jwt"`
	ClientEmail        string `json:"clientEmail"`
	TokenURI           string `json:"tokenUri"`
	AuthenticationType string `json:"authenticationType"`
	PrivateKeyPath     string `json:"privateKeyPath"`

	// Saved in secure JSON
	PrivateKey string `json:"-"`
}

DatasourceSettings contains Google Sheets API authentication properties.

func LoadSettings

func LoadSettings(ctx backend.PluginContext) (*DatasourceSettings, error)

LoadSettings gets the relevant settings from the plugin context

type QueryModel

type QueryModel struct {
	Spreadsheet          string `json:"spreadsheet"`
	Range                string `json:"range"`
	CacheDurationSeconds int    `json:"cacheDurationSeconds"`
	UseTimeFilter        bool   `json:"useTimeFilter"`

	// Not from JSON
	TimeRange     backend.TimeRange `json:"-"`
	MaxDataPoints int64             `json:"-"`
}

QueryModel represents a spreadsheet query.

func GetQueryModel

func GetQueryModel(query backend.DataQuery) (*QueryModel, error)

GetQueryModel returns the well typed query model