db

package

v0.0.0-...-e400c07 Latest Latest Go to latest Published: May 1, 2024 License: Apache-2.0 Imports: 9 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/hpetrov29/restapi

Links

Open Source Insights

Documentation ¶

Overview ¶

Package db provides support for access to a mysql database using the mysql driver

Index ¶

Variables
func ExecContext(ctx context.Context, log *logger.Logger, db sqlx.ExtContext, query string) (sql.Result, error)
func NamedExecContext(ctx context.Context, log *logger.Logger, db sqlx.ExtContext, query string, ...) (sql.Result, error)
func NamedQueryStruct(ctx context.Context, log *logger.Logger, db sqlx.ExtContext, query string, ...) error
func Open(config Config) (*sqlx.DB, error)
func StatusCheck(ctx context.Context, db *sqlx.DB) error
type Config

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrDBNotFound        = sql.ErrNoRows
	ErrDBDuplicatedEntry = errors.New("duplicated entry")
	ErrUndefinedTable    = errors.New("undefined table")
)

Set of error variables for CRUD operations.

Functions ¶

func ExecContext ¶

func ExecContext(ctx context.Context, log *logger.Logger, db sqlx.ExtContext, query string) (sql.Result, error)

ExecContext is a helper function to execute a CUD operation with logging and tracing.

func NamedExecContext ¶

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

NamedExecContext is a helper function to execute a CUD operation with logging and tracing 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 a helper function for executing queries that return a single value to be unmarshalled into a struct type where field replacement is necessary.

func Open ¶

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

Open opens a database specified by a configuration struct and a driver-specific data source name, usually consisting of at least a database name and connection information.

func StatusCheck ¶

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

StatusCheck returns nil if it can successfully talk to the database. It returns a non-nil error otherwise.

Types ¶

type Config ¶

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

Config is the required properties to use the database.

Source Files ¶

View all Source files

mysql.go

Directories ¶

Path	Synopsis
dbarray Package dbarray provides support for database array types.	Package dbarray provides support for database array types.

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