database

Jul 9, 2025

Changes in this version

type Config

+ func (c *Config) Validate() error

Jun 27, 2025

Changes in this version

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

type Config

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

Jun 6, 2025

Changes in this version

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

Jun 6, 2025

Changes in this version

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

+ AWSIAMAuth *AWSIAMAuthConfig

type DatabaseService

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

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

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

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

May 26, 2025

Changes in this version

type Module

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

+ func (m *Module) GetDefaultService() DatabaseService

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

Apr 17, 2025

Changes in this version

+ const Name

Apr 5, 2025

Changes in this version

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

+ var ErrDefaultConnectionNotFound = errors.New("default database connection not found in configuration")

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

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

+ type Config struct

+ Connections map[string]ConnectionConfig

+ Default string

+ type ConnectionConfig struct

+ 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

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

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

+ Ping func(ctx context.Context) 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) GetConnection(name string) (DatabaseService, bool)

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

+ func (m *Module) GetDefaultConnection() DatabaseService

+ 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