database

Documentation

Index

• Constants
• Variables
• type Config
  • func NewConfig() *Config
  • func (c *Config) ToDSN() string
  • func (c *Config) Validate() error
• type Cursor
  • func NewCursor(offset, limit int64) *Cursor
  • func (c Cursor) Valid() bool
• type Database
  • func FromDB(db *sql.DB, driver string) Database
  • func Open(driver string, dsn string) (Database, error)
• type Manager
  • func NewManager() Manager
• type NullBool
  • func (x NullBool) MarshalJSON() ([]byte, error)
• type NullByte
  • func (x NullByte) MarshalJSON() ([]byte, error)
• type NullFloat64
  • func (x NullFloat64) MarshalJSON() ([]byte, error)
• type NullInt16
  • func (x NullInt16) MarshalJSON() ([]byte, error)
• type NullInt32
  • func (x NullInt32) MarshalJSON() ([]byte, error)
• type NullInt64
  • func (x NullInt64) MarshalJSON() ([]byte, error)
• type NullString
  • func (x NullString) MarshalJSON() ([]byte, error)
• type NullTime
  • func (x NullTime) MarshalJSON() ([]byte, error)

Constants

const (
	KeyTransaction   string = "_DB_TXN"
	StringDeadlock   string = "Error 1213" // Deadlock detected.
	StringConnClosed string = "Error 2006" // MySQL server connection closed.
	StringLostConn   string = "Error 2013" // Lost connection during query.
)

Variables

var (
	ErrNoDriver   error = errors.Base("no driver provided")
	ErrNoUsername error = errors.Base("no username provided")
	ErrNoPassword error = errors.Base("no password provided")
	ErrNoHostname error = errors.Base("no hostname provided")
	ErrNoDatabase error = errors.Base("no database name provided")
)

var (
	ErrTxnKeyNotFound error = errors.Base("transaction key not found")
	ErrTxnKeyNotTxn   error = errors.Base("key value is not a transaction")
	ErrTxnContext     error = errors.Base("could not create transaction context")
	ErrTxnStart       error = errors.Base("could not start transaction")

	ErrTxnDeadlock      error = errors.Base("deadlock found when trying to get lock")
	ErrServerConnClosed error = errors.Base("server connection closed")
	ErrLostConn         error = errors.Base("lost connection during query")
)

var (
	// The empty cursor.
	EmptyCursor = &Cursor{Offset: 0, Limit: 0}
)

Types

type Config

type Config struct {
	Driver        string `json:"driver"`
	Username      string `json:"username"`
	Password      string `config_obscure:"true"  json:"password"`
	Hostname      string `json:"hostname"`
	Port          int    `json:"port"`
	Database      string `json:"database"`
	BatchSize     int    `json:"batch_size"`
	SetPoolLimits bool   `json:"set_pool_limits"`
	MaxIdleConns  int    `json:"max_idle_conns"`
	MaxOpenConns  int    `json:"max_open_conns"`
	// contains filtered or unexported fields
}

SQL configuration structure.

func NewConfig

func NewConfig() *Config

Create a new configuration object.

func (*Config) ToDSN

func (c *Config) ToDSN() string

Return the DSN for this database configuration.

func (*Config) Validate

func (c *Config) Validate() error

type Cursor

type Cursor struct {
	Offset int64 `json:"offset"`
	Limit  int64 `json:"limit"`
}

TODO: Look, this sucks... offset/limit cursors are just fail. TODO: Rework this to be a proper cursor!

func NewCursor

func NewCursor(offset, limit int64) *Cursor

Create a new cursor.

func (Cursor) Valid

func (c Cursor) Valid() bool

Is the cursor valid?

type Database

type Database interface {
	// Pings the database connection to ensure it is alive and connected.
	Ping() error

	// Close a database connection.  This does nothing if the connection
	// is already closed.
	Close() error

	// Set the maximum idle connections.
	SetMaxIdleConns(int)

	// Set the maximum open connections.
	SetMaxOpenConns(int)

	// Return the transaction (if any) from the given context.
	Tx(context.Context) (*sqlx.Tx, error)

	// Initiate a transaction.  Returns a new context that contains the
	// database transaction session as a value.
	Begin(context.Context) (context.Context, error)

	// Initiate a transaction commit.
	Commit(context.Context) error

	// Initiate a transaction rollback.
	Rollback(context.Context) error

	// Parses the given error looking for common MySQL error conditions.
	//
	// If one is found, then a Golang error describing the condition is
	// raised.
	//
	// If nothing interesting is found, then the original error is
	// returned.
	GetError(error) error
}

func FromDB

func FromDB(db *sql.DB, driver string) Database

Create a new database object using an existing `sql` object.

func Open

func Open(driver string, dsn string) (Database, error)

Open a connection using the relevant driver to the given data source name.

type Manager

type Manager interface {
	Open(string, string) (Database, error)
	OpenConfig(*Config) (Database, error)
	CheckDB(Database) error
}

Database management.

This is a series of wrappers around Go's internal DB stuff to ensure that we set up max idle/open connections et al.

func NewManager

func NewManager() Manager

Create a new manager.

type NullBool

type NullBool struct {
	sql.NullBool
}

func (NullBool) MarshalJSON

func (x NullBool) MarshalJSON() ([]byte, error)

type NullByte

type NullByte struct {
	sql.NullByte
}

func (NullByte) MarshalJSON

func (x NullByte) MarshalJSON() ([]byte, error)

type NullFloat64

type NullFloat64 struct {
	sql.NullFloat64
}

func (NullFloat64) MarshalJSON

func (x NullFloat64) MarshalJSON() ([]byte, error)

type NullInt16

type NullInt16 struct {
	sql.NullInt16
}

func (NullInt16) MarshalJSON

func (x NullInt16) MarshalJSON() ([]byte, error)

type NullInt32

type NullInt32 struct {
	sql.NullInt32
}

func (NullInt32) MarshalJSON

func (x NullInt32) MarshalJSON() ([]byte, error)

type NullInt64

type NullInt64 struct {
	sql.NullInt64
}

func (NullInt64) MarshalJSON

func (x NullInt64) MarshalJSON() ([]byte, error)

type NullString

type NullString struct {
	sql.NullString
}

func (NullString) MarshalJSON

func (x NullString) MarshalJSON() ([]byte, error)

type NullTime

type NullTime struct {
	sql.NullTime
}

func (NullTime) MarshalJSON

func (x NullTime) MarshalJSON() ([]byte, error)