database

Oct 28, 2025

Changes in this version

type AWSIAMAuthConfig

+ ConnectionCloseGracePeriod time.Duration

Sep 9, 2025

Changes in this version

+ const DefaultConnectionTimeout

type AWSIAMAuthConfig

+ ConnectionTimeout time.Duration

type AWSIAMTokenProvider

+ func (p *AWSIAMTokenProvider) SetTokenRefreshCallback(callback TokenRefreshCallback)

+ type IAMTokenProvider interface

+ BuildDSNWithIAMToken func(ctx context.Context, originalDSN string) (string, error)

+ GetToken func(ctx context.Context, endpoint string) (string, error)

+ SetTokenRefreshCallback func(callback TokenRefreshCallback)

+ StartTokenRefresh func(ctx context.Context, endpoint string)

+ StopTokenRefresh func()

type Module

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

+ type TokenRefreshCallback func(newToken string, endpoint string)

Aug 20, 2025

Changes in this version

+ const EventTypeConfigLoaded

+ const EventTypeConnected

+ const EventTypeConnectionError

+ const EventTypeDisconnected

+ const EventTypeMigrationCompleted

+ const EventTypeMigrationFailed

+ const EventTypeMigrationStarted

+ const EventTypeQueryError

+ const EventTypeQueryExecuted

+ const EventTypeTransactionCommitted

+ const EventTypeTransactionRolledBack

+ const EventTypeTransactionStarted

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

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

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

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

type DatabaseService

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

+ CreateMigrationsTable func(ctx context.Context) 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)

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

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

+ SetEventEmitter func(emitter EventEmitter)

+ 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

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

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

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

Jul 10, 2025

Changes in this version

+ const Name

+ 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 ErrIAMAuthNotEnabled = errors.New("AWS IAM auth not enabled")

+ var ErrIAMDBUserRequired = errors.New("database user is required for IAM authentication")

+ var ErrIAMRegionRequired = errors.New("AWS region is required for IAM authentication")

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

+ 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 ErrNoUserInfoInDSN = errors.New("no user information in DSN to replace password")

+ type AWSIAMAuthConfig struct

+ DBUser string

+ Enabled bool

+ Region string

+ TokenRefreshInterval int

+ type AWSIAMTokenProvider struct

+ func NewAWSIAMTokenProvider(authConfig *AWSIAMAuthConfig) (*AWSIAMTokenProvider, error)

+ func (p *AWSIAMTokenProvider) BuildDSNWithIAMToken(ctx context.Context, originalDSN string) (string, error)

+ func (p *AWSIAMTokenProvider) GetToken(ctx context.Context, endpoint string) (string, error)

+ func (p *AWSIAMTokenProvider) StartTokenRefresh(ctx context.Context, endpoint string)

+ func (p *AWSIAMTokenProvider) StopTokenRefresh()

+ 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 int

+ ConnectionMaxLifetime int

+ 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

+ Connect func() 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)

+ 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

+ Stats func() sql.DBStats

+ func NewDatabaseService(config ConnectionConfig) (DatabaseService, error)

+ type Module struct

+ func NewModule() *Module

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

+ 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) 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) RequiresServices() []modular.ServiceDependency

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

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