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

embeddedpostgres

package module

Go to main page

Versions in this module

v2

v2.0.1

Oct 19, 2026

v2.0.0

Oct 19, 2026

Changes in this version

+ var ErrDataVersion = errors.New("persistent data belongs to a different PostgreSQL major version")

+ var ErrServerAlreadyStarted = errors.New("server is already started")

+ var ErrServerNotStarted = errors.New("server has not been started")

+ var ReleaseVersion = "v2.0.0-dev"

+ func PruneCache(ctx context.Context, dir string) (int, error)

+ type BinaryProvider interface

+ Acquire func(context.Context, BinaryRequest) (*Installation, error)

+ type BinaryRequest struct

+ GOARCH string

+ GOOS string

+ Version PostgresVersion

+ type Config struct

+ func DefaultConfig() Config

+ func (c Config) BinariesPath(v string) Config

+ func (c Config) BinaryRepositoryURL(v string) Config

+ func (c Config) CachePath(v string) Config

+ func (c Config) DataPath(v string) Config

+ func (c Config) Database(v string) Config

+ func (c Config) Encoding(v string) Config

+ func (c Config) Environment(v ...string) Config

+ func (c Config) GetConnectionURL() string

+ func (c Config) Hooks(v Hooks) Config

+ func (c Config) Locale(v string) Config

+ func (c Config) Logger(v io.Writer) Config

+ func (c Config) Password(v string) Config

+ func (c Config) Port(v uint32) Config

+ func (c Config) Provider(v BinaryProvider) Config

+ func (c Config) RunAs(v User) Config

+ func (c Config) RuntimePath(v string) Config

+ func (c Config) StartParameters(v map[string]string) Config

+ func (c Config) StartTimeout(v time.Duration) Config

+ func (c Config) StopTimeout(v time.Duration) Config

+ func (c Config) Storage(v Storage) Config

+ func (c Config) Supervisor(path string) Config

+ func (c Config) UnixSocket(dir string) Config

+ func (c Config) Username(v string) Config

+ func (c Config) Version(v PostgresVersion) Config

+ type DownloadProvider struct

+ BaseURL string

+ CacheDir string

+ Client *http.Client

+ Offline bool

+ Target string

+ func (p DownloadProvider) Acquire(ctx context.Context, r BinaryRequest) (*Installation, error)

+ type EmbeddedPostgres struct

+ func NewDatabase(config ...Config) *EmbeddedPostgres

+ func (ep *EmbeddedPostgres) Close() error

+ func (ep *EmbeddedPostgres) ConnectionURL() string

+ func (ep *EmbeddedPostgres) Done() <-chan struct{}

+ func (ep *EmbeddedPostgres) Err() error

+ func (ep *EmbeddedPostgres) GetConnectionURL() string

+ func (ep *EmbeddedPostgres) GetPort() uint32

+ func (ep *EmbeddedPostgres) Info() InstanceInfo

+ func (ep *EmbeddedPostgres) Logs() string

+ func (ep *EmbeddedPostgres) Start() error

+ func (ep *EmbeddedPostgres) StartContext(ctx context.Context) (err error)

+ func (ep *EmbeddedPostgres) Stop() error

+ func (ep *EmbeddedPostgres) StopContext(ctx context.Context) error

+ type Hook func(context.Context, InstanceInfo) (cleanup func(context.Context) error, err error)

+ type Hooks struct

+ BeforeStart []Hook

+ Ready []Hook

+ type Installation struct

+ Dir string

+ Release func() error

+ type InstanceInfo struct

+ BinariesDir string

+ ConnectionURL string

+ DataDir string

+ Port uint32

+ WorkDir string

+ type LocalProvider string

+ func (p LocalProvider) Acquire(ctx context.Context, _ BinaryRequest) (*Installation, error)

+ type PostgresVersion string

+ const V15

+ const V16

+ const V17

+ const V18

+ type ProviderFunc func(context.Context, BinaryRequest) (*Installation, error)

+ func (f ProviderFunc) Acquire(ctx context.Context, r BinaryRequest) (*Installation, error)

+ type Storage struct

+ CacheDir string

+ DataDir string

+ WorkDir string

+ type User = platform.Identity

v2.0.0-alpha.5

Oct 19, 2026

v2.0.0-alpha.4

Oct 19, 2026

v2.0.0-alpha.3

Oct 6, 2026

v2.0.0-alpha.2

Oct 6, 2026

v2.0.0-alpha.1

Oct 6, 2026

Other modules containing this package

github.com/fergusstrange/embedded-postgres