GO语言的单事务SQL驱动
txdb包是一个基于单事务的数据库SQL驱动。当连接打开时,它会启动一个事务,并且在这个sql.DB上执行的所有操作都将在该事务内进行。如果执行并发操作,会获取锁并始终释放连接,语句和行不会持有连接。
为什么它有用?一个非常基本的用例是,如果你想进行功能测试,你可以准备一个测试数据库,在每个测试中你不需要重新加载数据库。所有测试都在事务内隔离,因此执行速度快。而且你不需要在代码中改变你的sql.DB引用,txdb就像一个标准的sql.Driver。
这个驱动支持打开任何sql.Driver连接。你可以为不同的SQL驱动注册txdb,并将其置于不同的驱动名下。在底层,每当打开txdb驱动时,它会尝试打开一个真实的连接并启动事务。当调用关闭时,它会回滚事务,使你准备好的测试数据库保持在与之前相同的状态。
假设你有一个名为txdb_test的mysql数据库,其中有一个users表,表中有一个username列。
package main
import (
"database/sql"
"log"
"github.com/DATA-DOG/go-txdb"
_ "github.com/go-sql-driver/mysql"
)
func init() {
// 我们注册一个名为"txdb"的SQL驱动
txdb.Register("txdb", "mysql", "root@/txdb_test")
}
func main() {
// dsn作为连接池的唯一标识符
db, err := sql.Open("txdb", "identifier")
if err != nil {
log.Fatal(err)
}
defer db.Close()
if _, err := db.Exec(`INSERT INTO users(username) VALUES("gopher")`); err != nil {
log.Fatal(err)
}
}
如果你喜欢,你也可以使用sql.OpenDB
(Go 1.10中新增)而不是注册txdb驱动实例:
package main
import (
"database/sql"
"log"
"github.com/DATA-DOG/go-txdb"
_ "github.com/go-sql-driver/mysql"
)
func main() {
db := sql.OpenDB(txdb.New("mysql", "root@/txdb_test"))
defer db.Close()
if _, err := db.Exec(`INSERT INTO users(username) VALUES("gopher")`); err != nil {
log.Fatal(err)
}
}
每次运行这个应用程序时,它都会保持与之前相同的状态。
测试
使用主要面向测试目的。测试需要数据库访问,支持使用postgres
和mysql
数据库。最简单的方法是使用testcontainers,通过将各自的数据库DSN值设置为AUTO
来启用。例如:
MYSQL_DSN=AUTO PSQL_DSN=AUTO go test ./...
如果你想使用正在运行的本地数据库实例,你也可以直接提供DSN,它将被使用:
MYSQL_DSN=root:pass@/ PSQL_DSN=postgres://postgres:pass@localhost/ go test ./...
要仅针对MySQL或PostgreSQL运行测试,你可以只提供各自的DSN值;任何未设置的DSN都会在测试中被跳过。
文档
有关一般API详细信息,请参阅godoc。 有关支持的go版本,请参阅**.travis.yml**。
贡献
欢迎提交拉取请求。请注意,如果你希望对公共(导出的方法或类型)进行扩展,请先开一个issue讨论这些更改是否可以被接受。所有向后不兼容的更改都将被谨慎对待。
公共API已锁定,因为它是一个sql.Driver,不会改变。
许可证
txdb采用三条款BSD许可证授权