postgres

Documentation

Overview

Package postgres is the native client probe for PostgreSQL

Index

• Constants
• type PostgreSQL
  • func New(opt conf.Options) (*PostgreSQL, error)
  • func (r *PostgreSQL) Kind() string
  • func (r *PostgreSQL) Probe() (bool, string)
  • func (r *PostgreSQL) ProbeWithDataChecking() (bool, string)
  • func (r *PostgreSQL) ProbeWithPing() (bool, string)

Constants

const Kind string = "PostgreSQL"

Kind is the type of driver

Types

type PostgreSQL

type PostgreSQL struct {
	conf.Options  `yaml:",inline"`
	ClientOptions []pgdriver.Option `yaml:"-" json:"-"`
}

revive:disable PostgreSQL is the PostgreSQL client

func New

func New(opt conf.Options) (*PostgreSQL, error)

New create a PostgreSQL client

func (*PostgreSQL) Kind

func (r *PostgreSQL) Kind() string

Kind return the name of client

func (*PostgreSQL) Probe

func (r *PostgreSQL) Probe() (bool, string)

Probe do the health check

func (*PostgreSQL) ProbeWithDataChecking

func (r *PostgreSQL) ProbeWithDataChecking() (bool, string)

ProbeWithDataChecking do the health check with data checking

func (*PostgreSQL) ProbeWithPing

func (r *PostgreSQL) ProbeWithPing() (bool, string)

ProbeWithPing do the health check with ping & Select 1;