postgres

Documentation

Index

• func AttachCluster(ctx context.Context, params AttachParams) error
• func CreateCluster(ctx context.Context, org *api.Organization, region *api.Region, ...) (err error)
• func IsFlex(machine *api.Machine) bool
• func MachineVMSizes() []api.VMSize
• func New() *cobra.Command
• func UnregisterMember(ctx context.Context, app *api.AppCompact, machine *api.Machine) error
• type AttachParams
• type ClusterParams
• type PostgresConfiguration

Functions

func AttachCluster

func AttachCluster(ctx context.Context, params AttachParams) error

AttachCluster is mean't to be called from an external package.

func CreateCluster

func CreateCluster(ctx context.Context, org *api.Organization, region *api.Region, params *ClusterParams) (err error)

CreateCluster creates a Postgres cluster with an optional name. The name will be prompted for if not supplied.

func IsFlex

func IsFlex(machine *api.Machine) bool

func MachineVMSizes

func MachineVMSizes() []api.VMSize

machineVMSizes represents the available VM configurations for Machines.

func New

func New() *cobra.Command

func UnregisterMember

func UnregisterMember(ctx context.Context, app *api.AppCompact, machine *api.Machine) error

Types

type AttachParams

type AttachParams struct {
	DbName       string
	AppName      string
	PgAppName    string
	DbUser       string
	VariableName string
	SuperUser    bool
	Force        bool
}

type ClusterParams

type ClusterParams struct {
	PostgresConfiguration
	Password   string
	SnapshotID string
	Detach     bool
	Manager    string
	ForkFrom   string
	Autostart  bool
}

type PostgresConfiguration

type PostgresConfiguration struct {
	Name               string
	Description        string
	ImageRef           string
	InitialClusterSize int
	VMSize             string
	MemoryMb           int
	DiskGb             int
}