dat

package
v0.0.2 Latest Latest
Warning

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

Go to latest
Published: May 22, 2015 License: MIT, MIT Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source
const DEFAULT = UnsafeString("DEFAULT")

DEFAULT SQL value

View Source
const NOW = UnsafeString("NOW()")

NOW SQL value

Variables

View Source
var (
	// ErrNotFound ...
	ErrNotFound = errors.New("not found")
	// ErrNotUTF8 ...
	ErrNotUTF8 = errors.New("invalid UTF-8")
	// ErrInvalidSliceLength ...
	ErrInvalidSliceLength = errors.New("length of slice is 0. length must be >= 1")
	// ErrInvalidSliceValue ...
	ErrInvalidSliceValue = errors.New("trying to interpolate invalid slice value into query")
	// ErrInvalidValue ...
	ErrInvalidValue = errors.New("trying to interpolate invalid value into query")
	// ErrArgumentMismatch ...
	ErrArgumentMismatch = errors.New("mismatch between ? (placeholders) and arguments")
)
View Source
var EnableInterpolation = false

Whether to enable interpolation

View Source
var NameMapping = camelCaseToSnakeCase

NameMapping is the routine to use when mapping column names to struct properties

View Source
var Strict = false

Strict tells dat to raise errors

Functions

func CalculateFieldMap

func CalculateFieldMap(recordType reflect.Type, columns []string,
	requireAllColumns bool) ([][]int, error)

CalculateFieldMap recordType is the type of a structure

func Interpolate

func Interpolate(sql string, vals []interface{}) (string, []interface{}, error)

Interpolate takes a SQL string with placeholders and a list of arguments to replace them with. Returns a blank string and error if the number of placeholders does not match the number of arguments.

func PrepareHolderFor

func PrepareHolderFor(record reflect.Value, fieldMap [][]int, holder []interface{}) ([]interface{}, error)

PrepareHolderFor creates holders for a record.

TODO: fill this in

func SQLMapFromFile

func SQLMapFromFile(filename string) (map[string]string, error)

SQLMapFromFile loads a file containing special markers and loads the SQL statements into a map.

func SQLMapFromReader

func SQLMapFromReader(r io.Reader) (map[string]string, error)

SQLMapFromReader creates a SQL map from an io.Reader.

This string

`
--@selectUsers
SELECT * FROM users;

--@selectAccounts
SELECT * FROM accounts;
`

returns map[string]string{
	"selectUsers": "SELECT * FROM users;",
	"selectACcounts": "SELECT * FROM accounts;",
}

func SQLMapFromString

func SQLMapFromString(s string) (map[string]string, error)

SQLMapFromString creates a map of strings from s.

func SQLSliceFromFile

func SQLSliceFromFile(filename string) ([]string, error)

SQLSliceFromFile reads a file's text then passes it to SQLSliceFromString.

func SQLSliceFromString

func SQLSliceFromString(s string) ([]string, error)

SQLSliceFromString converts a multiline string marked by `^GO$` into a slice of SQL statements.

This string

SELECT *
FROM users;
GO
SELECT *
FROM accounts;

returns []string{"SELECT *\nFROM users;", "SELECT *\nFROM accounts"}

func ValuesFor

func ValuesFor(recordType reflect.Type, record reflect.Value, columns []string) ([]interface{}, error)

ValuesFor does soemthing

TODO:

Types

type Builder

type Builder interface {
	// ToSQL builds the SQL and arguments from builder.
	ToSQL() (string, []interface{})

	// Interpolate builds the interpolation SQL and arguments from builder.
	// If interpolation flag is disabled then this is just a passthrough to ToSQL.
	Interpolate() (string, []interface{}, error)

	// IsInterpolated determines if this builder will interpolate when
	// Interpolate() is called.
	IsInterpolated() bool
}

Builder interface is used to tie SQL generators to executors.

type DeleteBuilder

type DeleteBuilder struct {
	Execer
	// contains filtered or unexported fields
}

DeleteBuilder contains the clauses for a DELETE statement

