sqlx

sqlx 是一个库，为 Go 的标准 database/sql 库提供了一系列扩展。sqlx 版本的 sql.DB、sql.TX、sql.Stmt 等保留了底层接口不变，使其接口成为标准接口的超集。这使得将现有使用 database/sql 的代码库与 sqlx 集成变得相对容易。

主要的新增概念包括：

将行数据封装到结构体（支持嵌套结构）、映射和切片中
支持命名参数，包括预处理语句
Get 和 Select 方法，可快速从查询结果到结构体/切片

除了 godoc API 文档，还有一些用户文档解释了如何与 sqlx 一起使用 database/sql。

安装

go get github.com/jmoiron/sqlx

问题

行头可能会有歧义（SELECT 1 AS a, 2 AS a），而且在像这样的查询中，Columns() 的结果不会完全限定列名：

SELECT a.id, a.name, b.id, b.name FROM foos AS a JOIN foos AS b ON a.parent = b.id;

这使得结构体或映射目标变得模糊不清。在查询中使用 AS 为列指定不同的名称，使用 rows.Scan 手动扫描它们，或使用 SliceScan 获取结果切片。

用法

以下是一个示例，展示了 sqlx 的一些常见用例。查看 sqlx_test.go 以获取更多用法。

package main

import (
    "database/sql"
    "fmt"
    "log"
    
    _ "github.com/lib/pq"
    "github.com/jmoiron/sqlx"
)

var schema = `
CREATE TABLE person (
    first_name text,
    last_name text,
    email text
);

CREATE TABLE place (
    country text,
    city text NULL,
    telcode integer
)`

type Person struct {
    FirstName string `db:"first_name"`
    LastName  string `db:"last_name"`
    Email     string
}

type Place struct {
    Country string
    City    sql.NullString
    TelCode int
}

func main() {
    // 这会尝试连接数据库并进行 Ping 操作
    // 使用 sqlx.Open() 来获得与 sql.Open() 相同的语义
    db, err := sqlx.Connect("postgres", "user=foo dbname=bar sslmode=disable")
    if err != nil {
        log.Fatalln(err)
    }

// 执行schema或失败；多语句Exec行为在不同数据库驱动间有所不同； // pq会执行所有语句，sqlite3不会，具体情况可能有所不同 db.MustExec(schema)

tx := db.MustBegin() tx.MustExec("INSERT INTO person (first_name, last_name, email) VALUES ($1, $2, $3)", "Jason", "Moiron", "jmoiron@jmoiron.net") tx.MustExec("INSERT INTO person (first_name, last_name, email) VALUES ($1, $2, $3)", "John", "Doe", "johndoeDNE@gmail.net") tx.MustExec("INSERT INTO place (country, city, telcode) VALUES ($1, $2, $3)", "United States", "New York", "1") tx.MustExec("INSERT INTO place (country, telcode) VALUES ($1, $2)", "Hong Kong", "852") tx.MustExec("INSERT INTO place (country, telcode) VALUES ($1, $2)", "Singapore", "65") // 命名查询可以使用结构体，所以如果你有一个已经填充的现有结构体（例如 person := &Person{}），你可以将其作为 &person 传入 tx.NamedExec("INSERT INTO person (first_name, last_name, email) VALUES (:first_name, :last_name, :email)", &Person{"Jane", "Citizen", "jane.citzen@example.com"}) tx.Commit()

// 查询数据库，将结果存储在 []Person 中（包装在 []interface{} 中） people := []Person{} db.Select(&people, "SELECT * FROM person ORDER BY first_name ASC") jason, john := people[0], people[1]

fmt.Printf("%#v\n%#v", jason, john) // Person{FirstName:"Jason", LastName:"Moiron", Email:"jmoiron@jmoiron.net"} // Person{FirstName:"John", LastName:"Doe", Email:"johndoeDNE@gmail.net"}

// 你也可以获取单个结果，类似于 QueryRow jason = Person{} err = db.Get(&jason, "SELECT * FROM person WHERE first_name=$1", "Jason") fmt.Printf("%#v\n", jason) // Person{FirstName:"Jason", LastName:"Moiron", Email:"jmoiron@jmoiron.net"}

// 如果你有空字段并使用 SELECT ，你必须在结构体中使用 sql.Null places := []Place{} err = db.Select(&places, "SELECT * FROM place ORDER BY telcode ASC") if err != nil { fmt.Println(err) return } usa, singsing, honkers := places[0], places[1], places[2]

fmt.Printf("%#v\n%#v\n%#v\n", usa, singsing, honkers) // Place{Country:"United States", City:sql.NullString{String:"New York", Valid:true}, TelCode:1} // Place{Country:"Singapore", City:sql.NullString{String:"", Valid:false}, TelCode:65} // Place{Country:"Hong Kong", City:sql.NullString{String:"", Valid:false}, TelCode:852}

// 使用单个结构体遍历行 place := Place{} rows, err := db.Queryx("SELECT * FROM place") for rows.Next() { err := rows.StructScan(&place) if err != nil { log.Fatalln(err) } fmt.Printf("%#v\n", place) } // Place{Country:"United States", City:sql.NullString{String:"New York", Valid:true}, TelCode:1} // Place{Country:"Hong Kong", City:sql.NullString{String:"", Valid:false}, TelCode:852} // Place{Country:"Singapore", City:sql.NullString{String:"", Valid:false}, TelCode:65}

// 命名查询，使用 :name 作为绑定变量。自动绑定变量支持 // 根据 sqlx.Open/Connect 中的 driverName 考虑数据库类型 _, err = db.NamedExec(INSERT INTO person (first_name,last_name,email) VALUES (:first,:last,:email), map[string]interface{}{ "first": "Bin", "last": "Smuth", "email": "bensmith@allblacks.nz", })

// 从数据库中选择 Mr. Smith rows, err = db.NamedQuery(SELECT * FROM person WHERE first_name=:fn, map[string]interface{}{"fn": "Bin"})

// 命名查询也可以使用结构体。它们的绑定名称遵循与名称 -> 数据库映射相同的规则， // 因此结构体字段会被转换为小写，并考虑 db 标签。 rows, err = db.NamedQuery(SELECT * FROM person WHERE first_name=:first_name, jason)

// 批量插入

// 使用结构体进行批量插入 personStructs := []Person{ {FirstName: "Ardie", LastName: "Savea", Email: "asavea@ab.co.nz"}, {FirstName: "Sonny Bill", LastName: "Williams", Email: "sbw@ab.co.nz"}, {FirstName: "Ngani", LastName: "Laumape", Email: "nlaumape@ab.co.nz"}, }

_, err = db.NamedExec(INSERT INTO person (first_name, last_name, email) VALUES (:first_name, :last_name, :email), personStructs)

// 使用映射进行批量插入 personMaps := []map[string]interface{}{ {"first_name": "Ardie", "last_name": "Savea", "email": "asavea@ab.co.nz"}, {"first_name": "Sonny Bill", "last_name": "Williams", "email": "sbw@ab.co.nz"}, {"first_name": "Ngani", "last_name": "Laumape", "email": "nlaumape@ab.co.nz"}, } _, err = db.NamedExec(INSERT INTO person (first_name, last_name, email) VALUES (:first_name, :last_name, :email), personMaps) }