orm

Documentation

Index

• type Association
• type ConnectionModel
• type Cursor
• type DispatchesEvents
• type Driver
  • func (d Driver) String() string
• type Event
• type EventType
• type Factory
• type Observer
• type Orm
• type Query
• type Result
• type Transaction

Types

type Association

type Association interface {
	Find(out any, conds ...any) error
	Append(values ...any) error
	Replace(values ...any) error
	Delete(values ...any) error
	Clear() error
	Count() int64
}

type ConnectionModel

type ConnectionModel interface {
	Connection() string
}

type Cursor

type Cursor interface {
	Scan(value any) error
}

type DispatchesEvents

type DispatchesEvents interface {
	DispatchesEvents() map[EventType]func(Event) error
}

type Driver

type Driver string

const (
	DriverMysql      Driver = "mysql"
	DriverPostgresql Driver = "postgresql"
	DriverSqlite     Driver = "sqlite"
	DriverSqlserver  Driver = "sqlserver"
)

func (Driver) String

func (d Driver) String() string

type Event

type Event interface {
	Context() context.Context
	GetAttribute(key string) any
	GetOriginal(key string, def ...any) any
	IsDirty(columns ...string) bool
	IsClean(columns ...string) bool
	Query() Query
	SetAttribute(key string, value any)
}

type EventType

type EventType string

const EventCreated EventType = "created"

const EventCreating EventType = "creating"

const EventDeleted EventType = "deleted"

const EventDeleting EventType = "deleting"

const EventForceDeleted EventType = "force_deleted"

const EventForceDeleting EventType = "force_deleting"

const EventRetrieved EventType = "retrieved"

const EventSaved EventType = "saved"

const EventSaving EventType = "saving"

const EventUpdated EventType = "Updated"

const EventUpdating EventType = "updating"

type Factory

type Factory interface {
	Count(count int) Factory
	Create(value any, attributes ...map[string]any) error
	CreateQuietly(value any, attributes ...map[string]any) error
	Make(value any, attributes ...map[string]any) error
}

type Observer

type Observer interface {
	Retrieved(Event) error
	Creating(Event) error
	Created(Event) error
	Updating(Event) error
	Updated(Event) error
	Saving(Event) error
	Saved(Event) error
	Deleting(Event) error
	Deleted(Event) error
	ForceDeleting(Event) error
	ForceDeleted(Event) error
}

type Orm

type Orm interface {
	Connection(name string) Orm
	DB() (*sql.DB, error)
	Query() Query
	Factory() Factory
	Observe(model any, observer Observer)
	Transaction(txFunc func(tx Transaction) error) error
	WithContext(ctx context.Context) Orm
}

type Query

type Query interface {
	Association(association string) Association
	Begin() (Transaction, error)
	Driver() Driver
	Count(count *int64) error
	Create(value any) error
	Cursor() (chan Cursor, error)
	Delete(value any, conds ...any) (*Result, error)
	Distinct(args ...any) Query
	Exec(sql string, values ...any) (*Result, error)
	Find(dest any, conds ...any) error
	FindOrFail(dest any, conds ...any) error
	First(dest any) error
	FirstOrCreate(dest any, conds ...any) error
	FirstOr(dest any, callback func() error) error
	FirstOrFail(dest any) error
	FirstOrNew(dest any, attributes any, values ...any) error
	ForceDelete(value any, conds ...any) (*Result, error)
	Get(dest any) error
	Group(name string) Query
	Having(query any, args ...any) Query
	Join(query string, args ...any) Query
	Limit(limit int) Query
	Load(dest any, relation string, args ...any) error
	LoadMissing(dest any, relation string, args ...any) error
	LockForUpdate() Query
	Model(value any) Query
	Offset(offset int) Query
	Omit(columns ...string) Query
	Order(value any) Query
	OrWhere(query any, args ...any) Query
	Paginate(page, limit int, dest any, total *int64) error
	Pluck(column string, dest any) error
	Raw(sql string, values ...any) Query
	Save(value any) error
	SaveQuietly(value any) error
	Scan(dest any) error
	Scopes(funcs ...func(Query) Query) Query
	Select(query any, args ...any) Query
	SharedLock() Query
	Sum(column string, dest any) error
	Table(name string, args ...any) Query
	Update(column any, value ...any) (*Result, error)
	UpdateOrCreate(dest any, attributes any, values any) error
	Where(query any, args ...any) Query
	WithoutEvents() Query
	WithTrashed() Query
	With(query string, args ...any) Query
}

type Result

type Result struct {
	RowsAffected int64
}

type Transaction

type Transaction interface {
	Query
	Commit() error
	Rollback() error
}