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 finds records that match given conditions.
	Find(out any, conds ...any) error
	// Append appending a model to the association.
	Append(values ...any) error
	// Replace replaces the association with the given value.
	Replace(values ...any) error
	// Delete deletes the given value from the association.
	Delete(values ...any) error
	// Clear clears the association.
	Clear() error
	// Count returns the number of records in the association.
	Count() int64
}

type ConnectionModel

type ConnectionModel interface {
	// Connection gets the connection name for the model.
	Connection() string
}

type Cursor

type Cursor interface {
	// Scan scans the current row into the given destination.
	Scan(value any) error
}

type DispatchesEvents

type DispatchesEvents interface {
	// DispatchesEvents returns the event handlers.
	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 returns the event context.
	Context() context.Context
	// GetAttribute returns the attribute value for the given key.
	GetAttribute(key string) any
	// GetOriginal returns the original attribute value for the given key.
	GetOriginal(key string, def ...any) any
	// IsDirty returns true if the given column is dirty.
	IsDirty(columns ...string) bool
	// IsClean returns true if the given column is clean.
	IsClean(columns ...string) bool
	// Query returns the query instance.
	Query() Query
	// SetAttribute sets the attribute value for the given key.
	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 sets the number of models that should be generated.
	Count(count int) Factory
	// Create creates a model and persists it to the database.
	Create(value any, attributes ...map[string]any) error
	// CreateQuietly creates a model and persists it to the database without firing any model events.
	CreateQuietly(value any, attributes ...map[string]any) error
	// Make creates a model and returns it, but does not persist it to the database.
	Make(value any, attributes ...map[string]any) error
}

type Observer

type Observer interface {
	// Retrieved called when the model is retrieved from the database.
	Retrieved(Event) error
	// Creating called when the model is being created.
	Creating(Event) error
	// Created called when the model has been created.
	Created(Event) error
	// Updating called when the model is being updated.
	Updating(Event) error
	// Updated called when the model has been updated.
	Updated(Event) error
	// Saving called when the model is being saved.
	Saving(Event) error
	// Saved called when the model has been saved.
	Saved(Event) error
	// Deleting called when the model is being deleted.
	Deleting(Event) error
	// Deleted called when the model has been deleted.
	Deleted(Event) error
	// ForceDeleting called when the model is being force deleted.
	ForceDeleting(Event) error
	// ForceDeleted called when the model has been force deleted.
	ForceDeleted(Event) error
}

type Orm

type Orm interface {
	// Connection gets an Orm instance from the connection pool.
	Connection(name string) Orm
	// DB gets the underlying database connection.
	DB() (*sql.DB, error)
	// Query gets a new query builder instance.
	Query() Query
	// Factory gets a new factory instance for the given model name.
	Factory() Factory
	// Observe registers an observer with the Orm.
	Observe(model any, observer Observer)
	// Transaction runs a callback wrapped in a database transaction.
	Transaction(txFunc func(tx Transaction) error) error
	// WithContext sets the context to be used by the Orm.
	WithContext(ctx context.Context) Orm
}

type Query

type Query interface {
	// Association gets an association instance by name.
	Association(association string) Association
	// Begin begins a new transaction
	Begin() (Transaction, error)
	// Driver gets the driver for the query.
	Driver() Driver
	// Count retrieve the "count" result of the query.
	Count(count *int64) error
	// Create inserts new record into the database.
	Create(value any) error
	// Cursor returns a cursor, use scan to iterate over the returned rows.
	Cursor() (chan Cursor, error)
	// Delete deletes records matching given conditions, if the conditions are empty will delete all records.
	Delete(value any, conds ...any) (*Result, error)
	// Distinct specifies distinct fields to query.
	Distinct(args ...any) Query
	// Exec executes raw sql
	Exec(sql string, values ...any) (*Result, error)
	// Find finds records that match given conditions.
	Find(dest any, conds ...any) error
	// FindOrFail finds records that match given conditions or throws an error.
	FindOrFail(dest any, conds ...any) error
	// First finds record that match given conditions.
	First(dest any) error
	// FirstOrCreate finds the first record that matches the given attributes
	// or create a new one with those attributes if none was found.
	FirstOrCreate(dest any, conds ...any) error
	// FirstOr finds the first record that matches the given conditions or
	// execute the callback and return its result if no record is found.
	FirstOr(dest any, callback func() error) error
	// FirstOrFail finds the first record that matches the given conditions or throws an error.
	FirstOrFail(dest any) error
	// FirstOrNew finds the first record that matches the given conditions or
	// return a new instance of the model initialized with those attributes.
	FirstOrNew(dest any, attributes any, values ...any) error
	// ForceDelete forces delete records matching given conditions.
	ForceDelete(value any, conds ...any) (*Result, error)
	// Get retrieves all rows from the database.
	Get(dest any) error
	// Group specifies the group method on the query.
	Group(name string) Query
	// Having specifying HAVING conditions for the query.
	Having(query any, args ...any) Query
	// Join specifying JOIN conditions for the query.
	Join(query string, args ...any) Query
	// Limit the number of records returned.
	Limit(limit int) Query
	// Load loads a relationship for the model.
	Load(dest any, relation string, args ...any) error
	// LoadMissing loads a relationship for the model that is not already loaded.
	LoadMissing(dest any, relation string, args ...any) error
	// LockForUpdate locks the selected rows in the table for updating.
	LockForUpdate() Query
	// Model sets the model instance to be queried.
	Model(value any) Query
	// Offset specifies the number of records to skip before starting to return the records.
	Offset(offset int) Query
	// Omit specifies columns that should be omitted from the query.
	Omit(columns ...string) Query
	// Order specifies the order in which the results should be returned.
	Order(value any) Query
	// OrWhere add an "or where" clause to the query.
	OrWhere(query any, args ...any) Query
	// Paginate the given query into a simple paginator.
	Paginate(page, limit int, dest any, total *int64) error
	// Pluck retrieves a single column from the database.
	Pluck(column string, dest any) error
	// Raw creates a raw query.
	Raw(sql string, values ...any) Query
	// Save updates value in a database
	Save(value any) error
	// SaveQuietly updates value in a database without firing events
	SaveQuietly(value any) error
	// Scan scans the query result and populates the destination object.
	Scan(dest any) error
	// Scopes applies one or more query scopes.
	Scopes(funcs ...func(Query) Query) Query
	// Select specifies fields that should be retrieved from the database.
	Select(query any, args ...any) Query
	// SharedLock locks the selected rows in the table.
	SharedLock() Query
	// Sum calculates the sum of a column's values and populates the destination object.
	Sum(column string, dest any) error
	// Table specifies the table for the query.
	Table(name string, args ...any) Query
	// Update updates records with the given column and values
	Update(column any, value ...any) (*Result, error)
	// UpdateOrCreate finds the first record that matches the given attributes
	// or create a new one with those attributes if none was found.
	UpdateOrCreate(dest any, attributes any, values any) error
	// Where add a "where" clause to the query.
	Where(query any, args ...any) Query
	// WithoutEvents disables event firing for the query.
	WithoutEvents() Query
	// WithTrashed allows soft deleted models to be included in the results.
	WithTrashed() Query
	// With returns a new query instance with the given relationships eager loaded.
	With(query string, args ...any) Query
}

type Result

type Result struct {
	RowsAffected int64
}

type Transaction

type Transaction interface {
	Query
	// Commit commits the changes in a transaction.
	Commit() error
	// Rollback rolls back the changes in a transaction.
	Rollback() error
}