sqlite

README

sqlite

Access SQLite3 through structured repository patterns.

Install

go get github.com/altipla-consulting/sqlite

Contributing

You can make pull requests or create issues in GitHub. Any code you send should be formatted using make gofmt.

License

MIT License

Documentation

Index

• func Migrate(ctx context.Context, db *sqlx.DB, migrations []Migration, ...) error
• func Open(dsn string, options ...OpenOption) (*sqlx.DB, error)
• func RerunLastMigration(ctx context.Context, db *sqlx.DB, migrations []Migration, ...) error
• type Hook
• type HookAfterPut
• type HookBeforePut
• type Hooks
• type MigrateOption
  • func WithMigrateLogger(logger *slog.Logger) MigrateOption
• type Migration
• type MissingKeyError
  • func (e MissingKeyError) Error() string
• type OpenOption
  • func WithDriver(driverName string) OpenOption
  • func WithLogger(logger *slog.Logger) OpenOption
• type Query
  • func NewQuery[T any](repo queryable, sql string, pending []string) *Query[T]
  • func (q *Query[T]) Bind(args ...sql.NamedArg)
  • func (q *Query[T]) Query(ctx context.Context, args ...sql.NamedArg) (*T, error)
  • func (q *Query[T]) QueryValue(ctx context.Context, args ...sql.NamedArg) (T, error)
