Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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
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.8.6

Jul 25, 2024

v0.8.5

Jul 22, 2024

Changes in this version

+ const MigrationDir

+ var ErrCantCreateDatabase = errors.New("can't create the database")

+ var ErrCloseListenersFull = errors.New("close listeners are at full capacity")

+ var ErrDatabaseNotFound = errors.New("database not found")

+ var ErrNoMigrationFS = fmt.Errorf("migration filesystem is not set")

+ type AfterOpenHook interface

+ AfterOpen func(dbh *DBHandle) error

+ type BaseDataSource string

+ func NewDataSource(dsn string) BaseDataSource

+ func (d BaseDataSource) ConnMaxLifetime() time.Duration

+ func (d BaseDataSource) DSN() string

+ func (d BaseDataSource) MaxConnections() int

+ func (d BaseDataSource) QueryTimeout() time.Duration

+ func (d BaseDataSource) String() string

+ type BaseEngine struct

+ func NewEngine(driver string, dsnSource DataSource, migrationFS *embed.FS) BaseEngine

+ func (e BaseEngine) DSNSource() DataSource

+ func (e BaseEngine) Driver() string

+ func (e BaseEngine) MigrationFS() *embed.FS

+ type BeforeClose func()

+ type BeforeMigrateUpHook interface

+ BeforeMigrateUp func(dbh *DBHandle) error

type DBHandle

+ Engine Engine

+ func New(engine Engine) *DBHandle

+ func (d *DBHandle) MigrateUp(env ...string) error

+ func (d DBHandle) MigrateReset(env ...string) error

+ func (d DBHandle) PrintMigrationStatus() error

+ func (s *DBHandle) AddCloseListener(f BeforeClose) error

+ type Engine interface

+ DSNSource func() DataSource

+ Driver func() string

+ MigrationFS func() *embed.FS

+ type Maintainable interface

+ Maintain func(dbh *DBHandle) error

+ type MigrationEnvSetter interface

+ MigrationEnv func() []string

+ type Observable interface

+ Stats func(dbh *DBHandle) (any, error)

v0.8.4

May 17, 2024

v0.8.3

May 6, 2024

v0.8.2

Apr 26, 2024

Changes in this version

type DBHandle

+ func (s *DBHandle[T]) Stats() (any, error)

v0.8.1

Apr 5, 2024

v0.8.0

Apr 2, 2024

Changes in this version

+ var ErrCantResetMaintenance = errors.New("can't reset maintenance ticker")

+ var ErrDatabaseAlreadyOpen = errors.New("database already opened")

+ var ErrDatabaseClosed = errors.New("database closed")

+ var ErrDatabaseNotOpen = errors.New("database not opened")

+ var ErrInvalidDuration = errors.New("invalid duration for maintenance ticker")

+ var MinMaintenanceInterval = 1 * time.Minute

+ func WithConnMaxLifetime(lifetime time.Duration) dataSourceOption

+ func WithMaxConnections(maxConnections int) dataSourceOption

+ func WithQueryTimeout(timeout time.Duration) dataSourceOption

+ type DBHandle struct

+ Ctx context.Context

+ DB *sql.DB

+ DSNSource DataSource

+ Driver DriverName

+ func (s *DBHandle[T]) Close() error

+ func (s *DBHandle[T]) Exec(query string, args ...any) (sql.Result, error)

+ func (s *DBHandle[T]) ExecTimeout(timeout time.Duration, query string, args ...any) (sql.Result, error)

+ func (s *DBHandle[T]) Maintenance(d time.Duration, f MaintenanceFunction) error

+ func (s *DBHandle[T]) Open(ctx context.Context) error

+ func (s *DBHandle[T]) Ping() error

+ func (s *DBHandle[T]) Query(query string, args ...any) (*sql.Rows, error)

+ func (s *DBHandle[T]) QueryRow(query string, args ...any) *sql.Row

+ func (s *DBHandle[T]) QueryRowTimeout(timeout time.Duration, query string, args ...any) *sql.Row

+ func (s *DBHandle[T]) QueryTimeout(timeout time.Duration, query string, args ...any) (*sql.Rows, error)

+ func (s *DBHandle[T]) Statement(key T, generator StatementGenerator) (*sql.Stmt, error)

+ func (s *DBHandle[T]) StopMaintenance()

+ func (s DBHandle[T]) String() string

+ type DSNOptions struct

+ DSNString string

+ func NewDSN(dsn string, options ...dataSourceOption) DSNOptions

+ func (d DSNOptions) ConnMaxLifetime() time.Duration

+ func (d DSNOptions) DSN() string

+ func (d DSNOptions) MaxConnections() int

+ func (d DSNOptions) QueryTimeout() time.Duration

+ func (d DSNOptions) String() string

+ type DataSource interface

+ ConnMaxLifetime func() time.Duration

+ DSN func() string

+ MaxConnections func() int

+ QueryTimeout func() time.Duration

+ type DriverName string

+ const MySQL

+ const SQLite

+ type MaintenanceFunction func(ctx context.Context, db *sql.DB, t time.Time) error

+ type StatementGenerator func(ctx context.Context, db *sql.DB) (*sql.Stmt, error)