Golang轻量级易学习的SQL查询构建器插件库bqb的使用

基本介绍

bqb是一个简单、轻量级且快速的Golang SQL查询构建器库。它具有以下特点：

1. 简单、轻量级且快速
2. 支持任何SQL语法
3. 不需要学习特殊语法或操作符
4. 100%测试覆盖率

兼容性

bqb已经测试过与sqlite、PostgreSQL和MySQL兼容，可以使用database/sql、pq、pgx和sqlx等驱动。它应该与任何使用?或$参数语法的数据库接口和数据库完全兼容。

注意：Go v1.20+是BQB >= v1.4.0的要求。Go v1.17+是BQB <= v1.3.0的要求。

基本用法

简单查询

q := bqb.New("SELECT * FROM places WHERE id = ?", 1234)
sql, params, err := q.ToSql()

生成结果：

SELECT * FROM places WHERE id = ?

参数：

PARAMS: [1234]

转义问号

在Postgres查询中使用双问号??来转义?。例如：

q := bqb.New("SELECT * FROM places WHERE json_obj_column ?? 'key'")
sql, params, err := q.ToPgsql()

生成结果：

SELECT * FROM places WHERE json_obj_column ? 'key'

参数：

PARAMS: []

PostgreSQL支持

只需调用ToPgsql()方法而不是ToSql()来将查询转换为Postgres语法：

q := bqb.New("DELETE FROM users").
    Space("WHERE id = ? OR name IN (?)", 7, []string{"delete", "remove"}).
    Space("LIMIT ?", 5)
sql, params, err := q.ToPgsql()

生成结果：

DELETE FROM users WHERE id = $1 OR name IN ($2, $3) LIMIT $4

参数：

PARAMS: [7, "delete", "remove", 5]

原始查询

ToRaw()调用返回一个填充了值而不是参数化的字符串。

q := New("a = ?, b = ?, c = ?", "my a", 1234, nil)
sql, err := q.ToRaw()

生成结果：

a = 'my a', b = 1234, c = NULL

类型支持

q := bqb.New(
    "int:? string:? []int:? []string:? Query:? JsonMap:? nil:? []intf:?",
    1, "2", []int{3, 3}, []string{"4", "4"}, bqb.New("5"), bqb.JsonMap{"6": 6}, nil, []interface{}{"a",1,true},
)
sql, _ := q.ToRaw()

生成结果：

int:1 string:'2' []int:3,3 []string:'4','4' Query:5 JsonMap:'{"6":6}' nil:NULL []intf:'a',1,true

IN查询

[]string、[]*string、[]int、[]*int和[]any/[]interface{}类型的参数会自动展开。

q := bqb.New(
    "strs:(?) *strs:(?) ints:(?) *ints:(?) intfs:(?)",
    []string{"a", "b"}, []*string{}, []int{1, 2}, []*int{}, []any{3, true},
)
sql, params, _ := q.ToSql()

生成结果：

SQL: strs:(?,?) *strs:(?) ints:(?,?) *ints:(?) intfs:(?,?)
PARAMS: [a b <nil> 1 2 <nil> 3 true]

JSON参数

有两个辅助结构体JsonMap和JsonList使JSON转换更简单：

sql, err := bqb.New(
    "INSERT INTO my_table (json_map, json_list) VALUES (?, ?)",
    bqb.JsonMap{"a": 1, "b": []string{"a","b","c"}},
    bqb.JsonList{"string",1,true,nil},
).ToRaw()

生成结果：

INSERT INTO my_table (json_map, json_list)
VALUES ('{"a": 1, "b": ["a","b","c"]}', '["string",1,true,null]')

查询构建

基本示例

sel := bqb.New("SELECT")

// later
sel.Space("id")

// even later
sel.Comma("age").Comma("email")

生成结果：

SELECT id,age,email

高级示例

sel := bqb.Optional("SELECT")

if getName {
    sel.Comma("name")
}

if getId {
    sel.Comma("id")
}

if !getName && !getId {
    sel.Comma("*")
}

from := bqb.New("FROM my_table")

where := bqb.Optional("WHERE")

if filterAdult {
    adultCond := bqb.New("name = ?", "adult")
    if ageCheck {
        adultCond.And("age > ?", 20)
    }
    where.And("(?)", adultCond)
}

if filterChild {
    where.Or("(name = ? AND age < ?)", "youth", 21)
}

q := bqb.New("? ? ?", sel, from, where).Space("LIMIT ?", 10)

假设所有值都为true，查询将如下所示：

SELECT name,id FROM my_table WHERE (name = 'adult' AND age > 20) OR (name = 'youth' AND age < 21) LIMIT 10

如果getName和getId为false，查询将是：

SELECT * FROM my_table WHERE (name = 'adult' AND age > 20) OR (name = 'youth' AND age < 21) LIMIT 10

如果所有值都为false，查询将是：

SELECT * FROM my_table LIMIT 10

方法

所有查询修改方法都采用一个字符串（查询文本）和可变长度接口（查询参数）。例如q.And("abc")将在查询中添加AND abc。

q := bqb.Optional("WHERE")
q.Empty() // returns true
q.Len() // returns 0
q.Space("1 = 2") // query is now WHERE 1 = 2
q.Empty() // returns false
q.Len() // returns 1
q.And("b") // query is now WHERE 1 = 2 AND b
q.Or("c") // query is now WHERE 1 = 2 AND b OR c
q.Concat("d") // query is now WHERE 1 = 2 AND b OR cd
q.Comma("e") // query is now WHERE 1 = 2 AND b OR cd,e
q.Join("+", "f") // query is now WHERE 1 = 2 AND b OR cd,e+f

有效的args包括string、int、floatN、*Query、[]int、Embedder、Embedded、driver.Valuer或[]string。

常见问题

为什么使用bqb而不是字符串构建器？

bqb提供了几个优于字符串构建器的好处：

1. 轻松适应MySQL或PostgreSQL而无需更改参数
2. 如果filterBobs和filterAge都为false，则隐藏"WHERE"子句
3. 更简洁的代码

为什么不使用完整的查询构建器？

bqb提供了更接近原生SQL的体验，同时保持了构建动态查询的灵活性。它不需要学习特殊的语法或操作符，使得代码更易于理解和维护。