gormx

Apr 21, 2026

Changes in this version

+ type ParamsContext interface

+ BindQuery func(obj interface{}) error

+ Param func() ParamsGetter

+ Queries func() ParamsQueries

+ Query func() ParamsGetter

+ type ParamsGetter interface

+ Get func(key string) ParamsValue

+ type ParamsQueries interface

+ Del func(key string)

+ Iterator func() map[string]any

+ type ParamsValue interface

+ Int64 func() int64

+ String func() string

Nov 11, 2025

Changes in this version

+ type RangeMode string

+ const RangeModeClosed

+ const RangeModeLeftClosed

+ const RangeModeOpen

+ const RangeModeRightClosed

type SetWhereOptions

+ IsGreaterOrEqualThan bool

+ IsGreaterThan bool

+ IsLessOrEqualThan bool

+ IsLessThan bool

+ IsRange bool

+ RangeMode RangeMode

type WhereOne

+ IsGreaterOrEqualThan bool

+ IsGreaterThan bool

+ IsLessOrEqualThan bool

+ IsLessThan bool

+ IsRange bool

Oct 23, 2025

Changes in this version

+ func Aggregate[T any](field string, where *Where, operations []string) (map[string]interface{}, error)

+ func Avg[T any](field string, where *Where) (float64, error)

+ func CountDistinct[T any](field string, where *Where) (int64, error)

+ func GetFieldType[T any](field string) (reflect.Type, error)

+ func Max[T any](field string, where *Where) (interface{}, error)

+ func Min[T any](field string, where *Where) (interface{}, error)

+ func Sum[T any](field string, where *Where) (float64, error)

+ type AggregateResult struct

+ Error error

+ Value interface{}

+ type GroupByResult struct

+ Avg float64

+ Count int64

+ Group map[string]interface{}

+ Max interface{}

+ Min interface{}

+ Sum float64

+ func GroupBy[T any](fields []string, where *Where, aggregates []string) ([]GroupByResult, error)

+ type JoinClause struct

+ Args []interface{}

+ Condition string

+ Table string

+ Type string

type OrderBy

+ func NewOrderBy() *OrderBy

+ type QueryBuilder struct

+ func NewQuery[T any]() *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Avg(field string) (float64, error)

+ func (q *QueryBuilder[T]) Chunk(chunkSize int, callback func([]*T) error) error

+ func (q *QueryBuilder[T]) Clone() *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Count() (int64, error)

+ func (q *QueryBuilder[T]) Create(value *T) error

+ func (q *QueryBuilder[T]) CreateInBatches(values []*T, batchSize int) error

+ func (q *QueryBuilder[T]) Delete() error

+ func (q *QueryBuilder[T]) Distinct() *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Exists() (bool, error)

+ func (q *QueryBuilder[T]) Find() ([]*T, error)

+ func (q *QueryBuilder[T]) FindInBatches(batchSize int, fn func(tx *gorm.DB, batch int) error) error

+ func (q *QueryBuilder[T]) First() (*T, error)

+ func (q *QueryBuilder[T]) GetDB() *gorm.DB

+ func (q *QueryBuilder[T]) GetTableName() string

+ func (q *QueryBuilder[T]) GroupBy(fields ...string) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Having(field string, value interface{}, opts ...*SetWhereOptions) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Join(table, condition string, args ...interface{}) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Last() (*T, error)

+ func (q *QueryBuilder[T]) LeftJoin(table, condition string, args ...interface{}) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Limit(limit int) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Max(field string) (interface{}, error)

+ func (q *QueryBuilder[T]) Min(field string) (interface{}, error)

+ func (q *QueryBuilder[T]) Offset(offset int) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) OrderBy(field string, desc ...bool) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) OrderByAsc(field string) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) OrderByDesc(field string) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Page(page, pageSize int) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Paginate(page, pageSize int) ([]*T, int64, error)

+ func (q *QueryBuilder[T]) Pluck(column string, dest interface{}) error

+ func (q *QueryBuilder[T]) Preload(associations ...string) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Raw(sql string, values ...interface{}) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) RightJoin(table, condition string, args ...interface{}) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Save(value *T) error

+ func (q *QueryBuilder[T]) Scan(dest interface{}) error

+ func (q *QueryBuilder[T]) Select(columns ...string) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) Sum(field string) (float64, error)

