postgres

Documentation

Index

• type Option
  • func MaxConnectionIdleTime(d time.Duration) Option
  • func MaxConnectionLifeTime(d time.Duration) Option
  • func MaxIdleConnections(c int) Option
  • func MaxOpenConnections(size int) Option
• type Postgres
  • func New(uri string, opts ...Option) (*Postgres, error)
  • func (p *Postgres) Close() error
  • func (p *Postgres) GetEngineType() string
  • func (p *Postgres) IsReady(ctx context.Context) (bool, error)
  • func (p *Postgres) Migrate(statements []string) (err error)

Types

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 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

type Postgres

type Postgres struct {
	DB      *sql.DB
	Builder squirrel.StatementBuilderType
	// contains filtered or unexported fields
}

Postgres - Structure for Postresql instance

func New

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

New - Creates new postgresql db instance

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) IsReady

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

IsReady - Check if database is ready

func (*Postgres) Migrate

func (p *Postgres) Migrate(statements []string) (err error)

Migrate - Migration operations for postgresql db