postgresql

Documentation

Overview

Package postgresql implements the PostgreSQL protocol plugin.

Index

• type Plugin
  • func New() *Plugin
  • func (p *Plugin) Connect(ctx context.Context, cfg plugin.ConnectConfig) (plugin.Session, error)
  • func (p *Plugin) Manifest() plugin.Manifest
  • func (p *Plugin) Routes() []plugin.Route
• type Session
  • func (s *Session) Close() error
  • func (s *Session) HealthCheck(ctx context.Context) error
  • func (s *Session) OpenChannel(context.Context, plugin.ChannelRequest) (plugin.Channel, error)

Types

type Plugin

type Plugin struct{}

func New

func New() *Plugin

func (*Plugin) Connect

func (p *Plugin) Connect(ctx context.Context, cfg plugin.ConnectConfig) (plugin.Session, error)

func (*Plugin) Manifest

func (p *Plugin) Manifest() plugin.Manifest

func (*Plugin) Routes

func (p *Plugin) Routes() []plugin.Route

type Session

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

Session brokers a PostgreSQL connection. A connection can browse every database in the cluster, so pools are opened lazily per database (keyed by name) and reused; the configured database is the default when none is named.

func (*Session) Close

func (s *Session) Close() error

func (*Session) HealthCheck

func (s *Session) HealthCheck(ctx context.Context) error

func (*Session) OpenChannel

func (s *Session) OpenChannel(context.Context, plugin.ChannelRequest) (plugin.Channel, error)