database

README

-database-go

Multi-DB support in a neat package

-database-go is part of the kiss-my-package set used by apps like FaceMasq, PaperBag, Celestial, Executrix, and more

Documentation

Index

• Constants
• Variables
• func Schema() (*jsonschema.Schema, error)
• type DBConn
  • func New(ctx context.Context, connStr string) (*DBConn, error)
  • func (db *DBConn) Close(ctx context.Context) (context.Context, error)
  • func (db *DBConn) Conn() *bun.DB
  • func (db *DBConn) ConnStr() string
  • func (db *DBConn) DB() *bun.DB
  • func (db *DBConn) Engine() string
  • func (db *DBConn) Prepare(ctx context.Context, lookForTable string, ...) error
• type TestContainer
  • func ConnectToTest(t *testing.T, ctx context.Context, engine string) (context.Context, TestContainer, error)

Constants

const (
	MySQL   = "mysql"
	PgSQL   = "postgres"
	SQLite  = "sqlite"
	MSSQL   = "mssql"
	MariaDB = "mariadb"
)

const DBTargetVer = 1

Variables

var (
	Conn    *bun.DB
	Verbose bool
)

var (
	ErrMSSql         = fmt.Errorf("`mssql` is not supported yet")
	ErrUnknownEngine = fmt.Errorf("specified engine is not supported yet")
	ErrConnStrFormat = fmt.Errorf("connection string is in the wrong format")
)

Functions

func Schema

func Schema() (*jsonschema.Schema, error)

Types

type DBConn

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

func New

func New(ctx context.Context, connStr string) (*DBConn, error)

func (*DBConn) Close

func (db *DBConn) Close(ctx context.Context) (context.Context, error)

func (*DBConn) Conn

func (db *DBConn) Conn() *bun.DB

func (*DBConn) ConnStr

func (db *DBConn) ConnStr() string

func (*DBConn) DB

func (db *DBConn) DB() *bun.DB

func (*DBConn) Engine

func (db *DBConn) Engine() string

func (*DBConn) Prepare

func (db *DBConn) Prepare(ctx context.Context, lookForTable string, doPreparation func(ctx context.Context, dbConn *DBConn) error) error

type TestContainer

type TestContainer interface {
	Close() error
	GetConnection() containers.ConnectionParams
}

var (
	RunningContainer TestContainer
	DBEngines        []string
)

func ConnectToTest

func ConnectToTest(t *testing.T, ctx context.Context, engine string) (context.Context, TestContainer, error)