func DeleteFrom

func DeleteFrom(table string) *DeleteBuilder

DeleteFrom creates a new DeleteBuilder for the given table.

func NewDeleteBuilder

func NewDeleteBuilder(table string) *DeleteBuilder

NewDeleteBuilder creates a new DeleteBuilder for the given table.

func (*DeleteBuilder) Interpolate

func (b *DeleteBuilder) Interpolate() (string, []interface{}, error)

Interpolate interpolates this builders sql.

func (*DeleteBuilder) IsInterpolated

func (b *DeleteBuilder) IsInterpolated() bool

IsInterpolated determines if this builder will interpolate when Interpolate() is called.

func (*DeleteBuilder) Limit

func (b *DeleteBuilder) Limit(limit uint64) *DeleteBuilder

Limit sets a LIMIT clause for the statement; overrides any existing LIMIT

func (*DeleteBuilder) Offset

func (b *DeleteBuilder) Offset(offset uint64) *DeleteBuilder

Offset sets an OFFSET clause for the statement; overrides any existing OFFSET

func (*DeleteBuilder) OrderBy

func (b *DeleteBuilder) OrderBy(ord string) *DeleteBuilder

OrderBy appends an ORDER BY clause to the statement

func (*DeleteBuilder) Scope

func (b *DeleteBuilder) Scope(sql string, args ...interface{}) *DeleteBuilder

Scope uses a predefined scope in place of WHERE.

func (*DeleteBuilder) ScopeMap

func (b *DeleteBuilder) ScopeMap(mapScope *MapScope, m M) *DeleteBuilder

ScopeMap uses a predefined scope in place of WHERE.

func (*DeleteBuilder) SetIsInterpolated

func (b *DeleteBuilder) SetIsInterpolated(enable bool) *DeleteBuilder

SetIsInterpolated sets whether this builder should interpolate.

func (*DeleteBuilder) ToSQL

func (b *DeleteBuilder) ToSQL() (string, []interface{})

ToSQL serialized the DeleteBuilder to a SQL string It returns the string with placeholders and a slice of query arguments

func (*DeleteBuilder) Where

func (b *DeleteBuilder) Where(whereSqlOrMap interface{}, args ...interface{}) *DeleteBuilder

Where appends a WHERE clause to the statement whereSqlOrMap can be a string or map. If it's a string, args wil replaces any places holders

type Eq

type Eq map[string]interface{}

Eq is a map column -> value pairs which must be matched in a query

type Execer

type Execer interface {
	Exec() (*Result, error)
	QueryScalar(destinations ...interface{}) error
	QuerySlice(dest interface{}) error
	QueryStruct(dest interface{}) error
	QueryStructs(dest interface{}) error
	QueryObject(dest interface{}) error
	QueryJSON() ([]byte, error)
}

Execer is any object that executes and queries SQL.

type Expression

type Expression struct {
	Sql  string
	Args []interface{}
}

Expression holds a sub expression.

func Expr

func Expr(sql string, values ...interface{}) *Expression

Expr is a SQL expression with placeholders, and a slice of args to replace them with

func (*Expression) WriteRelativeArgs

func (exp *Expression) WriteRelativeArgs(buf common.BufferWriter, args *[]interface{}, pos *int64)

WriteRelativeArgs writes the args to buf adjusting the placeholder to start at pos.

type InsectBuilder

type InsectBuilder struct {
	Execer
	// contains filtered or unexported fields
}

InsectBuilder inserts or selects an existing row when executed.

// Inserts new row unless there exists a record where
// `name='mario' AND email='mario@acme.com'`
conn.Insect("people").
	Columns("name", "email").
	Values("mario", "mario@acme.com").
	Returning("id", "name", "email")

// Inserts unless there exists a record with ID of 1.
// Insect WILL NOT update the row if it exists.
conn.Insect("people").
	Columns("name", "email").
	Values("mario", "mario@acme.com").
	Where("id=$1", 1).
	Returning("id", "name", "email")

func Insect

func Insect(table string) *InsectBuilder

Insect inserts into a table if does not exist.

func NewInsectBuilder

func NewInsectBuilder(table string) *InsectBuilder

NewInsectBuilder creates a new InsectBuilder for the given table.

func (*InsectBuilder) Blacklist

func (b *InsectBuilder) Blacklist(columns ...string) *InsectBuilder

Blacklist defines a blacklist of columns and should only be used in conjunction with Record.

func (*InsectBuilder) Columns

func (b *InsectBuilder) Columns(columns ...string) *InsectBuilder

Columns appends columns to insert in the statement

func (*InsectBuilder) Interpolate

func (b *InsectBuilder) Interpolate() (string, []interface{}, error)

Interpolate interpolates this builders sql.

func (*InsectBuilder) IsInterpolated

func (b *InsectBuilder) IsInterpolated() bool

IsInterpolated determines if this builder will interpolate when Interpolate() is called.

func (*InsectBuilder) Record

func (b *InsectBuilder) Record(record interface{}) *InsectBuilder

Record pulls in values to match Columns from the record

func (*InsectBuilder) Returning

func (b *InsectBuilder) Returning(columns ...string) *InsectBuilder

Returning sets the columns for the RETURNING clause

func (*InsectBuilder) SetIsInterpolated

func (b *InsectBuilder) SetIsInterpolated(enable bool) *InsectBuilder

SetIsInterpolated sets whether this builder should interpolate.

func (*InsectBuilder) ToSQL

func (b *InsectBuilder) ToSQL() (string, []interface{})

ToSQL serialized the InsectBuilder to a SQL string It returns the string with placeholders and a slice of query arguments

func (*InsectBuilder) Values

func (b *InsectBuilder) Values(vals ...interface{}) *InsectBuilder

Values appends a set of values to the statement

func (*InsectBuilder) Where

func (b *InsectBuilder) Where(whereSqlOrMap interface{}, args ...interface{}) *InsectBuilder

Where appends a WHERE clause to the statement for the given string and args or map of column/value pairs

func (*InsectBuilder) Whitelist

func (b *InsectBuilder) Whitelist(columns ...string) *InsectBuilder

Whitelist defines a whitelist of columns to be inserted. To specify all columsn of a record use "*".

type InsertBuilder

type InsertBuilder struct {
	Execer
	// contains filtered or unexported fields
}

InsertBuilder contains the clauses for an INSERT statement

func InsertInto

func InsertInto(table string) *InsertBuilder

InsertInto creates a new InsertBuilder for the given table.

func NewInsertBuilder

func NewInsertBuilder(table string) *InsertBuilder

NewInsertBuilder creates a new InsertBuilder for the given table.

func (*InsertBuilder) Blacklist

func (b *InsertBuilder) Blacklist(columns ...string) *InsertBuilder

Blacklist defines a blacklist of columns and should only be used in conjunction with Record.

func (*InsertBuilder) Columns

func (b *InsertBuilder) Columns(columns ...string) *InsertBuilder

Columns appends columns to insert in the statement

func (*InsertBuilder) Interpolate

func (b *InsertBuilder) Interpolate() (string, []interface{}, error)

Interpolate interpolates this builders sql.

func (*InsertBuilder) IsInterpolated

func (b *InsertBuilder) IsInterpolated() bool

IsInterpolated determines if this builder will interpolate when Interpolate() is called.

func (*InsertBuilder) Pair

func (b *InsertBuilder) Pair(column string, value interface{}) *InsertBuilder

Pair adds a key/value pair to the statement

func (*InsertBuilder) Record

func (b *InsertBuilder) Record(record interface{}) *InsertBuilder

Record pulls in values to match Columns from the record

func (*InsertBuilder) Returning

func (b *InsertBuilder) Returning(columns ...string) *InsertBuilder

Returning sets the columns for the RETURNING clause

func (*InsertBuilder) SetIsInterpolated

func (b *InsertBuilder) SetIsInterpolated(enable bool) *InsertBuilder

