profile

Documentation

Index

• type ConnectProfile
• type ConnectProfileFile

Types

type ConnectProfile

type ConnectProfile struct {
	// Name is the profile name.
	Name string
	// Host is the host to connect to.
	Host string
	// Port is the port number to connect to.
	Port int
	// User is an optional database user name.
	User string
	// Database is an optional database name.
	Database string
	// Insecure is whether to skip certificate validation.
	Insecure bool
	// CACertPath is the CA certificate path.
	CACertPath string
	// CertPath is the client certificate path.
	CertPath string
	// KeyPath is the client key path.
	KeyPath string
}

ConnectProfile represents a database connection profile parameters.

type ConnectProfileFile

type ConnectProfileFile interface {
	// Upsert saves the provided connection profile.
	Upsert(profile ConnectProfile) error
	// Env returns the specified connection profile as environment variables.
	Env(name string) (map[string]string, error)
	// Delete removes the specified connection profile.
	Delete(name string) error
}

ConnectProfileFile is a common interface for database connection profiles.