sql

Documentation

Overview

Package sql provides tools and DAOs for speaking SQL as well as managing tables migrations

Index

• Variables
• func CountStringFromExpression(tableName string, columnCount string, driver string, e Enquirer, ...) (string, []interface{}, error)
• func DeleteStringFromExpression(tableName string, driver string, ex goqu.Expression) (string, []interface{}, error)
• func ExecMax(db *sql.DB, dialect string, m migrate.MigrationSource, ...) (int, error)
• func ExecMigration(db *sql.DB, dialect string, m migrate.MigrationSource, ...) (int, error)
• func GetExpressionForString(neq bool, field string, values ...string) (expression goqu.Expression)
• func GetQueryValueFor(field string, values ...string) string
• func JoinWheresWithParenthesis(wheres []string, join string) string
• func LockMigratePackage()
• func NewDAOQuery(enquirer Enquirer, converters ...common.Converter) fmt.Stringer
• func PlanMigration(db *sql.DB, dialect string, m migrate.MigrationSource, ...) ([]*migrate.PlannedMigration, *gorp.DbMap, error)
• func QueryStringFromExpression(tableName string, driver string, e Enquirer, ex goqu.Expression, ...) (string, []interface{}, error)
• func SetSchema(name string)
• func SetTable(name string)
• func UnlockMigratePackage()
• type BatchReceiver
• type BatchSender
• type DAO
  • func NewDAO(driver string, dsn string, prefix string) DAO
• type Enquirer
• type ExpressionConverter
• type Expressioner
  • func NewQueryBuilder(e Enquirer, c ...ExpressionConverter) Expressioner
• type Handler
  • func (h *Handler) DB() *sql.DB
  • func (h *Handler) GetStmt(key string, args ...interface{}) *sql.Stmt
  • func (h *Handler) GetStmtWithArgs(key string, params ...interface{}) (*sql.Stmt, []interface{}, error)
  • func (h *Handler) Init(c common.ConfigValues) error
  • func (h *Handler) Lock()
  • func (h *Handler) Prepare(key string, query interface{}) error
  • func (h *Handler) Unlock()
  • func (h *Handler) UseExclusion()
  • func (h *Handler) Version() (string, error)
• type PackrBox
• type PackrMigrationSource
  • func (p PackrMigrationSource) FindMigrations() ([]*migrate.Migration, error)
• type Scanner

Variables

var (
	ErrNoRows = sql.ErrNoRows
)

Functions

func CountStringFromExpression

func CountStringFromExpression(tableName string, columnCount string, driver string, e Enquirer, ex goqu.Expression, resourceExpression goqu.Expression) (string, []interface{}, error)

QueryStringFromExpression finally builds a full SELECT from a Goqu Expression

func DeleteStringFromExpression

func DeleteStringFromExpression(tableName string, driver string, ex goqu.Expression) (string, []interface{}, error)

DeleteStringFromExpression creates sql for DELETE FROM expression

func ExecMax

func ExecMax(db *sql.DB, dialect string, m migrate.MigrationSource, dir migrate.MigrationDirection, max int, prefix string) (int, error)

Execute a set of migrations

Will apply at most `max` migrations. Pass 0 for no limit (or use Exec).

Returns the number of applied migrations.

func ExecMigration

func ExecMigration(db *sql.DB, dialect string, m migrate.MigrationSource, dir migrate.MigrationDirection, prefix string) (int, error)

Execute a set of migrations

Returns the number of applied migrations.

func GetExpressionForString

func GetExpressionForString(neq bool, field string, values ...string) (expression goqu.Expression)

GetExpressionForString creates correct goqu.Expression for field + string value

func GetQueryValueFor

func GetQueryValueFor(field string, values ...string) string

GetQueryValueFor field value

func JoinWheresWithParenthesis

func JoinWheresWithParenthesis(wheres []string, join string) string

JoinConditionsWithParenthesis joins conditions using parenthesis if there are many, or no parenthesis if there is just one, and prepend the WHERE keyword to the string

func LockMigratePackage

func LockMigratePackage()

LockMigratePackage sets a global lock on rubenv/migrate package

func NewDAOQuery

