postgrestest

package module

v1.5.1 Latest Latest Go to latest Published: Jul 1, 2022 License: LGPL-3.0 Imports: 7 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/pandrey2003/postgrestest

README ¶

Simple support for Go testing with a live Postgres database
----

This package makes it straightforward to write tests that connect
to a fresh Postgres database created for the tests.

Documentation ¶

Overview ¶

Package postgrestest provides a package intended for running tests which require a Postgres backend.

Index ¶

Variables
func PgTestDisable() bool
type DB
- func New() (*DB, error)
- func (pg *DB) Close() error
- func (pg *DB) TransactionName() string

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrDisabled = errgo.New("postgres testing is disabled")

ErrDisabled is returned by New when postgres testing has been explicitly disabled.

Functions ¶

func PgTestDisable ¶

func PgTestDisable() bool

PgTestDisable returns whether Postgres should be disabled based on the PGTESTDISABLE environment variable.

Types ¶

type DB ¶

type DB struct {
	*sql.DB
	// contains filtered or unexported fields
}

DB holds a connection to a Postgres database.

func New ¶

func New() (*DB, error)

func (*DB) Close ¶

func (pg *DB) Close() error

Close removes the test database and closes the database connection. This method should not be called from multiple goroutines.

func (*DB) TransactionName ¶ added in v1.5.0

func (pg *DB) TransactionName() string

TransactionName returns the test transaction name.

Source Files ¶

View all Source files

postgrestest.go

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