+ func (q *QueryBuilder[T]) ToSQL() (string, error)

+ func (q *QueryBuilder[T]) Transaction(fn func(tx *QueryBuilder[T]) error) error

+ func (q *QueryBuilder[T]) Update(updates map[string]interface{}) error

+ func (q *QueryBuilder[T]) UpdateColumn(updates map[string]interface{}) error

+ func (q *QueryBuilder[T]) Where(field string, value interface{}, opts ...*SetWhereOptions) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) WhereBetween(field string, start, end interface{}) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) WhereEqual(field string, value interface{}) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) WhereIn(field string, values interface{}) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) WhereLike(field string, value string) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) WhereNotEqual(field string, value interface{}) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) WhereNotIn(field string, values interface{}) *QueryBuilder[T]

+ func (q *QueryBuilder[T]) WhereRaw(sql string, args ...interface{}) *QueryBuilder[T]

type Where

+ func NewWhere() *Where

+ func ToWhere[T WhereCondition](condition T) *Where

+ type WhereCondition interface

Feb 26, 2025

Changes in this version

type OrderBy

+ func (w *OrderBy) Add(key string, IsDESC bool)

+ func (w *OrderBy) AddClause(clause string)

+ func (w *OrderBy) GetClause(key string) string

type OrderByOne

+ func (w *OrderByOne) Clause() string

+ func (w *OrderByOne) String() string

Dec 8, 2024

Changes in this version

+ type Date = datatypes.Date

+ type JSON = datatypes.JSON

+ type JSONArray datatypes.JSONSlice[T]

+ type JSONObject = datatypes.JSONMap

+ type UUID = datatypes.UUID

Apr 19, 2024

Changes in this version

+ func SetDB(d *gorm.DB)

Mar 12, 2024

Changes in this version

type Where

+ func (w *Where) Add(key string, value interface{}, opts ...*SetWhereOptions)

Mar 11, 2024

Changes in this version

+ func Connect(engine string, dsn string, opts ...func(*LoadDBOptions)) (db *gorm.DB, err error)

Jan 25, 2024

Changes in this version

+ func FindOneWithComplexConditions[T any](where *Where, orderBy *OrderBy) (*T, error)

Jan 8, 2024

Changes in this version

+ func Get[T any](id string) T

+ func Migrate()

Nov 22, 2023

Changes in this version

+ func GetDSN() string

+ func GetEngine() string

type LoadDBOptions

+ DryRun bool

+ TablePrefix string

Nov 1, 2023

Changes in this version

+ func SQL(sql string, values ...any) (*T, error)

Oct 18, 2023

Changes in this version

type OrderBy

+ func (w *OrderBy) Reset()

type Where

+ func (w *Where) Reset()

Sep 20, 2023

Changes in this version

type SetWhereOptions

+ IsEqual bool

+ IsNotEqual bool

+ IsNotIn bool

+ IsPlain bool

type WhereOne

+ IsEqual bool

+ IsIn bool

+ IsNotEqual bool

+ IsNotIn bool

+ IsPlain bool

Sep 5, 2023

Changes in this version

type Where

+ FullTextSearchFields []string

+ Items []WhereOne

Sep 5, 2023

Changes in this version

type SetWhereOptions

+ FullTextSearchFields []string

+ IsFullTextSearch bool

type WhereOne

+ FullTextSearchFields []string

+ IsFullTextSearch bool

Aug 25, 2023

Changes in this version

+ func ListALL(where *Where, orderBy *OrderBy) (data []*T, err error)

Aug 23, 2023

Changes in this version

+ func Count(where *Where) (count int64, err error)

+ func CountALL() (total int64, err error)

Aug 22, 2023

Changes in this version

+ type ModelGeneric struct

+ func (m *ModelGeneric[T]) Create(one *T) (*T, error)

+ func (m *ModelGeneric[T]) Delete(id uint) (err error)

+ func (m *ModelGeneric[T]) Exists(where map[any]any) (bool, error)

+ func (m *ModelGeneric[T]) FindAll(where *Where, orderBy *OrderBy) ([]*T, error)

+ func (m *ModelGeneric[T]) FindByID(id uint) (*T, error)

+ func (m *ModelGeneric[T]) FindOne(where map[any]any) (*T, error)

