yiigo

package module
v1.14.6 Latest Latest
Warning

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

 Go to latest Published: Jan 16, 2025 License: Apache-2.0 Imports: 39 Imported by: 8

README

yiigo

golang GitHub release pkg.go.dev Apache 2.0 license

一个好用的Go项目脚手架和工具库

工具集

请查看 👉 详情

脚手架

自动生成项目，支持 HTTP 和 gRPC，且支持单应用和多应用

go install github.com/shenghui0779/yiigo/cmd/yiigo@latest
gg

受 protoc-gen-go 启发，为结构体生成 Get 方法【支持泛型!!!】，以避免空指针引起的Panic

go install github.com/shenghui0779/yiigo/cmd/gg@latest

实用库

获取
go get -u github.com/shenghui0779/yiigo
特点
  • xhash - 封装便于使用
  • xcrypto - 封装便于使用(支持 AES & RSA)
  • validator - 支持汉化和自定义规则
  • 基于 Redis 的分布式锁
  • 基于 sqlx 的轻量SQLBuilder
  • 基于泛型的无限菜单分类层级树
  • linklist - 一个并发安全的双向列表
  • errgroup - 基于官方版本改良，支持并发协程数量控制
  • xvalue - 用于处理 k-v 格式化的场景，如：生成签名串 等
  • xcoord - 距离、方位角、经纬度与平面直角坐标系的相互转化
  • timewheel - 简单实用的单层时间轮(支持一次性和多次重试任务)
  • 实用的辅助方法：IP、file、time、slice、string、version compare 等

⚠️ 注意：如需支持协程并发复用的 errgroup 和 timewheel，请使用 👉 nightfall

SQL Builder

⚠️ 目前支持的特性有限，复杂的SQL（如：子查询等）还需自己手写

builder := yiigo.NewSQLBuilder(*sqlx.DB, func(ctx context.Context, query string, args ...any) {
    fmt.Println(query, args)
})
👉 Query
ctx := context.Background()

type User struct {
    ID     int    `db:"id"`
    Name   string `db:"name"`
    Age    int    `db:"age"`
    Phone  string `db:"phone,omitempty"`
}

var (
    record User
    records []User
)

builder.Wrap(
    yiigo.Table("user"),
    yiigo.Where("id = ?", 1),
).One(ctx, &record)
// SELECT * FROM user WHERE (id = ?)
// [1]

builder.Wrap(
    yiigo.Table("user"),
    yiigo.Where("name = ? AND age > ?", "shenghui0779", 20),
).All(ctx, &records)
// SELECT * FROM user WHERE (name = ? AND age > ?)
// [shenghui0779 20]

builder.Wrap(
    yiigo.Table("user"),
    yiigo.Where("name = ?", "shenghui0779"),
    yiigo.Where("age > ?", 20),
).All(ctx, &records)
// SELECT * FROM user WHERE (name = ?) AND (age > ?)
// [shenghui0779 20]

builder.Wrap(
    yiigo.Table("user"),
    yiigo.WhereIn("age IN (?)", []int{20, 30}),
).All(ctx, &records)
// SELECT * FROM user WHERE (age IN (?, ?))
// [20 30]

builder.Wrap(
    yiigo.Table("user"),
    yiigo.Select("id", "name", "age"),
    yiigo.Where("id = ?", 1),
).One(ctx, &record)
// SELECT id, name, age FROM user WHERE (id = ?)
// [1]

builder.Wrap(
    yiigo.Table("user"),
    yiigo.Distinct("name"),
    yiigo.Where("id = ?", 1),
).One(ctx, &record)
// SELECT DISTINCT name FROM user WHERE (id = ?)
// [1]

builder.Wrap(
    yiigo.Table("user"),
    yiigo.LeftJoin("address", "user.id = address.user_id"),
    yiigo.Where("user.id = ?", 1),
).One(ctx, &record)
// SELECT * FROM user LEFT JOIN address ON user.id = address.user_id WHERE (user.id = ?)
// [1]

builder.Wrap(
    yiigo.Table("address"),
    yiigo.Select("user_id", "COUNT(*) AS total"),
    yiigo.GroupBy("user_id"),
    yiigo.Having("user_id = ?", 1),
).All(ctx, &records)
// SELECT user_id, COUNT(*) AS total FROM address GROUP BY user_id HAVING (user_id = ?)
// [1]

builder.Wrap(
    yiigo.Table("user"),
    yiigo.Where("age > ?", 20),
    yiigo.OrderBy("age ASC", "id DESC"),
    yiigo.Offset(5),
    yiigo.Limit(10),
).All(ctx, &records)
// SELECT * FROM user WHERE (age > ?) ORDER BY age ASC, id DESC LIMIT ? OFFSET ?
// [20, 10, 5]

wrap1 := builder.Wrap(
    yiigo.Table("user_1"),
    yiigo.Where("id = ?", 2),
)

builder.Wrap(
    yiigo.Table("user_0"),
    yiigo.Where("id = ?", 1),
    yiigo.Union(wrap1),
).All(ctx, &records)
// (SELECT * FROM user_0 WHERE (id = ?)) UNION (SELECT * FROM user_1 WHERE (id = ?))
// [1, 2]

builder.Wrap(
    yiigo.Table("user_0"),
    yiigo.Where("id = ?", 1),
    yiigo.UnionAll(wrap1),
).All(ctx, &records)
// (SELECT * FROM user_0 WHERE (id = ?)) UNION ALL (SELECT * FROM user_1 WHERE (id = ?))
// [1, 2]

builder.Wrap(
    yiigo.Table("user_0"),
    yiigo.WhereIn("age IN (?)", []int{10, 20}),
    yiigo.Limit(5),
    yiigo.Union(
        builder.Wrap(
            yiigo.Table("user_1"),
            yiigo.Where("age IN (?)", []int{30, 40}),
            yiigo.Limit(5),
        ),
    ),
).All(ctx, &records)
// (SELECT * FROM user_0 WHERE (age IN (?, ?)) LIMIT ?) UNION (SELECT * FROM user_1 WHERE (age IN (?, ?)) LIMIT ?)
// [10, 20, 5, 30, 40, 5]
👉 Insert
ctx := context.Background()

type User struct {
    ID     int64  `db:"-"`
    Name   string `db:"name"`
    Age    int    `db:"age"`
    Phone  string `db:"phone,omitempty"`
}

builder.Wrap(Table("user")).Insert(ctx, &User{
    Name: "yiigo",
    Age:  29,
})
// INSERT INTO user (name, age) VALUES (?, ?)
// [yiigo 29]

builder.Wrap(yiigo.Table("user")).Insert(ctx, yiigo.X{
    "name": "yiigo",
    "age":  29,
})
// INSERT INTO user (name, age) VALUES (?, ?)
// [yiigo 29]
👉 Batch Insert
ctx := context.Background()

type User struct {
    ID     int64  `db:"-"`
    Name   string `db:"name"`
    Age    int    `db:"age"`
    Phone  string `db:"phone,omitempty"`
}

builder.Wrap(Table("user")).BatchInsert(ctx, []*User{
    {
        Name: "shenghui0779",
        Age:  20,
    },
    {
        Name: "yiigo",
        Age:  29,
    },
})
// INSERT INTO user (name, age) VALUES (?, ?), (?, ?)
// [shenghui0779 20 yiigo 29]

builder.Wrap(yiigo.Table("user")).BatchInsert(ctx, []yiigo.X{
    {
        "name": "shenghui0779",
        "age":  20,
    },
    {
        "name": "yiigo",
        "age":  29,
    },
})
// INSERT INTO user (name, age) VALUES (?, ?), (?, ?)
// [shenghui0779 20 yiigo 29]
👉 Update
ctx := context.Background()

type User struct {
    Name   string `db:"name"`
    Age    int    `db:"age"`
    Phone  string `db:"phone,omitempty"`
}

builder.Wrap(
    yiigo.Table("user"),
    yiigo.Where("id = ?", 1),
).Update(ctx, &User{
    Name: "yiigo",
    Age:  29,
})
// UPDATE user SET name = ?, age = ? WHERE (id = ?)
// [yiigo 29 1]

builder.Wrap(
    yiigo.Table("user"),
    yiigo.Where("id = ?", 1),
).Update(ctx, yiigo.X{
    "name": "yiigo",
    "age":  29,
})
// UPDATE user SET name = ?, age = ? WHERE (id = ?)
// [yiigo 29 1]

builder.Wrap(
    yiigo.Table("product"),
    yiigo.Where("id = ?", 1),
).Update(ctx, yiigo.X{
    "price": yiigo.SQLExpr("price * ? + ?", 2, 100),
})
// UPDATE product SET price = price * ? + ? WHERE (id = ?)
// [2 100 1]
👉 Delete
ctx := context.Background()

builder.Wrap(
    yiigo.Table("user"),
    yiigo.Where("id = ?", 1),
).Delete(ctx)
// DELETE FROM user WHERE id = ?
// [1]

builder.Wrap(yiigo.Table("user")).Truncate(ctx)
// TRUNCATE user
👉 Transaction
builder.Transaction(context.Background(), func(ctx context.Context, tx yiigo.TXBuilder) error {
    _, err := tx.Wrap(
        yiigo.Table("address"),
        yiigo.Where("user_id = ?", 1),
    ).Update(ctx, yiigo.X{"default": 0})
    if err != nil {
        return err
    }

    _, err = tx.Wrap(
        yiigo.Table("address"),
        yiigo.Where("id = ?", 1),
    ).Update(ctx, yiigo.X{"default": 1})

    return err
})

Enjoy 😊

Documentation

Index

Constants

View Source 
const (
	HeaderAccept        = "Accept"
	HeaderAuthorization = "Authorization"
	HeaderContentType   = "Content-Type"
)
View Source 
const (
	ContentText          = "text/plain; charset=utf-8"
	ContentJSON          = "application/json"
	ContentForm          = "application/x-www-form-urlencoded"
	ContentStream        = "application/octet-stream"
	ContentFormMultipart = "multipart/form-data"
)
View Source 
const (
	// B - Byte size
	B Quantity = 1
	// KiB - KibiByte size
	KiB = 1024 * B
	// MiB - MebiByte size
	MiB = 1024 * KiB
	// GiB - GibiByte size
	GiB = 1024 * MiB
	// TiB - TebiByte size
	TiB = 1024 * GiB
)
View Source 
const MaxFormMemory = 32 << 20
View Source 
const MediaThumbnailWidth = 200

Variables

View Source 
var (
	// ErrSQLDataType 不合法的插入或更新数据类型错误
	ErrSQLDataType = errors.New("invaild data type, expects: struct, *struct, yiigo.X")

	// ErrSQLBatchDataType 不合法的批量插入数据类型错误
	ErrSQLBatchDataType = errors.New("invaild data type, expects: []struct, []*struct, []yiigo.X")
)
View Source 
var GMT8 = time.FixedZone("CST", 8*3600)

GMT8 东八区时区

View Source 
var RestyClient = resty.NewWithClient(NewHttpClient())

RestyClient default client for http request

Functions

func AddSlashes 

func AddSlashes(s string) string

AddSlashes 在字符串的每个引号前添加反斜杠

func CmdExamples added in v1.13.2 

func CmdExamples(ex ...string) string

CmdExamples formats the given examples to the cli.

func ContentType added in v1.6.5 

func ContentType(r *http.Request) string

func CreateFile added in v1.6.4 

func CreateFile(filename string) (*os.File, error)

CreateFile 创建或清空指定的文件 文件已存在，则清空；文件或目录不存在，则以0775权限创建

func DebugLogger added in v1.11.2 

func DebugLogger(options ...zap.Option) *zap.Logger

func ExcelColumnIndex added in v1.13.2 

func ExcelColumnIndex(name string) int

ExcelColumnIndex 返回Excel列名对应的序号，如：A=0，B=1，AA=26，AB=27

func IP2Long 

func IP2Long(ip string) uint32

IP2Long IP地址转整数

func ImageCrop added in v1.13.2 

func ImageCrop(w io.Writer, filename string, rect *Rect, options ...imaging.EncodeOption) error

ImageCrop 图片裁切

func ImageCropFromReader added in v1.13.2 

func ImageCropFromReader(w io.Writer, r io.Reader, format imaging.Format, rect *Rect, options ...imaging.EncodeOption) error

ImageCropFromReader 图片裁切

func ImageLabel added in v1.13.2 

func ImageLabel(w io.Writer, filename string, rects []*Rect, options ...imaging.EncodeOption) error

ImageLabel 图片标注

func ImageLabelFromReader added in v1.13.2 

func ImageLabelFromReader(w io.Writer, r io.Reader, format imaging.Format, rects []*Rect, options ...imaging.EncodeOption) error

ImageLabelFromReader 图片标注

func ImageThumbnail added in v1.13.2 

func ImageThumbnail(w io.Writer, filename string, rect *Rect, options ...imaging.EncodeOption) error

ImageThumbnail 图片缩略图

func ImageThumbnailFromReader added in v1.13.2 

func ImageThumbnailFromReader(w io.Writer, r io.Reader, format imaging.Format, rect *Rect, options ...imaging.EncodeOption) error

ImageThumbnailFromReader 图片缩略图

func IsUniqueDuplicateError added in v1.12.4 

func IsUniqueDuplicateError(err error) bool

IsUniqueDuplicateError 判断是否「唯一索引冲突」错误

func Long2IP 

func Long2IP(ip uint32) string

Long2IP 整数转IP地址

func MapForm added in v1.6.5 

func MapForm(ptr any, form map[string][]string) error

func MapFormByTag added in v1.6.5 

func MapFormByTag(ptr any, form map[string][]string, tag string) error

func MapQuery added in v1.6.5 

func MapQuery(ptr any, m map[string][]string) error

func MappingByPtr added in v1.6.5 

func MappingByPtr(ptr any, setter setter, tag string) error

func MarshalNoEscapeHTML added in v1.7.5 

func MarshalNoEscapeHTML(v any) ([]byte, error)

MarshalNoEscapeHTML 不带HTML转义的JSON序列化

func MyTimeEncoder 

func MyTimeEncoder(t time.Time, e zapcore.PrimitiveArrayEncoder)

MyTimeEncoder 自定义时间格式化

func NewDB added in v1.11.2 

func NewDB(cfg *DBConfig) (*sql.DB, error)

NewDB sql.DB

func NewDBx added in v1.13.1 

func NewDBx(cfg *DBConfig) (*sqlx.DB, error)

NewDBx sqlx.DB

func NewHttpClient added in v1.14.0 

func NewHttpClient() *http.Client

NewHttpClient returns a http client

func NewLogger added in v1.11.2 

func NewLogger(cfg *LogConfig) *zap.Logger

func Nonce added in v1.10.4 

func Nonce(size uint8) string

Nonce 生成随机串(size应为偶数)

func OpenFile added in v1.6.6 

func OpenFile(filename string) (*os.File, error)

OpenFile 打开指定的文件 文件已存在，则追加内容；文件或目录不存在，则以0775权限创建

func QuoteMeta 

func QuoteMeta(s string) string

QuoteMeta 在字符串预定义的字符前添加反斜杠

func Retry added in v1.12.4 

func Retry(ctx context.Context, fn func(ctx context.Context) error, attempts int, sleep time.Duration) (err error)

Retry 重试

func SliceChunk added in v1.13.1 

func SliceChunk[T ~[]E, E any](list T, size int) []T

SliceChunk 集合分片

func SliceDiff added in v1.12.5 

