gorm

package
v1.16.0 Latest Latest
Warning

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

Go to latest
Published: Jul 20, 2025 License: MIT Imports: 24 Imported by: 10

Documentation

Index

Constants

View Source
const Associations = clause.Associations

Variables

This section is empty.

Functions

This section is empty.

Types

type Conditions added in v1.13.5

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

type Event added in v1.11.0

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

func NewEvent added in v1.11.0

func NewEvent(query *Query, model, dest any) *Event

func (*Event) Context added in v1.11.0

func (e *Event) Context() context.Context

func (*Event) GetAttribute added in v1.11.0

func (e *Event) GetAttribute(key string) any

func (*Event) GetOriginal added in v1.11.0

func (e *Event) GetOriginal(key string, def ...any) any

func (*Event) IsClean added in v1.11.0

func (e *Event) IsClean(fields ...string) bool

func (*Event) IsDirty added in v1.11.0

func (e *Event) IsDirty(columns ...string) bool

func (*Event) Query added in v1.11.0

func (e *Event) Query() orm.Query

func (*Event) SetAttribute added in v1.11.0

func (e *Event) SetAttribute(key string, value any)

type Query

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

func BuildQuery added in v1.15.0

func BuildQuery(ctx context.Context, config config.Config, connection string, log log.Log, modelToObserver []contractsorm.ModelToObserver) (*Query, contractsdatabase.Config, error)

func NewQuery

func NewQuery(
	ctx context.Context,
	config config.Config,
	dbConfig contractsdatabase.Config,
	db *gormio.DB,
	grammar driver.Grammar,
	log log.Log,
	modelToObserver []contractsorm.ModelToObserver,
	conditions *Conditions,
) *Query

func (*Query) Association

func (r *Query) Association(association string) contractsorm.Association

func (*Query) Begin added in v1.10.0

func (r *Query) Begin() (contractsorm.Query, error)

DEPRECATED Use BeginTransaction instead.

func (*Query) BeginTransaction added in v1.15.12

func (r *Query) BeginTransaction() (contractsorm.Query, error)

func (*Query) Commit added in v1.15.0

func (r *Query) Commit() error

func (*Query) Count

func (r *Query) Count() (int64, error)

func (*Query) Create

func (r *Query) Create(value any) error

func (*Query) Cursor added in v1.15.0

func (r *Query) Cursor() chan contractsdb.Row

func (*Query) DB added in v1.15.0

func (r *Query) DB() (*sql.DB, error)

func (*Query) Delete

func (r *Query) Delete(dests ...any) (*contractsdb.Result, error)

func (*Query) Distinct

func (r *Query) Distinct(columns ...string) contractsorm.Query

func (*Query) Driver

func (r *Query) Driver() string

func (*Query) Exec

func (r *Query) Exec(sql string, values ...any) (*contractsdb.Result, error)

func (*Query) Exists added in v1.15.0

func (r *Query) Exists() (bool, error)

func (*Query) Find

func (r *Query) Find(dest any, conds ...any) error

func (*Query) FindOrFail added in v1.11.0

func (r *Query) FindOrFail(dest any, conds ...any) error

func (*Query) First

func (r *Query) First(dest any) error

func (*Query) FirstOr added in v1.10.0

func (r *Query) FirstOr(dest any, callback func() error) error

func (*Query) FirstOrCreate

func (r *Query) FirstOrCreate(dest any, conds ...any) error

func (*Query) FirstOrFail added in v1.10.0

func (r *Query) FirstOrFail(dest any) error

func (*Query) FirstOrNew added in v1.10.0

func (r *Query) FirstOrNew(dest any, attributes any, values ...any) error

func (*Query) ForceDelete

func (r *Query) ForceDelete(dests ...any) (*contractsdb.Result, error)

func (*Query) Get

func (r *Query) Get(dest any) error

func (*Query) Group

func (r *Query) Group(column string) contractsorm.Query

DEPRECATED Use GroupBy instead.

func (*Query) GroupBy added in v1.15.12

func (r *Query) GroupBy(column ...string) contractsorm.Query

func (*Query) Having

func (r *Query) Having(query any, args ...any) contractsorm.Query

func (*Query) InRandomOrder added in v1.15.0

