condition

package
v0.8.0 Latest Latest
Warning

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

 Go to latest Published: Sep 10, 2026 License: MPL-2.0 Imports: 15 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrFieldModelNotConcerned   = errors.New("field's model is not concerned by the query (not joined)")
	ErrAppearanceMustBeSelected = errors.New("field's model appears more than once, select which one you want to use with Appearance")
	ErrAppearanceOutOfRange     = errors.New("selected appearance is bigger than field's model number of appearances")

	ErrEmptyConditions = errors.New("at least one condition is required")

	ErrMoreThanOneObjectFound = errors.New("found more that one object that meet the requested conditions")
	ErrObjectNotFound         = errors.New("no object exists that meets the requested conditions")

	ErrUnsupportedByDatabase = errors.New("method not supported by database")
	ErrOrderByMustBeCalled   = errors.New("order by must be called before limit in an update statement")

	ErrOnlyPreloadsAllowed = errors.New("only conditions that do a preload are allowed")

	ErrPreloadsInDeleteReturningNotAllowed = errors.New("preloads in delete returning are not allowed")
)

Functions

func AcquireDeletedAt added in v0.8.0 

func AcquireDeletedAt() *gorm.DeletedAt

func AcquireNullBool added in v0.8.0 

func AcquireNullBool() *sql.NullBool

func AcquireNullByte added in v0.8.0 

func AcquireNullByte() *sql.NullByte

func AcquireNullFloat64 added in v0.8.0 

func AcquireNullFloat64() *sql.NullFloat64

func AcquireNullInt16 added in v0.8.0 

func AcquireNullInt16() *sql.NullInt16

func AcquireNullInt32 added in v0.8.0 

func AcquireNullInt32() *sql.NullInt32

func AcquireNullInt64 added in v0.8.0 

func AcquireNullInt64() *sql.NullInt64

func AcquireNullString added in v0.8.0 

func AcquireNullString() *sql.NullString

func AcquireNullTime added in v0.8.0 

func AcquireNullTime() *sql.NullTime

func AcquireUUID added in v0.8.0 

func AcquireUUID() *model.UUID

func ApplyWhereCondition 

func ApplyWhereCondition[T model.Model](condition WhereCondition[T], query *CQLQuery, table Table) error

apply WhereCondition of any type on the query

func RegisterScanner added in v0.8.0 

func RegisterScanner[T model.Model](s *Scanner[T])

RegisterScanner records the per-model Scanner so a Query built without any conditions (e.g. Query[T](ctx, db).Find()) can still take the fast-scan path by resolving the scanner by type. Generated *_scanner.go files call this from init().

func ReleaseDeletedAt added in v0.8.0 

func ReleaseDeletedAt(v any)

func ReleaseNullBool added in v0.8.0 

func ReleaseNullBool(v any)

func ReleaseNullByte added in v0.8.0 

func ReleaseNullByte(v any)

func ReleaseNullFloat64 added in v0.8.0 

func ReleaseNullFloat64(v any)

func ReleaseNullInt16 added in v0.8.0 

func ReleaseNullInt16(v any)

func ReleaseNullInt32 added in v0.8.0 

func ReleaseNullInt32(v any)

func ReleaseNullInt64 added in v0.8.0 

func ReleaseNullInt64(v any)

func ReleaseNullSink added in v0.8.0 

func ReleaseNullSink(v any)

func ReleaseNullString added in v0.8.0 

func ReleaseNullString(v any)

func ReleaseNullTime added in v0.8.0 

func ReleaseNullTime(v any)

func ReleaseUUID added in v0.8.0 

func ReleaseUUID(v any)

func Select added in v0.3.0 

func Select[TResults any](
	query IQuery,
	selections []Selection[TResults],
) ([]TResults, error)

Types

type Aggregation added in v0.1.3 

type Aggregation interface {
	ToSQL(query *CQLQuery) (string, []any, error)
	// contains filtered or unexported methods
}

type AggregationCondition added in v0.1.3 

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

func ConnectionAggregationCondition added in v0.1.3 

func ConnectionAggregationCondition(conditions []AggregationCondition, operator sql.Operator) AggregationCondition

func ContainerAggregationCondition added in v0.1.3 

func ContainerAggregationCondition(conditions []AggregationCondition, operator sql.Operator) AggregationCondition

type AggregationResult added in v0.1.3 

type AggregationResult[T any] struct {
	Function sql.FunctionByDialector
	// contains filtered or unexported fields
}

func (AggregationResult[T]) Eq added in v0.1.3 

func (aggregation AggregationResult[T]) Eq(value ValueOfType[T]) AggregationCondition

EqualTo

func (AggregationResult[T]) GetValue added in v0.2.0 

func (aggregation AggregationResult[T]) GetValue() T

func (AggregationResult[T]) Gt added in v0.1.3 

func (aggregation AggregationResult[T]) Gt(value ValueOfType[T]) AggregationCondition

GreaterThan

func (AggregationResult[T]) GtOrEq added in v0.1.3 

func (aggregation AggregationResult[T]) GtOrEq(value ValueOfType[T]) AggregationCondition

GreaterThanOrEqualTo

func (AggregationResult[T]) In added in v0.1.3 

func (aggregation AggregationResult[T]) In(values []T) AggregationCondition

func (AggregationResult[T]) Like added in v0.1.3 

func (aggregation AggregationResult[T]) Like(value string) AggregationCondition

Pattern in all databases:

  • An underscore (_) in pattern stands for (matches) any single character.
  • A percent sign (%) matches any sequence of zero or more characters.

Additionally in SQLServer:

  • Square brackets ([ ]) matches any single character within the specified range ([a-f]) or set ([abcdef]).
  • [^] matches any single character not within the specified range ([^a-f]) or set ([^abcdef]).

WARNINGS:

refs:

func (AggregationResult[T]) Lt added in v0.1.3 

func (aggregation AggregationResult[T]) Lt(value ValueOfType[T]) AggregationCondition

LessThan

func (AggregationResult[T]) LtOrEq added in v0.1.3 

func (aggregation AggregationResult[T]) LtOrEq(value ValueOfType[T]) AggregationCondition

LessThanOrEqualTo

func (AggregationResult[T]) NotEq added in v0.1.3 

func (aggregation AggregationResult[T]) NotEq(value ValueOfType[T]) AggregationCondition

NotEqualTo

func (AggregationResult[T]) NotIn added in v0.1.3 

func (aggregation AggregationResult[T]) NotIn(values []T) AggregationCondition

func (AggregationResult[T]) ToSQL added in v0.2.0 

func (aggregation AggregationResult[T]) ToSQL(query *CQLQuery) (string, []any, error)

type BoolField 

type BoolField[TModel model.Model] struct {
	UpdatableField[TModel, bool]
}

func NewBoolField added in v0.0.8 

func NewBoolField[TModel model.Model](name, column, columnPrefix string, scanner ...*Scanner[TModel]) BoolField[TModel]

func (BoolField[TModel]) Aggregate added in v0.1.3 

func (boolField BoolField[TModel]) Aggregate() BoolFieldAggregation

Aggregate allows applying aggregation functions to the field inside a group by

func (BoolField[TModel]) Appearance added in v0.2.1 

func (boolField BoolField[TModel]) Appearance(number uint) BoolField[TModel]

Appearance allows to choose which number of appearance use when field's model is joined more than once.

func (BoolField[TModel]) Is 

func (boolField BoolField[TModel]) Is() BoolFieldIs[TModel]

type BoolFieldAggregation added in v0.1.3 

type BoolFieldAggregation struct {
	FieldAggregation[bool]
}

func (BoolFieldAggregation) All added in v0.1.3 

func (fieldAggregation BoolFieldAggregation) All() AggregationResult[bool]

All returns true if all the values are true

func (BoolFieldAggregation) Any added in v0.1.3 

func (fieldAggregation BoolFieldAggregation) Any() AggregationResult[bool]

All returns true if at least one value is true

func (BoolFieldAggregation) None added in v0.1.3 

func (fieldAggregation BoolFieldAggregation) None() AggregationResult[bool]

None returns true if all values are false

type BoolFieldIs 

type BoolFieldIs[TObject model.Model] struct {
	// contains filtered or unexported fields
}

func (BoolFieldIs[TObject]) False 

func (is BoolFieldIs[TObject]) False() WhereCondition[TObject]

func (BoolFieldIs[TObject]) NotFalse 

func (is BoolFieldIs[TObject]) NotFalse() WhereCondition[TObject]

func (BoolFieldIs[TObject]) NotTrue 

func (is BoolFieldIs[TObject]) NotTrue() WhereCondition[TObject]

func (BoolFieldIs[TObject]) NotUnknown 

func (is BoolFieldIs[TObject]) NotUnknown() WhereCondition[TObject]

func (BoolFieldIs[TObject]) True 

func (is BoolFieldIs[TObject]) True() WhereCondition[TObject]

func (BoolFieldIs[TObject]) Unknown 

func (is BoolFieldIs[TObject]) Unknown() WhereCondition[TObject]

type BoolValue added in v0.1.3 

type BoolValue struct {
	Value bool
}

func Bool added in v0.2.0 

func Bool(value bool) BoolValue

func (BoolValue) GetValue added in v0.2.0 

func (boolValue BoolValue) GetValue() bool

func (BoolValue) RawScalarValue added in v0.8.0 

func (boolValue BoolValue) RawScalarValue() any

RawScalarValue — see Value[T].RawScalarValue.

func (BoolValue) ToSQL added in v0.2.0 

func (boolValue BoolValue) ToSQL(_ *CQLQuery) (string, []any, error)

type CQLQuery added in v0.2.0 

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

func ApplyConditions 

func ApplyConditions[T model.Model](db *gorm.DB, conditions []Condition[T]) (*CQLQuery, error)

Create a GormQuery to which the conditions are applied

func NewGormQuery 

func NewGormQuery(db *gorm.DB, initialModel model.Model, initialTable Table) *CQLQuery

func (*CQLQuery) AddConcernedModel added in v0.2.0 

func (query *CQLQuery) AddConcernedModel(model model.Model, table Table)

func (*CQLQuery) AddSelect added in v0.2.0 

func (query *CQLQuery) AddSelect(sql string)

Select specify fields that you want when querying, creating, updating

func (*CQLQuery) AddSelectField added in v0.2.0 

func (query *CQLQuery) AddSelectField(table Table, fieldID IField, addAs bool)

func (CQLQuery) ColumnName added in v0.2.0 

func (query CQLQuery) ColumnName(table Table, fieldName string) string

func (*CQLQuery) Count added in v0.2.0 

func (query *CQLQuery) Count() (int64, error)

Count returns the amount of models that fulfill the conditions

func (*CQLQuery) Delete added in v0.2.0 

func (query *CQLQuery) Delete(cqlSubQuery *CQLQuery) (int64, error)

func (CQLQuery) Dialector added in v0.2.0 

func (query CQLQuery) Dialector() sql.Dialector

func (*CQLQuery) Find added in v0.2.0 

func (query *CQLQuery) Find(dest any) error

Find finds all models matching given conditions

func (*CQLQuery) First added in v0.2.0 

func (query *CQLQuery) First(dest any) error

First finds the first record ordered by primary key, matching given conditions

func (*CQLQuery) GetModelTable added in v0.2.0 

func (query *CQLQuery) GetModelTable(field IField) (Table, error)

func (*CQLQuery) GetTables added in v0.2.0 

func (query *CQLQuery) GetTables(modelType reflect.Type) []Table

func (*CQLQuery) GroupBy added in v0.2.0 

func (query *CQLQuery) GroupBy(fields []IField) error

GroupBy arrange identical data into groups

func (*CQLQuery) Having added in v0.2.0 

func (query *CQLQuery) Having(sql string, args ...any)

Having allows filter groups of rows based on conditions involving aggregate functions

func (*CQLQuery) Joins added in v0.2.0 

func (query *CQLQuery) Joins(joinQuery string, isLeftJoin bool, args ...interface{})

func (*CQLQuery) Last added in v0.2.0 

func (query *CQLQuery) Last(dest any) error

Last finds the last record ordered by primary key, matching given conditions

func (*CQLQuery) Limit added in v0.2.0 

func (query *CQLQuery) Limit(limit int)

Limit specify the number of records to be retrieved

Limit conditions can be cancelled by using `Limit(-1)`

func (*CQLQuery) Offset added in v0.2.0 

func (query *CQLQuery) Offset(offset int)

Offset specify the number of records to skip before starting to return the records

Offset conditions can be cancelled by using `Offset(-1)`.

func (*CQLQuery) Order added in v0.2.0 

func (query *CQLQuery) Order(field IField, descending bool) error

Order specify order when retrieving models from database.

if descending is true, the ordering is in descending direction.

func (*CQLQuery) Preload added in v0.2.0 

func (query *CQLQuery) Preload(preloadQuery string, args ...interface{})

func (*CQLQuery) Returning added in v0.2.0 

func (query *CQLQuery) Returning(dest any) error

available for: postgres, sqlite, sqlserver

warning: in sqlite, sqlserver preloads are not allowed

func (*CQLQuery) SoftDelete added in v0.6.0 

func (query *CQLQuery) SoftDelete(softDeleteColumnName string) (int64, error)

func (*CQLQuery) Take added in v0.2.0 

func (query *CQLQuery) Take(dest any) error

Take finds the first record returned by the database in no specified order, matching given conditions

func (*CQLQuery) Unscoped added in v0.2.0 

func (query *CQLQuery) Unscoped()

func (*CQLQuery) Update added in v0.2.0 

func (query *CQLQuery) Update(sets []ISet) (int64, error)

Find finds all models matching given conditions

func (*CQLQuery) Where added in v0.2.0 

func (query *CQLQuery) Where(whereQuery interface{}, args ...interface{})

func (*CQLQuery) WhereRaw added in v0.8.0 

func (query *CQLQuery) WhereRaw(sql string, args []any)

WhereRaw accumulates a WHERE fragment locally. flushPending pushes the batch into the gorm Statement once, right before execution. This trades N gormDB.WhereRaw chainable calls (each doing AddClause map lookup + merge with the existing WHERE clause) for a single AddClause call. Measured impact: 4.5% wall-clock + 17 fewer allocs at 5 conditions; noise at 1 condition.

type Collection added in v0.0.6 

type Collection[TObject model.Model, TAttribute model.Model] struct {
	// contains filtered or unexported fields
}

func NewCollection added in v0.0.6 

func NewCollection[TObject model.Model, TAttribute model.Model](
	name, t1Field, t2Field string,
	loader ...*HasManyLoader[TObject, TAttribute],
) Collection[TObject, TAttribute]

NewCollection builds a Collection. The optional loader is the per-relation HasManyLoader wired by cql-gen output. When provided, .Preload() takes the fast path: one extra child SELECT through Query[Child] + a generated mounter, no gorm reflective preload.

func (Collection[TObject, TAttribute]) All added in v0.0.6 

func (collection Collection[TObject, TAttribute]) All(
	firstCondition WhereCondition[TAttribute],
	conditions ...WhereCondition[TAttribute],
) WhereCondition[TObject]

All generates a condition that is true if all models in the collection fulfill the conditions (or is empty)

func (Collection[TObject, TAttribute]) Any added in v0.0.6 

func (collection Collection[TObject, TAttribute]) Any(
	firstCondition WhereCondition[TAttribute],
	conditions ...WhereCondition[TAttribute],
) WhereCondition[TObject]

Any generates a condition that is true if at least one model in the collection fulfills the conditions

func (Collection[TObject, TAttribute]) None added in v0.0.6 

func (collection Collection[TObject, TAttribute]) None(
	firstCondition WhereCondition[TAttribute],
	conditions ...WhereCondition[TAttribute],
) WhereCondition[TObject]

None generates a condition that is true if no model in the collection fulfills the conditions

func (Collection[TObject, TAttribute]) Preload added in v0.0.6 

func (collection Collection[TObject, TAttribute]) Preload(nestedPreloads ...JoinCondition[TAttribute]) Condition[TObject]

Preload collection of models

nestedPreloads can be used to preload relations of the models inside the collection

func (Collection[TObject, TAttribute]) WithParentScanner added in v0.8.0 

func (collection Collection[TObject, TAttribute]) WithParentScanner(s *Scanner[TObject]) Collection[TObject, TAttribute]

WithParentScanner attaches the parent model's Scanner so a query whose only condition is Collection.Preload() can still take the fast path. Generated init() calls this after the per-model scanner var is declared.

type Condition 

type Condition[T model.Model] interface {
	// contains filtered or unexported methods
}

func NewCollectionPreloadCondition 

func NewCollectionPreloadCondition[T1, T2 model.Model](
	collectionField string,
	nestedPreloads []JoinCondition[T2],
	hasManyLoader ...*HasManyLoader[T1, T2],
) Condition[T1]

NewCollectionPreloadCondition builds a condition used to preload a collection of models of a model.

The optional hasManyLoader (variadic for back-compat with hand-written callers) is the generated fast-scan mounter. When supplied AND the user preloaded this collection, the runtime runs ONE child query through Query[T2] and groups results onto parents — no gorm reflective preload.

func NewPreloadCondition 

func NewPreloadCondition[T model.Model](fields ...IField) Condition[T]

Condition used to the preload the attributes of a model

type Delete 

type Delete[T model.Model] struct {
	OrderLimitReturning[T]
	// contains filtered or unexported fields
}

func NewDelete 

func NewDelete[T model.Model](tx *gorm.DB, conditions []Condition[T]) *Delete[T]

Create a Delete to which the conditions are applied inside transaction tx

func (*Delete[T]) Ascending 

func (deleteS *Delete[T]) Ascending(field IField) *Delete[T]

Ascending specify an ascending order when updating models

available for: mysql

func (*Delete[T]) Descending 

func (deleteS *Delete[T]) Descending(field IField) *Delete[T]

Descending specify a descending order when updating models

available for: mysql

func (*Delete[T]) Exec 

func (deleteS *Delete[T]) Exec() (int64, error)

func (*Delete[T]) Limit 

func (deleteS *Delete[T]) Limit(limit int) *Delete[T]

