go-sqlbuilder概述
go-sqlbuilder库的核心目标是提供一套独立于特定数据库驱动的SQL语句构建工具,它不依赖于任何业务逻辑,专注于高效地生成SQL字符串,并最大限度地减少内存消耗。这使得它非常适合构建企业级应用,特别是在需要处理各种定制化数据库驱动、特殊运维标准、异构系统以及非标准SQL的复杂场景下。
go-sqlbuilder库的设计理念是简洁实用的。它不绑定任何数据库驱动,也不自动连接数据库,甚至不假设生成的SQL语句将如何被使用。这使得它可以应用于任何需要构建类SQL语句的场景,也为在其基础上进行二次开发,实现更复杂的数据库访问包、ORM等提供了可能性。
安装与使用
使用 go get 命令即可轻松安装go-sqlbuilder库:
go get github.com/huandu/go-sqlbuilder
go-sqlbuilder库提供了丰富的API,涵盖了各种常见的SQL语句构建需求。
基础用法
以下代码展示了使用go-sqlbuilder构建简单SQL语句的示例:
package main
import (
"fmt"
"github.com/huandu/go-sqlbuilder"
)
func main() {
// 构建SQL语句
sql := sqlbuilder.Select("id", "name").From("demo.user").
Where("status = 1").Limit(10).
String()
fmt.Println(sql)
// 输出:
// SELECT id, name FROM demo.user WHERE status = 1 LIMIT 10
}
预定义的SQL构建器
go-sqlbuilder库提供了以下预定义的构建器:
- Struct:用于根据结构体生成构建器的工厂函数。
- CreateTableBuilder:用于构建CREATE TABLE语句。
- SelectBuilder:用于构建SELECT语句。
- InsertBuilder:用于构建INSERT语句。
- UpdateBuilder:用于构建UPDATE语句。
- DeleteBuilder:用于构建DELETE语句。
- UnionBuilder:用于构建UNION和UNION ALL语句。
- CTEBuilder:用于构建公用表表达式(CTE),例如WITH name (col1, col2) AS (SELECT ...)。
- Buildf:使用类似fmt.Sprintf语法的自由格式构建器。
- Build:使用Args#Compile中定义的特殊语法的进阶自由格式构建器。
- BuildNamed:使用${key}引用map类型参数值的进阶自由格式构建器。
构建WHERE子句
WHERE子句是SQL语句中至关重要的部分。go-sqlbuilder提供了Cond类型来简化WHERE子句的构建。
package main
import (
"fmt"
"github.com/huandu/go-sqlbuilder"
)
func main() {
sb := sqlbuilder.Select("id").From("user")
sb.Where(
sb.In("status", 1, 2, 5),
sb.Or(
sb.Equal("name", "foo"),
sb.Like("email", "foo@%"),
),
)
sql, args := sb.Build()
fmt.Println(sql)
fmt.Println(args)
// 输出:
// SELECT id FROM user WHERE status IN (?, ?, ?) AND (name = ? OR email LIKE ?)
// [1 2 5 foo foo@%]
}
构建针对不同数据库系统的SQL语句
不同的数据库系统可能使用不同的SQL语法和参数标记。go-sqlbuilder引入了"flavor"的概念来解决这个问题。
目前,go-sqlbuilder支持MySQL、PostgreSQL、SQLServer、SQLite、CQL、ClickHouse、Presto和Oracle等数据库系统的语法。
使用Struct作为轻量级ORM
Struct类型存储了结构体的类型信息和字段信息,它可以作为构建器的工厂。我们可以使用Struct的方法来创建初始化的SELECT/INSERT/UPDATE/DELETE构建器,从而更方便地操作结构体数据。
嵌套SQL
go-sqlbuilder可以很容易地创建嵌套SQL语句:
package main
import (
"fmt"
"github.com/huandu/go-sqlbuilder"
)
func main() {
sb := sqlbuilder.NewSelectBuilder()
fromSb := sqlbuilder.NewSelectBuilder()
statusSb := sqlbuilder.NewSelectBuilder()
sb.Select("id")
sb.From(sb.BuilderAs(fromSb, "user"))
sb.Where(sb.In("status", statusSb))
fromSb.Select("id").From("user").Where(fromSb.GreaterThan("level", 4))
statusSb.Select("status").From("config").Where(statusSb.Equal("state", 1))
sql, args := sb.Build()
fmt.Println(sql)
fmt.Println(args)
// 输出:
// SELECT id FROM (SELECT id FROM user WHERE level > ?) AS user WHERE status IN (SELECT status FROM config WHERE state = ?)
// [4 1]
}
自由格式构建器
如果需要构建包含大量特殊语法的复杂SQL语句,可以使用Buildf函数:
package main
import (
"fmt"
"github.com/huandu/go-sqlbuilder"
)
func main() {
sb := sqlbuilder.NewSelectBuilder()
sb.Select("id").From("user")
explain := sqlbuilder.Buildf("EXPLAIN %v LEFT JOIN SELECT * FROM banned WHERE state IN (%v, %v)", sb, 1, 2)
sql, args := explain.Build()
fmt.Println(sql)
fmt.Println(args)
// 输出:
// EXPLAIN SELECT id FROM user LEFT JOIN SELECT * FROM banned WHERE state IN (?, ?)
// [1 2]
}
总结
go-sqlbuilder库提供了一种灵活、高效且易于使用的SQL语句构建方案,它可以帮助Go语言开发者们更轻松地处理数据库操作。它既可以作为纯粹的SQL语句构建工具,也可以充当轻量级的ORM框架,满足不同场景下的需求。