SetIsInterpolated sets whether this builder should interpolate.

func (*InsertBuilder) ToSQL

func (b *InsertBuilder) ToSQL() (string, []interface{})

ToSQL serialized the InsertBuilder to a SQL string It returns the string with placeholders and a slice of query arguments

func (*InsertBuilder) Values

func (b *InsertBuilder) Values(vals ...interface{}) *InsertBuilder

Values appends a set of values to the statement

func (*InsertBuilder) Whitelist

func (b *InsertBuilder) Whitelist(columns ...string) *InsertBuilder

Whitelist defines a whitelist of columns to be inserted. To specify all columsn of a record use "*".

type Interpolator

type Interpolator interface {
	Interpolate() (string, error)
}

Interpolator is the interface for types which interpolate.

type JSON

type JSON json.RawMessage

JSON is a json.RawMessage, which is a []byte underneath. Value() validates the json format in the source, and returns an error if the json is not valid. Scan does no validation. JSON additionally implements `Unmarshal`, which unmarshals the json within to an interface{}

func NewJSON

func NewJSON(any interface{}) (*JSON, error)

NewJSON creates a JSON value.

func (JSON) Interpolate

func (j JSON) Interpolate() (string, error)

Interpolate interpolates the value into a string.

func (*JSON) MarshalJSON

func (j *JSON) MarshalJSON() ([]byte, error)

MarshalJSON returns the *j as the JSON encoding of j.

func (*JSON) Scan

func (j *JSON) Scan(src interface{}) error

Scan stores the src in *j. No validation is done.

func (*JSON) Unmarshal

func (j *JSON) Unmarshal(v interface{}) error

Unmarshal unmarshal's the json in j to v, as in json.Unmarshal.

func (*JSON) UnmarshalJSON

func (j *JSON) UnmarshalJSON(data []byte) error

UnmarshalJSON sets *j to a copy of data

func (JSON) Value

func (j JSON) Value() (driver.Value, error)

Value returns j as a value. This does a validating unmarshal into another RawMessage. If j is invalid json, it returns an error.

type M

type M map[string]interface{}

M is a generic map from string to interface{}

type MapScope

type MapScope struct {
	SQL    string
	Fields M
}

MapScope defines scope for using a fields map.

func NewScope

func NewScope(sql string, fields M) *MapScope

NewScope creates a new scope.

func (*MapScope) ToSQL

func (scope *MapScope) ToSQL(table string) (string, []interface{})

ToSQL converts this scope's SQL to SQL and args.

type NullBool

type NullBool struct {
	sql.NullBool
}

NullBool is a type that can be null or a bool

func (*NullBool) MarshalJSON

func (n *NullBool) MarshalJSON() ([]byte, error)

MarshalJSON correctly serializes a NullBool to JSON

type NullFloat64

type NullFloat64 struct {
	sql.NullFloat64
}

NullFloat64 is a type that can be null or a float64

func (*NullFloat64) MarshalJSON

func (n *NullFloat64) MarshalJSON() ([]byte, error)

MarshalJSON correctly serializes a NullFloat64 to JSON

type NullInt64

type NullInt64 struct {
	sql.NullInt64
}

NullInt64 is a type that can be null or an int

func (*NullInt64) MarshalJSON

func (n *NullInt64) MarshalJSON() ([]byte, error)

MarshalJSON correctly serializes a NullInt64 to JSON

type NullString

type NullString struct {
	sql.NullString
}

NullString is a type that can be null or a string

func (*NullString) MarshalJSON

func (n *NullString) MarshalJSON() ([]byte, error)

MarshalJSON correctly serializes a NullString to JSON

type NullTime

type NullTime struct {
	pq.NullTime
}

NullTime is a type that can be null or a time

func (*NullTime) MarshalJSON

func (n *NullTime) MarshalJSON() ([]byte, error)

MarshalJSON correctly serializes a NullTime to JSON

type RawBuilder

type RawBuilder struct {
	Execer
	// contains filtered or unexported fields
}

