postgres_pg

Documentation

Index

• func PostgresPingChecker(database *pg.DB, timeout time.Duration) probes.HandleFunc
• type Config
• type Options
• type Plugin
  • func NewPlugin(runtime runtime.Runtime, opts *Options) Plugin

Functions

func PostgresPingChecker

func PostgresPingChecker(database *pg.DB, timeout time.Duration) probes.HandleFunc

Types

type Config

type Config struct {
	DSN           string `` /* 143-byte string literal not displayed */
	Host          string `env:"HOST" envDefault:"127.0.0.1"  comment:"The host to connect to (required)"`
	Port          int32  `env:"PORT" envDefault:"5432" comment:"The port to bind to (default: 5432)"`
	Database      string `env:"DATABASE" comment:"Database to be selected after connecting to the server."`
	Username      string `env:"USERNAME" comment:"The username to connect with. Not required if using IntegratedSecurity"`
	Password      string `env:"PASSWORD" comment:"The password to connect with. Not required if using IntegratedSecurity"`
	SSLMode       string `env:"SSLMODE" comment:" Whether or not to use SSL mode (disable, allow, prefer, require, verify-ca, verify-full)"`
	TimeZone      string `env:"TIMEZONE" comment:"Sets the session timezone"`
	MigrationsDir string `env:"MIGRATIONS_DIR" comment:"Migrations directory to run migration when plugin is started"`
}

type Options

type Options struct {
	Name string
}

type Plugin

type Plugin interface {
	DB() *pg.DB
	RunMigration() error
}

func NewPlugin

func NewPlugin(runtime runtime.Runtime, opts *Options) Plugin