postgres

Documentation

Index

• Constants
• func DBMigrationsAlreadyInit(err error) bool
• func DBStatementCancelledByUser(err error) bool
• func WithContextTimeout(ctx context.Context, f func(ctx context.Context))
• func WithContextTimeoutValue(ctx context.Context, timeout time.Duration, f func(ctx context.Context))
• type TGPGDB
  • func CreateTGPGDB(url string) *TGPGDB
  • func CreateTGPGDBWithOptions(dbOpts *TGPGDBOptions) *TGPGDB
  • func NewTGPGDB(db *pg.DB) *TGPGDB
  • func (db *TGPGDB) ExecContext(ctx context.Context, query interface{}, params ...interface{}) (pg.Result, error)
  • func (db *TGPGDB) Migrate() error
  • func (db *TGPGDB) ModelContext(ctx context.Context, models ...interface{}) *orm.Query
  • func (db *TGPGDB) Ping() error
  • func (db *TGPGDB) RunInTransactionContext(ctx context.Context, txFunc func(context.Context, *TGPGDB) error) error
  • func (db *TGPGDB) WithTimeout(timeout time.Duration) *TGPGDB
• type TGPGDBOptions

Constants

const (
	DBMigrationsConcurrentInitErrPrefix = "ERROR #23505" // safe to ignore, error when gopg_migrations already exists
	DBStatementCancelledErrPrefix       = "ERROR #57014"
)

Functions

func DBMigrationsAlreadyInit

func DBMigrationsAlreadyInit(err error) bool

func DBStatementCancelledByUser

func DBStatementCancelledByUser(err error) bool

func WithContextTimeout

func WithContextTimeout(ctx context.Context, f func(ctx context.Context))

WithContextTimeout executes statements with a default timeout

func WithContextTimeoutValue

func WithContextTimeoutValue(ctx context.Context, timeout time.Duration, f func(ctx context.Context))

WithContextTimeoutValue executes an inner routine while passing a ctx that supports custom timeout and query cancellation to the postgres server.

Types

type TGPGDB

type TGPGDB struct {
	*pg.DB
}

func CreateTGPGDB

func CreateTGPGDB(url string) *TGPGDB

func CreateTGPGDBWithOptions

func CreateTGPGDBWithOptions(dbOpts *TGPGDBOptions) *TGPGDB

func NewTGPGDB

func NewTGPGDB(db *pg.DB) *TGPGDB

func (*TGPGDB) ExecContext

func (db *TGPGDB) ExecContext(ctx context.Context, query interface{}, params ...interface{}) (pg.Result, error)

func (*TGPGDB) Migrate

func (db *TGPGDB) Migrate() error

Migrate check and migrate to lastest db version.

func (*TGPGDB) ModelContext

func (db *TGPGDB) ModelContext(ctx context.Context, models ...interface{}) *orm.Query

func (*TGPGDB) Ping

func (db *TGPGDB) Ping() error

Ping simulates a "blank query" behavior similar to lib/pq's to check if the db connection is alive.

func (*TGPGDB) RunInTransactionContext

func (db *TGPGDB) RunInTransactionContext(ctx context.Context, txFunc func(context.Context, *TGPGDB) error) error

RunInTransactionContext wraps around underlying go-pg's rollback-supported transaction execution with our custom context so it can be easily passed down.

func (*TGPGDB) WithTimeout

func (db *TGPGDB) WithTimeout(timeout time.Duration) *TGPGDB

WithTimeout needs to create a new db instance in order to pass into the next chain of commands.

type TGPGDBOptions

type TGPGDBOptions struct {
	Url string

	DisableBeforeQueryLog bool
	DisableAfterQueryLog  bool
}