Limit specify the number of models to be updated

Limit conditions can be cancelled by using `Limit(-1)`

available for: mysql

func (*Delete[T]) Returning 

func (deleteS *Delete[T]) Returning(dest *[]T) *Delete[T]

available for: postgres, sqlite, sqlserver

warning: in mysql preloads are not allowed

type Field 

type Field[TModel model.Model, TAttribute any] struct {
	// contains filtered or unexported fields
}

func NewField added in v0.0.8 

func NewField[TModel model.Model, TAttribute any](name, column, columnPrefix string, scanner ...*Scanner[TModel]) Field[TModel, TAttribute]

NewField builds a Field. The optional scanner is shared by pointer across every field on a model's conditions struct; cql-gen output passes it on every constructor call. Hand-written callers may omit it (the fast scan path simply falls back to gorm).

func (Field[TModel, TAttribute]) Aggregate added in v0.1.3 

func (field Field[TModel, TAttribute]) Aggregate() FieldAggregation[TAttribute]

Aggregate allows applying aggregation functions to the field inside a group by

func (Field[TModel, TAttribute]) Appearance added in v0.1.2 

func (field Field[TModel, TAttribute]) Appearance(number uint) Field[TModel, TAttribute]

Appearance allows to choose which number of appearance use when field's model is joined more than once.

func (Field[TModel, TAttribute]) GetValue added in v0.2.1 

func (field Field[TModel, TAttribute]) GetValue() TAttribute

func (Field[TModel, TAttribute]) Is 

func (field Field[TModel, TAttribute]) Is() FieldIs[TModel, TAttribute]

Is allows creating conditions that include the field and a static value

func (Field[TModel, TAttribute]) IsUnsafe added in v0.0.10 

func (field Field[TModel, TAttribute]) IsUnsafe() UnsafeFieldIs[TModel, TAttribute]

Should not be used.

IsUnsafe allows creating conditions that include the field and are not verified in compilation time.

func (Field[TModel, TAttribute]) ToSQL added in v0.2.1 

func (field Field[TModel, TAttribute]) ToSQL(query *CQLQuery) (string, []any, error)

func (Field[TModel, TAttribute]) ToSQLForTable added in v0.3.2 

func (field Field[TModel, TAttribute]) ToSQLForTable(query *CQLQuery, table Table) (string, []any, error)

type FieldAggregation added in v0.1.3 

type FieldAggregation[T any] struct {
	// contains filtered or unexported fields
}

func (FieldAggregation[T]) Count added in v0.1.3 

func (fieldAggregation FieldAggregation[T]) Count() AggregationResult[float64]

Count returns the number of values that are not null

func (FieldAggregation[T]) Max added in v0.1.3 

func (fieldAggregation FieldAggregation[T]) Max() AggregationResult[T]

Max returns the maximum value of all values

func (FieldAggregation[T]) Min added in v0.1.3 

func (fieldAggregation FieldAggregation[T]) Min() AggregationResult[T]

Min returns the minimum value of all values

type FieldIs 

type FieldIs[TObject model.Model, TAttribute any] struct {
	// contains filtered or unexported fields
}

func (FieldIs[TObject, TAttribute]) Between 

func (is FieldIs[TObject, TAttribute]) Between(v1, v2 ValueOfType[TAttribute]) WhereCondition[TObject]

Equivalent to v1 < value < v2

func (FieldIs[TObject, TAttribute]) Custom 

func (is FieldIs[TObject, TAttribute]) Custom(op Operator[TAttribute]) WhereCondition[TObject]

Custom can be used to use other Operators, like database specific operators

func (FieldIs[TObject, TAttribute]) Distinct 

func (is FieldIs[TObject, TAttribute]) Distinct(value ValueOfType[TAttribute]) WhereCondition[TObject]

func (FieldIs[TObject, TAttribute]) Eq 

func (is FieldIs[TObject, TAttribute]) Eq(value ValueOfType[TAttribute]) WhereCondition[TObject]

EqualTo NotDistinct must be used in cases where value can be NULL

func (FieldIs[TObject, TAttribute]) Gt 

func (is FieldIs[TObject, TAttribute]) Gt(value ValueOfType[TAttribute]) WhereCondition[TObject]

GreaterThan

func (FieldIs[TObject, TAttribute]) GtOrEq 

func (is FieldIs[TObject, TAttribute]) GtOrEq(value ValueOfType[TAttribute]) WhereCondition[TObject]

GreaterThanOrEqualTo

func (FieldIs[TObject, TAttribute]) In 

func (is FieldIs[TObject, TAttribute]) In(values ...ValueOfType[TAttribute]) WhereCondition[TObject]

func (FieldIs[TObject, TAttribute]) Lt 

func (is FieldIs[TObject, TAttribute]) Lt(value ValueOfType[TAttribute]) WhereCondition[TObject]

LessThan

func (FieldIs[TObject, TAttribute]) LtOrEq 

func (is FieldIs[TObject, TAttribute]) LtOrEq(value ValueOfType[TAttribute]) WhereCondition[TObject]

LessThanOrEqualTo

func (FieldIs[TObject, TAttribute]) NotBetween 

func (is FieldIs[TObject, TAttribute]) NotBetween(v1, v2 ValueOfType[TAttribute]) WhereCondition[TObject]

Equivalent to NOT (v1 < value < v2)

func (FieldIs[TObject, TAttribute]) NotDistinct 

func (is FieldIs[TObject, TAttribute]) NotDistinct(value ValueOfType[TAttribute]) WhereCondition[TObject]

func (FieldIs[TObject, TAttribute]) NotEq 

func (is FieldIs[TObject, TAttribute]) NotEq(value ValueOfType[TAttribute]) WhereCondition[TObject]

NotEqualTo Distinct must be used in cases where value can be NULL

func (FieldIs[TObject, TAttribute]) NotIn 

func (is FieldIs[TObject, TAttribute]) NotIn(values ...ValueOfType[TAttribute]) WhereCondition[TObject]

func (FieldIs[TObject, TAttribute]) NotNull 

func (is FieldIs[TObject, TAttribute]) NotNull() WhereCondition[TObject]

func (FieldIs[TObject, TAttribute]) Null 

func (is FieldIs[TObject, TAttribute]) Null() WhereCondition[TObject]

type FieldOfModel added in v0.4.0 

type FieldOfModel[T model.Model] interface {
	IField
	// contains filtered or unexported methods
}

type FieldSet 

type FieldSet[TModel model.Model, TAttribute any] struct {
	// contains filtered or unexported fields
}

func (FieldSet[TModel, TAttribute]) Eq 

func (set FieldSet[TModel, TAttribute]) Eq(value ValueOfType[TAttribute]) *Set[TModel]

func (FieldSet[TModel, TAttribute]) Unsafe 

func (set FieldSet[TModel, TAttribute]) Unsafe(value IValue) *Set[TModel]

type HasManyLoader added in v0.8.0 

type HasManyLoader[Parent, Child model.Model] struct {
	// CollectionField is the Go field name on Parent that holds the
	// children (e.g. "Sellers"). Used for diagnostic output.
	CollectionField string
	// ParentID extracts the PK value from a parent. Compared against
	// ChildFK to group children with their parent.
	ParentID func(*Parent) any
	// ChildFK extracts the foreign-key value from a child (e.g. its
	// CompanyID for a Seller→Company relation).
	ChildFK func(*Child) any
	// Mount writes the grouped children onto parent. Pointer slices
	// (`*[]Seller`) and value slices (`[]Seller`) both use Mount —
	// generated code adapts.
	Mount func(parent *Parent, children []*Child)
	// BuildQuery constructs the SELECT-children-WHERE-fk-IN(...) query.
	// Generated code uses the child's conditions struct so nested
	// preloads/joins/filters compose naturally:
	//   func(tx *gorm.DB, ids []any, nested []Condition[Seller]) (*Query[Seller], error) {
	//       conds := append(
	//         []Condition[Seller]{ conditions.Seller.CompanyID.IsUnsafe().In(ids) },
	//         nested...,
	//       )
	//       return NewQuery[Seller](tx, conds...), nil
	//   }
	BuildQuery func(tx *gorm.DB, parentIDs []any, nested []Condition[Child]) (*Query[Child], error)
}

HasManyLoader is a code-generated post-scan mounter for a HasMany relation. After the main query materializes parents, the runtime walks every registered loader exactly once:

  • collect parent PK values via ParentID
  • build a Query[Child] (which gets all the fast-path goodies, including a nested fast scanner for Child) via BuildQuery and run Find
  • group results by ChildFK
  • call Mount(parent, groupedChildren) per parent

