pool

Documentation

Overview

This package opens and retains a pool of distinct DBMS connections.

Index

• type DbmsEntry
• type DbmsPool
  • func NewDbmsPool(rps int) DbmsPool
  • func (pool DbmsPool) Get(name string) Entry
  • func (pool DbmsPool) Keepalive(interval time.Duration, logger logr.Logger)
  • func (pool DbmsPool) Register(name string, driver string, dsn database.Dsn) error
  • func (pool DbmsPool) RegisterDbms(dbms database.Dbms, driver string) error
• type Entry
• type Pool

Types

type DbmsEntry

type DbmsEntry struct {
	Entry
	// contains filtered or unexported fields
}

DbmsEntry represents a standard Dbms connection.

type DbmsPool

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

DbmsPool is a map of pool entries identified by a unique name.

func NewDbmsPool

func NewDbmsPool(rps int) DbmsPool

NewDbmsPool initializes a DbmsPool struct with the given rps. See also database.RateLimitedDbmsConn.

func (DbmsPool) Get

func (pool DbmsPool) Get(name string) Entry

Get retrieves an Entry from pool.

func (DbmsPool) Keepalive

func (pool DbmsPool) Keepalive(interval time.Duration, logger logr.Logger)

Keepalive starts a periodic ping to each endpoint, if an endpoint becomes unreachable, an error is logged.

func (DbmsPool) Register

func (pool DbmsPool) Register(name string, driver string, dsn database.Dsn) error

Register registers a new database.Dbms in the pool.

func (DbmsPool) RegisterDbms

func (pool DbmsPool) RegisterDbms(dbms database.Dbms, driver string) error

RegisterDbms is a utility function around Register. It iterates over database.Dbms.Endpoints and registers a connection for each endpoint.

type Entry

type Entry interface {
	database.Driver
}

Entry specifies the generic interface for an entry of DbmsPool.

type Pool

type Pool interface {
	Get(name string) Entry
	Register(name string, driver string, dsn database.Dsn) error
	Keepalive(interval time.Duration, logger logr.Logger)
}

Pool specifies the generic interface for a Pool of DBMS connections.