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

database

package

Go to main page

Versions in this module

v0

v0.6.0

Oct 2, 2026

Changes in this version

type DatabaseProvider

+ func NewAt(root string, environment []string) *DatabaseProvider

v0.5.0

Sep 14, 2026

v0.4.1

Aug 29, 2026

v0.4.0

Aug 29, 2026

v0.3.5

Aug 26, 2026

v0.3.4

Aug 25, 2026

v0.3.3

Aug 24, 2026

Changes in this version

+ func RegisterConnections(rt *runner.Runtime)

v0.3.2

Aug 20, 2026

v0.3.1

Aug 20, 2026

Changes in this version

+ var ErrReadOnly = errors.New("database is read-only")

+ func Open(driver, dsn string) (*sqlx.DB, error)

+ func Register(rt *runner.Runtime)

+ func RegisterMigrate(rt *runner.Runtime)

+ type Database struct

+ Bridge *client.Bridge

+ ID string

+ IsReadonly bool

+ func (b *Database) Begin(ctx context.Context) (any, error)

+ func (b *Database) Close(ctx context.Context) (any, error)

+ func (b *Database) Commit(ctx context.Context) (any, error)

+ func (b *Database) Connect(ctx context.Context) (any, error)

+ func (b *Database) Get(ctx context.Context, query string, args ...any) (any, error)

+ func (b *Database) GetAll(ctx context.Context, query string, args ...any) (any, error)

+ func (b *Database) Insert(ctx context.Context, table string, value any) (any, error)

+ func (b *Database) InsertID(ctx context.Context) (any, error)

+ func (b *Database) Query(ctx context.Context, query string, args ...any) (any, error)

+ func (b *Database) Replace(ctx context.Context, table string, value any) (any, error)

+ func (b *Database) Rollback(ctx context.Context) (any, error)

+ func (b *Database) RowsAffected(ctx context.Context) (any, error)

+ func (b *Database) SetID(id string)

+ func (b *Database) Update(ctx context.Context, table string, value any, keyColumns ...any) (any, error)

+ type DatabaseMigrate struct

+ func (m *DatabaseMigrate) Load(pattern string) error

+ func (m *DatabaseMigrate) Run(ctx context.Context) error

+ type DatabaseOption struct

+ MaxIdleConns int

+ MaxOpenConns int

+ func (o *DatabaseOption) Apply(client *sqlx.DB)

+ type DatabaseProvider struct

+ func New(environment []string) *DatabaseProvider

+ func NewDatabaseProvider(open func(string, string) (*sqlx.DB, error)) *DatabaseProvider

+ func (r *DatabaseProvider) Connect(ctx context.Context, names ...string) (*sqlx.DB, error)

+ func (r *DatabaseProvider) List() []string

+ func (r *DatabaseProvider) Open(_ context.Context, names ...string) (*sqlx.DB, error)

+ func (r *DatabaseProvider) Register(name string, config string)

+ type Provider = model.DatabaseProvider

+ var Default Provider = New(os.Environ())