func (r *Query) InRandomOrder() contractsorm.Query

func (*Query) InTransaction added in v1.15.0

func (r *Query) InTransaction() bool

func (*Query) Instance added in v1.10.0

func (r *Query) Instance() *gormio.DB

func (*Query) Join

func (r *Query) Join(query string, args ...any) contractsorm.Query

func (*Query) Limit

func (r *Query) Limit(limit int) contractsorm.Query

func (*Query) Load

func (r *Query) Load(model any, relation string, args ...any) error

func (*Query) LoadMissing

func (r *Query) LoadMissing(model any, relation string, args ...any) error

func (*Query) LockForUpdate added in v1.11.0

func (r *Query) LockForUpdate() contractsorm.Query

func (*Query) Model

func (r *Query) Model(value any) contractsorm.Query

func (*Query) Observe added in v1.15.0

func (r *Query) Observe(model any, observer contractsorm.Observer)

func (*Query) Offset

func (r *Query) Offset(offset int) contractsorm.Query

func (*Query) Omit

func (r *Query) Omit(columns ...string) contractsorm.Query

func (*Query) OrWhere

func (r *Query) OrWhere(query any, args ...any) contractsorm.Query

func (*Query) OrWhereBetween added in v1.15.0

func (r *Query) OrWhereBetween(column string, x, y any) contractsorm.Query

func (*Query) OrWhereIn added in v1.15.0

func (r *Query) OrWhereIn(column string, values []any) contractsorm.Query

func (*Query) OrWhereJsonContains added in v1.15.12

func (r *Query) OrWhereJsonContains(column string, value any) contractsorm.Query

func (*Query) OrWhereJsonContainsKey added in v1.15.12

func (r *Query) OrWhereJsonContainsKey(column string) contractsorm.Query

func (*Query) OrWhereJsonDoesntContain added in v1.15.12

func (r *Query) OrWhereJsonDoesntContain(column string, value any) contractsorm.Query

func (*Query) OrWhereJsonDoesntContainKey added in v1.15.12

func (r *Query) OrWhereJsonDoesntContainKey(column string) contractsorm.Query

func (*Query) OrWhereJsonLength added in v1.15.12

func (r *Query) OrWhereJsonLength(column string, length int) contractsorm.Query

func (*Query) OrWhereNotBetween added in v1.15.0

func (r *Query) OrWhereNotBetween(column string, x, y any) contractsorm.Query

func (*Query) OrWhereNotIn added in v1.15.0

func (r *Query) OrWhereNotIn(column string, values []any) contractsorm.Query

func (*Query) OrWhereNull added in v1.15.0

func (r *Query) OrWhereNull(column string) contractsorm.Query

func (*Query) Order

func (r *Query) Order(value any) contractsorm.Query

DEPRECATED: Use OrderByRaw instead

func (*Query) OrderBy added in v1.15.0

func (r *Query) OrderBy(column string, direction ...string) contractsorm.Query

func (*Query) OrderByDesc added in v1.15.0

func (r *Query) OrderByDesc(column string) contractsorm.Query

func (*Query) OrderByRaw added in v1.15.12

func (r *Query) OrderByRaw(raw string) contractsorm.Query

func (*Query) Paginate added in v1.9.0

func (r *Query) Paginate(page, limit int, dest any, total *int64) error

func (*Query) Pluck

func (r *Query) Pluck(column string, dest any) error

func (*Query) Raw

func (r *Query) Raw(sql string, values ...any) contractsorm.Query

func (*Query) Restore added in v1.15.0

func (r *Query) Restore(dests ...any) (*contractsdb.Result, error)

func (*Query) Rollback added in v1.15.0

func (r *Query) Rollback() error

func (*Query) Save

func (r *Query) Save(dest any) error

func (*Query) SaveQuietly added in v1.11.0

func (r *Query) SaveQuietly(value any) error

func (*Query) Scan

func (r *Query) Scan(dest any) error

func (*Query) Scopes

func (r *Query) Scopes(funcs ...func(contractsorm.Query) contractsorm.Query) contractsorm.Query

func (*Query) Select

func (r *Query) Select(columns ...string) contractsorm.Query

func (*Query) SharedLock added in v1.11.0

func (r *Query) SharedLock() contractsorm.Query

