postgres

Documentation

Index

• Variables
• type ConnectionOptions
• type Options
• type PostgresSQL
  • func New(options Options) (*PostgresSQL, error)
  • func (db *PostgresSQL) Close() error
  • func (db *PostgresSQL) Connect() error
  • func (db *PostgresSQL) Connection() *sqlx.DB
  • func (db *PostgresSQL) EventTx(ctx context.Context, etxFn db.EventTxFn) (eventId *events.EventID, err error)
  • func (db *PostgresSQL) EventsTx(ctx context.Context, etxFn db.EventsTxFn) (eventIds []events.EventID, err error)
  • func (db *PostgresSQL) Migrate(ctx context.Context, options *db.MigrationOptions) (*db.MigrationResult, error)
  • func (db *PostgresSQL) Tx(ctx context.Context, txFn db.TxFn) (err error)

Variables

var (
	ErrNoDSN      = errors.New("no dsn provided")
	ErrNoMigrator = errors.New("no migrator provided")
)

var DefaultConnectionOptions = ConnectionOptions{
	MaxOpenCons:     100,
	MaxIdleCons:     10,
	ConnMaxLifetime: 1 * time.Minute,
	ConnMaxIdleTime: 30 * time.Second,
}

var (
	ErrNoOutboxConfigured = errors.New("no event outbox configured")
)

Types

type ConnectionOptions

type ConnectionOptions struct {
	MaxOpenCons     int
	MaxIdleCons     int
	ConnMaxLifetime time.Duration
	ConnMaxIdleTime time.Duration
}

type Options

type Options struct {
	DSN               string
	OutboxOptions     *outbox.Options
	Logger            *zap.Logger
	Migrator          db.Migrator
	ConnectionOptions *ConnectionOptions
}

type PostgresSQL

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

func New

func New(options Options) (*PostgresSQL, error)

func (*PostgresSQL) Close

func (db *PostgresSQL) Close() error

func (*PostgresSQL) Connect

func (db *PostgresSQL) Connect() error

func (*PostgresSQL) Connection

func (db *PostgresSQL) Connection() *sqlx.DB

func (*PostgresSQL) EventTx

func (db *PostgresSQL) EventTx(ctx context.Context, etxFn db.EventTxFn) (eventId *events.EventID, err error)

EventTx is a convenience method for emitting a single event in a single transaction.

func (*PostgresSQL) EventsTx

func (db *PostgresSQL) EventsTx(ctx context.Context, etxFn db.EventsTxFn) (eventIds []events.EventID, err error)

EventsTx is a convenience method for emitting multiple events in a single transaction.

func (*PostgresSQL) Migrate

func (db *PostgresSQL) Migrate(ctx context.Context, options *db.MigrationOptions) (*db.MigrationResult, error)

func (*PostgresSQL) Tx

func (db *PostgresSQL) Tx(ctx context.Context, txFn db.TxFn) (err error)