• type RepoConfig
• type RepoGeneric
  • func NewRepoGeneric[T any](db *sqlx.DB, cnf RepoConfig[T]) *RepoGeneric[T]
  • func (repo *RepoGeneric[T]) BeginTx(ctx context.Context) (*Tx[T], error)
  • func (repo *RepoGeneric[T]) Count(ctx context.Context) (int64, error)
  • func (repo *RepoGeneric[T]) Delete(ctx context.Context, model *T) error
  • func (repo *RepoGeneric[T]) DeleteKey(ctx context.Context, key string) error
  • func (repo *RepoGeneric[T]) Exec(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
  • func (repo *RepoGeneric[T]) Exists(ctx context.Context, key string) (bool, error)
  • func (repo *RepoGeneric[T]) ExistsQuery() *Query[bool]
  • func (repo *RepoGeneric[T]) Get(ctx context.Context, key string) (*T, error)
  • func (repo *RepoGeneric[T]) GetMulti(ctx context.Context, keys []string) ([]*T, error)
  • func (repo *RepoGeneric[T]) List(ctx context.Context) ([]*T, error)
  • func (repo *RepoGeneric[T]) Put(ctx context.Context, model *T) error
  • func (repo *RepoGeneric[T]) Query(ctx context.Context, query string, args ...interface{}) (*T, error)
  • func (repo *RepoGeneric[T]) QueryList(ctx context.Context, query string, args ...interface{}) ([]*T, error)
  • func (repo *RepoGeneric[T]) QueryMap(ctx context.Context, query string, args ...interface{}) (map[string]*T, error)
• type RepoSingleton
  • func NewRepoSingleton[T any](db *sqlx.DB, cnf RepoConfig[T]) *RepoSingleton[T]
  • func (repo *RepoSingleton[T]) BeginTx(ctx context.Context) (*Tx[T], error)
  • func (repo *RepoSingleton[T]) Exists(ctx context.Context, key string) (bool, error)
  • func (repo *RepoSingleton[T]) Get(ctx context.Context, key string) (*T, error)
  • func (repo *RepoSingleton[T]) List(ctx context.Context) ([]*T, error)
  • func (repo *RepoSingleton[T]) Put(ctx context.Context, model *T) error
  • func (repo *RepoSingleton[T]) Query(ctx context.Context, query string, args ...interface{}) (*T, error)
  • func (repo *RepoSingleton[T]) QueryList(ctx context.Context, query string, args ...interface{}) ([]*T, error)
• type Tx
  • func (tx *Tx[T]) Commit() error
  • func (tx *Tx[T]) Put(ctx context.Context, model *T) error
  • func (tx *Tx[T]) Rollback() error

Functions

func Migrate

func Migrate(ctx context.Context, db *sqlx.DB, migrations []Migration, options ...MigrateOption) error

Migrate runs migrations from the list that have not been yet executed.

func Open

func Open(dsn string, options ...OpenOption) (*sqlx.DB, error)

func RerunLastMigration

func RerunLastMigration(ctx context.Context, db *sqlx.DB, migrations []Migration, options ...MigrateOption) error

RerunLastMigration runs the last migration in the list.

Types

type Hook

type Hook[T any] func(ctx context.Context, model *T) error

type HookAfterPut

type HookAfterPut interface {
	AfterPut(ctx context.Context) error
}

type HookBeforePut

type HookBeforePut[T any] interface {
	BeforePut(ctx context.Context, tx *Tx[T]) error
}

type Hooks

type Hooks[T any] struct {
	BeforePut []Hook[T]
	AfterPut  []Hook[T]
}

type MigrateOption

type MigrateOption func(opts *migrateOptions)

func WithMigrateLogger

func WithMigrateLogger(logger *slog.Logger) MigrateOption

type Migration

type Migration func(ctx context.Context, db *sqlx.DB) error

Migration is the function that will be run to execute the migration operation in the database.

type MissingKeyError

type MissingKeyError struct {
	Key string
}

func (MissingKeyError) Error

func (e MissingKeyError) Error() string

type OpenOption

type OpenOption func(opts *openOptions)

func WithDriver

func WithDriver(driverName string) OpenOption

func WithLogger

func WithLogger(logger *slog.Logger) OpenOption

type Query

type Query[T any] struct {
	// contains filtered or unexported fields
}

func NewQuery

func NewQuery[T any](repo queryable, sql string, pending []string) *Query[T]

func (*Query[T]) Bind

func (q *Query[T]) Bind(args ...sql.NamedArg)

func (*Query[T]) Query

func (q *Query[T]) Query(ctx context.Context, args ...sql.NamedArg) (*T, error)

func (*Query[T]) QueryValue

func (q *Query[T]) QueryValue(ctx context.Context, args ...sql.NamedArg) (T, error)

type RepoConfig

type RepoConfig[T any] struct {
	Table      string
	PrimaryKey string
	Hooks      Hooks[T]
	Logger     *slog.Logger
}

type RepoGeneric

type RepoGeneric[T any] struct {
	// contains filtered or unexported fields
}

func NewRepoGeneric

func NewRepoGeneric[T any](db *sqlx.DB, cnf RepoConfig[T]) *RepoGeneric[T]

func (*RepoGeneric[T]) BeginTx

func (repo *RepoGeneric[T]) BeginTx(ctx context.Context) (*Tx[T], error)

func (*RepoGeneric[T]) Count

func (repo *RepoGeneric[T]) Count(ctx context.Context) (int64, error)

func (*RepoGeneric[T]) Delete

func (repo *RepoGeneric[T]) Delete(ctx context.Context, model *T) error

func (*RepoGeneric[T]) DeleteKey

func (repo *RepoGeneric[T]) DeleteKey(ctx context.Context, key string) error

func (*RepoGeneric[T]) Exec

func (repo *RepoGeneric[T]) Exec(ctx context.Context, query string, args ...interface{}) (sql.Result, error)

func (*RepoGeneric[T]) Exists

func (repo *RepoGeneric[T]) Exists(ctx context.Context, key string) (bool, error)

func (*RepoGeneric[T]) ExistsQuery

func (repo *RepoGeneric[T]) ExistsQuery() *Query[bool]

func (*RepoGeneric[T]) Get

func (repo *RepoGeneric[T]) Get(ctx context.Context, key string) (*T, error)

func (*RepoGeneric[T]) GetMulti

func (repo *RepoGeneric[T]) GetMulti(ctx context.Context, keys []string) ([]*T, error)

func (*RepoGeneric[T]) List

func (repo *RepoGeneric[T]) List(ctx context.Context) ([]*T, error)

func (*RepoGeneric[T]) Put

func (repo *RepoGeneric[T]) Put(ctx context.Context, model *T) error

func (*RepoGeneric[T]) Query

func (repo *RepoGeneric[T]) Query(ctx context.Context, query string, args ...interface{}) (*T, error)

func (*RepoGeneric[T]) QueryList

func (repo *RepoGeneric[T]) QueryList(ctx context.Context, query string, args ...interface{}) ([]*T, error)

func (*RepoGeneric[T]) QueryMap

func (repo *RepoGeneric[T]) QueryMap(ctx context.Context, query string, args ...interface{}) (map[string]*T, error)

type RepoSingleton

type RepoSingleton[T any] struct {
	// contains filtered or unexported fields
}

func NewRepoSingleton

func NewRepoSingleton[T any](db *sqlx.DB, cnf RepoConfig[T]) *RepoSingleton[T]

func (*RepoSingleton[T]) BeginTx

func (repo *RepoSingleton[T]) BeginTx(ctx context.Context) (*Tx[T], error)

func (*RepoSingleton[T]) Exists

func (repo *RepoSingleton[T]) Exists(ctx context.Context, key string) (bool, error)

func (*RepoSingleton[T]) Get

func (repo *RepoSingleton[T]) Get(ctx context.Context, key string) (*T, error)

func (*RepoSingleton[T]) List

func (repo *RepoSingleton[T]) List(ctx context.Context) ([]*T, error)

func (*RepoSingleton[T]) Put

func (repo *RepoSingleton[T]) Put(ctx context.Context, model *T) error

func (*RepoSingleton[T]) Query

func (repo *RepoSingleton[T]) Query(ctx context.Context, query string, args ...interface{}) (*T, error)

func (*RepoSingleton[T]) QueryList

func (repo *RepoSingleton[T]) QueryList(ctx context.Context, query string, args ...interface{}) ([]*T, error)

type Tx

type Tx[T any] struct {
	// contains filtered or unexported fields
}

func (*Tx[T]) Commit

func (tx *Tx[T]) Commit() error

func (*Tx[T]) Put

func (tx *Tx[T]) Put(ctx context.Context, model *T) error

func (*Tx[T]) Rollback

func (tx *Tx[T]) Rollback() error