pgdump

Documentation

Index

• func GetDump(db *pgengine.DB, additionalParams ...Parameter) (string, error)
• func GetDumpUsingBinary(pgDumpBinaryPath string, db *pgengine.DB, additionalParams ...Parameter) (string, error)
• type Parameter
  • func WithExcludeSchema(pattern string) Parameter
  • func WithSchemaOnly() Parameter

Functions

func GetDump

func GetDump(db *pgengine.DB, additionalParams ...Parameter) (string, error)

GetDump gets the pg_dump of the inputted database. It is only intended to be used for testing. You cannot securely pass passwords with this implementation, so it will only accept databases created for unit tests (spun up with the pgengine package) "pgdump" must be on the system's PATH

func GetDumpUsingBinary

func GetDumpUsingBinary(pgDumpBinaryPath string, db *pgengine.DB, additionalParams ...Parameter) (string, error)

Types

type Parameter

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

Parameter represents a parameter to be pg_dump. Don't use a type alias for a string slice because all parameters for pgdump should be explicitly added here

func WithExcludeSchema

func WithExcludeSchema(pattern string) Parameter

func WithSchemaOnly

func WithSchemaOnly() Parameter