pgdump

type Form struct {
	Format string `json:"format"` // a ParseFormat name
	Out    string `json:"out"`    // ~ and relative paths allowed (ResolveOut)
	Jobs   string `json:"jobs"`   // "" for 1
	// Content is "" (everything), "schema" or "data".
	Content string `json:"content"`
	// The filters: pg_dump patterns, separated by commas or blanks; a
	// pattern with a blank in it is "quoted".
	Schemas       string `json:"schemas"`
	Tables        string `json:"tables"`
	ExcludeTables string `json:"exclude_tables"`
	ExcludeData   string `json:"exclude_data"`

	NoOwner      bool `json:"no_owner"`
	NoPrivileges bool `json:"no_privileges"`
	Inserts      bool `json:"inserts"`
	Create       bool `json:"create"`
	Clean        bool `json:"clean"`
	// Extra is any other pg_dump options, as on a command line.
	Extra string `json:"extra"`
}

type Format string

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

type Options struct {
	Format Format
	// Out is the file, or for directory and split the directory, to write.
	// "" is stdout, for the single-file formats.
	Out string
	// Jobs dumps that many tables at once (directory and split only).
	// pg_dump's workers share one snapshot, so the dump stays consistent.
	Jobs int

	SchemaOnly, DataOnly bool
	// The filters take pg_dump's patterns: "public", "sales.*", "*log*".
	Schemas, ExcludeSchemas            []string
	Tables, ExcludeTables, ExcludeData []string

	Clean, IfExists, Create bool
	NoOwner, NoPrivileges   bool
	Inserts, ColumnInserts  bool
	// Compress is pg_dump's --compress: a level ("6") or, from
	// PostgreSQL 16, method[:detail] ("zstd:3", "lz4").
	Compress string
	Encoding string

	// KeepArchive keeps, for split, the directory-format archive the SQL
	// files were made from, as Out/archive — restorable with pg_restore.
	KeepArchive bool

	// Extra are pg_dump options dbc has no flag for, passed after its own:
	// `dbc dump -- --no-comments --lock-wait-timeout=10s`.
	Extra []string
}

type Run struct {
	// Name is the dbc connection, for messages; ServerMajor its server's
	// version, as Prepare found it (0 when not asked).
	Name        string
	ServerMajor int

	Tools Tools
	Conn  db.LibpqConn
	Opts  Options
	// Stdout receives the dump when it goes to stdout (no Opts.Out).
	Stdout io.Writer
	// Stderr receives the tools' own messages (warnings, errors).
	Stderr io.Writer
	// Progress, if set, is told what is happening, a line at a time.
	Progress func(string)
	// contains filtered or unexported fields
}

type Tools struct {
	Dump    string // pg_dump's path
	Restore string // pg_restore's, beside it; "" if not there
	Version string // "17.2", as pg_dump reports it
	Major   int
	// Image, when set, is the PostgreSQL image the tools run in, through
	// Docker (docker.go): no local pg_dump was new enough for the server.
	// Dump and Restore are then the tools' names in it, Docker the docker
	// binary.
	Image  string
	Docker string
}