db

Documentation

Overview

Package db implements a SQL database.

Index

• Variables
• type Config
  • func (cfg Config) NewDatabase(sqlDB *sql.DB) (*Database, error)
• type Database
  • func (db Database) Exec(ctx context.Context, queries ...Query) error
  • func (db Database) Query(ctx context.Context, q Query, dest ...interface{}) error
  • func (db Database) Setup(ctx context.Context, files []io.Reader) error
• type ExecFunction
  • func NewExecFunction(name string, args ...interface{}) ExecFunction
  • func (e ExecFunction) Args() []interface{}
  • func (e ExecFunction) Cmd() string
• type Query
• type QueryFunction
  • func NewQueryFunction(name string, cols []string, args ...interface{}) QueryFunction
  • func (q QueryFunction) Args() []interface{}
  • func (q QueryFunction) Cmd() string
• type RawQuery
  • func (RawQuery) Args() []interface{}
  • func (r RawQuery) Cmd() string

Variables

var ErrNoRows = sql.ErrNoRows

ErrNoRows is returned by the Scanner when there are no rows to scan.

Types

type Config

type Config struct {
	// QueryPeriod is the amount of time that any database action can take before it should timeout.
	QueryPeriod time.Duration
}

Config contains options for how the database should run.

func (Config) NewDatabase

func (cfg Config) NewDatabase(sqlDB *sql.DB) (*Database, error)

NewDatabase creates a SQL database from the database.

type Database

type Database struct {
	*sql.DB
	Config
}

Database is a SQL db.Database with additional configuration

func (Database) Exec

func (db Database) Exec(ctx context.Context, queries ...Query) error

Exec evaluates multiple queries in a transaction, ensuring each execSQLFunction one only updates one row.

func (Database) Query

func (db Database) Query(ctx context.Context, q Query, dest ...interface{}) error

Query queries a single row, scanning into the destination array.

func (Database) Setup

func (db Database) Setup(ctx context.Context, files []io.Reader) error

Setup initializes the database by reading the files and executing their contents as raw queries.

type ExecFunction

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

ExecFunction is a db Query that changes data.

func NewExecFunction

func NewExecFunction(name string, args ...interface{}) ExecFunction

NewExecFunction creates a Query to call an exec function.

func (ExecFunction) Args

func (e ExecFunction) Args() []interface{}

Args returns the arguments for the exec function.

func (ExecFunction) Cmd

func (e ExecFunction) Cmd() string

Cmd returns a SQL string to execute the function with arguments.

type Query

type Query interface {
	// cmd is the injection-safe message to send to the database.
	Cmd() string
	// args are the user-provided properties of the messages which should be escaped.
	Args() []interface{}
}

Query is a message that is sent to the database.

type QueryFunction

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

QueryFunction is a db Query that reads data.

func NewQueryFunction

func NewQueryFunction(name string, cols []string, args ...interface{}) QueryFunction

NewQueryFunction creates a Query to call a query function.

func (QueryFunction) Args

func (q QueryFunction) Args() []interface{}

Args returns the arguments for the query function.

func (QueryFunction) Cmd

func (q QueryFunction) Cmd() string

Cmd returns a SQL string to execute the function with arguments.

type RawQuery

type RawQuery string

RawQuery is a db Query that changes data and has no arguments..

func (RawQuery) Args

func (RawQuery) Args() []interface{}

Args returns nil for the raw SQL query.

func (RawQuery) Cmd

func (r RawQuery) Cmd() string

Cmd returns the raw SQL query.