Help us shape the future of Go! Take the 2026 Go Developer Survey

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

testdb

package module

Go to main page

Versions in this module

v0

v0.1.0

Oct 22, 2026

Changes in this version

+ const KeepOnFailureEnv

+ const MaxDBPrefixLength

+ var ErrNilProvider = errors.New("provider cannot be nil")

+ var ErrNoMigrator = errors.New("no migrator configured")

+ var ErrPrefixTooLong = errors.New("database prefix too long: would exceed database identifier limit")

+ var ErrTemplatesNotSupported = errors.New("templates are not supported")

+ func ContextOf(t testing.TB) context.Context

+ func NewDatabaseName(prefix string) (string, error)

+ func RegisterCleanup(t testing.TB, db *TestDatabase)

+ func ResolveAdminDSN(cfg Config, defaultDSN string, providerEnv ...string) string

+ func RunConfiguredMigrations(t testing.TB, db *TestDatabase, callerName string)

+ type Config struct

+ AdminDSNOverride string

+ DBPrefix string

+ KeepOnFailure bool

+ Migrator Migrator

+ TemplateName string

+ Verbose bool

+ func DefaultConfig() Config

+ type DBInitializer interface

+ InitializeTestDatabase func(ctx context.Context, dsn string) (any, error)

+ type Error struct

+ Err error

+ Op string

+ func (e *Error) Error() string

+ func (e *Error) Unwrap() error

+ type InspectCommander interface

+ InspectCommand func(dsn string) string

+ type Migrator interface

+ Migrate func(ctx context.Context, dsn string) error

+ type MigratorFunc func(ctx context.Context, dsn string) error

+ func (f MigratorFunc) Migrate(ctx context.Context, dsn string) error

+ type Option func(*Config)

+ func WithAdminDSN(dsn string) Option

+ func WithDBPrefix(prefix string) Option

+ func WithKeepOnFailure() Option

+ func WithMigrator(m Migrator) Option

+ func WithTemplate(name string) Option

+ func WithVerbose() Option

+ type Provider interface

+ BuildDSN func(dbName string) (string, error)

+ Cleanup func(ctx context.Context) error

+ CreateDatabase func(ctx context.Context, name string) error

+ DropDatabase func(ctx context.Context, name string) error

+ Initialize func(ctx context.Context, cfg Config) error

+ ResolvedAdminDSN func() string

+ TerminateConnections func(ctx context.Context, name string) error

+ type TemplateProvider interface

+ CreateDatabaseFromTemplate func(ctx context.Context, requestedName, templateName string) (actualName string, err error)

+ TemplateExists func(ctx context.Context, name string) (bool, error)

+ type TestDatabase struct

+ func New(t testing.TB, provider Provider, initializer DBInitializer, opts ...Option) (*TestDatabase, error)

+ func (td *TestDatabase) Close() error

+ func (td *TestDatabase) Config() Config

+ func (td *TestDatabase) DSN() string

+ func (td *TestDatabase) Entity() any

+ func (td *TestDatabase) Keep()

+ func (td *TestDatabase) Name() string

+ func (td *TestDatabase) RunMigrations(ctx context.Context) error