config

Documentation

Index

• func AccessTokenPath() string
• func ConfigDir() string
• func DefaultConfigPath() 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)
  • func (c *Config) ToWritableConfig() *WritableConfig
  • func (c *Config) ToWritableProjectConfig() *WritableProjectConfig
• type WritableConfig
  • func (w *WritableConfig) Write(path string) 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 DefaultConfigPath

func DefaultConfigPath() string

DefaultConfigPath is the path for the 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
}

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

func (*Config) ToWritableConfig

func (c *Config) ToWritableConfig() *WritableConfig

ToWritableConfig returns an instance of WritableConfig from the Config struct.

func (*Config) ToWritableProjectConfig

func (c *Config) ToWritableProjectConfig() *WritableProjectConfig

ToWritableProjectConfig returns an instance of WritableProjectConfig from the Config struct.

type WritableConfig

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

WritableConfig maps

func (*WritableConfig) Write

func (w *WritableConfig) Write(path string) error

Write persists the writable config at the designated 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.