Golang高效构建SQL查询语句插件库Squirrel的使用

简介

Squirrel是一个Go语言的流式SQL生成器，它可以帮助你从可组合的部分构建SQL查询。Squirrel不是一个ORM。

基本用法

安装

import "github.com/Masterminds/squirrel"

查询示例

import sq "github.com/Masterminds/squirrel"

// 基础查询
users := sq.Select("*").From("users").Join("emails USING (email_id)")

// 添加条件
active := users.Where(sq.Eq{"deleted_at": nil})

// 生成SQL
sql, args, err := active.ToSql()

// sql == "SELECT * FROM users JOIN emails USING (email_id) WHERE deleted_at IS NULL"

插入示例

sql, args, err := sq.
    Insert("users").Columns("name", "age").
    Values("moe", 13).Values("larry", sq.Expr("? + 5", 12)).
    ToSql()

// sql == "INSERT INTO users (name,age) VALUES (?,?),(?,? + 5)"

执行查询

stooges := users.Where(sq.Eq{"username": []string{"moe", "larry", "curly", "shemp"}})
three_stooges := stooges.Limit(3)
rows, err := three_stooges.RunWith(db).Query()

// 等同于:
rows, err := db.Query("SELECT * FROM users WHERE username IN (?,?,?,?) LIMIT 3",
                     "moe", "larry", "curly", "shemp")

条件查询构建

if len(q) > 0 {
    users = users.Where("name LIKE ?", fmt.Sprint("%", q, "%"))
}

高级特性

语句缓存和构建器

// StmtCache缓存准备好的语句
dbCache := sq.NewStmtCache(db)

// StatementBuilder保持语法整洁
mydb := sq.StatementBuilder.RunWith(dbCache)
select_users := mydb.Select("*").From("users")

PostgreSQL支持

psql := sq.StatementBuilder.PlaceholderFormat(sq.Dollar)

// 使用问号作为占位符...
sql, _, _ := psql.Select("*").From("elephants").Where("name IN (?,?)", "Dumbo", "Verna").ToSql()

// ...squirrel会根据PlaceholderFormat替换它们
// sql == "SELECT * FROM elephants WHERE name IN ($1,$2)"

// 可以检索id...
query := sq.Insert("nodes").
    Columns("uuid", "type", "data").
    Values(node.Uuid, node.Type, node.Data).
    Suffix("RETURNING \"id\"").
    RunWith(m.db).
    PlaceholderFormat(sq.Dollar)

query.QueryRow().Scan(&node.id)

转义问号

可以通过插入两个问号来转义问号：

SELECT * FROM nodes WHERE meta->'format' ??| array[?,?]

使用Dollar占位符时会生成：

SELECT * FROM nodes WHERE meta->'format' ?| array[$1,$2]

完整示例Demo

package main

import (
	"database/sql"
	"fmt"
	"log"

	sq "github.com/Masterminds/squirrel"
	_ "github.com/lib/pq"
)

func main() {
	// 连接数据库
	db, err := sql.Open("postgres", "user=postgres dbname=test sslmode=disable")
	if err != nil {
		log.Fatal(err)
	}
	defer db.Close()

	// 创建StatementBuilder
	psql := sq.StatementBuilder.PlaceholderFormat(sq.Dollar)

	// 1. 查询示例
	query := psql.Select("id", "name", "email").
		From("users").
		Where(sq.Eq{"active": true}).
		Limit(10)

	sql, args, err := query.ToSql()
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("生成的SQL:", sql)
	fmt.Println("参数:", args)

	// 执行查询
	rows, err := query.RunWith(db).Query()
	if err != nil {
		log.Fatal(err)
	}
	defer rows.Close()

	// 处理结果...

	// 2. 插入示例
	insert := psql.Insert("users").
		Columns("name", "age").
		Values("John", 30).
		Values("Alice", sq.Expr("? + 5", 25))

	sql, args, err = insert.ToSql()
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("\n生成的插入SQL:", sql)
	fmt.Println("参数:", args)

	// 执行插入
	_, err = insert.RunWith(db).Exec()
	if err != nil {
		log.Fatal(err)
	}

	// 3. 更新示例
	update := psql.Update("users").
		Set("name", "Bob").
		Set("age", sq.Expr("age + 1")).
		Where(sq.Eq{"id": 1})

	sql, args, err = update.ToSql()
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("\n生成的更新SQL:", sql)
	fmt.Println("参数:", args)

	// 4. 条件查询构建
	searchTerm := "john"
	query = psql.Select("*").From("users")
	if searchTerm != "" {
		query = query.Where("name LIKE ?", fmt.Sprintf("%%%s%%", searchTerm))
	}

	sql, args, err = query.ToSql()
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("\n条件查询SQL:", sql)
	fmt.Println("参数:", args)
}

常见问题

1. 如何构建复合键/元组的IN查询？

   使用Or和Eq组合：

   sq.Or{
     sq.Eq{"col1": 1, "col2": 2},
     sq.Eq{"col1": 3, "col2": 4}}
   

   生成的SQL：

   WHERE (col1 = 1 AND col2 = 2) OR (col1 = 3 AND col2 = 4)
   

2. 为什么Eq{"mynumber": []uint8{1,2,3}}不会转换为IN查询？

   因为[]byte在Go中只是[]uint8的别名，无法区分两者。

3. 某些功能文档不完善？

   测试用例可以作为文档的一部分参考。

许可证

Squirrel采用MIT许可证发布。