lorm

package module

Go to main page

Versions in this module

v1

v1.0.0

May 15, 2026

Changes in this version

type Config

+ Dialect DialectConfig

type DeleteStmt

+ func (s *DeleteStmt[T]) Clone() *DeleteStmt[T]

+ type DialectConfig struct

+ Escaper names.Escaper

+ IgnoreStrategy IgnoreStrategy

+ PlaceholderFormat builder.PlaceholderFormat

+ SupportsForUpdate bool

+ SupportsLastInsertID bool

+ SupportsReturning bool

+ func DefaultDialectConfig(driverName string) DialectConfig

type Engine

+ func NewEngineContext(ctx context.Context, driverName, dsn string, option ...Option) (*Engine, error)

+ func (e *Engine) IgnoreStrategy() IgnoreStrategy

+ func (e *Engine) SupportsForUpdate() bool

+ func (e *Engine) TXWithOptions(ctx context.Context, opts *sql.TxOptions, fn func(context.Context) error) error

type FieldDescriptor

+ EnsureFullName string

+ EnsureType string

+ type IgnoreStrategy uint8

+ const IgnoreConflictSuffix

+ const IgnoreKeyword

+ const IgnoreOrKeyword

type InsertStmt

+ func (s *InsertStmt[T]) Clone() *InsertStmt[T]

type Model

+ LormFieldPtr func(name string) any

type Option

+ func WithDialectConfig(dialect DialectConfig) Option

+ func WithLogSQLArgs(enabled bool) Option

+ func WithSupportsForUpdate(enabled bool) Option

+ func WithSupportsLastInsertID(enabled bool) Option

+ func WithSupportsReturning(enabled bool) Option

type QueryColStmt

+ func (s *QueryColStmt[T]) Clone() *QueryColStmt[T]

type QueryModelStmt

+ func (s *QueryModelStmt[T]) Clone() *QueryModelStmt[T]

type UpdateStmt

+ func (s *UpdateStmt[T]) Clone() *UpdateStmt[T]

v0

v0.0.2

Dec 31, 2025

Changes in this version

+ var FlagTagMap = map[FieldFlag]string

+ func Escaper(driverName string) names.Escaper

+ func ModelToInsertData[T Model](model T, ignoreFields ...string) (columns []string, values []any)

+ func ModelsToInsertData[T Model](models []T, ignoreFields ...string) (columns []string, values [][]any)

+ func Placeholder(driverName string) builder.PlaceholderFormat

+ func ScanCol[T any](row *sql.Rows, t T) error

+ func ScanCols[T any](rows *sql.Rows, v *[]T) error

+ func ScanModel[T Model](row *sql.Rows, m T) error

+ func ScanModels[T Model](rows *sql.Rows, models *[]T) error

+ type Config struct

+ type DBProxy interface

+ type DeleteStmt struct

+ func Delete(engine *Engine) *DeleteStmt

+ func (s *DeleteStmt) Exec(ctx context.Context) (rowsAffected int64, err error)

+ func (s *DeleteStmt) From(from string) *DeleteStmt

+ func (s *DeleteStmt) ID(id any) *DeleteStmt

+ func (s *DeleteStmt) Limit(limit uint64) *DeleteStmt

+ func (s *DeleteStmt) Offset(offset uint64) *DeleteStmt

+ func (s *DeleteStmt) OrderBy(orderBys ...string) *DeleteStmt

+ func (s *DeleteStmt) Prefix(sql string, args ...any) *DeleteStmt

+ func (s *DeleteStmt) PrefixExpr(expr builder.Sqlizer) *DeleteStmt

+ func (s *DeleteStmt) Suffix(sql string, args ...any) *DeleteStmt

+ func (s *DeleteStmt) SuffixExpr(expr builder.Sqlizer) *DeleteStmt

+ func (s *DeleteStmt) Where(pred any, args ...any) *DeleteStmt

+ type Engine struct

+ func NewEngine(driverName, dsn string, option ...Option) (*Engine, error)

+ func (e *Engine) Close() error

+ func (e *Engine) DriverName() string

+ func (e *Engine) Escaper() names.Escaper

+ func (e *Engine) Exec(ctx context.Context, query string, args ...any) (result sql.Result, err error)

+ func (e *Engine) Exist(ctx context.Context, query string, args ...any) (exist bool, err error)

+ func (e *Engine) Placeholder() builder.PlaceholderFormat

+ func (e *Engine) Query(ctx context.Context, query string, args ...any) (rows *sql.Rows, err error)

+ func (e *Engine) SupportsLastInsertId() bool

+ func (e *Engine) SupportsReturning() bool

+ func (e *Engine) TX(ctx context.Context, fn func(context.Context) error) error

+ type Execer interface

+ ExecContext func(ctx context.Context, query string, args ...any) (sql.Result, error)

+ type FieldDescriptor struct

+ DBField string

+ Flag FieldFlag

+ FullName string

+ Name string

+ Type string

+ type FieldFlag uint8

+ const FlagAutoIncrement

