config

Documentation

Overview

Package config stores connection profiles — named endpoints such as "staging" or "prod" — in one JSON file with mode 0600, since it holds passwords. The local container is the built-in "local" profile and is never stored.

Index

• func DefaultPath() string
• func ValidName(name string) error
• type Profile
• type Store
  • func Load(path string) (*Store, error)
  • func (s *Store) Delete(name string)
  • func (s *Store) Endpoint(name string) (driver.Endpoint, error)
  • func (s *Store) Get(name string) (Profile, bool)
  • func (s *Store) ImportLegacy(path string) (bool, error)
  • func (s *Store) Names() []string
  • func (s *Store) Put(old string, p Profile)
  • func (s *Store) Save() error

Functions

func DefaultPath

func DefaultPath() string

DefaultPath is <user config dir>/dbclone/profiles.json.

func ValidName

func ValidName(name string) error

ValidName checks a new profile name.

Types

type Profile

type Profile struct {
	Name   string            `json:"name"`
	Values map[string]string `json:"values"`
}

type Store

type Store struct {
	Path     string    `json:"-"`
	Profiles []Profile `json:"profiles"`
}

func Load

func Load(path string) (*Store, error)

Load reads the store; a missing file is an empty store.

func (*Store) Delete

func (s *Store) Delete(name string)

func (*Store) Endpoint

func (s *Store) Endpoint(name string) (driver.Endpoint, error)

Endpoint resolves a profile name, "local" included.

func (*Store) Get

func (s *Store) Get(name string) (Profile, bool)

func (*Store) ImportLegacy

func (s *Store) ImportLegacy(path string) (bool, error)

ImportLegacy turns an old .env.staging file into a "staging" profile, once. It reports whether a profile was added.

func (*Store) Names

func (s *Store) Names() []string

Names returns the profile names, sorted.

func (*Store) Put

func (s *Store) Put(old string, p Profile)

Put adds p, or replaces the profile called old (old may equal p.Name).

func (*Store) Save

func (s *Store) Save() error

Save writes the store with mode 0600 — it holds passwords.