dbutil

Documentation

Index

• Variables
• func Configure(ctx context.Context, db ConfigurableDB, dbName string, mon *monkit.Scope)
• func SchemeForImplementation(implementation Implementation) string
• type ConfigurableDB
• type Implementation
  • func ImplementationForScheme(scheme string) Implementation
  • func SplitConnStr(s string) (driver string, source string, implementation Implementation, err error)
• type NullTime
  • func (nt *NullTime) Scan(value interface{}) error
  • func (nt NullTime) Value() (driver.Value, error)
• type TempDatabase
  • func (db *TempDatabase) Close() error

Variables

var ErrNullTime = errs.Class("null time error")

ErrNullTime defines error class for NullTime.

Functions

func Configure

func Configure(ctx context.Context, db ConfigurableDB, dbName string, mon *monkit.Scope)

Configure Sets Connection Boundaries and adds db_stats monitoring to monkit.

func SchemeForImplementation

func SchemeForImplementation(implementation Implementation) string

SchemeForImplementation returns the scheme that is used for URLs that use the given Implementation.

Types

type ConfigurableDB

type ConfigurableDB interface {
	SetMaxIdleConns(int)
	SetMaxOpenConns(int)
	SetConnMaxLifetime(time.Duration)
	Stats() sql.DBStats
}

ConfigurableDB contains methods for configuring a database.

type Implementation

type Implementation int

Implementation type of valid DBs.

const (
	// Unknown is an unknown db type.
	Unknown Implementation = iota
	// Postgres is a Postgresdb type.
	Postgres
	// Cockroach is a Cockroachdb type.
	Cockroach
	// Bolt is a Bolt kv store.
	Bolt
	// Redis is a Redis kv store.
	Redis
	// SQLite3 is a sqlite3 database.
	SQLite3
)

func ImplementationForScheme

func ImplementationForScheme(scheme string) Implementation

ImplementationForScheme returns the Implementation that is used for the url with the provided scheme.

func SplitConnStr

func SplitConnStr(s string) (driver string, source string, implementation Implementation, err error)

SplitConnStr returns the driver and DSN portions of a URL, along with the db implementation.

type NullTime

type NullTime struct {
	time.Time
	Valid bool
}

NullTime time helps convert nil to time.Time.

func (*NullTime) Scan

func (nt *NullTime) Scan(value interface{}) error

Scan implements the Scanner interface.

func (NullTime) Value

func (nt NullTime) Value() (driver.Value, error)

Value implements the driver Valuer interface.

type TempDatabase

type TempDatabase struct {
	tagsql.DB
	ConnStr        string
	Schema         string
	Driver         string
	Implementation Implementation
	Cleanup        func(tagsql.DB) error
}

TempDatabase is a database (or something that works like an isolated database, such as a PostgreSQL schema) with a semi-unique name which will be cleaned up when closed. Mainly useful for testing purposes.

func (*TempDatabase) Close

func (db *TempDatabase) Close() error

Close closes the database and deletes the schema.