orm

sqlbuilder 提供了一组以链式操作构建 SQL 语句的方法。 且对象本身可以复用。

构建 SQL 语句的方式有很多种：

1. 直接采用 sqlbuilder 下的方法，比如：

sqlbuilder.CreateTable(e).Column(...)

1. 通过 sqlbuilder.SQLBuilder 对象生成：

builder := sqlbuiler.NewSQLBuilder(e)
builder.CreateTable().Column(...) // 创建表
builder.Update().Table(...)       // 更新表

1. 或是通过 DB 和 Tx 的 SQLBuilder() 方法，这种方法本质是和 sqlbuilder.SQLBuilder 是一样的，只不过在 DB 和 Tx 中预先初始化了 SQLBuilder。

stmt := sqlbuilder.Select(db)
    Column("*").
    From("users", "u").
    Where("id>@id", sql.Named("id", 1)).
    And("age<@age", sql.Named("age", 100)).
    Desc("id")

// 所有符合条件的数据会导出到 list 中，如果 list 不够长，会自动添加元素。
list := make([]*User, 0, 10)
stmt.QueryObject(false, &list)

命名参数

支持 Go 1.8 之后提供的 sql.NamedArgs 格式的命名参数。在链式操作中，并不要求语句的顺序，比如：

stmt1, err := sqlbuilder.Select(db)
    Column("*").
    From("users", "u").
    Where("id>?", 1).
    Limit(20, 10).
    Prepare()

stmt2, err := sqlbuilder.Select(db)
    From("users", "u").
    Column("*").
    Limit(20, 10).
    Where("id>?", 1).
    Prepare()

以上两个语句生成的 SQL 是一样的：

SELECT * FROM users AS u WHERE id>? LIMIT ? OFFSET ?

所以在调用预编译的语句时，给的参数也必须是一样的， 而不是按照链式语句的参数顺序就行了。 这就成造成了，一旦你的语句需要预编译，那么链式操作带来的只有麻烦而不是便捷。

所以在这类操作中，推荐使用命名参数的方式调用：

stmt2, err := sqlbuilder.Select(db)
    From("users", "u").
    Column("*").
    Limit(sql.Named("limit", 20), sql.Named("offset", 10)).
    Where("id>@id", sql.Named("id", 1)).
    Prepare()
stmt2.Query([]interface{}{
    sql.Named("id", 1),
    sql.Named("offset", 30),
    sql.Named("limit", 20),
})

占位符

如果你表中的字段是 SQL 的关键字，那么在查询时，需要将该字段加特殊的引号， 各个数据库不尽相同。 在 sqlbuilder 中，你不需要关心具体是什么，我们统一采用 {}， 系统会自动处理成当前数据库的符号。

当然大部分时候，你都不需要手动添加，系统会自动帮你添加， 只有在 WHERE 和 CHECK 表达式才需要：

query := sqlbuilder.Select(db).
    From("users").
    Column("group").              // 此处不需要
    Where("{group} IS NOT NULL")  // WHERE 表达式需要加 {}

还支持使用 # 表示表名前缀，这在将多个实例安装在同一个数据库时非常有用， 表名前缀由 New 或是 DB.Prefix 指定。

CrateTable/TruncateTable/DropTable

// 创建表
creator := sqlbuilder.CreateTable(db).
    Table("users").
    AutoIncrement("id", core.Int64Type). // 自增列
    Column("name", core.StringType, false, false, nil).
    Column("username", core.StringType, false, false, nil).
    Column("age", core.IntType, false, false, nil).
    PK("u_unique_username", "username").  // 唯一约束
    Check("chk_age_great_18", "age>18")

// 清空表
truncate := sqlbuilder.TruncateTable(db).
    Table("users", "id")

// 删除表
drop := sqlbuilder.DropTable(db).
    Table("users")

Insert

sqlbuilder.Insert(e).Table("users").Columns("name","age").
    Values("alice", 18).
    Values("jobs", 19)

或是采用 KeyValue 的方式:

sqlbuilder.Insert(e).Table("users").
    KeyValue("name","alice").
    KeyValues("age",18)

当然也支持 DEFAULT VALUES 地插入数据，当然前提是你的表中所有字段都有提供默认值。

// 全部采用默认或是自增的值填充到 users 表中
sqlbuilder.Insert(e).Table("users").Exec()

或者直接从 SELECT 语句中生成 INSERT：

// 将从 userinfo 中获取的 name 和 age 列插入到 users 表中
sqlbuilder.Select(e).Column("age").
    Column("name").
    From("userinfo").
    Insert().
    Table("users")

Delete

sqlbuilder.Delete(e).
    Where("id=?", 1).
    Exec()

Update

sqlbuilder.Update(e).
    Where("id=?", 1).
    Increase("age", 1). // 增加列的值
    OCC("version", 5). // 如果服务器上 version 值不为 5，则会更新失败
    Exec()

Where

Where 作为 Delete、Select 和 Update 的共有部分，提供了很多预定义的操作， 所有的操作都包含了 And 和 Or 两个操作。 比如 AndIn() 和 OrIn()、AndBetween() 和 OrBetween() 都是成对出现。

stmt.Where("id>?", 1).
    And("id>? AND name LIKE ?", 1, "%name").
    AndIn("id", []interface{}{1, 2, 3}). // IN
    OrBetween("id", 1, 2).               // BETWEEN
    AndLike("id", "%xx").                // LIKE
    AndIsNull("name").                   // IS NULL
    OrIsNotNull("name")                  // IS NOT NULL

生成 SQL 语句为：

WHERE id>? AND id>? AND name LIKE ? AND id IN(?,?,?) OR id BETWEEN 1 AND 2 AND id LIKE ? AND name IS NULL OR name IS NOT NULL

子查询条件

stmt.Where("id>?", 1).
    AndGroup().
    AndBetween("id", 1, 2).
    EndGroup().
    OrIsNull("id")

生成的 SQL 语句为：

WHERE id>? AND (id BETWEEN ? AND ?) OR id IS NULL

也可以直接使用 Where 生成其它语句：

// 删除符合条件的语句
sqlbuilder.Where().And("id>?",1).
    And("name like ?", "%xx").
    Delete(db).
    Table("users").
    Exec()

Select

Select 支持大部分标准的 SQL 语句，对调用顺序没要求。

builder := sqlbuilder.Select(e).Column("id").
    Columns("username as name", "age").
    Where("id=?", 5).
    Limit(20,1)

// 获取当前分页的内容
list := make([]*User, 0, 10);
    builder.QueryObject(true, &builder);

// 查询符合以上条件的所有记录数
builder.Count("count(*) AS cnt")
    count, err := builder.QueryInt("cnt")

This site is open source. Improve this page.