starter

Documentation

Index

• Constants
• func BuildDbString() (*string, error)
• func BuildLogger() (*zap.Logger, error)
• func DeriveContextWithRequestId(ctx context.Context) context.Context
• func GetVariableValue(variableName string) string
• func OpenDbConnection(connectionString *string, logger *zap.Logger) (*sql.DB, error)
• func ReadEnvBoolVarOrDefault(varName string, defaultValue bool) bool
• func ReadEnvVarOrDefault(varName string, defaultValue string) (varVal string)
• func RunMigrations(db *sql.DB, log *zap.Logger) error
• func ZapFieldWithRequestIdFromCtx(ctx context.Context) zap.Field
• type HttpConfig
  • func ReadHttpConfig() *HttpConfig
• type TransactionManager
  • func NewTransactionManager(db *sql.DB) TransactionManager
  • func (txw TransactionManager) ExecWithTransaction(txFunc func(*sql.Tx) error) error
• type TransactionResult

Constants

const (
	RequestIDKey = "requestID"
)

Functions

func BuildDbString

func BuildDbString() (*string, error)

func BuildLogger

func BuildLogger() (*zap.Logger, error)

BuildLogger build a zap logger by default is development or production if is set on LOGGER_ENV variable

func DeriveContextWithRequestId

func DeriveContextWithRequestId(ctx context.Context) context.Context

func GetVariableValue

func GetVariableValue(variableName string) string

func OpenDbConnection

func OpenDbConnection(connectionString *string, logger *zap.Logger) (*sql.DB, error)

func ReadEnvBoolVarOrDefault

func ReadEnvBoolVarOrDefault(varName string, defaultValue bool) bool

func ReadEnvVarOrDefault

func ReadEnvVarOrDefault(varName string, defaultValue string) (varVal string)

func RunMigrations

func RunMigrations(db *sql.DB, log *zap.Logger) error

func ZapFieldWithRequestIdFromCtx

func ZapFieldWithRequestIdFromCtx(ctx context.Context) zap.Field

Types

type HttpConfig

type HttpConfig struct {
	Port, Host, ContextPath string
	ProfEnabled             bool
}

func ReadHttpConfig

func ReadHttpConfig() *HttpConfig

ReadHttpConfig initialize the HTTPConfig

type TransactionManager

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

func NewTransactionManager

func NewTransactionManager(db *sql.DB) TransactionManager

func (TransactionManager) ExecWithTransaction

func (txw TransactionManager) ExecWithTransaction(txFunc func(*sql.Tx) error) error

type TransactionResult

type TransactionResult struct {
	Rows   uint64
	Result interface{}
}