+ func (m *ModelGeneric[T]) FindOneAndDelete(where map[any]any) (*T, error)

+ func (m *ModelGeneric[T]) FindOneAndUpdate(where map[any]any, callback func(*T)) (*T, error)

+ func (m *ModelGeneric[T]) FindOneOrCreate(where map[any]any, callback func(*T)) (*T, error)

+ func (m *ModelGeneric[T]) GetMany(ids []uint) (data []*T, err error)

+ func (m *ModelGeneric[T]) List(page, pageSize uint, where *Where, orderBy *OrderBy) (data []*T, total int64, err error)

+ func (m *ModelGeneric[T]) Retrieve(id uint) (*T, error)

+ func (m *ModelGeneric[T]) Save() error

+ func (m *ModelGeneric[T]) Update(id uint, uc func(*T)) (err error)

Aug 21, 2023

Changes in this version

+ var ErrDryRunModeUnsupported = gorm.ErrDryRunModeUnsupported

+ var ErrDuplicatedKey = gorm.ErrDuplicatedKey

+ var ErrEmptySlice = gorm.ErrEmptySlice

+ var ErrForeignKeyViolated = gorm.ErrForeignKeyViolated

+ var ErrInvalidDB = gorm.ErrInvalidDB

+ var ErrInvalidData = gorm.ErrInvalidData

+ var ErrInvalidField = gorm.ErrInvalidField

+ var ErrInvalidTransaction = gorm.ErrInvalidTransaction

+ var ErrInvalidValue = gorm.ErrInvalidValue

+ var ErrInvalidValueOfLength = gorm.ErrInvalidValueOfLength

+ var ErrMissingWhereClause = gorm.ErrMissingWhereClause

+ var ErrModelAccessibleFieldsRequired = gorm.ErrModelAccessibleFieldsRequired

+ var ErrModelValueRequired = gorm.ErrModelValueRequired

+ var ErrNotImplemented = gorm.ErrNotImplemented

+ var ErrPreloadNotAllowed = gorm.ErrPreloadNotAllowed

+ var ErrPrimaryKeyRequired = gorm.ErrPrimaryKeyRequired

+ var ErrRecordNotFound = gorm.ErrRecordNotFound

+ var ErrRegistered = gorm.ErrRegistered

+ var ErrSubQueryRequired = gorm.ErrSubQueryRequired

+ var ErrUnsupportedDriver = gorm.ErrUnsupportedDriver

+ var ErrUnsupportedRelation = gorm.ErrUnsupportedRelation

+ func IsDryRunModeUnsupportedError(err error) bool

+ func IsDuplicatedKeyError(err error) bool

+ func IsEmptySliceError(err error) bool

+ func IsForeignKeyViolatedError(err error) bool

+ func IsInvalidDBError(err error) bool

+ func IsInvalidDataError(err error) bool

+ func IsInvalidFieldError(err error) bool

+ func IsInvalidTransactionError(err error) bool

+ func IsInvalidValueError(err error) bool

+ func IsInvalidValueOfLengthError(err error) bool

+ func IsMissingWhereClauseError(err error) bool

+ func IsModelAccessibleFieldsRequiredError(err error) bool

+ func IsModelValueRequiredError(err error) bool

+ func IsNotImplementedError(err error) bool

+ func IsPreloadNotAllowedError(err error) bool

+ func IsPrimaryKeyRequiredError(err error) bool

+ func IsRecordNotFoundError(err error) bool

+ func IsRegisteredError(err error) bool

+ func IsSubQueryRequiredError(err error) bool

+ func IsUnsupportedDriverError(err error) bool

+ func IsUnsupportedRelationError(err error) bool

Aug 3, 2023

Changes in this version

type OrderBy

+ func (w *OrderBy) Del(key string)

type Where

+ func (w *Where) Del(key string)

Jul 24, 2023

Changes in this version

type Controller

+ Params func(ctx *zoox.Context) *Params

type ControllerImpl

+ func (c *ControllerImpl) Params(ctx *zoox.Context) *Params

+ type ListParams struct

+ OrderBy *OrderBy

+ Page uint

+ PageSize uint

+ Where *Where

+ type ListParamsDefault struct

+ Page uint

+ PageSize uint

+ type Params struct

+ func NewParams(ctx *zoox.Context) *Params