RawBuilder builds SQL from raw SQL.

func NewRawBuilder

func NewRawBuilder(sql string, args ...interface{}) *RawBuilder

NewRawBuilder creates a new RawBuilder for the given SQL string and arguments

func SQL

func SQL(sql string, args ...interface{}) *RawBuilder

SQL creates a new raw SQL builder.

func (*RawBuilder) Interpolate

func (b *RawBuilder) Interpolate() (string, []interface{}, error)

Interpolate interpolates this builders sql.

func (*RawBuilder) IsInterpolated

func (b *RawBuilder) IsInterpolated() bool

IsInterpolated determines if this builder will interpolate when Interpolate() is called.

func (*RawBuilder) SetIsInterpolated

func (b *RawBuilder) SetIsInterpolated(enable bool) *RawBuilder

SetIsInterpolated sets whether this builder should interpolate.

func (*RawBuilder) ToSQL

func (b *RawBuilder) ToSQL() (string, []interface{})

ToSQL implements builder interface

type Result

type Result struct {
	LastInsertID int64
	RowsAffected int64
}

Result serves the same purpose as sql.Result. Defining it for the package avoids tight coupling with database/sql.

type SQLDialect

type SQLDialect interface {
	// WriteStringLiteral writes a string literal.
	WriteStringLiteral(buf common.BufferWriter, value string)
	// WriteIdentifier writes a quoted identifer such as a column or table.
	WriteIdentifier(buf common.BufferWriter, column string)
}

SQLDialect represents a vendor specific SQL dialect.

var Dialect SQLDialect

Dialect is the active SQLDialect.

type Scope

type Scope interface {
	ToSQL(table string) (string, []interface{})
}

Scope predefines parameterized JOIN and WHERE conditions.

type ScopeFunc

type ScopeFunc func(table string) (string, []interface{})

ScopeFunc is an ad-hoc scope function.

func (ScopeFunc) ToSQL

func (sf ScopeFunc) ToSQL(table string) (string, []interface{})

ToSQL converts scoped func to sql.

type SelectBuilder

type SelectBuilder struct {
	Execer
	// contains filtered or unexported fields
}

SelectBuilder contains the clauses for a SELECT statement

func NewSelectBuilder

func NewSelectBuilder(columns ...string) *SelectBuilder

NewSelectBuilder creates a new SelectBuilder for the given columns

func Select

func Select(columns ...string) *SelectBuilder

Select creates a new SelectBuilder for the given columns.

func (*SelectBuilder) Distinct

func (b *SelectBuilder) Distinct() *SelectBuilder

Distinct marks the statement as a DISTINCT SELECT

func (*SelectBuilder) From

func (b *SelectBuilder) From(from string) *SelectBuilder

From sets the table to SELECT FROM

func (*SelectBuilder) GroupBy

func (b *SelectBuilder) GroupBy(group string) *SelectBuilder

GroupBy appends a column to group the statement

func (*SelectBuilder) Having

func (b *SelectBuilder) Having(whereSqlOrMap interface{}, args ...interface{}) *SelectBuilder

Having appends a HAVING clause to the statement

func (*SelectBuilder) Interpolate

func (b *SelectBuilder) Interpolate() (string, []interface{}, error)

Interpolate interpolates this builders sql.

func (*SelectBuilder) IsInterpolated

func (b *SelectBuilder) IsInterpolated() bool

IsInterpolated determines if this builder will interpolate when Interpolate() is called.

func (*SelectBuilder) Limit

func (b *SelectBuilder) Limit(limit uint64) *SelectBuilder

Limit sets a limit for the statement; overrides any existing LIMIT

func (*SelectBuilder) Offset

func (b *SelectBuilder) Offset(offset uint64) *SelectBuilder

Offset sets an offset for the statement; overrides any existing OFFSET

func (*SelectBuilder) OrderBy

func (b *SelectBuilder) OrderBy(ord string) *SelectBuilder

OrderBy appends a column to ORDER the statement by

