postgres

Documentation

Index

• type MockPQDatabase
  • func (m *MockPQDatabase) Close() error
  • func (m *MockPQDatabase) GetEngineType() string
  • func (m *MockPQDatabase) IsReady(ctx context.Context) (bool, error)
• type Option
  • func MaxConnectionIdleTime(d time.Duration) Option
  • func MaxConnectionLifeTime(d time.Duration) Option
  • func MaxDataPerWrite(v int) Option
  • func MaxIdleConnections(c int) Option
  • func MaxOpenConnections(size int) Option
  • func MaxRetries(v int) Option
  • func WatchBufferSize(v int) Option
• type Postgres
  • func New(uri string, opts ...Option) (*Postgres, error)
  • func NewWithSeparateURIs(writerUri, readerUri string, opts ...Option) (*Postgres, error)
  • func (p *Postgres) Close() error
  • func (p *Postgres) GetEngineType() string
  • func (p *Postgres) GetMaxDataPerWrite() int
  • func (p *Postgres) GetMaxRetries() int
  • func (p *Postgres) GetWatchBufferSize() int
  • func (p *Postgres) IsReady(ctx context.Context) (bool, error)

Types

type MockPQDatabase

type MockPQDatabase struct {
	mock.Mock
}

MockPQDatabase simulates the behavior of a real PQDatabase.

func (*MockPQDatabase) Close

func (m *MockPQDatabase) Close() error

func (*MockPQDatabase) GetEngineType

func (m *MockPQDatabase) GetEngineType() string

func (*MockPQDatabase) IsReady

func (m *MockPQDatabase) IsReady(ctx context.Context) (bool, error)

type Option

type Option func(*Postgres)

Option - Option type

func MaxConnectionIdleTime

func MaxConnectionIdleTime(d time.Duration) Option

MaxConnectionIdleTime - Defines maximum connection idle for postgresql db

func MaxConnectionLifeTime

func MaxConnectionLifeTime(d time.Duration) Option

MaxConnectionLifeTime - Defines maximum connection lifetime for postgresql db

func MaxDataPerWrite

func MaxDataPerWrite(v int) Option

func MaxIdleConnections

func MaxIdleConnections(c int) Option

MaxIdleConnections - Defines maximum idle connections for postgresql db

func MaxOpenConnections

func MaxOpenConnections(size int) Option

MaxOpenConnections - Defines maximum open connections for postgresql db

func MaxRetries

func MaxRetries(v int) Option

func WatchBufferSize

func WatchBufferSize(v int) Option

type Postgres

type Postgres struct {
	ReadPool  *pgxpool.Pool
	WritePool *pgxpool.Pool

	Builder squirrel.StatementBuilderType
	// contains filtered or unexported fields
}

Postgres - Structure for Postresql instance

func New

func New(uri string, opts ...Option) (*Postgres, error)

New -

func NewWithSeparateURIs

func NewWithSeparateURIs(writerUri, readerUri string, opts ...Option) (*Postgres, error)

NewWithSeparateURIs -

func (*Postgres) Close

func (p *Postgres) Close() error

Close - Close postgresql instance

func (*Postgres) GetEngineType

func (p *Postgres) GetEngineType() string

GetEngineType - Get the engine type which is postgresql in string

func (*Postgres) GetMaxDataPerWrite

func (p *Postgres) GetMaxDataPerWrite() int

func (*Postgres) GetMaxRetries

func (p *Postgres) GetMaxRetries() int

func (*Postgres) GetWatchBufferSize

func (p *Postgres) GetWatchBufferSize() int

func (*Postgres) IsReady

func (p *Postgres) IsReady(ctx context.Context) (bool, error)

IsReady - Check if database is ready