+ func (c *Params) GetList(defaults ...*ListParamsDefault) (*ListParams, error)

+ func (c *Params) ID() (uint, error)

+ func (c *Params) OrderBy() *OrderBy

+ func (c *Params) Page() (uint, error)

+ func (c *Params) PageSize() (uint, error)

+ func (c *Params) Where() *Where

Jul 24, 2023

Changes in this version

+ func Register(namespace string, model Model, service Service, controller Controller)

Jul 24, 2023

Changes in this version

+ func GetController(id string) T

+ func GetModel(id string) T

+ func GetService(id string) T

+ func RegisterController(name string, m Controller)

+ func RegisterModel(name string, m Model)

+ func RegisterService(name string, m Service)

+ type Controller interface

+ Name func() string

+ Service func() container.Container

+ type ControllerImpl struct

+ func (c *ControllerImpl) Service() container.Container

+ type Model interface

+ Model func() container.Container

+ ModelName func() string

+ type ModelImpl struct

+ CreatedAt time.Time

+ Creator uint

+ DeletedAt gorm.DeletedAt

+ ID uint

+ Modifier uint

+ UpdatedAt time.Time

+ func (m *ModelImpl) Model() container.Container

+ func (m *ModelImpl) ModelName() string

+ type Service interface

+ Model func() container.Container

+ Name func() string

+ Service func() container.Container

+ type ServiceImpl struct

+ func (s *ServiceImpl) Model() container.Container

+ func (s *ServiceImpl) Name() string

+ func (s *ServiceImpl) Service() container.Container

Jul 23, 2023

Changes in this version

+ type LoadDBOptions struct

+ IsProd bool

Jul 22, 2023

Changes in this version

+ var Version = "1.0.0"

+ func Create(one *T) (*T, error)

+ func Delete(where map[any]any) (err error)

+ func DeleteOneByID(id uint) (err error)

+ func Exists(where map[any]any) (bool, error)

+ func Find(page, pageSize uint, where *Where, orderBy *OrderBy) (data []*T, total int64, err error)

+ func FindAll(where *Where, orderBy *OrderBy) (data []*T, err error)

+ func FindByID(id uint) (*T, error)

+ func FindOne(where map[any]any) (*T, error)

+ func FindOneAndDelete(where map[any]any) (*T, error)

+ func FindOneAndUpdate(where map[any]any, callback func(*T)) (*T, error)

+ func FindOneByIDAndDelete(id uint) (*T, error)

+ func FindOneByIDAndUpdate(id uint, callback func(*T)) (*T, error)

+ func FindOneByIDOrCreate(id uint, callback func(*T)) (*T, error)

+ func FindOneOrCreate(where map[any]any, callback func(*T)) (*T, error)

+ func GetDB() *gorm.DB

+ func GetMany(ids []uint) (data []*T, err error)

+ func GetOrCreate(where map[any]any, callback func(*T)) (*T, error)

+ func Has(where map[string]any) bool

+ func List(page, pageSize uint, where *Where, orderBy *OrderBy) (data []*T, total int64, err error)

+ func ListAll(where *Where, orderBy *OrderBy) (data []*T, err error)

+ func LoadDB(engine string, dsn string) (err error)

+ func Retrieve(id uint) (*T, error)

+ func Save(one *T) error

+ func Update(id uint, uc func(*T)) (err error)

+ type OrderBy []OrderByOne

+ func (w *OrderBy) Build() string

+ func (w *OrderBy) Debug()

+ func (w *OrderBy) Get(key string) (bool, bool)

+ func (w *OrderBy) Length() int

+ func (w *OrderBy) Set(key string, IsDESC bool)

+ type OrderByOne struct

+ IsDESC bool

+ Key string

+ type Page struct

+ Page int64

+ PageSize int64

+ type SetWhereOptions struct

+ IsFuzzy bool

+ IsIn bool

+ IsNot bool

+ type Where []WhereOne

+ func (w *Where) Build() (string, []interface{})

+ func (w *Where) Debug()

+ func (w *Where) Get(key string) (interface{}, bool)

+ func (w *Where) Length() int

+ func (w *Where) Set(key string, value interface{}, opts ...*SetWhereOptions)

+ type WhereOne struct

+ IsFuzzy bool

+ Key string

+ Value interface{}