func (*SelectBuilder) Paginate

func (b *SelectBuilder) Paginate(page, perPage uint64) *SelectBuilder

Paginate sets LIMIT/OFFSET for the statement based on the given page/perPage Assumes page/perPage are valid. Page and perPage must be >= 1

func (*SelectBuilder) Scope

func (b *SelectBuilder) Scope(sql string, args ...interface{}) *SelectBuilder

Scope uses a predefined scope in place of WHERE.

func (*SelectBuilder) ScopeMap

func (b *SelectBuilder) ScopeMap(mapScope *MapScope, m M) *SelectBuilder

ScopeMap uses a predefined scope in place of WHERE.

func (*SelectBuilder) SetIsInterpolated

func (b *SelectBuilder) SetIsInterpolated(enable bool) *SelectBuilder

SetIsInterpolated sets whether this builder should interpolate.

func (*SelectBuilder) ToSQL

func (b *SelectBuilder) ToSQL() (string, []interface{})

ToSQL serialized the SelectBuilder to a SQL string It returns the string with placeholders and a slice of query arguments

func (*SelectBuilder) Where

func (b *SelectBuilder) Where(whereSqlOrMap interface{}, args ...interface{}) *SelectBuilder

Where appends a WHERE clause to the statement for the given string and args or map of column/value pairs

type SelectDocBuilder

type SelectDocBuilder struct {
	*SelectBuilder
	// contains filtered or unexported fields
}

SelectDocBuilder builds SQL that returns a JSON row.

func NewSelectDocBuilder

func NewSelectDocBuilder(columns ...string) *SelectDocBuilder

NewSelectDocBuilder creates an instance of SelectDocBuilder.

func SelectDoc

func SelectDoc(columns ...string) *SelectDocBuilder

SelectDoc creates a new SelectDocBuilder for the given columns.

func (*SelectDocBuilder) As

func (b *SelectDocBuilder) As(column string, sqlOrBuilder interface{}, a ...interface{}) *SelectDocBuilder

As is an alias for HasMany

func (*SelectDocBuilder) Distinct

func (b *SelectDocBuilder) Distinct() *SelectDocBuilder

Distinct marks the statement as a DISTINCT SELECT

func (*SelectDocBuilder) From

func (b *SelectDocBuilder) From(from string) *SelectDocBuilder

From sets the table to SELECT FROM

func (*SelectDocBuilder) GroupBy

func (b *SelectDocBuilder) GroupBy(group string) *SelectDocBuilder

GroupBy appends a column to group the statement

func (*SelectDocBuilder) HasMany

func (b *SelectDocBuilder) HasMany(column string, sqlOrBuilder interface{}, a ...interface{}) *SelectDocBuilder

HasMany loads a sub query resulting in an array of rows as an alias.

func (*SelectDocBuilder) HasOne

func (b *SelectDocBuilder) HasOne(column string, sqlOrBuilder interface{}, a ...interface{}) *SelectDocBuilder

HasOne loads a query resulting in a single row as an alias.

func (*SelectDocBuilder) Having

func (b *SelectDocBuilder) Having(whereSqlOrMap interface{}, args ...interface{}) *SelectDocBuilder

Having appends a HAVING clause to the statement

func (*SelectDocBuilder) InnerSQL

func (b *SelectDocBuilder) InnerSQL(sql string, a ...interface{}) *SelectDocBuilder

InnerSQL sets the SQL after the SELECT (columns...) statement

func (*SelectDocBuilder) Interpolate

func (b *SelectDocBuilder) Interpolate() (string, []interface{}, error)

Interpolate interpolates this builders sql.

func (*SelectDocBuilder) IsInterpolated

func (b *SelectDocBuilder) IsInterpolated() bool

IsInterpolated determines if this builder will interpolate when Interpolate() is called.

func (*SelectDocBuilder) Limit

func (b *SelectDocBuilder) Limit(limit uint64) *SelectDocBuilder

Limit sets a limit for the statement; overrides any existing LIMIT

