table

package module

v0.0.0-...-593eb99 Latest Latest Go to latest Published: Oct 31, 2023 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

sqlx helper library for some db boilerplate

This section is empty.

This section is empty.

This section is empty.

type Option func(*helper)

func WithDBGeneratedField(col string) Option

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

Table provides boilerplate ops for some table with sqlx.

func New[T any](name, pk string, opts ...Option) *Table[T]

New returns a new Table for the given type.

func (t *Table[T]) Delete(ctx context.Context, db *sqlx.DB, query string, args ...any) (int64, error)

Delete deletes records matching the query.

func (t *Table[T]) Fetch(ctx context.Context, db *sqlx.DB, col string, val any) (*T, error)

Fetch returns a single record with a value matching a given field. Mostly useful for fetching by unique values.

func (t *Table[T]) Find(ctx context.Context, db *sqlx.DB, id any) (*T, error)

Find returns a single record with a value matching a given pk.

func (t *Table[T]) Insert(ctx context.Context, db *sqlx.DB, obj *T) error

Insert inserts a single record into the table.

func (t *Table[T]) Replace(ctx context.Context, db *sqlx.DB, obj *T) error

Replace replaces the given record.

func (t *Table[T]) Select(ctx context.Context, db *sqlx.DB, query string, args ...any) ([]*T, error)

Select fetches all records matching a given query.