Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

pgdocker

package module

Go to main page

Versions in this module

v0

v0.7.6

Sep 1, 2026

v0.7.5

Aug 25, 2026

v0.7.4

Aug 18, 2026

v0.7.3

Aug 10, 2026

v0.7.2

Aug 10, 2026

v0.7.1

Aug 2, 2026

v0.7.0

Aug 1, 2026

v0.6.2

Aug 1, 2026

v0.6.1

Aug 1, 2026

v0.6.0

Aug 1, 2026

Changes in this version

type SnapshotSpec

+ Labels docker.Labels

v0.5.1

Aug 1, 2026

v0.5.0

Aug 1, 2026

v0.4.0

Aug 1, 2026

v0.3.1

Aug 1, 2026

v0.3.0

Aug 1, 2026

v0.2.1

Aug 1, 2026

v0.2.0

Aug 1, 2026

Changes in this version

+ const DefaultImage

+ const DefaultPort

+ const ErrAlreadyRunning

+ const ErrCloneFailed

+ const ErrInvalidSpec

+ const ErrNoDataVolume

+ const ErrNotReady

+ const ErrNotRunning

+ const ErrSnapshotExists

+ const ErrSnapshotNotFound

+ const ErrSnapshotSkew

+ type Clock func() time.Time

+ type DSN string

+ type DataDir docker.MountTarget

+ type DatabaseName string

+ type Engine interface

+ ContainerLogs func(ctx context.Context, id docker.ContainerID, options docker.LogOptions, ...) error

+ Containers func(ctx context.Context, query docker.ContainerQuery) ([]docker.ContainerSummary, error)

+ CreateContainer func(ctx context.Context, spec docker.ContainerSpec) (docker.ContainerID, error)

+ CreateVolume func(ctx context.Context, spec docker.VolumeSpec) (docker.VolumeDetails, error)

+ Exec func(ctx context.Context, id docker.ContainerID, command docker.Command, ...) (docker.ExitCode, error)

+ ImageExists func(ctx context.Context, image docker.ImageRef) (bool, error)

+ InspectContainer func(ctx context.Context, id docker.ContainerID) (docker.ContainerDetails, error)

+ PullImage func(ctx context.Context, image docker.ImageRef, options docker.PullOptions) error

+ RemoveContainer func(ctx context.Context, id docker.ContainerID, options docker.RemovalOptions) error

+ RemoveVolume func(ctx context.Context, name docker.VolumeName, options docker.VolumeRemoval) error

+ StartContainer func(ctx context.Context, id docker.ContainerID) error

+ StopContainer func(ctx context.Context, id docker.ContainerID, grace docker.StopSeconds) error

+ Volumes func(ctx context.Context, query docker.VolumeQuery) ([]docker.VolumeDetails, error)

+ WaitContainer func(ctx context.Context, id docker.ContainerID, condition docker.WaitCondition) (docker.ExitCode, error)

+ type Entropy io.Reader

+ type InitSQLDir string

+ type InitSpec struct

+ Command docker.Command

+ Database DatabaseName

+ Env docker.Env

+ Image docker.ImageRef

+ Output io.Writer

+ Password Password

+ Port docker.Port

+ User UserName

+ type Instance struct

+ DSN DSN

+ ID docker.ContainerID

+ Image docker.ImageRef

+ IsRunning bool

+ Labels docker.Labels

+ Name docker.ContainerName

+ Port docker.Port

+ Status docker.ContainerStatus

+ Volume docker.VolumeName

+ type ListenAddress docker.HostIP

+ type Manager struct

+ func New(options ...ManagerOption) (Manager, error)

+ func (m Manager) Init(ctx context.Context, spec InitSpec) (docker.ExitCode, error)

+ func (m Manager) Inspect(ctx context.Context, port docker.Port) (Report, error)

+ func (m Manager) List(ctx context.Context) ([]Report, error)

+ func (m Manager) SnapshotCreate(ctx context.Context, spec SnapshotSpec) (Snapshot, error)

+ func (m Manager) SnapshotDelete(ctx context.Context, name SnapshotName) error

+ func (m Manager) SnapshotList(ctx context.Context) ([]Snapshot, error)

+ func (m Manager) Start(ctx context.Context, spec StartSpec) (Instance, error)

+ func (m Manager) Stop(ctx context.Context, spec StopSpec) (StopReport, error)

+ type ManagerOption interface

+ type Namespace string

+ const DefaultNamespace

+ type Password string

+ type PortThreshold docker.Port

+ type PostgresMajor string

+ type Report struct

+ HasContainer bool

+ Instance Instance

+ Port docker.Port

+ Volumes []docker.VolumeName

+ type Retention string

+ const RetainAuto

+ const RetainKeep

+ const RetainRemove

+ type SettingKey string

+ type SettingValue string

+ type Settings map[SettingKey]SettingValue

+ type Snapshot struct

+ CreatedAt docker.VolumeCreatedAt

+ Labels docker.Labels

+ Major PostgresMajor

+ Name SnapshotName

+ SourcePort docker.Port

+ Volume docker.VolumeName

+ type SnapshotName string

+ type SnapshotSpec struct

+ CopyImage docker.ImageRef

+ Name SnapshotName

+ Port docker.Port

+ type StartSpec struct

+ Data DataDir

+ Database DatabaseName

+ Env docker.Env

+ Image docker.ImageRef

+ InitSQL InitSQLDir

+ Labels docker.Labels

+ Listen ListenAddress

+ Password Password

+ Platform docker.Platform

+ Port docker.Port

+ ReadyInterval time.Duration

+ ReadyTimeout time.Duration

+ Retain Retention

+ Settings Settings

+ Snapshot SnapshotName

+ SnapshotSkewEnabled bool

+ User UserName

+ Volume VolumeSource

+ type StopReport struct

+ KeptVolumes []docker.VolumeName

+ RemovedVolumes []docker.VolumeName

+ Stopped []docker.ContainerName

+ type StopSpec struct

+ Grace docker.StopSeconds

+ Port docker.Port

+ Retain Retention

+ type UserName string

+ type VolumeSource string

+ const VolumeAuto

+ const VolumeFresh

+ const VolumeReuse

+ type WithClock struct

+ Clock Clock

+ type WithEngine struct

+ Engine Engine

+ type WithEntropy struct

+ Entropy Entropy