queries

package
v2.7.3+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 27, 2018 License: BSD-3-Clause Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source
const (
	JoinInner joinKind = iota
	JoinOuterLeft
	JoinOuterRight
	JoinNatural
)

Join type constants

Variables

This section is empty.

Functions

func AppendFrom

func AppendFrom(q *Query, from ...string)

AppendFrom on the query.

func AppendGroupBy

func AppendGroupBy(q *Query, clause string)

AppendGroupBy on the query.

func AppendHaving

func AppendHaving(q *Query, clause string, args ...interface{})

AppendHaving on the query.

func AppendIn

func AppendIn(q *Query, clause string, args ...interface{})

AppendIn on the query.

func AppendInnerJoin

func AppendInnerJoin(q *Query, clause string, args ...interface{})

AppendInnerJoin on the query.

func AppendLoad

func AppendLoad(q *Query, relationships ...string)

AppendLoad on the query.

func AppendOrderBy

func AppendOrderBy(q *Query, clause string)

AppendOrderBy on the query.

func AppendSelect

func AppendSelect(q *Query, columns ...string)

AppendSelect on the query.

func AppendWhere

func AppendWhere(q *Query, clause string, args ...interface{})

AppendWhere on the query.

func Bind

func Bind(rows *sql.Rows, obj interface{}) error

Bind executes the query and inserts the result into the passed in object pointer.

The caller is responsible for closing the rows.

Bind rules:

  • Struct tags control bind, in the form of: `boil:"name,bind"`
  • If "name" is omitted the sql column names that come back are TitleCased and matched against the field name.
  • If the "name" part of the struct tag is specified, the given name will be used instead of the struct field name for binding.
  • If the "name" of the struct tag is "-", this field will not be bound to.
  • If the ",bind" option is specified on a struct field and that field is a struct itself, it will be recursed into to look for fields for binding.

Example Query:

type JoinStruct struct {
  // User1 can have it's struct fields bound to since it specifies
  // ,bind in the struct tag, it will look specifically for
  // fields that are prefixed with "user." returning from the query.
  // For example "user.id" column name will bind to User1.ID
  User1      *models.User `boil:"user,bind"`
  // User2 will follow the same rules as noted above except it will use
  // "friend." as the prefix it's looking for.
  User2      *models.User `boil:"friend,bind"`
  // RandomData will not be recursed into to look for fields to
  // bind and will not be bound to because of the - for the name.
  RandomData myStruct     `boil:"-"`
  // Date will not be recursed into to look for fields to bind because
  // it does not specify ,bind in the struct tag. But it can be bound to
  // as it does not specify a - for the name.
  Date       time.Time
}

models.Users(qm.InnerJoin("users as friend on users.friend_id = friend.id")).Bind(&joinStruct)

For custom objects that want to use eager loading, please see the loadRelationships function.

func BindMapping

func BindMapping(typ reflect.Type, mapping map[string]uint64, cols []string) ([]uint64, error)

BindMapping creates a mapping that helps look up the pointer for the column given.

func BuildUpsertQueryMSSQL

func BuildUpsertQueryMSSQL(dia Dialect, tableName string, primary, update, insert []string, output []string) string

BuildUpsertQueryMSSQL builds a SQL statement string using the upsertData provided.

func BuildUpsertQueryMySQL

func BuildUpsertQueryMySQL(dia Dialect, tableName string, update, whitelist []string) string

BuildUpsertQueryMySQL builds a SQL statement string using the upsertData provided.

func BuildUpsertQueryPostgres

func BuildUpsertQueryPostgres(dia Dialect, tableName string, updateOnConflict bool, ret, update, conflict, whitelist []string) string

BuildUpsertQueryPostgres builds a SQL statement string using the upsertData provided.

func GetExecutor

func GetExecutor(q *Query) boil.Executor

GetExecutor on the query.

func GetSelect

func GetSelect(q *Query) []string

GetSelect from the query

func MakeStructMapping

func MakeStructMapping(typ reflect.Type) map[string]uint64

