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 DefaultPinger
  • func NewDefaultPinger(ds datastore.Datastorer) DefaultPinger
  • func (d DefaultPinger) PingDB(ctx context.Context) error
• type Pinger

Types

type DefaultPinger

type DefaultPinger struct {
	datastore.Datastorer
}

DefaultPinger is the default implementation for pinging the db

func NewDefaultPinger

func NewDefaultPinger(ds datastore.Datastorer) DefaultPinger

NewDefaultPinger is an initializer for DefaultPinger

func (DefaultPinger) PingDB

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

PingDB pings the DB

type Pinger

type Pinger interface {
	PingDB(context.Context) error
}

Pinger pings the database