dbutil

Documentation

Overview

Package dbutil provides utilities for managing connections to a SQL database.

Index

• func OpenDB(driver, dsn string, opts ...Option) (*sql.DB, error)
• func OpenDBX(driver, dsn string, opts ...Option) (*sqlx.DB, error)
• type Option
  • func WithCensusDriver() Option
  • func WithCensusTraceOptions(opts ...ocsql.TraceOption) Option
  • func WithLogger(logger log.Logger) Option
  • func WithMaxAttempts(maxAttempts int) Option

Functions

func OpenDB

func OpenDB(driver, dsn string, opts ...Option) (*sql.DB, error)

OpenDB creates a sql.DB connection to the database driver. OpenDB uses a linear backoff timer when attempting to establish a connection, only returning after the connection is successful or the number of attempts exceeds the maxAttempts value(defaults to 15 attempts).

func OpenDBX

func OpenDBX(driver, dsn string, opts ...Option) (*sqlx.DB, error)

dbutil.OpenDBX is similar to dbutil.OpenDB, except it returns a *sqlx.DB from the popular github.com/jmoiron/sqlx package.

Types

type Option

type Option func(*dbConfig)

Option provides optional configuration for managing DB connections.

func WithCensusDriver

func WithCensusDriver() Option

func WithCensusTraceOptions

func WithCensusTraceOptions(opts ...ocsql.TraceOption) Option

func WithLogger

func WithLogger(logger log.Logger) Option

WithLogger configures a logger Option.

func WithMaxAttempts

func WithMaxAttempts(maxAttempts int) Option

WithMaxAttempts configures the number of maximum attempts to make