func (*SelectDocBuilder) Offset

func (b *SelectDocBuilder) Offset(offset uint64) *SelectDocBuilder

Offset sets an offset for the statement; overrides any existing OFFSET

func (*SelectDocBuilder) OrderBy

func (b *SelectDocBuilder) OrderBy(ord string) *SelectDocBuilder

OrderBy appends a column to ORDER the statement by

func (*SelectDocBuilder) Paginate

func (b *SelectDocBuilder) Paginate(page, perPage uint64) *SelectDocBuilder

Paginate sets LIMIT/OFFSET for the statement based on the given page/perPage Assumes page/perPage are valid. Page and perPage must be >= 1

func (*SelectDocBuilder) Scope

func (b *SelectDocBuilder) Scope(sql string, args ...interface{}) *SelectDocBuilder

Scope uses a predefined scope in place of WHERE.

func (*SelectDocBuilder) ScopeMap

func (b *SelectDocBuilder) ScopeMap(mapScope *MapScope, m M) *SelectDocBuilder

ScopeMap uses a predefined scope in place of WHERE.

func (*SelectDocBuilder) SetIsInterpolated

func (b *SelectDocBuilder) SetIsInterpolated(enable bool) *SelectDocBuilder

SetIsInterpolated sets whether this builder should interpolate.

func (*SelectDocBuilder) ToSQL

func (b *SelectDocBuilder) ToSQL() (string, []interface{})

ToSQL serialized the SelectBuilder to a SQL string It returns the string with placeholders and a slice of query arguments

func (*SelectDocBuilder) Where

func (b *SelectDocBuilder) Where(whereSqlOrMap interface{}, args ...interface{}) *SelectDocBuilder

Where appends a WHERE clause to the statement for the given string and args or map of column/value pairs

type UnsafeString

type UnsafeString string

UnsafeString is interpolated as an unescaped and unquoted value and should only be used to create constants.

func (UnsafeString) Value

func (u UnsafeString) Value() (driver.Value, error)

Value implements a valuer for compatibility

type UpdateBuilder

type UpdateBuilder struct {
	Execer
	// contains filtered or unexported fields
}

UpdateBuilder contains the clauses for an UPDATE statement

func NewUpdateBuilder

func NewUpdateBuilder(table string) *UpdateBuilder

NewUpdateBuilder creates a new UpdateBuilder for the given table

func Update

func Update(table string) *UpdateBuilder

Update creates a new UpdateBuilder for the given table.

func (*UpdateBuilder) Interpolate

func (b *UpdateBuilder) Interpolate() (string, []interface{}, error)

Interpolate interpolates this builders sql.

func (*UpdateBuilder) IsInterpolated

func (b *UpdateBuilder) IsInterpolated() bool

IsInterpolated determines if this builder will interpolate when Interpolate() is called.

func (*UpdateBuilder) Limit

func (b *UpdateBuilder) Limit(limit uint64) *UpdateBuilder

Limit sets a limit for the statement; overrides any existing LIMIT

func (*UpdateBuilder) Offset

func (b *UpdateBuilder) Offset(offset uint64) *UpdateBuilder

Offset sets an offset for the statement; overrides any existing OFFSET

func (*UpdateBuilder) OrderBy

func (b *UpdateBuilder) OrderBy(ord string) *UpdateBuilder

OrderBy appends a column to ORDER the statement by

func (*UpdateBuilder) Returning

func (b *UpdateBuilder) Returning(columns ...string) *UpdateBuilder

Returning sets the columns for the RETURNING clause

func (*UpdateBuilder) Scope

func (b *UpdateBuilder) Scope(sql string, args ...interface{}) *UpdateBuilder

Scope uses a predefined scope in place of WHERE.

func (*UpdateBuilder) ScopeMap

func (b *UpdateBuilder) ScopeMap(mapScope *MapScope, m M) *UpdateBuilder

ScopeMap uses a predefined scope in place of WHERE.

func (*UpdateBuilder) Set