+ const FlagCreated

+ const FlagJson

+ const FlagPrimaryKey

+ const FlagUpdated

+ const FlagVersion

+ func (f FieldFlag) HasFlag(flag FieldFlag) bool

+ type FileDescriptor struct

+ Imports []*Import

+ LormImportAlias string

+ Package string

+ Path string

+ Structs []*ModelDescriptor

+ func (d *FileDescriptor) JsonMarshal() string

+ func (d *FileDescriptor) RawVarPrefix() string

+ type Import struct

+ Alias string

+ Path string

+ type InsertStmt struct

+ func Insert[T Table](engine *Engine) *InsertStmt[T]

+ func (s *InsertStmt[T]) AddModel(model T) *InsertStmt[T]

+ func (s *InsertStmt[T]) AddModels(models ...T) *InsertStmt[T]

+ func (s *InsertStmt[T]) Columns(columns ...string) *InsertStmt[T]

+ func (s *InsertStmt[T]) Exec(ctx context.Context) (rowsAffected int64, err error)

+ func (s *InsertStmt[T]) Ignore() *InsertStmt[T]

+ func (s *InsertStmt[T]) Prefix(sql string, args ...any) *InsertStmt[T]

+ func (s *InsertStmt[T]) PrefixExpr(expr builder.Sqlizer) *InsertStmt[T]

+ func (s *InsertStmt[T]) Suffix(sql string, args ...any) *InsertStmt[T]

+ func (s *InsertStmt[T]) SuffixExpr(expr builder.Sqlizer) *InsertStmt[T]

+ func (s *InsertStmt[T]) Values(values ...any) *InsertStmt[T]

+ type JSONFieldWrapper struct

+ func NewJSONFieldWrapper(v any) *JSONFieldWrapper

+ func (s *JSONFieldWrapper) MarshalJSON() ([]byte, error)

+ func (s *JSONFieldWrapper) Scan(src any) error

+ func (s *JSONFieldWrapper) String() string

+ func (s *JSONFieldWrapper) UnmarshalJSON(data []byte) error

+ func (s *JSONFieldWrapper) Value() (driver.Value, error)

+ type Logger interface

+ DebugContext func(ctx context.Context, msg string, args ...any)

+ ErrorContext func(ctx context.Context, msg string, args ...any)

+ InfoContext func(ctx context.Context, msg string, args ...any)

+ WarnContext func(ctx context.Context, msg string, args ...any)

+ type Model interface

+ LormFieldMap func() map[string]any

+ LormModelDescriptor func() *ModelDescriptor

+ New func() Model

+ type ModelDescriptor struct

+ Fields []*FieldDescriptor

+ Name string

+ TableName string

+ func (m *ModelDescriptor) AllFields() []string

+ func (m *ModelDescriptor) FlagFields(flag FieldFlag) []string

+ type Option func(*Config)

+ func WithConnMaxIdleTime(connMaxIdleTime time.Duration) Option

+ func WithConnMaxLifetime(connMaxLifetime time.Duration) Option

+ func WithEscaper(escaper names.Escaper) Option

+ func WithLogger(logger Logger) Option

+ func WithMaxIdleConns(maxIdleConns int) Option

+ func WithMaxOpenConns(maxOpenConns int) Option

+ func WithPlaceholderFormat(format builder.PlaceholderFormat) Option

+ type Querier interface

+ QueryContext func(ctx context.Context, query string, args ...any) (*sql.Rows, error)

+ type QueryColStmt struct

+ func QueryCol[T any](engine *Engine) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) AddColumn(column any, args ...any) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) Column(column any, args ...any) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) CrossJoin(join string, rest ...any) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) Distinct() *QueryColStmt[T]

+ func (s *QueryColStmt[T]) Find(ctx context.Context) ([]T, error)

+ func (s *QueryColStmt[T]) From(from string) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) FromSelect(from *builder.SelectBuilder, alias string) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) Get(ctx context.Context) (T, bool, error)

+ func (s *QueryColStmt[T]) GroupBy(groupBys ...string) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) Having(pred any, rest ...any) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) InnerJoin(join string, rest ...any) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) Join(join string, rest ...any) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) JoinClause(pred any, args ...any) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) LeftJoin(join string, rest ...any) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) Limit(limit uint64) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) Offset(offset uint64) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) Options(options ...string) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) OrderBy(orderBys ...string) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) OrderByClause(pred any, args ...any) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) Prefix(sql string, args ...any) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) PrefixExpr(expr builder.Sqlizer) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) RemoveColumns() *QueryColStmt[T]

+ func (s *QueryColStmt[T]) RemoveLimit() *QueryColStmt[T]

+ func (s *QueryColStmt[T]) RemoveOffset() *QueryColStmt[T]

+ func (s *QueryColStmt[T]) RightJoin(join string, rest ...any) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) Select(columns ...string) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) Suffix(sql string, args ...any) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) SuffixExpr(expr builder.Sqlizer) *QueryColStmt[T]