MakeStructMapping creates a map of the struct to be able to quickly look up its pointers and values by name.

func NonZeroDefaultSet

func NonZeroDefaultSet(defaults []string, obj interface{}) []string

NonZeroDefaultSet returns the fields included in the defaults slice that are non zero values

func PtrsFromMapping

func PtrsFromMapping(val reflect.Value, mapping []uint64) []interface{}

PtrsFromMapping expects to be passed an addressable struct and a mapping of where to find things. It pulls the pointers out referred to by the mapping.

func SetCount

func SetCount(q *Query)

SetCount on the query.

func SetDelete

func SetDelete(q *Query)

SetDelete on the query.

func SetDialect

func SetDialect(q *Query, dialect *Dialect)

SetDialect on the query.

func SetExecutor

func SetExecutor(q *Query, exec boil.Executor)

SetExecutor on the query.

func SetFor

func SetFor(q *Query, clause string)

SetFor on the query.

func SetFrom

func SetFrom(q *Query, from ...string)

SetFrom replaces the current from statements.

func SetLastInAsOr

func SetLastInAsOr(q *Query)

SetLastInAsOr sets the or separator for the tail "IN" in the slice

func SetLastWhereAsOr

func SetLastWhereAsOr(q *Query)

SetLastWhereAsOr sets the or separator for the tail "WHERE" in the slice

func SetLimit

func SetLimit(q *Query, limit int)

SetLimit on the query.

func SetLoad

func SetLoad(q *Query, relationships ...string)

SetLoad on the query.

func SetOffset

func SetOffset(q *Query, offset int)

SetOffset on the query.

func SetSQL

func SetSQL(q *Query, sql string, args ...interface{})

SetSQL on the query.

func SetSelect

func SetSelect(q *Query, sel []string)

SetSelect on the query.

func SetUpdate

func SetUpdate(q *Query, cols map[string]interface{})

SetUpdate on the query.

func ValuesFromMapping

func ValuesFromMapping(val reflect.Value, mapping []uint64) []interface{}

ValuesFromMapping expects to be passed an addressable struct and a mapping of where to find things. It pulls the pointers out referred to by the mapping.

Types

type Dialect

type Dialect struct {
	// The left quote character for SQL identifiers
	LQ byte
	// The right quote character for SQL identifiers
	RQ byte
	// Bool flag indicating whether indexed
	// placeholders ($1) are used, or ? placeholders.
	IndexPlaceholders bool
	// Bool flag indicating whether "TOP" or "LIMIT" clause
	// must be used for rows limitation
	UseTopClause bool
}

Dialect holds values that direct the query builder how to build compatible queries for each database. Each database driver needs to implement functions that provide these values.

type Query

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

Query holds the state for the built up query

func Raw

func Raw(exec boil.Executor, query string, args ...interface{}) *Query

Raw makes a raw query, usually for use with bind

func RawG

func RawG(query string, args ...interface{}) *Query

RawG makes a raw query using the global boil.Executor, usually for use with bind

func (*Query) Bind

func (q *Query) Bind(obj interface{}) error

Bind executes the query and inserts the result into the passed in object pointer.

See documentation for boil.Bind()

func (*Query) BindP

func (q *Query) BindP(obj interface{})

BindP executes the query and inserts the result into the passed in object pointer. It panics on error. See boil.Bind() documentation.

func (*Query) Exec

func (q *Query) Exec() (sql.Result, error)

Exec executes a query that does not need a row returned

func (*Query) ExecP

func (q *Query) ExecP() sql.Result

ExecP executes a query that does not need a row returned It will panic on error

func (*Query) Query

func (q *Query) Query() (*sql.Rows, error)

Query executes the query for the All finisher and returns multiple rows

func (*Query) QueryP

func (q *Query) QueryP() *sql.Rows

QueryP executes the query for the All finisher and returns multiple rows It will panic on error

func (*Query) QueryRow

func (q *Query) QueryRow() *sql.Row

QueryRow executes the query for the One finisher and returns a row

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL