pgconn

package module
v1.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 23, 2017 License: Apache-2.0 Imports: 9 Imported by: 6

README

PGConn - Postgres Connection Utilities

CircleCI

This package provide a simple mechanism to extend the Postgres sql.DB implementation with some additional capabilities:

  • The ability to retry initial connection attempts using a simple backoff mechanism. This is useful in scenarios such as starting containerized applications without wanting to worry about start up order.
  • Detecting certain classes of connection related errors.
  • Reconnecting to the database using retrys and backoff.

Usage

  • Use the OpenAndConnect method to instantiate a *sql.DB instance.
  • Use IsConnectionError to determine if the error indicates the connection to the database is lost or hopeless, in which Reconnect should be used to reconnect to the database.

Dependencies

go get github.com/lib/pq
go get github.com/gucumber/gucumber/cmd/gucumber
go get github.com/stretchr/testify/assert
go get github.com/Sirupsen/logrus

Contributing

To contribute, you must certify you agree with the Developer Certificate of Origin by signing your commits via git -s. To create a signature, configure your user name and email address in git. Sign with your real name, do not use pseudonyms or submit anonymous commits.

In terms of workflow:

  1. For significant changes or improvement, create an issue before commencing work.
  2. Fork the respository, and create a branch for your edits.
  3. Add tests that cover your changes, unit tests for smaller changes, acceptance test for more significant functionality.
  4. Run gofmt on each file you change before committing your changes.
  5. Run golint on each file you change before committing your changes.
  6. Make sure all the tests pass before committing your changes.
  7. Commit your changes and issue a pull request.

License

(c) 2017 Fidelity Investments Licensed under the Apache License, Version 2.0

Documentation

Index

Constants

View Source
const (
	DBUser     = "DB_USER"
	DBPassword = "DB_PASSWORD"
	DBHost     = "DB_HOST"
	DBPort     = "DB_PORT"
	DBName     = "DB_NAME"
)

Variables

View Source
var ErrRetryCount = errors.New("Retry count must be greater than 1")

Functions

func BuildConnectString

func BuildConnectString(user, password, host, port, dbName string) string

BuildConnectString builds an Oracle connect string from its constituent parts.

func ConnectStringFromInjectedEnv added in v1.8.0

func ConnectStringFromInjectedEnv(env *envinject.InjectedEnv) (string, error)

func IsConnectionError

func IsConnectionError(err error) bool

IsConnectionError returns error if the argument is a connection error

func MaskedConnectStringFromInjectedEnv added in v1.8.0

func MaskedConnectStringFromInjectedEnv(env *envinject.InjectedEnv) (string, error)

Types

type PostgresDB

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

func OpenAndConnect

func OpenAndConnect(env *envinject.InjectedEnv, retryCount int) (*PostgresDB, error)

func (*PostgresDB) Reconnect

func (pgdb *PostgresDB) Reconnect(retryCount int) error

Reconnect to the database. Useful when a loss of connection has been detected

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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