config

Documentation

Index

• func AccessTokenPath() string
• func ConfigDir() string
• func DefaultGlobalConfigPath() string
• func GetProjectConfigFile() string
• func GetRootGitRepoDir() (string, error)
• func ProjectConfigPath() (string, error)
• type Config
  • func New() *Config
  • func (c *Config) IsAuthenticated() bool
  • func (c *Config) NewClientFromConfig(clientOpts ...ps.ClientOption) (*ps.Client, error)
• type GlobalConfig
  • func DefaultGlobalConfig() (*GlobalConfig, error)
  • func (g *GlobalConfig) Write(path string) error
  • func (g *GlobalConfig) WriteDefault() error
• type WritableProjectConfig
  • func (w *WritableProjectConfig) WriteDefault() error

Functions

func AccessTokenPath

func AccessTokenPath() string

AccessTokenPath is the path for the access token file

func ConfigDir

func ConfigDir() string

ConfigDir is the directory for PlanetScale config.

func DefaultGlobalConfigPath

func DefaultGlobalConfigPath() string

DefaultGlobalConfigPath returns the default path for the global config file.

func GetProjectConfigFile

func GetProjectConfigFile() string

func GetRootGitRepoDir

func GetRootGitRepoDir() (string, error)

func ProjectConfigPath

func ProjectConfigPath() (string, error)

Types

type Config

type Config struct {
	AccessToken  string
	BaseURL      string
	Organization string

	ServiceTokenName string
	ServiceToken     string

	// Project Configuration
	Database string
	Branch   string

	OutputJSON bool
}

Config is dynamically sourced from various files and environment variables.

func New

func New() *Config

func (*Config) IsAuthenticated

func (c *Config) IsAuthenticated() bool

func (*Config) NewClientFromConfig

func (c *Config) NewClientFromConfig(clientOpts ...ps.ClientOption) (*ps.Client, error)

NewClientFromConfig creates a PlaentScale API client from our configuration

type GlobalConfig

type GlobalConfig struct {
	Organization string `yaml:"org" json:"org"`
}

GlobalConfig is sourced from the global config path and contains globaly configurable options.

func DefaultGlobalConfig

func DefaultGlobalConfig() (*GlobalConfig, error)

DefaultGlobalConfig returns the global config from the default config path.

func (*GlobalConfig) Write

func (g *GlobalConfig) Write(path string) error

Write persists the writable global config at the designated path.

func (*GlobalConfig) WriteDefault

func (g *GlobalConfig) WriteDefault() error

WriteDefault persists the writable global config to the default global path.

type WritableProjectConfig

type WritableProjectConfig struct {
	Database string `yaml:"database"`
	Branch   string `yaml:"branch"`
}

func (*WritableProjectConfig) WriteDefault

func (w *WritableProjectConfig) WriteDefault() error

WriteDefault persists the writable project config at the default path which is pulled from the root of the git repository if a user is in one.