+ func (s *QueryColStmt[T]) Where(pred any, args ...any) *QueryColStmt[T]

+ type QueryModelStmt struct

+ func Query[T Model](engine *Engine) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) AddColumn(column any, args ...any) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) Column(column any, args ...any) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) CrossJoin(join string, rest ...any) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) Distinct() *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) Exist(ctx context.Context) (bool, error)

+ func (s *QueryModelStmt[T]) Find(ctx context.Context) ([]T, error)

+ func (s *QueryModelStmt[T]) From(from string) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) FromSelect(from *builder.SelectBuilder, alias string) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) Get(ctx context.Context) (T, error)

+ func (s *QueryModelStmt[T]) GroupBy(groupBys ...string) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) Having(pred any, rest ...any) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) ID(id any) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) InnerJoin(join string, rest ...any) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) Join(join string, rest ...any) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) JoinClause(pred any, args ...any) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) LeftJoin(join string, rest ...any) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) Limit(limit uint64) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) Offset(offset uint64) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) Options(options ...string) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) OrderBy(orderBys ...string) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) OrderByClause(pred any, args ...any) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) Page(ctx context.Context, page, size uint64) ([]T, uint64, error)

+ func (s *QueryModelStmt[T]) Prefix(sql string, args ...any) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) PrefixExpr(expr builder.Sqlizer) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) RemoveColumns() *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) RemoveLimit() *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) RemoveOffset() *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) RightJoin(join string, rest ...any) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) Select(columns ...string) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) Suffix(sql string, args ...any) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) SuffixExpr(expr builder.Sqlizer) *QueryModelStmt[T]

+ func (s *QueryModelStmt[T]) Where(pred any, args ...any) *QueryModelStmt[T]

+ type Repository struct

+ Engine *Engine

+ func NewRepository[T Table](engine *Engine) *Repository[T]

+ func (r *Repository[T]) Delete(ctx context.Context, id int64) (rowsAffected int64, err error)

+ func (r *Repository[T]) DeleteByField(ctx context.Context, field string, value any) (rowsAffected int64, err error)

+ func (r *Repository[T]) Exist(ctx context.Context, id int64) (bool, error)

+ func (r *Repository[T]) ExistByField(ctx context.Context, field string, value any) (bool, error)

+ func (r *Repository[T]) Get(ctx context.Context, id int64) (T, error)

+ func (r *Repository[T]) GetByField(ctx context.Context, field string, value any) (T, error)

+ func (r *Repository[T]) Insert(ctx context.Context, model T) (rowsAffected int64, err error)

+ func (r *Repository[T]) InsertAll(ctx context.Context, models []T) (rowsAffected int64, err error)

+ func (r *Repository[T]) InsertIgnore(ctx context.Context, model T) (rowsAffected int64, err error)

+ func (r *Repository[T]) InsertIgnoreAll(ctx context.Context, models []T) (rowsAffected int64, err error)

+ func (r *Repository[T]) Lock(ctx context.Context, id int64) (T, error)

+ func (r *Repository[T]) LockByField(ctx context.Context, field string, value any) (T, error)

+ func (r *Repository[T]) Update(ctx context.Context, model T) (rowsAffected int64, err error)

+ func (r *Repository[T]) UpdateMap(ctx context.Context, id int64, data map[string]any) (rowsAffected int64, err error)

+ type Table interface

+ type TableName interface

+ TableName func() string

+ type UnimplementedModel struct

+ type UnimplementedTable struct

+ type UpdateStmt struct

+ func Update[T Table](engine *Engine) *UpdateStmt[T]

+ func (s *UpdateStmt[T]) Exec(ctx context.Context) (rowsAffected int64, err error)

+ func (s *UpdateStmt[T]) ID(id any) *UpdateStmt[T]

+ func (s *UpdateStmt[T]) Limit(limit uint64) *UpdateStmt[T]

+ func (s *UpdateStmt[T]) Offset(offset uint64) *UpdateStmt[T]

+ func (s *UpdateStmt[T]) OrderBy(orderBys ...string) *UpdateStmt[T]

+ func (s *UpdateStmt[T]) Prefix(sql string, args ...any) *UpdateStmt[T]

+ func (s *UpdateStmt[T]) PrefixExpr(expr builder.Sqlizer) *UpdateStmt[T]

+ func (s *UpdateStmt[T]) Set(column string, value any) *UpdateStmt[T]

+ func (s *UpdateStmt[T]) SetMap(clauses map[string]any) *UpdateStmt[T]

+ func (s *UpdateStmt[T]) SetModel(t T) *UpdateStmt[T]

+ func (s *UpdateStmt[T]) Suffix(sql string, args ...any) *UpdateStmt[T]

+ func (s *UpdateStmt[T]) SuffixExpr(expr builder.Sqlizer) *UpdateStmt[T]

+ func (s *UpdateStmt[T]) Table(table string) *UpdateStmt[T]

+ func (s *UpdateStmt[T]) Where(pred any, args ...any) *UpdateStmt[T]

v0.0.1

Dec 29, 2025

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