config

Documentation

Index

• Constants
• func AccessTokenPath() (string, error)
• func ConfigDir() (string, error)
• func DefaultConfigPath() (string, error)
• func ProjectConfigFile() string
• func ProjectConfigPath() (string, error)
• func RootGitRepoDir() (string, error)
• type Config
  • func New() (*Config, error)
  • func (c *Config) IsAuthenticated() bool
  • func (c *Config) NewClientFromConfig(clientOpts ...ps.ClientOption) (*ps.Client, error)
• type ConfigFS
  • func NewConfigFS(fsys fs.FS) *ConfigFS
  • func (c *ConfigFS) DefaultConfig() (*FileConfig, error)
  • func (c *ConfigFS) NewFileConfig(path string) (*FileConfig, error)
  • func (c *ConfigFS) ProjectConfig() (*FileConfig, error)
• type FileConfig
  • func (f *FileConfig) Write(path string) error
  • func (f *FileConfig) WriteDefault() error
  • func (f *FileConfig) WriteProject() error

Constants

const (
	TokenFileMode = 0600
)

Functions

func AccessTokenPath

func AccessTokenPath() (string, error)

AccessTokenPath is the path for the access token file

func ConfigDir

func ConfigDir() (string, error)

ConfigDir is the directory for PlanetScale config.

func DefaultConfigPath

func DefaultConfigPath() (string, error)

DefaultConfigPath returns the default path for the config file.

func ProjectConfigFile

func ProjectConfigFile() string

func ProjectConfigPath

func ProjectConfigPath() (string, error)

ProjectConfigPath returns the path of a configuration inside a Git repository.

func RootGitRepoDir

func RootGitRepoDir() (string, error)

Types

type Config

type Config struct {
	AccessToken  string
	BaseURL      string
	Organization string

	ServiceTokenName string
	ServiceToken     string

	// Project Configuration
	Database string
	Branch   string
}

Config is dynamically sourced from various files and environment variables.

func New

func New() (*Config, error)

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 ConfigFS

type ConfigFS struct {
	// contains filtered or unexported fields
}

func NewConfigFS

func NewConfigFS(fsys fs.FS) *ConfigFS

func (*ConfigFS) DefaultConfig

func (c *ConfigFS) DefaultConfig() (*FileConfig, error)

DefaultConfig returns the file config from the default config path.

func (*ConfigFS) NewFileConfig

func (c *ConfigFS) NewFileConfig(path string) (*FileConfig, error)

NewFileConfig reads the file config from the designated path and returns a new FileConfig.

func (*ConfigFS) ProjectConfig

func (c *ConfigFS) ProjectConfig() (*FileConfig, error)

ProjectConfig returns the file config from the git project

type FileConfig

type FileConfig struct {
	Organization string `yaml:"org" json:"org"`
	Database     string `yaml:"database,omitempty" json:"database,omitempty"`
	Branch       string `yaml:"branch,omitempty" json:"branch,omitempty"`
}

FileConfig defines a pscale configuration from a file.

func (*FileConfig) Write

func (f *FileConfig) Write(path string) error

Write persists the file config at the designated path.

func (*FileConfig) WriteDefault

func (f *FileConfig) WriteDefault() error

WriteDefault persists the file config to the default global path.

func (*FileConfig) WriteProject

func (f *FileConfig) WriteProject() error

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