db

package

v0.0.0-...-2e936b0 Latest Latest Go to latest Published: Nov 17, 2023 License: Apache-2.0 Imports: 11 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

Repository

github.com/rocketb/asperitas

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func NamedExecContext(ctx context.Context, log *logger.Logger, db sqlx.ExtContext, query string, ...) error
func NamedQuerySlice[T any](ctx context.Context, log *logger.Logger, db sqlx.ExtContext, query string, ...) error
func NamedQueryStruct(ctx context.Context, log *logger.Logger, db sqlx.ExtContext, query string, ...) error
func Open(cfg Config) (*sqlx.DB, error)
func QuerySlice[T any](ctx context.Context, log *logger.Logger, db sqlx.ExtContext, query string, ...) error
func StatusCheck(ctx context.Context, db *sqlx.DB) error
type Config

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrDBNotFound        = errors.New("not found")
	ErrDBDuplicatedEntry = errors.New("duplicated entry")
	ErrUndefinedTable    = errors.New("undefined table")
)

Functions ¶

func NamedExecContext ¶

func NamedExecContext(ctx context.Context, log *logger.Logger, db sqlx.ExtContext, query string, data any) error

NamedExecContext is a helper function to execute a CUD operation where field replacement is necessary.

func NamedQuerySlice ¶

func NamedQuerySlice[T any](ctx context.Context, log *logger.Logger, db sqlx.ExtContext, query string, data any, dest *[]T) error

NamedQuerySlice is a helper function to executing queries that return a collection of data to be unmarshalled into a slice where field replacement is necessary.

func NamedQueryStruct ¶

func NamedQueryStruct(ctx context.Context, log *logger.Logger, db sqlx.ExtContext, query string, data any, dest any) error

NamedQueryStruct is used to return a single value to be unmarshalled into a struct type where field replacement is necessary.

func Open ¶

func Open(cfg Config) (*sqlx.DB, error)

Open used to open a database connection based on the configuration.

func QuerySlice ¶

func QuerySlice[T any](ctx context.Context, log *logger.Logger, db sqlx.ExtContext, query string, dest *[]T) error

QuerySlice is a helper function to executing queries that return a collection of data to be unmarshalled into a slice.

func StatusCheck ¶

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

StatusCheck checks if it can successfully talk to the database.

Types ¶

type Config ¶

type Config struct {
	User         string
	Password     string
	Host         string
	Name         string
	MaxIdleConns int
	MaxOpenConns int
	DisableTLS   bool
}

Source Files ¶

View all Source files

pq.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL