orm

Documentation

Index

• Variables
• type Aggregate
  • func Avg(col string) Aggregate
  • func (a Aggregate) As(alias string) Aggregate
  • func (a Aggregate) Select()
• type Assignable
• type Assignment
  • func Assign(col string, val any) Assignment
  • func (Assignment) Assign()
• type Column
  • func C(columnName string) Column
  • func (c Column) As(alias string) Column
  • func (Column) Assign()
  • func (c Column) Eq(val any) Predicate
  • func (c Column) LT(val any) Predicate
  • func (c Column) Plus(val any) Predicate
  • func (c Column) Select()
• type DB
  • func MustNewDB(driveName string, dataSourceName string, opts ...DBOption) *DB
  • func Open(driveName string, dataSourceName string, opts ...DBOption) (*DB, error)
  • func OpenDB(sqlDB *sql.DB, opts ...DBOption) (*DB, error)
• type DBOption
  • func DBWithCreator(creator valuer.Creator) DBOption
  • func DBWithDialect(dialect Dialect) DBOption
  • func DBWithRegister(r *schema.Register) DBOption
• type Deleter
  • func NewDeleter[T any](db *DB) *Deleter[T]
  • func (d *Deleter[T]) Build() (*Query, error)
  • func (d *Deleter[T]) Exec(ctx context.Context) (sql.Result, error)
  • func (d *Deleter[T]) From(tableName string) *Deleter[T]
  • func (b *Deleter) Quoter(columnName string)
  • func (d *Deleter[T]) Where(e Predicate) *Deleter[T]
• type Dialect
• type Executor
• type Expression
• type Inserter
  • func NewInserter[T any](db *DB) *Inserter[T]
  • func (i *Inserter[T]) Build() (*Query, error)
  • func (i *Inserter[T]) Columns(columns ...string) *Inserter[T]
  • func (i *Inserter[T]) Exec(ctx context.Context) Result
  • func (i *Inserter[T]) OnDuplicateKey() *OnDuplicateKeyBuilder[T]
  • func (b *Inserter) Quoter(columnName string)
  • func (i *Inserter[T]) Values(values ...*T) *Inserter[T]
• type OnDuplicateKey
• type OnDuplicateKeyBuilder
  • func (b *OnDuplicateKeyBuilder[T]) Update(assigns ...Assignable) *Inserter[T]
• type Predicate
  • func Not(right Predicate) Predicate
  • func (left Predicate) And(right Predicate) Predicate
  • func (left Predicate) Or(right Predicate) Predicate
• type Querier
• type Query
• type QueryBuilder
• type RawExpression
  • func Raw(expr string, args ...any) RawExpression
  • func (r RawExpression) AsPredicate() Predicate
  • func (r RawExpression) Select()
• type Result
  • func (r Result) LastInsertId() (int64, error)
  • func (r Result) RowsAffected() (int64, error)
• type Selectable
• type Selector
  • func NewSelector[T any](db *DB) *Selector[T]
  • func (s *Selector[T]) Build() (*Query, error)
  • func (s *Selector[T]) From(tableName string) *Selector[T]
  • func (s *Selector[T]) Get(ctx context.Context) (*T, error)
  • func (s *Selector[T]) GetMulti(ctx context.Context) ([]*T, error)
  • func (s *Selector[T]) GroupBy(groupBy ...Expression) *Selector[T]
  • func (b *Selector) Quoter(columnName string)
  • func (s *Selector[T]) Select(cols ...Selectable) *Selector[T]
  • func (s *Selector[T]) Where(e Predicate) *Selector[T]
• type StandSQL
  • func (s StandSQL) BuildOnDuplicateKey(b *builder, odk *OnDuplicateKey) error
  • func (s StandSQL) Quoter() string

Variables

var (
	ErrNoRows = errs.ErrNoRows
)

Types

type Aggregate

type Aggregate struct {
	Fn    string
	Arg   string
	Alias string
}

Aggregate 聚合函数

func Avg

func Avg(col string) Aggregate

func (Aggregate) As

func (a Aggregate) As(alias string) Aggregate

func (Aggregate) Select

func (a Aggregate) Select()

type Assignable

type Assignable interface {
	Assign()
}

Assignable 可用于update语句的SET,ON DUPLICATE KEY UPDATE后

type Assignment

type Assignment struct {
	Column string
	Val    any
}

func Assign

func Assign(col string, val any) Assignment

func (Assignment) Assign

func (Assignment) Assign()

type Column

type Column struct {
	Name  string
	Alias string // 别名
}

func C

func C(columnName string) Column

func (Column) As

func (c Column) As(alias string) Column

func (Column) Assign

func (Column) Assign()

func (Column) Eq

func (c Column) Eq(val any) Predicate

func (Column) LT

func (c Column) LT(val any) Predicate

func (Column) Plus

func (c Column) Plus(val any) Predicate

func (Column) Select

func (c Column) Select()

type DB

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

func MustNewDB

func MustNewDB(driveName string, dataSourceName string, opts ...DBOption) *DB

func Open

func Open(driveName string, dataSourceName string, opts ...DBOption) (*DB, error)

func OpenDB

func OpenDB(sqlDB *sql.DB, opts ...DBOption) (*DB, error)

type DBOption

type DBOption func(db *DB)

func DBWithCreator

func DBWithCreator(creator valuer.Creator) DBOption

func DBWithDialect

func DBWithDialect(dialect Dialect) DBOption

func DBWithRegister

func DBWithRegister(r *schema.Register) DBOption

type Deleter

type Deleter[T any] struct {
	// contains filtered or unexported fields
}

func NewDeleter

func NewDeleter[T any](db *DB) *Deleter[T]

func (*Deleter[T]) Build

func (d *Deleter[T]) Build() (*Query, error)

func (*Deleter[T]) Exec

func (d *Deleter[T]) Exec(ctx context.Context) (sql.Result, error)

func (*Deleter[T]) From

func (d *Deleter[T]) From(tableName string) *Deleter[T]

func (*Deleter) Quoter

func (b *Deleter) Quoter(columnName string)

func (*Deleter[T]) Where

func (d *Deleter[T]) Where(e Predicate) *Deleter[T]

type Dialect

type Dialect interface {
	// 表名，列名标记符号 mysql `
	Quoter() string

	BuildOnDuplicateKey(b *builder, odk *OnDuplicateKey) error
}

type Executor

type Executor interface {
	Exec(ctx context.Context) Result
}

type Expression

type Expression interface {
	// contains filtered or unexported methods
}

type Inserter

type Inserter[T any] struct {
	// contains filtered or unexported fields
}

func NewInserter

func NewInserter[T any](db *DB) *Inserter[T]

func (*Inserter[T]) Build

func (i *Inserter[T]) Build() (*Query, error)

func (*Inserter[T]) Columns

func (i *Inserter[T]) Columns(columns ...string) *Inserter[T]

Columns 指定要插入的列

func (*Inserter[T]) Exec

func (i *Inserter[T]) Exec(ctx context.Context) Result

func (*Inserter[T]) OnDuplicateKey

func (i *Inserter[T]) OnDuplicateKey() *OnDuplicateKeyBuilder[T]

OnDuplicateKey 主键冲突时的操作

func (*Inserter) Quoter

func (b *Inserter) Quoter(columnName string)

func (*Inserter[T]) Values

func (i *Inserter[T]) Values(values ...*T) *Inserter[T]

type OnDuplicateKey

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

type OnDuplicateKeyBuilder

type OnDuplicateKeyBuilder[T any] struct {
	// contains filtered or unexported fields
}

func (*OnDuplicateKeyBuilder[T]) Update

func (b *OnDuplicateKeyBuilder[T]) Update(assigns ...Assignable) *Inserter[T]

type Predicate

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

func Not

func Not(right Predicate) Predicate

func (Predicate) And

func (left Predicate) And(right Predicate) Predicate

func (Predicate) Or

func (left Predicate) Or(right Predicate) Predicate

type Querier

type Querier[T any] interface {
	Get(ctx context.Context) (*T, error)
	GetMulti(ctx context.Context) ([]*T, error)
}

Querier querier 用于select语句

type Query

type Query struct {
	SQL  string
	Args []any
}

type QueryBuilder

type QueryBuilder interface {
	Build() (*Query, error)
}

type RawExpression

type RawExpression struct {
	Expr string
	Args []any
}

RawExpression raw expression will not do anything to this

func Raw

func Raw(expr string, args ...any) RawExpression

func (RawExpression) AsPredicate

func (r RawExpression) AsPredicate() Predicate

func (RawExpression) Select

func (r RawExpression) Select()

type Result

type Result struct {
	Res sql.Result
	Err error
}

func (Result) LastInsertId

func (r Result) LastInsertId() (int64, error)

func (Result) RowsAffected

func (r Result) RowsAffected() (int64, error)

type Selectable

type Selectable interface {
	Select()
}

type Selector

type Selector[T any] struct {
	// contains filtered or unexported fields
}

func NewSelector

func NewSelector[T any](db *DB) *Selector[T]

func (*Selector[T]) Build

func (s *Selector[T]) Build() (*Query, error)

func (*Selector[T]) From

func (s *Selector[T]) From(tableName string) *Selector[T]

func (*Selector[T]) Get

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

func (*Selector[T]) GetMulti

func (s *Selector[T]) GetMulti(ctx context.Context) ([]*T, error)

func (*Selector[T]) GroupBy

func (s *Selector[T]) GroupBy(groupBy ...Expression) *Selector[T]

func (*Selector) Quoter

func (b *Selector) Quoter(columnName string)

func (*Selector[T]) Select

func (s *Selector[T]) Select(cols ...Selectable) *Selector[T]

func (*Selector[T]) Where

func (s *Selector[T]) Where(e Predicate) *Selector[T]

type StandSQL

type StandSQL struct{}

func (StandSQL) BuildOnDuplicateKey

func (s StandSQL) BuildOnDuplicateKey(b *builder, odk *OnDuplicateKey) error

func (StandSQL) Quoter

func (s StandSQL) Quoter() string