func SliceDiff[T ~[]E, E comparable](list1 T, list2 T) (ret1 T, ret2 T)

SliceDiff 返回两个集合之间的差异

func SliceIn added in v1.12.5 

func SliceIn[T ~[]E, E comparable](list T, elem E) bool

SliceIn 返回指定元素是否在集合中

func SliceIntersect added in v1.12.5 

func SliceIntersect[T ~[]E, E comparable](list1 T, list2 T) T

SliceIntersect 返回两个集合的交集

func SlicePinTop added in v1.13.1 

func SlicePinTop[T ~[]E, E any](list T, index int)

SlicePinTop 置顶集合中的一个元素

func SlicePinTopF added in v1.13.1 

func SlicePinTopF[T ~[]E, E any](list T, fn func(v E) bool)

SlicePinTopF 置顶集合中满足条件的一个元素

func SliceRand added in v1.8.0 

func SliceRand[T ~[]E, E any](list T, n int) T

SliceRand 返回一个指定随机挑选个数的切片 若 n == -1 or n >= len(list)，则返回打乱的切片

func SliceUnion added in v1.12.5 

func SliceUnion[T ~[]E, E comparable](lists ...T) T

SliceUnion 返回两个集合的并集

func SliceUniq added in v1.8.0 

func SliceUniq[T ~[]E, E comparable](list T) T

SliceUniq 集合去重

func SliceWithout added in v1.12.5 

func SliceWithout[T ~[]E, E comparable](list T, exclude ...E) T

SliceWithout 返回不包括所有给定值的切片

func StrToTime 

func StrToTime(layout, datetime string, loc *time.Location) time.Time

StrToTime 时间字符串解析为时间戳

func StripSlashes 

func StripSlashes(s string) string

StripSlashes 删除字符串中的反斜杠

func TimeToStr added in v1.9.0 

func TimeToStr(layout string, timestamp int64, loc *time.Location) string

TimeToStr 时间戳格式化为时间字符串 若 timestamp < 0，则使用 `time.Now()`

func Transaction added in v1.9.0 

func Transaction(ctx context.Context, db *sqlx.DB, fn func(ctx context.Context, tx *sqlx.Tx) error) (err error)

Transaction 执行数据库事物

func VersionCompare 

func VersionCompare(rangeVer, curVer string) (bool, error)

VersionCompare 语义化的版本比较，支持：>, >=, =, !=, <, <=, | (or), & (and). 参数 `rangeVer` 示例：1.0.0, =1.0.0, >2.0.0, >=1.0.0&<2.0.0, <2.0.0|>3.0.0, !=4.0.4

func WeekAround 

func WeekAround(layout string, now time.Time) (monday, sunday string)

WeekAround 返回给定时间戳所在周的「周一」和「周日」时间字符串

Types

type DBConfig added in v1.6.0 

type DBConfig struct {
	// Driver 驱动名称
	Driver string
	// DSN 数据源名称
	// - [-- MySQL] username:password@tcp(localhost:3306)/dbname?timeout=10s&charset=utf8mb4&collation=utf8mb4_general_ci&parseTime=True&loc=Local
	// - [Postgres] host=localhost port=5432 user=root password=secret dbname=test search_path=schema connect_timeout=10 sslmode=disable
	// - [- SQLite] file::memory:?cache=shared
	DSN string
	// MaxOpenConns 设置最大可打开的连接数
	MaxOpenConns int
	// MaxIdleConns 连接池最大闲置连接数
	MaxIdleConns int
	// ConnMaxLifetime 连接的最大生命时长
	ConnMaxLifetime time.Duration
	// ConnMaxIdleTime 连接最大闲置时间
	ConnMaxIdleTime time.Duration
}

DBConfig 数据库初始化配置

type DistributedMutex added in v1.6.5 

type DistributedMutex interface {
	// Lock 获取锁
	Lock(ctx context.Context) (bool, error)
	// TryLock 尝试获取锁
	TryLock(ctx context.Context, attempts int, delay time.Duration) (bool, error)
	// UnLock 释放锁
	UnLock(ctx context.Context) error
}