Generated code constructs one HasManyLoader per HasMany relation on each parent model, with all the typed accessors baked in. The cost is one extra SQL round-trip per HasMany relation per query (same shape gorm's reflective preload uses).

type IField 

type IField interface {
	ToSQL(query *CQLQuery) (string, []any, error)
	ToSQLForTable(query *CQLQuery, table Table) (string, []any, error)
	// contains filtered or unexported methods
}

type IQuery added in v0.7.0 

type IQuery interface {
	// contains filtered or unexported methods
}

type ISet 

type ISet interface {
	// contains filtered or unexported methods
}

type IValue added in v0.0.10 

type IValue interface {
	ToSQL(query *CQLQuery) (string, []any, error)
}

type IValueList added in v0.2.0 

type IValueList[T any] []ValueOfType[T]

func (IValueList[T]) ToSQL added in v0.2.0 

func (values IValueList[T]) ToSQL(query *CQLQuery) (string, []any, error)

type Insert added in v0.4.0 

type Insert[T model.Model] struct {
	// contains filtered or unexported fields
}

func NewInsert added in v0.4.0 

func NewInsert[T model.Model](tx *gorm.DB, models []*T) *Insert[T]

func (*Insert[T]) Exec added in v0.4.0 

func (insert *Insert[T]) Exec() (int64, error)

Exec execute the insert statement, returning the amount of rows inserted. It will also update the inserted model's primary key in their ids

WARNING: the value returned may depend on the db engine, for example mysql returns the double of the other ones when there is conflict

func (*Insert[T]) ExecInBatches added in v0.4.0 

func (insert *Insert[T]) ExecInBatches(batchSize int) (int64, error)

ExecInBatches execute the insert statement in batches of batchSize, returning the amount of rows inserted. It will also update the inserted model's primary key in their ids

WARNING: the value returned may depend on the db engine, for example mysql returns the double of the other ones when there is conflict

func (*Insert[T]) OnConflict added in v0.4.0 

func (insert *Insert[T]) OnConflict() *InsertOnConflict[T]

OnConflict allows to set the action to be taken when any conflict happens when inserting the data.

WARNING: in postgres OnConflict can be used only with DoNothing, for UpdateAll, Update and Set, OnConflictOn must be used

func (*Insert[T]) OnConflictOn added in v0.4.0 

func (insert *Insert[T]) OnConflictOn(field FieldOfModel[T], fields ...FieldOfModel[T]) *InsertOnConflict[T]

OnConflictOn allows to set the action to be taken when a conflict with the fields specified by parameter happens when inserting the data. For this, there must be a constraint on these fields, otherwise an error will be returned.

Available for: postgres, sqlite

func (*Insert[T]) OnConstraint added in v0.4.0 

func (insert *Insert[T]) OnConstraint(constraintName string) *InsertOnConflict[T]

OnConstraint allows to set the action to be taken when a conflict with the constraint specified by parameter happens when inserting the data. For this, the constraint must exist, otherwise an error will be returned.

Available for: postgres

type InsertExec added in v0.4.0 

type InsertExec[T model.Model] struct {
	// contains filtered or unexported fields
}

func (*InsertExec[T]) Exec added in v0.4.0 

func (insertExec *InsertExec[T]) Exec() (int64, error)

Exec execute the insert statement, returning the amount of rows inserted. It will also update the inserted model's primary key in their ids

WARNING: the value returned may depend on the db engine, for example mysql returns the double of the other ones when there is conflict

func (*InsertExec[T]) ExecInBatches added in v0.4.0 

func (insertExec *InsertExec[T]) ExecInBatches(batchSize int) (int64, error)

ExecInBatches execute the insert statement in batches of batchSize, returning the amount of rows inserted. It will also update the inserted model's primary key in their ids

WARNING: the value returned may depend on the db engine, for example mysql returns the double of the other ones when there is conflict

type InsertOnConflict added in v0.4.0 

type InsertOnConflict[T model.Model] struct {
	// contains filtered or unexported fields
}

func (*InsertOnConflict[T]) DoNothing added in v0.4.0 

func (insertOnConflict *InsertOnConflict[T]) DoNothing() *InsertExec[T]

DoNothing will not take any action, simply preventing an error from being responded.

func (*InsertOnConflict[T]) Set added in v0.4.0 

func (insertOnConflict *InsertOnConflict[T]) Set(sets ...*Set[T]) *InsertOnConflictSet[T]

Set allows to specify which updates to perform.

func (*InsertOnConflict[T]) Update added in v0.4.0 

func (insertOnConflict *InsertOnConflict[T]) Update(fields ...FieldOfModel[T]) *InsertExec[T]

Update will update the attributes specified by parameter with the values of the models that already exist.

func (*InsertOnConflict[T]) UpdateAll added in v0.4.0 

func (insertOnConflict *InsertOnConflict[T]) UpdateAll() *InsertExec[T]

UpdateAll will update all model attributes with the values of the models that already exist.

type InsertOnConflictSet added in v0.4.0 

type InsertOnConflictSet[T model.Model] struct {
	// contains filtered or unexported fields
}

func (*InsertOnConflictSet[T]) Exec added in v0.4.0 

func (insertOnConflictSet *InsertOnConflictSet[T]) Exec() (int64, error)

Exec execute the insert statement, returning the amount of rows inserted. It will also update the inserted model's primary key in their ids

WARNING: the value returned may depend on the db engine, for example mysql returns the double of the other ones when there is conflict

func (*InsertOnConflictSet[T]) ExecInBatches added in v0.4.0 

func (insertOnConflictSet *InsertOnConflictSet[T]) ExecInBatches(batchSize int) (int64, error)

ExecInBatches execute the insert statement in batches of batchSize, returning the amount of rows inserted. It will also update the inserted model's primary key in their ids

WARNING: the value returned may depend on the db engine, for example mysql returns the double of the other ones when there is conflict

func (*InsertOnConflictSet[T]) Where added in v0.4.0 

func (insertOnConflictSet *InsertOnConflictSet[T]) Where(conditions ...Condition[T]) *InsertExec[T]

Where allows to set conditions on the models that generate conflicts when performing the updates.

Available for: postgres, sqlite

type JoinCondition 

type JoinCondition[T model.Model] interface {
	Condition[T]

	// Preload activates the preloading of the joined model.
	Preload() JoinCondition[T]
	// contains filtered or unexported methods
}

Condition that joins T with any other model

func NewJoinCondition 

func NewJoinCondition[T1, T2 model.Model](
	conditions []Condition[T2],
	relationField string,
	t1Field string,
	t1PreloadCondition Condition[T1],
	t2Field string,
	t2PreloadCondition Condition[T2],
	relationScanner ...*RelationScanner[T1, T2],
) JoinCondition[T1]

Condition that joins T with any other model

The optional `relationScanner` (variadic for back-compat with hand-written callers) is the per-relation mounter cql-gen emits alongside the per-model scanner. When non-nil AND the user calls .Preload(), applyTo registers it on the query so findWith materializes joined columns directly into the parent's relation field — no gorm reflection.

type LikeOperator 

type LikeOperator struct {
	ValueOperator[string]
}

func Like 

func Like(pattern string) LikeOperator

Pattern in all databases:

  • An underscore (_) in pattern stands for (matches) any single character.
  • A percent sign (%) matches any sequence of zero or more characters.

Additionally in SQLServer:

  • Square brackets ([ ]) matches any single character within the specified range ([a-f]) or set ([abcdef]).
  • [^] matches any single character not within the specified range ([^a-f]) or set ([^abcdef]).

WARNINGS:

  • SQLite: LIKE is case-insensitive unless case_sensitive_like pragma (https://www.sqlite.org/pragma.html#pragma_case_sensitive_like) is true.
  • SQLServer, MySQL: the case-sensitivity depends on the collation used in compared column.
  • PostgreSQL: LIKE is always case-sensitive, if you want case-insensitive use the ILIKE operator (implemented in psql.ILike)

refs:

func NewLikeOperator 

func NewLikeOperator(sqlOperator sql.Operator, pattern string) LikeOperator

func (LikeOperator) Escape 

func (operator LikeOperator) Escape(escape rune) ValueOperator[string]

type NotUpdatableNumericField added in v0.2.1 

type NotUpdatableNumericField[TModel model.Model, TAttribute Numeric] struct {
	Field[TModel, TAttribute]
}

func (NotUpdatableNumericField[TModel, TAttribute]) Absolute added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) Absolute() NotUpdatableNumericField[TModel, TAttribute]

Absolute calculates the absolute value of the value

func (NotUpdatableNumericField[TModel, TAttribute]) Aggregate added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) Aggregate() NumericFieldAggregation

Aggregate allows applying aggregation functions to the field inside a group by

func (NotUpdatableNumericField[TModel, TAttribute]) And added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) And(other NumericOfType[TAttribute]) NotUpdatableNumericField[TModel, TAttribute]

And calculates the bitwise AND between value and other

func (NotUpdatableNumericField[TModel, TAttribute]) Divided added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) Divided(other ValueOfType[float64]) NotUpdatableNumericField[TModel, TAttribute]

Divided divides value by other

func (NotUpdatableNumericField[TModel, TAttribute]) GetNumericValue added in v0.3.2 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) GetNumericValue() TAttribute

func (NotUpdatableNumericField[TModel, TAttribute]) GetValue added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) GetValue() float64

func (NotUpdatableNumericField[TModel, TAttribute]) Is added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) Is() NumericFieldIs[TModel]

func (NotUpdatableNumericField[TModel, TAttribute]) Minus added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) Minus(other ValueOfType[float64]) NotUpdatableNumericField[TModel, TAttribute]

Minus subtracts other from the value

func (NotUpdatableNumericField[TModel, TAttribute]) Modulo added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) Modulo(other ValueOfType[float64]) NotUpdatableNumericField[TModel, TAttribute]

Modulo returns the remainder of the entire division

func (NotUpdatableNumericField[TModel, TAttribute]) Not added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) Not() NotUpdatableNumericField[TModel, TAttribute]

Not calculates the bitwise NOT of value

func (NotUpdatableNumericField[TModel, TAttribute]) Or added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) Or(other NumericOfType[TAttribute]) NotUpdatableNumericField[TModel, TAttribute]

Or calculates the bitwise OR between value and other

func (NotUpdatableNumericField[TModel, TAttribute]) Plus added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) Plus(other ValueOfType[float64]) NotUpdatableNumericField[TModel, TAttribute]

Plus sums other to value

func (NotUpdatableNumericField[TModel, TAttribute]) Power added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) Power(other ValueOfType[float64]) NotUpdatableNumericField[TModel, TAttribute]

Power elevates value to other

Warning: in sqlite DSQLITE_ENABLE_MATH_FUNCTIONS needs to be enabled or the error "no such function: POWER" will be returned

func (NotUpdatableNumericField[TModel, TAttribute]) ShiftLeft added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) ShiftLeft(amount NumericOfType[int]) NotUpdatableNumericField[TModel, TAttribute]

ShiftLeft shifts value amount bits to the left

func (NotUpdatableNumericField[TModel, TAttribute]) ShiftRight added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) ShiftRight(amount NumericOfType[int]) NotUpdatableNumericField[TModel, TAttribute]

ShiftRight shifts value amount bits to the right

func (NotUpdatableNumericField[TModel, TAttribute]) SquareRoot added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) SquareRoot() NotUpdatableNumericField[TModel, TAttribute]

SquareRoot calculates the square root of the value

Warning: in sqlite DSQLITE_ENABLE_MATH_FUNCTIONS needs to be enabled or the error "no such function: SQRT" will be returned

func (NotUpdatableNumericField[TModel, TAttribute]) Times added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) Times(other ValueOfType[float64]) NotUpdatableNumericField[TModel, TAttribute]

Times multiplies value by other

func (NotUpdatableNumericField[TModel, TAttribute]) Xor added in v0.2.1 

func (numericField NotUpdatableNumericField[TModel, TAttribute]) Xor(other NumericOfType[TAttribute]) NotUpdatableNumericField[TModel, TAttribute]

Xor calculates the bitwise XOR (exclusive OR) between value and other

Available for: postgres, mysql, sqlserver

type NotUpdatableStringField added in v0.2.1 

type NotUpdatableStringField[TModel model.Model] struct {
	Field[TModel, string]
}

func (NotUpdatableStringField[TModel]) Concat added in v0.2.1 

func (stringField NotUpdatableStringField[TModel]) Concat(other ValueOfType[string]) NotUpdatableStringField[TModel]

Concat concatenates other to value

func (NotUpdatableStringField[TModel]) Is added in v0.2.1 

func (stringField NotUpdatableStringField[TModel]) Is() StringFieldIs[TModel]

type NullSink added in v0.8.0 

type NullSink struct{}

NullSink is a sql.Scanner that discards any value. Generated ScanValues uses it as a safe placeholder for columns the model doesn't know about (e.g. extra projections added by Order in Postgres), so the row can be drained cleanly without erroring.

func AcquireNullSink added in v0.8.0 

func AcquireNullSink() *NullSink

func (*NullSink) Scan added in v0.8.0 

func (*NullSink) Scan(_ any) error

type NullableBoolField added in v0.0.2 

type NullableBoolField[TModel model.Model] struct {
	BoolField[TModel]
}

func NewNullableBoolField added in v0.0.8 

func NewNullableBoolField[TModel model.Model](name, column, columnPrefix string, scanner ...*Scanner[TModel]) NullableBoolField[TModel]

func (NullableBoolField[TModel]) Appearance added in v0.2.1 

func (boolField NullableBoolField[TModel]) Appearance(number uint) NullableBoolField[TModel]

Appearance allows to choose which number of appearance use when field's model is joined more than once.

func (NullableBoolField[TModel]) Set added in v0.2.1 

func (boolField NullableBoolField[TModel]) Set() NullableFieldSet[TModel, bool]

type NullableField added in v0.0.2 

type NullableField[TModel model.Model, TAttribute any] struct {
	UpdatableField[TModel, TAttribute]
}

func NewNullableField added in v0.0.8 

func NewNullableField[TModel model.Model, TAttribute any](name, column, columnPrefix string, scanner ...*Scanner[TModel]) NullableField[TModel, TAttribute]

func (NullableField[TModel, TAttribute]) Appearance added in v0.1.2 

func (field NullableField[TModel, TAttribute]) Appearance(number uint) NullableField[TModel, TAttribute]

Appearance allows to choose which number of appearance use when field's model is joined more than once.

func (NullableField[TModel, TAttribute]) Set added in v0.0.2 

func (field NullableField[TModel, TAttribute]) Set() NullableFieldSet[TModel, TAttribute]

type NullableFieldSet added in v0.0.2 

type NullableFieldSet[TModel model.Model, TAttribute any] struct {
	FieldSet[TModel, TAttribute]
}

func (NullableFieldSet[TModel, TAttribute]) Null added in v0.0.2 

func (set NullableFieldSet[TModel, TAttribute]) Null() *Set[TModel]

type NullableNumericField added in v0.0.10 

type NullableNumericField[
	TModel model.Model,
	TAttribute Numeric,
] struct {
	NumericField[TModel, TAttribute]
}

func NewNullableNumericField added in v0.0.10 

func NewNullableNumericField[
	TModel model.Model,
	TAttribute Numeric,
](name, column, columnPrefix string, scanner ...*Scanner[TModel]) NullableNumericField[TModel, TAttribute]

func (NullableNumericField[TModel, TAttribute]) Appearance added in v0.1.2 

func (field NullableNumericField[TModel, TAttribute]) Appearance(number uint) NullableNumericField[TModel, TAttribute]

Appearance allows to choose which number of appearance use when field's model is joined more than once.

func (NullableNumericField[TModel, TAttribute]) Set added in v0.0.10 

func (field NullableNumericField[TModel, TAttribute]) Set() NullableNumericFieldSet[TModel, TAttribute]

type NullableNumericFieldSet added in v0.2.1 

type NullableNumericFieldSet[TModel model.Model, TAttribute Numeric] struct {
	NumericFieldSet[TModel, TAttribute]
}

func (NullableNumericFieldSet[TModel, TAttribute]) Null added in v0.2.1 

func (set NullableNumericFieldSet[TModel, TAttribute]) Null() *Set[TModel]

type NullableScanner added in v0.8.0 

type NullableScanner struct {
	Inner sql.Scanner
}

NullableScanner wraps any sql.Scanner so NULL values from the driver are silently skipped instead of forwarded to the inner Scan. Generated scanners use this for user-defined types that implement sql.Scanner but don't themselves accept nil (the common case — see models.MultiString as an example). gorm's reflective scan path applies the same filter before invoking field-level setters, so wrapping here keeps behavior identical.

func (*NullableScanner) Scan added in v0.8.0 

func (n *NullableScanner) Scan(src any) error

type NullableStringField added in v0.0.2 

type NullableStringField[TModel model.Model] struct {
	StringField[TModel]
}

func NewNullableStringField added in v0.0.8 

func NewNullableStringField[TModel model.Model](name, column, columnPrefix string, scanner ...*Scanner[TModel]) NullableStringField[TModel]

func (NullableStringField[TModel]) Appearance added in v0.1.2 

func (stringField NullableStringField[TModel]) Appearance(number uint) NullableStringField[TModel]

Appearance allows to choose which number of appearance use when field's model is joined more than once.

func (NullableStringField[TModel]) Set added in v0.2.1 

func (stringField NullableStringField[TModel]) Set() NullableFieldSet[TModel, string]

type Numeric added in v0.1.3 

type Numeric interface {
	constraints.Integer | constraints.Float
}

type NumericField added in v0.0.10 

type NumericField[TModel model.Model, TAttribute Numeric] struct {
	UpdatableField[TModel, TAttribute]
}

func NewNumericField added in v0.0.10 

func NewNumericField[
	TModel model.Model,
	TAttribute Numeric,
](name, column, columnPrefix string, scanner ...*Scanner[TModel]) NumericField[TModel, TAttribute]

func (NumericField[TModel, TAttribute]) Absolute added in v0.2.1 

func (numericField NumericField[TModel, TAttribute]) Absolute() NotUpdatableNumericField[TModel, TAttribute]

Absolute calculates the absolute value of the value

func (NumericField[TModel, TAttribute]) Aggregate added in v0.1.3 

func (numericField NumericField[TModel, TAttribute]) Aggregate() NumericFieldAggregation

Aggregate allows applying aggregation functions to the field inside a group by

func (NumericField[TModel, TAttribute]) And added in v0.2.1 

func (numericField NumericField[TModel, TAttribute]) And(other NumericOfType[TAttribute]) NotUpdatableNumericField[TModel, TAttribute]

And calculates the bitwise AND between value and other

func (NumericField[TModel, TAttribute]) Appearance added in v0.1.2 

func (numericField NumericField[TModel, TAttribute]) Appearance(number uint) NumericField[TModel, TAttribute]

Appearance allows to choose which number of appearance use when field's model is joined more than once.

func (NumericField[TModel, TAttribute]) Divided added in v0.2.1 

func (numericField NumericField[TModel, TAttribute]) Divided(other ValueOfType[float64]) NotUpdatableNumericField[TModel, TAttribute]

Divided divides value by other

func (NumericField[TModel, TAttribute]) GetNumericValue added in v0.3.2 

func (numericField NumericField[TModel, TAttribute]) GetNumericValue() TAttribute

func (NumericField[TModel, TAttribute]) GetValue added in v0.2.1 

func (numericField NumericField[TModel, TAttribute]) GetValue() float64

func (NumericField[TModel, TAttribute]) Is added in v0.2.0 

func (numericField NumericField[TModel, TAttribute]) Is() NumericFieldIs[TModel]

func (NumericField[TModel, TAttribute]) Minus added in v0.2.1 

func (numericField NumericField[TModel, TAttribute]) Minus(other ValueOfType[float64]) NotUpdatableNumericField[TModel, TAttribute]

Minus subtracts other from the value

func (NumericField[TModel, TAttribute]) Modulo added in v0.2.1 

func (numericField NumericField[TModel, TAttribute]) Modulo(other ValueOfType[float64]) NotUpdatableNumericField[TModel, TAttribute]

Modulo returns the remainder of the entire division

func (NumericField[TModel, TAttribute]) Not added in v0.2.1 

func (numericField NumericField[TModel, TAttribute]) Not() NotUpdatableNumericField[TModel, TAttribute]

Not calculates the bitwise NOT of value

func (NumericField[TModel, TAttribute]) Or added in v0.2.1 

func (numericField NumericField[TModel, TAttribute]) Or(other NumericOfType[TAttribute]) NotUpdatableNumericField[TModel, TAttribute]

Or calculates the bitwise OR between value and other

func (NumericField[TModel, TAttribute]) Plus added in v0.2.1 

func (numericField NumericField[TModel, TAttribute]) Plus(other ValueOfType[float64]) NotUpdatableNumericField[TModel, TAttribute]

Plus sums other to value

func (NumericField[TModel, TAttribute]) Power added in v0.2.1 

func (numericField NumericField[TModel, TAttribute]) Power(other ValueOfType[float64]) NotUpdatableNumericField[TModel, TAttribute]

Power elevates value to other

Warning: in sqlite DSQLITE_ENABLE_MATH_FUNCTIONS needs to be enabled or the error "no such function: POWER" will be returned

func (NumericField[TModel, TAttribute]) Set added in v0.0.10 

func (numericField NumericField[TModel, TAttribute]) Set() NumericFieldSet[TModel, TAttribute]

func (NumericField[TModel, TAttribute]) ShiftLeft added in v0.2.1 

func (numericField NumericField[TModel, TAttribute]) ShiftLeft(amount NumericOfType[int]) NotUpdatableNumericField[TModel, TAttribute]

ShiftLeft shifts value amount bits to the left

func (NumericField[TModel, TAttribute]) ShiftRight added in v0.2.1 

func (numericField NumericField[TModel, TAttribute]) ShiftRight(amount NumericOfType[int]) NotUpdatableNumericField[TModel, TAttribute]

ShiftRight shifts value amount bits to the right

func (NumericField[TModel, TAttribute]) SquareRoot added in v0.2.1 

func (numericField NumericField[TModel, TAttribute]) SquareRoot() NotUpdatableNumericField[TModel, TAttribute]

SquareRoot calculates the square root of the value

Warning: in sqlite DSQLITE_ENABLE_MATH_FUNCTIONS needs to be enabled or the error "no such function: SQRT" will be returned

func (NumericField[TModel, TAttribute]) Times added in v0.2.1 

func (numericField NumericField[TModel, TAttribute]) Times(other ValueOfType[float64]) NotUpdatableNumericField[TModel, TAttribute]

Times multiplies value by other

func (NumericField[TModel, TAttribute]) Xor added in v0.2.1 

func (numericField NumericField[TModel, TAttribute]) Xor(other NumericOfType[TAttribute]) NotUpdatableNumericField[TModel, TAttribute]

Xor calculates the bitwise XOR (exclusive OR) between value and other

Available for: postgres, mysql, sqlserver

type NumericFieldAggregation added in v0.1.3 

type NumericFieldAggregation struct {
	FieldAggregation[float64]
}

func (NumericFieldAggregation) And added in v0.1.3 

func (fieldAggregation NumericFieldAggregation) And() AggregationResult[float64]

And calculates the bitwise AND of all non-null values (null values are ignored)

Not available for: sqlite, sqlserver

func (NumericFieldAggregation) Average added in v0.1.3 

func (fieldAggregation NumericFieldAggregation) Average() AggregationResult[float64]

Average calculates the average (arithmetic mean) of all values

func (NumericFieldAggregation) Max added in v0.1.3 

func (fieldAggregation NumericFieldAggregation) Max() AggregationResult[float64]

Max returns the maximum value of all values

func (NumericFieldAggregation) Min added in v0.1.3 

func (fieldAggregation NumericFieldAggregation) Min() AggregationResult[float64]

Min returns the minimum value of all values

func (NumericFieldAggregation) Or added in v0.1.3 

func (fieldAggregation NumericFieldAggregation) Or() AggregationResult[float64]

Or calculates the bitwise OR of all non-null values (null values are ignored)

Not available for: sqlite, sqlserver

func (NumericFieldAggregation) Sum added in v0.1.3 

func (fieldAggregation NumericFieldAggregation) Sum() AggregationResult[float64]

Sum calculates the summation of all values

type NumericFieldIs added in v0.2.0 

type NumericFieldIs[TObject model.Model] struct {
	FieldIs[TObject, float64]
}

type NumericFieldSet added in v0.0.10 

type NumericFieldSet[TModel model.Model, TAttribute Numeric] struct {
	// contains filtered or unexported fields
}

func (NumericFieldSet[TModel, TAttribute]) Eq added in v0.0.10 

func (set NumericFieldSet[TModel, TAttribute]) Eq(value ValueOfType[float64]) *Set[TModel]

func (NumericFieldSet[TModel, TAttribute]) Unsafe added in v0.0.10 

func (set NumericFieldSet[TModel, TAttribute]) Unsafe(value IValue) *Set[TModel]

type NumericOfType added in v0.3.2 

type NumericOfType[T any] interface {
	IValue

	GetValue() float64

	GetNumericValue() T
}

type NumericValue added in v0.1.3 

type NumericValue[T Numeric] struct {
	Value T
}

func Float32 added in v0.2.0 

func Float32(value float32) NumericValue[float32]

func Float64 added in v0.2.0 

func Float64(value float64) NumericValue[float64]

func Int added in v0.2.0 

func Int(value int) NumericValue[int]

func Int8 added in v0.2.0 

func Int8(value int8) NumericValue[int8]

func Int16 added in v0.2.0 

func Int16(value int16) NumericValue[int16]

func Int32 added in v0.2.0 

func Int32(value int32) NumericValue[int32]

func Int64 added in v0.2.0 

func Int64(value int64) NumericValue[int64]

func UInt added in v0.2.0 

func UInt(value uint) NumericValue[uint]

func UInt8 added in v0.2.0 

func UInt8(value uint8) NumericValue[uint8]

func UInt16 added in v0.2.0 

func UInt16(value uint16) NumericValue[uint16]

func UInt32 added in v0.2.0 

func UInt32(value uint32) NumericValue[uint32]

func UInt64 added in v0.2.0 

func UInt64(value uint64) NumericValue[uint64]

func UIntPTR added in v0.2.0 

func UIntPTR(value uintptr) NumericValue[uintptr]

func (NumericValue[T]) GetNumericValue added in v0.3.2 

func (numericValue NumericValue[T]) GetNumericValue() T

func (NumericValue[T]) GetValue added in v0.2.0 

func (numericValue NumericValue[T]) GetValue() float64

func (NumericValue[T]) RawScalarValue added in v0.8.0 

func (numericValue NumericValue[T]) RawScalarValue() any

RawScalarValue — see Value[T].RawScalarValue.

func (NumericValue[T]) ToSQL added in v0.2.0 

func (numericValue NumericValue[T]) ToSQL(_ *CQLQuery) (string, []any, error)

type Operator 

type Operator[T any] interface {
	// Transform the Operator to a SQL string and a list of values to use in the query
	// columnName is used by the operator to determine which is the objective column.
	ToSQL(query *CQLQuery, columnName string) (string, []any, error)

	// This method is necessary to get the compiler to verify
	// that an object is of type Operator[T],
	// since if no method receives by parameter a type T,
	// any other Operator[T2] would also be considered a Operator[T].
	InterfaceVerificationMethod(t T)
}

func Between 

func Between[T any](v1, v2 IValue) Operator[T]

Equivalent to v1 < value < v2

func Eq 

func Eq[T any](value IValue) Operator[T]

EqualTo IsNotDistinct must be used in cases where value can be NULL

func Gt 

func Gt[T any](value IValue) Operator[T]

GreaterThan

func GtOrEq 

func GtOrEq[T any](value IValue) Operator[T]

GreaterThanOrEqualTo

func In 

func In[T any](values IValueList[T]) Operator[T]

func IsDistinct 

func IsDistinct[T any](value IValue) Operator[T]

func IsNotDistinct 

func IsNotDistinct[T any](value IValue) Operator[T]

func IsNotNull 

func IsNotNull[T any]() Operator[T]

func IsNull 

func IsNull[T any]() Operator[T]

func Lt 

func Lt[T any](value IValue) Operator[T]

LessThan

func LtOrEq 

func LtOrEq[T any](value IValue) Operator[T]

LessThanOrEqualTo

func NotBetween 

func NotBetween[T any](v1, v2 IValue) Operator[T]

Equivalent to NOT (v1 < value < v2)

func NotEq 

func NotEq[T any](value IValue) Operator[T]

NotEqualTo IsDistinct must be used in cases where value can be NULL

func NotIn 

func NotIn[T any](values IValueList[T]) Operator[T]

type OrderLimitReturning 

type OrderLimitReturning[T model.Model] struct {
	// contains filtered or unexported fields
}

func (*OrderLimitReturning[T]) Ascending 

func (olr *OrderLimitReturning[T]) Ascending(field IField)

Ascending specify an ascending order when updating models

available for: mysql

func (*OrderLimitReturning[T]) Descending 

func (olr *OrderLimitReturning[T]) Descending(field IField)

Descending specify a descending order when updating models

available for: mysql

func (*OrderLimitReturning[T]) Limit 

func (olr *OrderLimitReturning[T]) Limit(limit int)

Limit specify the number of models to be updated

Limit conditions can be cancelled by using `Limit(-1)`

available for: mysql

func (OrderLimitReturning[T]) Returning 

func (olr OrderLimitReturning[T]) Returning(dest *[]T)

available for: postgres, sqlite, sqlserver

warning: in sqlite preloads are not allowed

type PredicateOperator 

type PredicateOperator[T any] struct {
	SQLOperator string
}

Operator that verifies a predicate Example: value IS TRUE

func NewPredicateOperator 

func NewPredicateOperator[T any](sqlOperator string) PredicateOperator[T]

func (PredicateOperator[T]) InterfaceVerificationMethod 

func (operator PredicateOperator[T]) InterfaceVerificationMethod(_ T)

func (PredicateOperator[T]) ToSQL 

func (operator PredicateOperator[T]) ToSQL(_ *CQLQuery, columnName string) (string, []any, error)

type Query 

type Query[T model.Model] struct {
	// contains filtered or unexported fields
}

func NewQuery 

func NewQuery[T model.Model](tx *gorm.DB, conditions ...Condition[T]) *Query[T]

Create a Query to which the conditions are applied inside transaction tx

func (*Query[T]) Ascending 

func (query *Query[T]) Ascending(field IField) *Query[T]

Ascending specify an ascending order when retrieving models from database

func (*Query[T]) Count added in v0.0.6 

func (query *Query[T]) Count() (int64, error)

Count returns the amount of models that fulfill the conditions

func (*Query[T]) Descending 

func (query *Query[T]) Descending(field IField) *Query[T]

Descending specify a descending order when retrieving models from database

func (*Query[T]) Find 

func (query *Query[T]) Find() ([]*T, error)

Find finds all models matching given conditions

func (*Query[T]) FindOne 

func (query *Query[T]) FindOne() (*T, error)

FindOne finds the only one model that matches given conditions or returns error if 0 or more than 1 are found.

func (*Query[T]) First 

func (query *Query[T]) First() (*T, error)

First finds the first model ordered by primary key, matching given conditions or returns gorm.ErrRecordNotFound is if no model does it

func (*Query[T]) GroupBy added in v0.1.3 

func (query *Query[T]) GroupBy(fields ...IField) *QueryGroup

GroupBy arrange identical data into groups

func (*Query[T]) Last 

func (query *Query[T]) Last() (*T, error)

Last finds the last model ordered by primary key, matching given conditions or returns gorm.ErrRecordNotFound is if no model does it

func (*Query[T]) Limit 

func (query *Query[T]) Limit(limit int) *Query[T]

Limit specify the number of models to be retrieved

Limit conditions can be cancelled by using `Limit(-1)`

func (*Query[T]) Offset 

func (query *Query[T]) Offset(offset int) *Query[T]

Offset specify the number of models to skip before starting to return the results

Offset conditions can be cancelled by using `Offset(-1)`

Warning: in MySQL Offset can only be used if Limit is also used

func (*Query[T]) Take 

func (query *Query[T]) Take() (*T, error)

Take finds the first model returned by the database in no specified order, matching given conditions or returns gorm.ErrRecordNotFound is if no model does it

type QueryGroup added in v0.1.3 

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

func (*QueryGroup) Having added in v0.1.3 

func (query *QueryGroup) Having(conditions ...AggregationCondition) *QueryGroup

Having allows filter groups of rows based on conditions involving aggregate functions

type RelationScanner added in v0.8.0 

type RelationScanner[Parent, Child any] struct {
	// RelationField is the Go field name on Parent (e.g. "Brand"). Matches
	// what CQL's Table.DeliverTable uses as the first-level alias.
	RelationField string
	// ChildScanner provides ScanValues + AssignValues for Child's columns.
	// Same instance the user gets via Query[Child].
	ChildScanner *Scanner[Child]
	// Mount sets the (non-nil) child onto parent. Pointer-relation
	// generators set `p.X = c`; value-relation generators set `p.X = *c`.
	Mount func(parent *Parent, child *Child)
	// SetNil resets the relation field on parent. For pointer relations
	// this sets to nil; for value relations it is a no-op because the
	// LEFT-JOIN-no-match case leaves the field at its zero value (probed
	// against gorm in TestProbe_ValueRelationNoMatch).
	SetNil func(parent *Parent)
}

RelationScanner is a code-generated mounter for a single relation between Parent and Child. It reuses the existing per-model Scanner[Child] for column materialization and adds typed hooks for mounting (or nilling) the child onto the parent.

Generated code wires one RelationScanner per relation onto its matching generated JoinCondition. When the user calls .Preload() on that condition at runtime, the JoinCondition registers the scanner against its runtime-computed alias (e.g. "Seller", "Seller__Company") so findWith dispatches joined columns through it.

type Scanner added in v0.8.0 

type Scanner[T any] struct {
	ScanValues   func(columns []string) ([]any, error)
	AssignValues func(dest *T, columns []string, values []any) error
	// ReleaseValues returns each scanned cell to its sync.Pool. Optional;
	// when nil the runtime just drops the values for GC. Generated code
	// emits this alongside ScanValues so cells acquired from the per-type
	// pools (see scanner_pool.go) are returned after AssignValues has
	// copied the data into dest. Mirrors gorm's per-Field NewValuePool
	// usage in scan.go.
	ReleaseValues func(columns []string, values []any)
}

Scanner is a code-generated row materializer for model type T. It avoids per-row reflection: ScanValues returns a []any of concrete pointer types matching the result columns (so database/sql.Rows.Scan does its native driver conversion), and AssignValues consumes that same slice with cheap type assertions and direct struct-field stores.

Generated code (from cql-gen) creates one Scanner[T] per model and shares a pointer to it from every Field on that model's conditions struct. Query[T] picks it up from any condition built off those fields and dispatches the fast Find/First/Take/Last paths through it.

type Selection added in v0.3.0 

type Selection[T any] interface {
	Apply(value any, result *T) error
	ValueType() any
	ToSQL(query *CQLQuery) (string, []any, error)
}

type Set 

type Set[T model.Model] struct {
	// contains filtered or unexported fields
}

type StringField 

type StringField[TModel model.Model] struct {
	UpdatableField[TModel, string]
}

func NewStringField added in v0.0.8 

func NewStringField[TModel model.Model](name, column, columnPrefix string, scanner ...*Scanner[TModel]) StringField[TModel]

func (StringField[TModel]) Appearance added in v0.1.2 

func (stringField StringField[TModel]) Appearance(number uint) StringField[TModel]

Appearance allows to choose which number of appearance use when field's model is joined more than once.

func (StringField[TModel]) Concat added in v0.2.1 

func (stringField StringField[TModel]) Concat(other ValueOfType[string]) NotUpdatableStringField[TModel]

Concat concatenates other to value

func (StringField[TModel]) Is 

func (stringField StringField[TModel]) Is() StringFieldIs[TModel]

type StringFieldIs 

type StringFieldIs[TObject model.Model] struct {
	FieldIs[TObject, string]
}

func (StringFieldIs[TObject]) Like 

func (is StringFieldIs[TObject]) Like(pattern string) WhereCondition[TObject]

Pattern in all databases:

  • An underscore (_) in pattern stands for (matches) any single character.
  • A percent sign (%) matches any sequence of zero or more characters.

Additionally in SQLServer:

  • Square brackets ([ ]) matches any single character within the specified range ([a-f]) or set ([abcdef]).
  • [^] matches any single character not within the specified range ([^a-f]) or set ([^abcdef]).

