query

README

Query

Performance

# https://graphviz.org/download/#mac
brew install graphviz

go test -bench=. ./core/lib/utils/query/testgen/. -cpuprofile cpu.prof
go tool pprof -svg cpu.prof > cpu.svg

go test -bench=. -trace trace.out ./core/lib/utils/query/testgen/.
go tool trace trace.out

# Data Race: Two goroutines access the same variable concurrently 
# and at least one of the accesses is a write 
# https://golang.org/doc/articles/race_detector
go test -race

Documentation

Index

• func Union(queries ...*Q) (string, error)
• type Column
• type IModel
• type OrderDir
  • func OrderDirFromString(s string) OrderDir
  • func (q OrderDir) String() string
• type Q
  • func Delete(model IModel) *Q
  • func Insert(model IModel) *Q
  • func Query(model IModel) *Q
  • func Raw(model IModel, query string) *Q
  • func Select(model IModel) *Q
  • func Update(model IModel) *Q
  • func (q *Q) Alias(alias string) *Q
  • func (q *Q) Count(name Column, as string) *Q
  • func (q *Q) Field(name Column) *Q
  • func (q *Q) FieldAs(name Column, as string) *Q
  • func (q *Q) FieldRaw(fieldStr, as string) *Q
  • func (q *Q) Fields(fields ...string) *Q
  • func (q *Q) Limit(limit, offset int64) *Q
  • func (q *Q) OrderBy(col Column, dir OrderDir) *Q
  • func (q *Q) Raw(query string) *Q
  • func (q *Q) Set(fieldName Column, value interface{}) *Q
  • func (q *Q) String() (string, error)
  • func (q *Q) Sum(name Column, as string) *Q
  • func (q *Q) Where(args ...*WherePart) *Q
• type QueryType
• type TableName
• type WherePart
  • func And(args ...*WherePart) *WherePart
  • func Ands(args ...*WherePart) *WherePart
  • func Between(fieldName Column, from, to interface{}) *WherePart
  • func BitAnd(fieldName Column, a, b int64) *WherePart
  • func EQ(fieldName Column, value interface{}) *WherePart
  • func EQF(fieldName1, fieldName2 string) *WherePart
  • func Exists(clause *Q) *WherePart
  • func GT(fieldName Column, value interface{}) *WherePart
  • func GTOE(fieldName Column, value interface{}) *WherePart
  • func IN(fieldName Column, values ...interface{}) *WherePart
  • func INInt64(fieldName Column, values []int64) *WherePart
  • func INString(fieldName Column, values []string) *WherePart
  • func LT(fieldName Column, value interface{}) *WherePart
  • func LTOE(fieldName Column, value interface{}) *WherePart
  • func Like(fieldName Column, value string) *WherePart
  • func Mod(fieldName Column, value, remainder int64) *WherePart
  • func Modf(value int64, fieldName Column, remainder int64) *WherePart
  • func NE(fieldName Column, value interface{}) *WherePart
  • func NOTIN(fieldName Column, values ...interface{}) *WherePart
  • func NotLike(fieldName Column, value string) *WherePart
  • func Or(args ...*WherePart) *WherePart
  • func Ors(args ...*WherePart) *WherePart
  • func PE() *WherePart
  • func PS() *WherePart
  • func Paren(args ...*WherePart) *WherePart
  • func Rawf(str string, args ...interface{}) *WherePart
  • func WhereAll() *WherePart
• type WhereType

Functions

func Union

func Union(queries ...*Q) (string, error)

Types

type Column

type Column string

type IModel

type IModel interface {
	Table_Name() TableName
	Table_Columns() []Column
	Table_PrimaryKey() Column
	Table_PrimaryKey_Value() int64
	Table_InsertColumns() []Column
	Table_UpdateColumns() []Column
	Table_Column_Types() map[Column]string
	String() string
	Update(db db.IDB) error
	Create(db db.IDB) error
	Delete(db db.IDB) error
	FromID(db db.IDB, id int64) (IModel, error)
}

type OrderDir

type OrderDir int

const (
	OrderDirASC OrderDir = iota
	OrderDirDESC
)

func OrderDirFromString

func OrderDirFromString(s string) OrderDir

func (OrderDir) String

func (q OrderDir) String() string

type Q

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

func Delete

func Delete(model IModel) *Q

func Insert

func Insert(model IModel) *Q

func Query

func Query(model IModel) *Q

func Raw

func Raw(model IModel, query string) *Q

func Select

func Select(model IModel) *Q

func Update

func Update(model IModel) *Q

func (*Q) Alias

func (q *Q) Alias(alias string) *Q

func (*Q) Count

func (q *Q) Count(name Column, as string) *Q

func (*Q) Field

func (q *Q) Field(name Column) *Q

Field includes a specific field in the columns to be returned by a result set

func (*Q) FieldAs

func (q *Q) FieldAs(name Column, as string) *Q

FieldAs includes a specific field in the columns to be returned by a set aliased by `as`

func (*Q) FieldRaw

func (q *Q) FieldRaw(fieldStr, as string) *Q

FieldRaw allows for an arbitrary string (e.g. "NOW()") to be included in the select columns

func (*Q) Fields

func (q *Q) Fields(fields ...string) *Q

func (*Q) Limit

func (q *Q) Limit(limit, offset int64) *Q

func (*Q) OrderBy

func (q *Q) OrderBy(col Column, dir OrderDir) *Q

func (*Q) Raw

func (q *Q) Raw(query string) *Q

func (*Q) Set