func NewDAOQuery(enquirer Enquirer, converters ...common.Converter) fmt.Stringer

NewDAOQuery adds database functionality to a Query proto message

func PlanMigration

func PlanMigration(db *sql.DB, dialect string, m migrate.MigrationSource, dir migrate.MigrationDirection, max int, prefix string) ([]*migrate.PlannedMigration, *gorp.DbMap, error)

Plan a migration.

func QueryStringFromExpression

func QueryStringFromExpression(tableName string, driver string, e Enquirer, ex goqu.Expression, resourceExpression goqu.Expression, limit int64) (string, []interface{}, error)

QueryStringFromExpression finally builds a full SELECT from a Goqu Expression

func SetSchema

func SetSchema(name string)

SetSchema sets the name of a schema that the migration table be referenced.

func SetTable

func SetTable(name string)

Set the name of the table used to store migration info.

Should be called before any other call such as (Exec, ExecMax, ...).

func UnlockMigratePackage

func UnlockMigratePackage()

UnlockMigratePackage frees the global lock on rubenv/migrate package

Types

type BatchReceiver

type BatchReceiver interface {
	Recv(interface{})
}

BatchReceiver interface

type BatchSender

type BatchSender interface {
	Send(interface{})
	Close() error
}

BatchSender interface

type DAO

type DAO interface {
	dao.DAO

	DB() *sql.DB
	Version() (string, error)
	Prepare(string, interface{}) error
	GetStmt(string, ...interface{}) *sql.Stmt
	GetStmtWithArgs(string, ...interface{}) (*sql.Stmt, []interface{}, error)
	UseExclusion()
	Lock()
	Unlock()
}

DAO interface definition

func NewDAO

func NewDAO(driver string, dsn string, prefix string) DAO

type Enquirer

type Enquirer interface {
	GetSubQueries() []*any.Any
	GetOperation() service.OperationType
	GetOffset() int64
	GetLimit() int64
	GetGroupBy() int32
	GetResourcePolicyQuery() *service.ResourcePolicyQuery

	fmt.Stringer
}

Enquirer interface

type ExpressionConverter

type ExpressionConverter interface {
	Convert(sub *any.Any, driver string) (goqu.Expression, bool)
}

ExpressionConverter ...

type Expressioner

type Expressioner interface {
	Expression(driver string) goqu.Expression
}

Expressioner ...

func NewQueryBuilder

func NewQueryBuilder(e Enquirer, c ...ExpressionConverter) Expressioner

NewQueryBuilder generates SQL request from object

type Handler

type Handler struct {
	dao.DAO
	// contains filtered or unexported fields
}

Handler for the main functions of the DAO

func (*Handler) DB

func (h *Handler) DB() *sql.DB

DB returns the sql DB object

func (*Handler) GetStmt

func (h *Handler) GetStmt(key string, args ...interface{}) *sql.Stmt

GetStmt returns a list of all statements used by the dao

func (*Handler) GetStmtWithArgs

func (h *Handler) GetStmtWithArgs(key string, params ...interface{}) (*sql.Stmt, []interface{}, error)

GetStmt returns a list of all statements used by the dao

func (*Handler) Init

func (h *Handler) Init(c common.ConfigValues) error

func (*Handler) Lock

func (h *Handler) Lock()

func (*Handler) Prepare

func (h *Handler) Prepare(key string, query interface{}) error

Prepare the statements that can be used by the DAO

func (*Handler) Unlock

func (h *Handler) Unlock()

func (*Handler) UseExclusion

func (h *Handler) UseExclusion()

func (*Handler) Version

func (h *Handler) Version() (string, error)

Version

type PackrBox

type PackrBox interface {
	List() []string
	Bytes(name string) []byte
}

Avoids pulling in the packr library for everyone, mimicks the bits of packr.Box that we need.

type PackrMigrationSource

type PackrMigrationSource struct {
	Box PackrBox

	// Path in the box to use.
	Dir string

	TablePrefix string
}

Migrations from a packr box.

func (PackrMigrationSource) FindMigrations

func (p PackrMigrationSource) FindMigrations() ([]*migrate.Migration, error)

type Scanner

type Scanner interface {
	Scan(...interface{}) error
}