WARNINGS:

  • SQLite: LIKE is case-insensitive unless case_sensitive_like pragma (https://www.sqlite.org/pragma.html#pragma_case_sensitive_like) is true.
  • SQLServer, MySQL: the case-sensitivity depends on the collation used in compared column.
  • PostgreSQL: LIKE is always case-sensitive, if you want case-insensitive use the ILIKE operator (implemented in psql.ILike)

refs:

type Table 

type Table struct {
	Name    string
	Alias   string
	Initial bool
	// Schema is the parsed gorm schema for this table's model, pinned so
	// column-name lookups skip the per-query NamingStrategy allocations.
	// Populated by NewTable / DeliverTable via getTableSchema (cache-shared).
	Schema *schema.Schema
}

func NewTable 

func NewTable(db *gorm.DB, model model.Model) (Table, error)

func (Table) DeliverTable 

func (t Table) DeliverTable(query *CQLQuery, model model.Model, relationName string) (Table, error)

Returns the related Table corresponding to the model

func (Table) IsInitial 

func (t Table) IsInitial() bool

Returns true if the Table is the initial table in a query

func (Table) SQLName 

func (t Table) SQLName() string

SQLName returns the name that must be used in a sql query to use this table: the alias if not empty or the table name

type UnsafeCondition added in v0.0.5 

type UnsafeCondition[T model.Model] struct {
	SQLCondition string
	Values       []any
}

Condition that can be used to express conditions that are not supported (yet?) by cql Example: table1.columnX = table2.columnY

type UnsafeFieldIs 

type UnsafeFieldIs[TObject model.Model, TAttribute any] struct {
	// contains filtered or unexported fields
}

func (UnsafeFieldIs[TObject, TAttribute]) Between 

func (is UnsafeFieldIs[TObject, TAttribute]) Between(v1, v2 IValue) WhereCondition[TObject]

Equivalent to field1 < value < field2

func (UnsafeFieldIs[TObject, TAttribute]) Distinct 

func (is UnsafeFieldIs[TObject, TAttribute]) Distinct(value IValue) WhereCondition[TObject]

func (UnsafeFieldIs[TObject, TAttribute]) Eq 

func (is UnsafeFieldIs[TObject, TAttribute]) Eq(value IValue) WhereCondition[TObject]

EqualTo

func (UnsafeFieldIs[TObject, TAttribute]) Gt 

func (is UnsafeFieldIs[TObject, TAttribute]) Gt(value IValue) WhereCondition[TObject]

GreaterThan

func (UnsafeFieldIs[TObject, TAttribute]) GtOrEq 

func (is UnsafeFieldIs[TObject, TAttribute]) GtOrEq(value IValue) WhereCondition[TObject]

GreaterThanOrEqualTo

func (UnsafeFieldIs[TObject, TAttribute]) Lt 

func (is UnsafeFieldIs[TObject, TAttribute]) Lt(value IValue) WhereCondition[TObject]

LessThan

func (UnsafeFieldIs[TObject, TAttribute]) LtOrEq 

func (is UnsafeFieldIs[TObject, TAttribute]) LtOrEq(value IValue) WhereCondition[TObject]

LessThanOrEqualTo

func (UnsafeFieldIs[TObject, TAttribute]) NotBetween 

func (is UnsafeFieldIs[TObject, TAttribute]) NotBetween(v1, v2 IValue) WhereCondition[TObject]

Equivalent to NOT (field1 < value < field2)

func (UnsafeFieldIs[TObject, TAttribute]) NotDistinct 

func (is UnsafeFieldIs[TObject, TAttribute]) NotDistinct(value IValue) WhereCondition[TObject]

func (UnsafeFieldIs[TObject, TAttribute]) NotEq 

func (is UnsafeFieldIs[TObject, TAttribute]) NotEq(value IValue) WhereCondition[TObject]

NotEqualTo

type UpdatableField added in v0.0.2 

type UpdatableField[TModel model.Model, TAttribute any] struct {
	Field[TModel, TAttribute]
}

func NewUpdatableField added in v0.0.8 

func NewUpdatableField[TModel model.Model, TAttribute any](name, column, columnPrefix string, scanner ...*Scanner[TModel]) UpdatableField[TModel, TAttribute]

func (UpdatableField[TModel, TAttribute]) Appearance added in v0.1.2 

func (field UpdatableField[TModel, TAttribute]) Appearance(number uint) UpdatableField[TModel, TAttribute]

Appearance allows to choose which number of appearance use when field's model is joined more than once.

func (UpdatableField[TModel, TAttribute]) Set added in v0.0.2 

func (field UpdatableField[TModel, TAttribute]) Set() FieldSet[TModel, TAttribute]

type Update 

type Update[T model.Model] struct {
	OrderLimitReturning[T]
}

func NewUpdate 

func NewUpdate[T model.Model](tx *gorm.DB, conditions []Condition[T]) *Update[T]

Create a Update to which the conditions are applied inside transaction tx

func (*Update[T]) Ascending 

func (update *Update[T]) Ascending(field IField) *Update[T]

Ascending specify an ascending order when updating models

available for: mysql

func (*Update[T]) Descending 

func (update *Update[T]) Descending(field IField) *Update[T]

Descending specify a descending order when updating models

available for: mysql

func (*Update[T]) Limit 

func (update *Update[T]) Limit(limit int) *Update[T]

Limit specify the number of models to be updated

Limit conditions can be cancelled by using `Limit(-1)`

available for: mysql

func (*Update[T]) Returning 

func (update *Update[T]) Returning(dest *[]T) *Update[T]

available for: postgres, sqlite, sqlserver

warning: in sqlite preloads are not allowed

func (*Update[T]) Set 

func (update *Update[T]) Set(sets ...*Set[T]) (int64, error)

Set allows updating multiple attributes of the same table.

func (*Update[T]) SetMultiple 

func (update *Update[T]) SetMultiple(sets ...ISet) (int64, error)

SetMultiple allows updating multiple tables in the same query.

available for: mysql

type Value added in v0.1.3 

type Value[T any] struct {
	Value T
}

func ByteArray added in v0.2.0 

func ByteArray(value []byte) Value[[]byte]

func String added in v0.2.0 

func String(value string) Value[string]

func Time added in v0.2.0 

func Time(value time.Time) Value[time.Time]

func UIntID added in v0.8.0 

func UIntID(value model.UIntID) Value[model.UIntID]

func UUID added in v0.2.0 

func UUID(value model.UUID) Value[model.UUID]

func (Value[T]) GetValue added in v0.2.0 

func (value Value[T]) GetValue() T

func (Value[T]) RawScalarValue added in v0.8.0 

func (value Value[T]) RawScalarValue() any

RawScalarValue exposes the underlying Go value for callers (e.g. getUpdateValue) that only need the scalar and want to avoid ToSQL's per-call []any{v} slice allocation.

func (Value[T]) ToSQL added in v0.2.0 

func (value Value[T]) ToSQL(_ *CQLQuery) (string, []any, error)

type ValueOfType added in v0.0.10 

type ValueOfType[T any] interface {
	IValue

	GetValue() T
}

type ValueOperator 

type ValueOperator[T any] struct {
	Operations []operation
	Modifier   map[sql.Dialector]string
}

Operator that compares the value of the column against a fixed value If Operations has multiple entries, operations will be nested Example (single): value = v1 Example (multi): value LIKE v1 ESCAPE v2

func NewValueOperator 

func NewValueOperator[T any](sqlOperator sql.Operator, value IValue) *ValueOperator[T]

func (*ValueOperator[T]) AddOperation 

func (operator *ValueOperator[T]) AddOperation(sqlOperator any, value IValue) *ValueOperator[T]

func (ValueOperator[T]) InterfaceVerificationMethod 

func (operator ValueOperator[T]) InterfaceVerificationMethod(_ T)

func (ValueOperator[T]) ToSQL 

func (operator ValueOperator[T]) ToSQL(query *CQLQuery, columnName string) (string, []any, error)

type WhereCondition 

type WhereCondition[T model.Model] interface {
	Condition[T]
	// contains filtered or unexported methods
}

Conditions that can be used in a where clause (or in a on of a join)

func And 

func And[T model.Model](conditions ...WhereCondition[T]) WhereCondition[T]

func NewConnectionCondition 

func NewConnectionCondition[T model.Model](connector sql.Operator, conditions []WhereCondition[T]) WhereCondition[T]

Condition that connects multiple conditions. Example: condition1 AND condition2

func NewContainerCondition 

func NewContainerCondition[T model.Model](prefix sql.Operator, conditions []WhereCondition[T]) WhereCondition[T]

Condition that contains a internal condition. Example: NOT (internal condition)

func NewFieldCondition 

func NewFieldCondition[TObject model.Model, TAttribute any](
	fieldIdentifier IField,
	operator Operator[TAttribute],
) WhereCondition[TObject]

func Not added in v0.0.6 

func Not[T model.Model](conditions ...WhereCondition[T]) WhereCondition[T]

func Or added in v0.0.14 

func Or[T model.Model](conditions ...WhereCondition[T]) WhereCondition[T]

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.