func (q *Q) Set(fieldName Column, value interface{}) *Q

func (*Q) String

func (q *Q) String() (string, error)

func (*Q) Sum

func (q *Q) Sum(name Column, as string) *Q

func (*Q) Where

func (q *Q) Where(args ...*WherePart) *Q

Where().Equals("a", "b")

type QueryType

type QueryType int

const (
	QueryTypeNotSet QueryType = iota
	QueryTypeSelect
	QueryTypeRaw
	QueryTypeUpdate
	QueryTypeDelete
	QueryTypeInsert
)

type TableName

type TableName string

type WherePart

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

WherePart is a part of a where clause. This object is an exposed part of the api to make conditional queries easier EXAMPLE:

wheres := []query.WherePart{
	query.EQ(models.ObjectRelationship_Column_IsDeleted, 0),
}
if objectTypeFrom != constants.ObjectTypeUnknown {
	wheres = append(wheres, query.And(), query.EQ(models.ObjectRelationship_Column_ObjectTypeFrom, objectTypeFrom))
}
if objectIDFrom > 0 {
	wheres = append(wheres, query.And(), query.EQ(models.ObjectRelationship_Column_ObjectIDFrom, objectIDFrom))
}

func And

func And(args ...*WherePart) *WherePart

And is an and statement with optional args that, if provided, are wrapped in parentheses Example: And() will result in the word `AND` being added to the where clause Example: And(EQ(1, 1), And(), And(2, 2)) will result in `AND ( 1 = 1 AND 2 = 2 )`

func Ands

func Ands(args ...*WherePart) *WherePart

Ands takes a list of args and separes them all by `AND` Example: Ands(query.EQ(1,1), query.EQ(2,2), query.EQ(3,3)) == 1 = 1 AND 2 = 2 AND 3 = 3

func Between

func Between(fieldName Column, from, to interface{}) *WherePart

func BitAnd

func BitAnd(fieldName Column, a, b int64) *WherePart

BitAnd `t`.`Field` & a = b

func EQ

func EQ(fieldName Column, value interface{}) *WherePart

EQ is an equals statement between a table column and a value

func EQF

func EQF(fieldName1, fieldName2 string) *WherePart

func Exists

func Exists(clause *Q) *WherePart

func GT

func GT(fieldName Column, value interface{}) *WherePart

Greater Than

func GTOE

func GTOE(fieldName Column, value interface{}) *WherePart

Greater Than Or Equal

func IN

func IN(fieldName Column, values ...interface{}) *WherePart

IN is an IN clause

func INInt64

func INInt64(fieldName Column, values []int64) *WherePart

INInt64 is a helper function for converting a slice of string arguments into a slice of interface arguments, passed into an IN clause and returned

func INString

func INString(fieldName Column, values []string) *WherePart

INString is a helper function for converting a slice of string arguments into a slice of interface arguments, passed into an IN clause and returned

func LT

func LT(fieldName Column, value interface{}) *WherePart

Less Than

func LTOE

func LTOE(fieldName Column, value interface{}) *WherePart

Less Than Or Equal

func Like

func Like(fieldName Column, value string) *WherePart

func Mod

func Mod(fieldName Column, value, remainder int64) *WherePart

Mod MOD(`t`.`Field`, value) = remainder

func Modf

func Modf(value int64, fieldName Column, remainder int64) *WherePart

Modf MOD(value, `t`.`Field`) = remainder

func NE

func NE(fieldName Column, value interface{}) *WherePart

func NOTIN

func NOTIN(fieldName Column, values ...interface{}) *WherePart

IN is an NOT IN clause

func NotLike

func NotLike(fieldName Column, value string) *WherePart

func Or

func Or(args ...*WherePart) *WherePart

func Ors

func Ors(args ...*WherePart) *WherePart

Ors takes a list of args and separes them all by `OR` Example: Ors(query.EQ(1,1), query.EQ(2,2), query.EQ(3,3)) == 1 = 1 OR 2 = 2 OR 3 = 3

func PE

func PE() *WherePart

Parenthesis End

func PS

func PS() *WherePart

Parenthesis Start

func Paren

func Paren(args ...*WherePart) *WherePart

func Rawf

func Rawf(str string, args ...interface{}) *WherePart

Rawf

func WhereAll

func WhereAll() *WherePart

type WhereType

type WhereType int

const (
	WhereTypeEquals WhereType = iota
	WhereTypeEqualsField
	WhereTypeNotEquals
	WhereTypeGreaterThan
	WhereTypeLessThan
	WhereTypeGreaterThanOrEqualTo
	WhereTypeLessThanOrEqualTo
	WhereTypeBetween
	WhereTypeLike
	WhereTypeNotLike
	WhereTypeIN
	WhereTypeNotIN
	WhereTypeExists
	WhereTypeAnd
	WhereTypeOr
	WhereTypeParenthesisEnd
	WhereTypeParenthesisStart
	// WhereTypeNone indicates that the wherePart is a noop for the query,
	// If, however, it contains any child clauses, they will be parsed as individual wherePart objects
	WhereTypeNone
	// WhereTypeAll is a WHERE clause of `1=1` used for convenience
	// when conditionally adding WHERE clauses starting with a conjunction (AND/OR,etc)
	// separating them.
	// e.g. SELECT * FROM `Foo` WHERE 1=1
	//      SELECT * FROM `Foo` WHERE 1=1 AND FooID = 123;
	WhereTypeAll
	WhereTypeMod
	WhereTypeModF
	WhereTypeBitAnd
	WhereTypeRaw
)