sqlhealth

package

v0.37.0 Latest Latest Go to latest Published: Mar 12, 2024 License: Apache-2.0 Imports: 4 Imported by: 3

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

Package sqlhealth provides a health check for a SQL database connection.

This section is empty.

This section is empty.

This section is empty.

type Checker struct {
	// contains filtered or unexported fields
}

Checker checks the health of a SQL database.

func New(db *sql.DB) *Checker

New starts a new asynchronous ping of the SQL database. Pings will be sent until one succeeds or Stop is called, whichever comes first.

func (c *Checker) CheckHealth() error

CheckHealth returns nil iff the ping started by New has returned success.

func (c *Checker) Stop()

Stop stops any ongoing ping of the database.