func (*Query) Sum added in v1.15.0

func (r *Query) Sum(column string) (int64, error)

func (*Query) Table

func (r *Query) Table(name string, args ...any) contractsorm.Query

func (*Query) ToRawSql added in v1.15.0

func (r *Query) ToRawSql() contractsorm.ToSql

func (*Query) ToSql added in v1.15.0

func (r *Query) ToSql() contractsorm.ToSql

func (*Query) Update

func (r *Query) Update(column any, value ...any) (*contractsdb.Result, error)

func (*Query) UpdateOrCreate added in v1.10.0

func (r *Query) UpdateOrCreate(dest any, attributes any, values any) error

func (*Query) Where

func (r *Query) Where(query any, args ...any) contractsorm.Query

func (*Query) WhereBetween added in v1.15.0

func (r *Query) WhereBetween(column string, x, y any) contractsorm.Query

func (*Query) WhereIn added in v1.15.0

func (r *Query) WhereIn(column string, values []any) contractsorm.Query

func (*Query) WhereJsonContains added in v1.15.12

func (r *Query) WhereJsonContains(column string, value any) contractsorm.Query

func (*Query) WhereJsonContainsKey added in v1.15.12

func (r *Query) WhereJsonContainsKey(column string) contractsorm.Query

func (*Query) WhereJsonDoesntContain added in v1.15.12

func (r *Query) WhereJsonDoesntContain(column string, value any) contractsorm.Query

func (*Query) WhereJsonDoesntContainKey added in v1.15.12

func (r *Query) WhereJsonDoesntContainKey(column string) contractsorm.Query

func (*Query) WhereJsonLength added in v1.15.12

func (r *Query) WhereJsonLength(column string, length int) contractsorm.Query

func (*Query) WhereNotBetween added in v1.15.0

func (r *Query) WhereNotBetween(column string, x, y any) contractsorm.Query

func (*Query) WhereNotIn added in v1.15.0

func (r *Query) WhereNotIn(column string, values []any) contractsorm.Query

func (*Query) WhereNotNull added in v1.15.0

func (r *Query) WhereNotNull(column string) contractsorm.Query

func (*Query) WhereNull added in v1.15.0

func (r *Query) WhereNull(column string) contractsorm.Query

func (*Query) With

func (r *Query) With(query string, args ...any) contractsorm.Query

func (*Query) WithContext added in v1.15.6

func (r *Query) WithContext(ctx context.Context) contractsorm.Query

func (*Query) WithTrashed

func (r *Query) WithTrashed() contractsorm.Query

func (*Query) WithoutEvents added in v1.11.0

func (r *Query) WithoutEvents() contractsorm.Query

type Row added in v1.15.12

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

func (*Row) Err added in v1.15.12

func (r *Row) Err() error

func (*Row) Scan added in v1.15.12

func (r *Row) Scan(value any) error

type Table added in v1.12.0

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

type ToSql added in v1.13.10

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

func NewToSql added in v1.13.10

func NewToSql(query *Query, log log.Log, raw bool) *ToSql

func (*ToSql) Count added in v1.13.10

func (r *ToSql) Count() string

func (*ToSql) Create added in v1.13.10

func (r *ToSql) Create(value any) string

func (*ToSql) Delete added in v1.13.10

func (r *ToSql) Delete(dests ...any) string

func (*ToSql) Find added in v1.13.10

func (r *ToSql) Find(dest any, conds ...any) string

func (*ToSql) First added in v1.13.10

func (r *ToSql) First(dest any) string

func (*ToSql) ForceDelete added in v1.15.0

func (r *ToSql) ForceDelete(dests ...any) string

func (*ToSql) Get added in v1.13.10

func (r *ToSql) Get(dest any) string

func (*ToSql) Pluck added in v1.13.10

func (r *ToSql) Pluck(column string, dest any) string

func (*ToSql) Save added in v1.13.10

func (r *ToSql) Save(dest any) string

func (*ToSql) Sum added in v1.13.10

func (r *ToSql) Sum(column string, dest any) string

func (*ToSql) Update added in v1.13.10

func (r *ToSql) Update(column any, value ...any) string

type With added in v1.13.5

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

Jump to

Keyboard shortcuts

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