db

Documentation

Index

• type DBConfig
  • func WithOptions(defaultOpts func() *DBConfig, opts ...OptFunc[DBConfig]) *DBConfig
• type OptFunc
  • func WithDSN(dsn string) OptFunc[DBConfig]
  • func WithEnableWALMode(enable bool) OptFunc[DBConfig]
• type PersistentSQLx
  • func MustConnect(opts ...OptFunc[DBConfig]) *PersistentSQLx
  • func NewWithOptions(opts *DBConfig) *PersistentSQLx
  • func (psqlx *PersistentSQLx) GetDB() *sqlx.DB

Types

type DBConfig

type DBConfig struct {
	DSN           string
	EnableWALMode bool
}

DBConfig defines the options for PersistentSQLx

func WithOptions

func WithOptions(defaultOpts func() *DBConfig, opts ...OptFunc[DBConfig]) *DBConfig

WithOptions builds the options with the given opt

type OptFunc

type OptFunc[T any] func(*T)

OptFunc defines the signature for an option function

func WithDSN

func WithDSN(dsn string) OptFunc[DBConfig]

WithDSN sets the DSN

func WithEnableWALMode

func WithEnableWALMode(enable bool) OptFunc[DBConfig]

WithEnableWALMode sets the WAL mode

type PersistentSQLx

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

PersistentSQLx contains the persistent database connection

func MustConnect

func MustConnect(opts ...OptFunc[DBConfig]) *PersistentSQLx

Connect creates a new PersistentSQLx instance

func NewWithOptions

func NewWithOptions(opts *DBConfig) *PersistentSQLx

NewWithOptions creates a new PersistentSQLx instance with the given options

func (*PersistentSQLx) GetDB

func (psqlx *PersistentSQLx) GetDB() *sqlx.DB

GetDB returns the database connection