DistributedMutex 分布式锁

func RedisMutex added in v1.12.2 

func RedisMutex(cli *redis.Client, key string, ttl time.Duration) DistributedMutex

RedisMutex 基于Redis实现的分布式锁实例

type ILevelNode added in v1.13.1 

type ILevelNode interface {
	GetID() int64
	GetPid() int64
}

ILevelNode 层级树泛型约束

type ImageEXIF added in v1.13.2 

type ImageEXIF struct {
	Size        int64
	Format      string
	Width       int
	Height      int
	Orientation string
	Longitude   decimal.Decimal
	Latitude    decimal.Decimal
}

ImageEXIF 定义图片EXIF

func ParseImageEXIF added in v1.13.2 

func ParseImageEXIF(filename string) (*ImageEXIF, error)

ParseImageEXIF 解析图片EXIF

type LevelTree added in v1.13.1 

type LevelTree[T ILevelNode] struct {
	Data     T
	Children []*LevelTree[T]
}

LevelTree 菜单或分类层级树

func BuildLevelTree added in v1.13.1 

func BuildLevelTree[T ILevelNode](data map[int64][]T, pid int64) []*LevelTree[T]

BuildLevelTree 构建菜单或分类层级树（data=按pid归类后的数据, pid=树的起始ID）

type LogConfig added in v1.11.2 

type LogConfig struct {
	// Filename 日志名称
	Filename string
	// Level 日志级别
	Level zapcore.Level
	// MaxSize 当前文件多大时轮替；默认：100MB
	MaxSize int
	// MaxAge 轮替的旧文件最大保留时长；默认：不限
	MaxAge int
	// MaxBackups 轮替的旧文件最大保留数量；默认：不限
	MaxBackups int
	// Compress 轮替的旧文件是否压缩；默认：不压缩
	Compress bool
	// Stderr 是否输出到控制台
	Stderr bool
	// Options Zap日志选项
	Options []zap.Option
}

LogConfig 日志初始化配置

type Orientation added in v1.13.2 

type Orientation int

Orientation 图片的旋转方向 

const (
	TopLeft     Orientation = 1
	TopRight    Orientation = 2
	BottomRight Orientation = 3
	BottomLeft  Orientation = 4
	LeftTop     Orientation = 5
	RightTop    Orientation = 6
	RightBottom Orientation = 7
	LeftBottom  Orientation = 8
)

func (Orientation) String added in v1.13.2 

func (o Orientation) String() string

type Quantity added in v1.12.0 

type Quantity int64

Quantity 字节大小

func (Quantity) String added in v1.12.0 

func (q Quantity) String() string

String 实现 Stringer 接口

type Rect added in v1.13.2 

type Rect struct {
	X int
	Y int
	W int
	H int
}

Rect 定义一个矩形框

type SQLBuilder added in v1.0.4 

type SQLBuilder interface {
	TXBuilder
	// Transaction 启用事务
	Transaction(ctx context.Context, f func(ctx context.Context, tx TXBuilder) error) error
}

SQLBuilder SQL构造器

func NewSQLBuilder added in v1.0.4 

func NewSQLBuilder(db *sqlx.DB, logFn func(ctx context.Context, query string, args ...any)) SQLBuilder

NewSQLBuilder 生成SQL构造器

type SQLClause added in v1.0.4 

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

SQLClause SQL语句

func SQLExpr added in v1.8.2 

func SQLExpr(query string, binds ...any) *SQLClause

SQLExpr 生成一个语句表达式，例如：yiigo.SQLExpr("price * ? + ?", 2, 100)

type SQLOption added in v1.12.0 

type SQLOption func(w *sqlWrapper)

SQLOption SQL查询选项

func CrossJoin added in v1.2.4 

func CrossJoin(table string) SQLOption

CrossJoin 指定 `CROSS JOIN` 语句

func Distinct added in v1.0.5 

