sqlhealth

Documentation

Overview

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

Index

• type Checker
  • func New(db *sql.DB) *Checker
  • func (c *Checker) CheckHealth() error
  • func (c *Checker) Stop()

Types

type Checker

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

Checker checks the health of a SQL database.

func New

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 (*Checker) CheckHealth

func (c *Checker) CheckHealth() error

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

func (*Checker) Stop

func (c *Checker) Stop()

Stop stops any ongoing ping of the database.