db

package

v1.0.0 Latest Latest Go to latest Published: Sep 19, 2023 License: BSD-3-Clause Imports: 10 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/bbengfort/epistolary

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func BeginTx(ctx context.Context, opts *sql.TxOptions) (tx *sql.Tx, err error)
func Close() (err error)
func Connect(conf config.DatabaseConfig) (err error)
func Mock() sqlmock.Sqlmock
func Prep(query string, args ...any) (string, []any)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNotConnected = errors.New("not connected to the database")
	ErrReadOnly     = errors.New("connected in readonly mode - only readonly transactions allowed")
	ErrNotfound     = errors.New("record not found or no rows returned")
)

Functions ¶

func BeginTx ¶

func BeginTx(ctx context.Context, opts *sql.TxOptions) (tx *sql.Tx, err error)

BeginTx creates a transaction with the connected dtabase; errors if not connected.

func Close ¶

func Close() (err error)

Close the database safely and allow reconnect after close.

func Connect ¶

func Connect(conf config.DatabaseConfig) (err error)

Connect to the Postgres stabase specified by theDSN. Connecting in read-only mode is is managed by the package, not by the database. Multiple or concurrent calls to Connect will be ignored even if a different configuration is passed.

func Mock ¶

func Mock() sqlmock.Sqlmock

Mock returns the sql mock object for use in unit testing

func Prep ¶ added in v0.4.0

func Prep(query string, args ...any) (string, []any)

Prep converts named query arguments into positional arguments for postgres queries.

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
schema

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