func Distinct(columns ...string) SQLOption

Distinct 指定 `DISTINCT` 子句

func FullJoin added in v1.0.5 

func FullJoin(table, on string) SQLOption

FullJoin 指定 `FULL JOIN` 子句

func GroupBy added in v1.0.5 

func GroupBy(columns ...string) SQLOption

GroupBy 指定 `GROUP BY` 子句

func Having added in v1.0.5 

func Having(query string, binds ...any) SQLOption

Having 指定 `HAVING` 子句

func Join added in v1.1.2 

func Join(table, on string) SQLOption

Join 指定 `INNER JOIN` 子句

func LeftJoin added in v1.0.5 

func LeftJoin(table, on string) SQLOption

LeftJoin 指定 `LEFT JOIN` 子句

func Limit added in v1.0.5 

func Limit(n int) SQLOption

Limit 指定 `LIMIT` 子句

func Offset added in v1.0.5 

func Offset(n int) SQLOption

Offset 指定 `OFFSET` 子句

func OrderBy added in v1.0.5 

func OrderBy(columns ...string) SQLOption

OrderBy 指定 `ORDER BY` 子句

func Returning added in v1.12.1 

func Returning(columns ...string) SQLOption

Returning 指定 `RETURNING` 子句； 用于 PostgresSQL 和 SQLite(3.35.0) `INSERT` 语句

func RightJoin added in v1.0.5 

func RightJoin(table, on string) SQLOption

RightJoin 指定 `RIGHT JOIN` 子句

func Select added in v1.0.5 

func Select(columns ...string) SQLOption

Select 指定查询字段名

func Table added in v1.0.5 

func Table(name string) SQLOption

Table 指定查询表名称

func Union added in v1.1.2 

func Union(wrappers ...SQLWrapper) SQLOption

Union 指定 `UNION` 子句

func UnionAll added in v1.1.2 

func UnionAll(wrappers ...SQLWrapper) SQLOption

UnionAll 指定 `UNION ALL` 子句

func Where added in v1.0.5 

func Where(query string, binds ...any) SQLOption

Where 指定 `WHERE` 子句

func WhereIn added in v1.1.2 

func WhereIn(query string, binds ...any) SQLOption

WhereIn 指定 `IN` 子句

type SQLWrapper added in v1.1.2 

type SQLWrapper interface {
	// One 查询一条数据
	One(ctx context.Context, data any) error
	// All 查询多条数据
	All(ctx context.Context, data any) error
	// Insert 插入数据 (数据类型：`struct`, `*struct`, `yiigo.X`)
	Insert(ctx context.Context, data any) (sql.Result, error)
	// BatchInsert 批量插入数据 (数据类型：`[]struct`, `[]*struct`, `[]yiigo.X`)
	BatchInsert(ctx context.Context, data any) (sql.Result, error)
	// Update 更新数据 (数据类型：`struct`, `*struct`, `yiigo.X`)
	Update(ctx context.Context, data any) (sql.Result, error)
	// Delete 删除数据
	Delete(ctx context.Context) (sql.Result, error)
	// Truncate 清空表
	Truncate(ctx context.Context) (sql.Result, error)
}

SQLWrapper SQL包装器

type Step added in v1.14.0 

type Step struct {
	Head int
	Tail int
}

func Steps added in v1.14.0 

func Steps(total, step int) (steps []Step)

Steps calculates the steps.

Example: 

arr := []int{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20}
for _, step := range yiigo.Steps(len(arr), 6) {
	cur := arr[step.Head:step.Tail]
	// todo: do something
}

type TXBuilder added in v1.12.0 

type TXBuilder interface {
	// Wrap 包装查询选项
	Wrap(opts ...SQLOption) SQLWrapper
	// contains filtered or unexported methods
}

TXBuilder 事务构造器

type X 

type X map[string]any

X 类型别名

Source Files

View all Source files

Directories

Path Synopsis
cmd
gg
internal
internal/ent
internal/grpc
internal/http
yiigo

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.