options

Documentation

Index

• Constants
• type Connection
  • func (c *Connection) ConfigMap() map[string]interface{}
  • func (c *Connection) Equals(other *Connection) bool
  • func (c *Connection) Merge(otherOptions Options)
  • func (c *Connection) MigrateLegacy()
  • func (c *Connection) String() string
• type Database
  • func (d *Database) ConfigMap() map[string]interface{}
  • func (d *Database) Merge(otherOptions Options)
  • func (d *Database) String() string
• type General
  • func (g *General) ConfigMap() map[string]interface{}
  • func (g *General) Merge(otherOptions Options)
  • func (g *General) String() string
• type Options
• type Terminal
  • func (t *Terminal) ConfigMap() map[string]interface{}
  • func (t *Terminal) Merge(otherOptions Options)
  • func (t *Terminal) String() string

Constants

const (
	ConnectionBlock = "connection"
	DatabaseBlock   = "database"
	GeneralBlock    = "general"
	TerminalBlock   = "terminal"
)

hcl options block types

Types

type Connection

type Connection struct {
	Cache    *bool `hcl:"cache" json:"cache,omitempty"`
	CacheTTL *int  `hcl:"cache_ttl" json:"cache_ttl,omitempty"`

	// legacy properties included for backwards compatibility with v0.13
	LegacyCache    *bool `json:"Cache,omitempty"`
	LegacyCacheTTL *int  `json:"CacheTTL,omitempty"`
}

Connection is a struct representing connection options json tags needed as this is stored in the connection state file

func (*Connection) ConfigMap

func (c *Connection) ConfigMap() map[string]interface{}

func (*Connection) Equals

func (c *Connection) Equals(other *Connection) bool

func (*Connection) Merge

func (c *Connection) Merge(otherOptions Options)

Merge merges other options over the top of this options object i.e. if a property is set in otherOptions, it takes precedence

func (*Connection) MigrateLegacy

func (c *Connection) MigrateLegacy()

MigrateLegacy migrates the legacy properties into new properties

func (*Connection) String

func (c *Connection) String() string

type Database

type Database struct {
	Port         *int    `hcl:"port"`
	Listen       *string `hcl:"listen"`
	SearchPath   *string `hcl:"search_path"`
	StartTimeout *int    `hcl:"start_timeout"`
}

Database

func (*Database) ConfigMap

func (d *Database) ConfigMap() map[string]interface{}

ConfigMap :: create a config map to pass to viper

func (*Database) Merge

func (d *Database) Merge(otherOptions Options)

Merge :: merge other options over the the top of this options object i.e. if a property is set in otherOptions, it takes precedence

func (*Database) String

func (d *Database) String() string

type General

type General struct {
	UpdateCheck *string `hcl:"update_check"`
	MaxParallel *int    `hcl:"max_parallel"`
	Telemetry   *string `hcl:"telemetry"`
}

General

func (*General) ConfigMap

func (g *General) ConfigMap() map[string]interface{}

ConfigMap :: create a config map to pass to viper

func (*General) Merge

func (g *General) Merge(otherOptions Options)

Merge :: merge other options over the the top of this options object i.e. if a property is set in otherOptions, it takes precedence

func (*General) String

func (g *General) String() string

type Options

type Options interface {
	// map of config keys to values - used to populate viper
	ConfigMap() map[string]interface{}
	// merge with another options of same type
	Merge(otherOptions Options)
}

type Terminal

type Terminal struct {
	Output           *string `hcl:"output"`
	Separator        *string `hcl:"separator"`
	Header           *bool   `hcl:"header"`
	Multi            *bool   `hcl:"multi"`
	Timing           *bool   `hcl:"timing"`
	SearchPath       *string `hcl:"search_path"`
	SearchPathPrefix *string `hcl:"search_path_prefix"`
	Watch            *bool   `hcl:"watch"`
	AutoComplete     *bool   `hcl:"autocomplete"`
}

Terminal

func (*Terminal) ConfigMap

func (t *Terminal) ConfigMap() map[string]interface{}

ConfigMap :: create a config map to pass to viper

func (*Terminal) Merge

func (t *Terminal) Merge(otherOptions Options)

merge other options over the the top of this options object i.e. if a property is set in otherOptions, it takes precedence

func (*Terminal) String

func (t *Terminal) String() string