func (b *UpdateBuilder) Set(column string, value interface{}) *UpdateBuilder

Set appends a column/value pair for the statement

func (*UpdateBuilder) SetBlacklist

func (b *UpdateBuilder) SetBlacklist(rec interface{}, columns ...string) *UpdateBuilder

SetBlacklist creates SET clause(s) using a record and blacklist of columns

func (*UpdateBuilder) SetIsInterpolated

func (b *UpdateBuilder) SetIsInterpolated(enable bool) *UpdateBuilder

SetIsInterpolated sets whether this builder should interpolate.

func (*UpdateBuilder) SetMap

func (b *UpdateBuilder) SetMap(clauses map[string]interface{}) *UpdateBuilder

SetMap appends the elements of the map as column/value pairs for the statement

func (*UpdateBuilder) SetWhitelist

func (b *UpdateBuilder) SetWhitelist(rec interface{}, columns ...string) *UpdateBuilder

SetWhitelist creates SET clause(s) using a record and whitelist of columns. To specify all columns, use "*".

func (*UpdateBuilder) ToSQL

func (b *UpdateBuilder) ToSQL() (string, []interface{})

ToSQL serialized the UpdateBuilder to a SQL string It returns the string with placeholders and a slice of query arguments

func (*UpdateBuilder) Where

func (b *UpdateBuilder) Where(whereSqlOrMap interface{}, args ...interface{}) *UpdateBuilder

Where appends a WHERE clause to the statement

type UpsertBuilder

type UpsertBuilder struct {
	Execer
	// contains filtered or unexported fields
}

UpsertBuilder contains the clauses for an INSERT statement

func NewUpsertBuilder

func NewUpsertBuilder(table string) *UpsertBuilder

NewUpsertBuilder creates a new UpsertBuilder for the given table.

func Upsert

func Upsert(table string) *UpsertBuilder

Upsert insert (if it does not exist) or updates a row.

func (*UpsertBuilder) Blacklist

func (b *UpsertBuilder) Blacklist(columns ...string) *UpsertBuilder

Blacklist defines a blacklist of columns and should only be used in conjunction with Record.

func (*UpsertBuilder) Columns

func (b *UpsertBuilder) Columns(columns ...string) *UpsertBuilder

Columns appends columns to insert in the statement

func (*UpsertBuilder) Interpolate

func (b *UpsertBuilder) Interpolate() (string, []interface{}, error)

Interpolate interpolates this builders sql.

func (*UpsertBuilder) IsInterpolated

func (b *UpsertBuilder) IsInterpolated() bool

IsInterpolated determines if this builder will interpolate when Interpolate() is called.

func (*UpsertBuilder) Record

func (b *UpsertBuilder) Record(record interface{}) *UpsertBuilder

Record pulls in values to match Columns from the record

func (*UpsertBuilder) Returning

func (b *UpsertBuilder) Returning(columns ...string) *UpsertBuilder

Returning sets the columns for the RETURNING clause

func (*UpsertBuilder) SetIsInterpolated

func (b *UpsertBuilder) SetIsInterpolated(enable bool) *UpsertBuilder

SetIsInterpolated sets whether this builder should interpolate.

func (*UpsertBuilder) ToSQL

func (b *UpsertBuilder) ToSQL() (string, []interface{})

ToSQL serialized the UpsertBuilder to a SQL string It returns the string with placeholders and a slice of query arguments

func (*UpsertBuilder) Values

func (b *UpsertBuilder) Values(vals ...interface{}) *UpsertBuilder

Values appends a set of values to the statement

func (*UpsertBuilder) Where

func (b *UpsertBuilder) Where(whereSqlOrMap interface{}, args ...interface{}) *UpsertBuilder

Where appends a WHERE clause to the statement for the given string and args or map of column/value pairs

func (*UpsertBuilder) Whitelist

func (b *UpsertBuilder) Whitelist(columns ...string) *UpsertBuilder

Whitelist defines a whitelist of columns to be inserted. To specify all columsn of a record use "*".

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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