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
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 module

Go to main page

Versions in this module

v2

v2.2.0

Nov 2, 2025

Changes in this version

+ const EffectiveTokenLifetime

+ const IAMTokenTTL

+ const TokenRefreshBuffer

+ var ErrMissingIAMRegion = errors.New("AWS IAM auth region is required but not configured")

+ var ErrMissingIAMUsername = errors.New("database username is required for IAM auth but not found in DSN or config")

+ type TTLStore struct

+ func NewTTLStore(wrapped driver.Store) *TTLStore

+ func NewTTLStoreWithLifetime(wrapped driver.Store, lifetime time.Duration) *TTLStore

+ func (s *TTLStore) Get(ctx context.Context) (driver.Credentials, error)

+ func (s *TTLStore) GetTokenAge() time.Duration

+ func (s *TTLStore) IsTokenFresh() bool

+ func (s *TTLStore) Refresh(ctx context.Context) (driver.Credentials, error)

v2.1.0

Nov 1, 2025

v2.0.0

Oct 31, 2025

Changes in this version

+ const DefaultConnectionTimeout

+ const EventTypeConfigLoaded

+ const EventTypeConnected

+ const EventTypeConnectionError

+ const EventTypeDisconnected

+ const EventTypeMigrationCompleted

+ const EventTypeMigrationFailed

+ const EventTypeMigrationStarted

+ const EventTypeQueryError

+ const EventTypeQueryExecuted

+ const EventTypeTransactionCommitted

+ const EventTypeTransactionRolledBack

+ const EventTypeTransactionStarted

+ const Name

+ var ErrAWSIAMAuthNotEnabled = errors.New("AWS IAM auth not enabled")

+ var ErrDatabaseNotConnected = errors.New("database not connected")

+ var ErrEmptyDSN = errors.New("database connection string (DSN) cannot be empty")

+ var ErrEmptyDriver = errors.New("database driver cannot be empty")

+ var ErrExtractEndpointFailed = errors.New("could not extract endpoint from DSN")

+ var ErrInvalidConfigType = errors.New("invalid config type for database module")

+ var ErrInvalidDSNFormat = errors.New("invalid DSN format")

+ var ErrInvalidTableName = errors.New(...)

+ var ErrMigrationServiceNotInitialized = errors.New("migration service not initialized")

+ var ErrMissingDSN = errors.New("database connection missing DSN")

+ var ErrMissingDriver = errors.New("database connection missing driver")

+ var ErrNoDefaultService = errors.New("no default database service available")

+ var ErrNoSubjectForEventEmission = errors.New("no subject available for event emission")

+ var ErrNoUserInfoInDSN = errors.New("no user information in DSN to replace password")

+ var ErrTransactionNil = errors.New("transaction cannot be nil")

+ type AWSIAMAuthConfig struct

+ ConnectionTimeout time.Duration

+ DBUser string

+ Enabled bool

+ Region string

+ type Config struct

+ Connections map[string]*ConnectionConfig

+ Default string

+ func (c *Config) GetInstanceConfigs() map[string]interface{}

+ func (c *Config) Validate() error

+ type ConnectionConfig struct

+ AWSIAMAuth *AWSIAMAuthConfig

+ ConnectionMaxIdleTime time.Duration

+ ConnectionMaxLifetime time.Duration

+ DSN string

+ Driver string

+ MaxIdleConnections int

+ MaxOpenConnections int

+ type DatabaseService interface

+ Begin func() (*sql.Tx, error)

+ BeginTx func(ctx context.Context, opts *sql.TxOptions) (*sql.Tx, error)

+ Close func() error

+ CommitTransaction func(ctx context.Context, tx *sql.Tx) error

+ Connect func() error

+ CreateMigrationsTable func(ctx context.Context) error

+ DB func() *sql.DB

+ Exec func(query string, args ...interface{}) (sql.Result, error)

+ ExecContext func(ctx context.Context, query string, args ...interface{}) (sql.Result, error)

+ Execute func(query string, args ...interface{}) (sql.Result, error)

+ ExecuteContext func(ctx context.Context, query string, args ...interface{}) (sql.Result, error)

+ GetAppliedMigrations func(ctx context.Context) ([]string, error)

+ Ping func(ctx context.Context) error

+ Prepare func(query string) (*sql.Stmt, error)

+ PrepareContext func(ctx context.Context, query string) (*sql.Stmt, error)

+ Query func(query string, args ...interface{}) (*sql.Rows, error)

+ QueryContext func(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)

+ QueryRow func(query string, args ...interface{}) *sql.Row

+ QueryRowContext func(ctx context.Context, query string, args ...interface{}) *sql.Row

+ RollbackTransaction func(ctx context.Context, tx *sql.Tx) error

+ RunMigration func(ctx context.Context, migration Migration) error

+ SetEventEmitter func(emitter EventEmitter)

+ Stats func() sql.DBStats

+ func NewDatabaseService(config ConnectionConfig, logger modular.Logger) (DatabaseService, error)

+ type EventEmitter interface

+ EmitEvent func(ctx context.Context, event cloudevents.Event) error

+ type Migration struct

+ ID string

+ SQL string

+ Up bool

+ Version string

+ type MigrationRunner struct

+ func NewMigrationRunner(service MigrationService) *MigrationRunner

+ func (r *MigrationRunner) RunMigrations(ctx context.Context, migrations []Migration) error

+ type MigrationService interface

+ CreateMigrationsTable func(ctx context.Context) error

+ GetAppliedMigrations func(ctx context.Context) ([]string, error)

+ RunMigration func(ctx context.Context, migration Migration) error

+ func NewMigrationService(db *sql.DB, eventEmitter EventEmitter) MigrationService

+ type Module struct

+ func NewModule() *Module

+ func (m *Module) Constructor() modular.ModuleConstructor

+ func (m *Module) Dependencies() []string

+ func (m *Module) EmitEvent(ctx context.Context, event cloudevents.Event) error

+ func (m *Module) GetConnection(name string) (*sql.DB, bool)

+ func (m *Module) GetConnections() []string

+ func (m *Module) GetDefaultConnection() *sql.DB

+ func (m *Module) GetDefaultService() DatabaseService

+ func (m *Module) GetRegisteredEventTypes() []string

+ func (m *Module) GetService(name string) (DatabaseService, bool)

+ func (m *Module) Init(app modular.Application) error

+ func (m *Module) Name() string

+ func (m *Module) ProvidesServices() []modular.ServiceProvider

+ func (m *Module) RegisterConfig(app modular.Application) error

+ func (m *Module) RegisterObservers(subject modular.Subject) error

+ func (m *Module) RequiresServices() []modular.ServiceDependency

+ func (m *Module) Start(ctx context.Context) error

+ func (m *Module) Stop(ctx context.Context) error

Other modules containing this package

github.com/CrisisTextLine/modular/modules/database