pingstore

Documentation

Overview

Package pingstore enables database health checks through the db PingContext method. The Pinger interface allows mocking the Ping when testing with no db connectivity.

Index

• type Datastorer
• type Pinger
  • func NewPinger(ds Datastorer) Pinger
  • func (d Pinger) PingDB(ctx context.Context) error

Types

type Datastorer

type Datastorer interface {
	// DB returns a sql.DB
	DB() *sql.DB
}

Datastorer is an interface for working with the Database

type Pinger

type Pinger struct {
	Datastorer
}

Pinger is the default implementation for pinging the db

func NewPinger

func NewPinger(ds Datastorer) Pinger

NewPinger is an initializer for DefaultPinger

func (Pinger) PingDB

func (d Pinger) PingDB(ctx context.Context) error

PingDB pings the DB