healthcheck

package

v1.1.0 Latest Latest Go to latest Published: May 8, 2024 License: MIT Imports: 5 Imported by: 0

Details

View Source

const DefaultProbeName = "sql"

DefaultProbeName is the name of the SQL probe.

This section is empty.

This section is empty.

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

SQLProbe is a probe compatible with the healthcheck module.

func NewSQLProbe(db *sql.DB) *SQLProbe

NewSQLProbe returns a new SQLProbe.

func (p *SQLProbe) Check(ctx context.Context) *healthcheck.CheckerProbeResult

Check returns a successful healthcheck.CheckerProbeResult if the database connection can be pinged.

func (p *SQLProbe) Name() string

Name returns the name of the SQLProbe.

func (p *SQLProbe) SetName(name string) *SQLProbe

SetName sets the name of the SQLProbe.