pgctl

Documentation

Index

• Constants
• Variables
• func Exec(name string, arg ...string) (string, error)
• func IsAdminUser(db *sql.DB) (bool, error)
• func SanitizeDSN(dsn string) string
• type Config
• type Dump
  • func NewDump(DsnUri string) *Dump
  • func (x *Dump) EnableVerbose()
  • func (x *Dump) Exec(opts ExecOptions) Result
  • func (x *Dump) GetFileName() string
  • func (x *Dump) GetOptions() []string
  • func (x *Dump) ResetOptions()
  • func (x *Dump) SetFileName(filename string)
  • func (x *Dump) SetOptions(o []string)
  • func (x *Dump) SetPath(path string)
  • func (x *Dump) SetupFormat(f string)
• type ExecOptions
• type ExportFile
• type Restore
  • func NewRestore(DsnUri string) *Restore
  • func (x *Restore) DropSchemas() Result
  • func (x *Restore) EnableVerbose()
  • func (x *Restore) Exec(filename string, opts ExecOptions) Result
  • func (x *Restore) GetOptions() []string
  • func (x *Restore) ResetOptions()
  • func (x *Restore) SetOptions(o []string)
  • func (x *Restore) SetPath(path string)
  • func (x *Restore) SetSchemas(schemas []string)
• type Result
• type ResultError
• type Results
• type State
  • func GetReplicatorState(name string, c Config) (State, error)
• type StateEnum
  • func GetStateEnum(name string) (StateEnum, error)
  • func (s StateEnum) String() string

Constants

const (
	DefaultPubName = "dbc_temp_pub_for_upgrade"
	DefaultSubName = "dbc_temp_sub_for_upgrade"
)

Variables

var (
	PGDump              = "pg_dump"
	PGDumpOpts          = []string{}
	PGDumpDefaultFormat = "p"
)

var (
	PSQL           = "psql"
	PGDRestoreOpts = []string{}
)

Functions

func Exec

func Exec(name string, arg ...string) (string, error)

func IsAdminUser

func IsAdminUser(db *sql.DB) (bool, error)

IsAdminUser checks if the user is a superuser or has replication role

func SanitizeDSN

func SanitizeDSN(dsn string) string

Types

type Config

type Config struct {
	Log logr.Logger
	// Cloud assumes `aws` if not specified
	Cloud            string
	SourceDBAdminDsn string
	SourceDBUserDsn  string
	TargetDBAdminDsn string
	TargetDBUserDsn  string
	ExportFilePath   string
}

type Dump

type Dump struct {
	DsnUri  string
	Verbose bool
	Path    string
	Format  *string
	Options []string
	// contains filtered or unexported fields
}

func NewDump

func NewDump(DsnUri string) *Dump

func (*Dump) EnableVerbose

func (x *Dump) EnableVerbose()

func (*Dump) Exec

func (x *Dump) Exec(opts ExecOptions) Result

func (*Dump) GetFileName

func (x *Dump) GetFileName() string

func (*Dump) GetOptions

func (x *Dump) GetOptions() []string

func (*Dump) ResetOptions

func (x *Dump) ResetOptions()

func (*Dump) SetFileName

func (x *Dump) SetFileName(filename string)

func (*Dump) SetOptions

func (x *Dump) SetOptions(o []string)

func (*Dump) SetPath

func (x *Dump) SetPath(path string)

func (*Dump) SetupFormat

func (x *Dump) SetupFormat(f string)

type ExecOptions

type ExecOptions struct {
	StreamPrint bool
}

type ExportFile

type ExportFile struct {
	Path string
	Name string
}

type Restore

type Restore struct {
	DsnUri  string
	Verbose bool
	Path    string
	Options []string
	Schemas []string
}

func NewRestore

func NewRestore(DsnUri string) *Restore

NewRestore creates a new Restore instance with the provided configuration.

func (*Restore) DropSchemas

func (x *Restore) DropSchemas() Result

DropSchemas drops all schemas except the system ones.

func (*Restore) EnableVerbose

func (x *Restore) EnableVerbose()

func (*Restore) Exec

func (x *Restore) Exec(filename string, opts ExecOptions) Result

Exec runs the pg_restore command with the provided filename and options.

func (*Restore) GetOptions

func (x *Restore) GetOptions() []string

func (*Restore) ResetOptions

func (x *Restore) ResetOptions()

func (*Restore) SetOptions

func (x *Restore) SetOptions(o []string)

func (*Restore) SetPath

func (x *Restore) SetPath(path string)

func (*Restore) SetSchemas

func (x *Restore) SetSchemas(schemas []string)

type Result

type Result struct {
	Mine        string
	FileName    string
	Output      string
	Error       *ResultError
	FullCommand string
}

type ResultError

type ResultError struct {
	Err       error
	CmdOutput string
	ExitCode  int
}

type Results

type Results struct {
	Dump    Result
	Restore Result
}

type State

type State interface {
	Execute() (State, error)
	Id() StateEnum
	String() string
}

func GetReplicatorState

func GetReplicatorState(name string, c Config) (State, error)

type StateEnum

type StateEnum int

const (
	S_Initial StateEnum = iota
	S_ValidateConnection
	S_CreatePublication
	S_CopySchema
	S_CreateSubscription
	S_EnableSubscription
	S_CutOverReadinessCheck
	S_ResetTargetSequence
	S_RerouteTargetSecret
	S_WaitToDisableSource
	S_DisableSourceAccess
	S_MigrationInProgress
	S_ValidateMigrationStatus
	S_DisableSubscription
	S_DeleteSubscription
	S_DeletePublication
	S_Completed
	S_Retry
)

func GetStateEnum

func GetStateEnum(name string) (StateEnum, error)

func (StateEnum) String

func (s StateEnum) String() string