mysql

Documentation

Index

• Variables
• func New(params Parameters) (*sql.DB, error)
• type Configuration
  • func (d *Configuration) ConnectionUrl(migration bool) (string, error)
• type InTransactionHandler
• type MDuration
  • func (d *MDuration) UnmarshalJSON(data []byte) error
• type Migrator
  • func NewMigrator(lc fx.Lifecycle, settings Configuration, log *zap.SugaredLogger) *Migrator
• type Parameters
• type TransactionScopeBuilder
  • func InitializeModule(db *sql.DB, log *zap.SugaredLogger) TransactionScopeBuilder
• type TransactionScopeWrapper

Variables

var (
	ErrTxAlreadyClosed = errors.New("transaction is already closed")
	TxModule           = fx.Module(
		"mysqlTx",
		fx.Provide(InitializeModule),
	)
)

var Module = fx.Module(
	"sql",
	fx.Provide(New),
	fx.Invoke(NewMigrator),
)

Functions

func New

func New(
	params Parameters,
) (*sql.DB, error)

Types

type Configuration

type Configuration struct {
	Connection string `yaml:"connection"`
	// User can also be specified separately from the connection string
	User string `yaml:"user"`
	// Password can also be specified separately from the connection string
	Password string `yaml:"password"`
	// User can also be specified separately from the connection string
	MigrateUser string `yaml:"migrateUser"`
	// Password can also be specified separately from the connection string
	MigratePassword string `yaml:"migratePassword"`
	// MaxLifetime is the maximum lifetime of a connection
	// from time.ParseDuration:
	// A duration string is a possibly signed sequence of
	// decimal numbers, each with optional fraction and a unit suffix,
	// such as "300ms", "-1.5h" or "2h45m".
	// Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
	MaxLifetime        MDuration `yaml:"maxLifetime"`
	MaxOpenConnections int       `yaml:"maxOpenConnections"`
	MaxIdleConnections int       `yaml:"maxIdleConnections"`
	MigrationPath      string    `yaml:"migrationPath"`
}

func (*Configuration) ConnectionUrl

func (d *Configuration) ConnectionUrl(migration bool) (string, error)

type InTransactionHandler

type InTransactionHandler func(ctx context.Context, db boil.ContextExecutor) error

type MDuration

type MDuration struct {
	time.Duration
}

func (*MDuration) UnmarshalJSON

func (d *MDuration) UnmarshalJSON(data []byte) error

type Migrator

type Migrator struct {
	// contains filtered or unexported fields
}

func NewMigrator

func NewMigrator(lc fx.Lifecycle, settings Configuration, log *zap.SugaredLogger) *Migrator

type Parameters

type Parameters struct {
	fx.In

	Configuration Configuration
	Tracing       opentelemetry.Configuration
	MeterProvider *metric.MeterProvider `optional:"true"`
}

type TransactionScopeBuilder

type TransactionScopeBuilder func(ctx context.Context, txIsolationLevel sql.IsolationLevel) (TransactionScopeWrapper, error)

func InitializeModule

func InitializeModule(db *sql.DB, log *zap.SugaredLogger) TransactionScopeBuilder

type TransactionScopeWrapper

type TransactionScopeWrapper func(executeInTx InTransactionHandler) error