sunnyJam 2020-04-03
导读:能单独拎出SQL文件的某一行或几行执行,是不是非常有趣?今天我们来介绍一下这个有意思的库--dotsql。
背景介绍
dotsql不是ORM,也不是SQL查询语句的构建器,而是可以在一个SQL文件中拎出某几行来执行的工具,非常类似于ini配置文件的读取。如果还不理解,我们来看如下内容。
-- name: create-users-table CREATE TABLE users ( id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, name VARCHAR(255), email VARCHAR(255) ); -- name: create-user INSERT INTO users (name, email) VALUES(?, ?) -- name: find-users-by-email SELECT id,name,email FROM users WHERE email = ? -- name: find-one-user-by-email SELECT id,name,email FROM users WHERE email = ? LIMIT 1 -- name: drop-users-table DROP TABLE users
上面是SQL文件中定义的语句,我们可以很清晰地看出,每条语句上方都以 -- name 的方式打上了“注解”,而作为开发人员,可以根据打了标记的名称挑选语句执行。
快速上手
准备工作
目录结构概览
├── data.sql
├── go.mod
├── go.sum
└── main.go
初始化项目
go mod init dotsql
创建data.sql文件,键入如下SQL,只是示例,内容可以自定义。
-- name: create-users-table DROP TABLE IF EXISTS users; CREATE TABLE users ( id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, name VARCHAR(255), email VARCHAR(255) ); -- name: create-user INSERT INTO users (name, email) VALUES(?, ?) -- name: find-users-by-email SELECT id,name,email FROM users WHERE email = ? -- name: find-one-user-by-email SELECT id,name,email FROM users WHERE email = ? LIMIT 1 --name: drop-users-table DROP TABLE users
为了方便,我们用sqlite来演示,并存储在内存当中,所以要先安装sqlite驱动
go get github.com/mattn/go-sqlite3
代码演示
现在来写代码,导入go-sqlite3库
import _ "github.com/mattn/go-sqlite3"
获取sqlite3的数据库句柄
db, _ := sql.Open("sqlite3", ":memory:")
加载data.sql文件
dot, _ := dotsql.LoadFromFile("data.sql")
挑选文件中的一个标签来执行,Exec方法的第一个参数需要传入句柄
dot.Exec(db, "create-users-table")
从注释可以找到对应的语句,是一个创建表的操作
-- name: create-users-table DROP TABLE IF EXISTS users; CREATE TABLE users ( id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, name VARCHAR(255), email VARCHAR(255) );
再来执行第二条语句,插入表数据
dot.Exec(db, "create-user", "User Name", "[email protected]")
我们再来尝试查询表数据,这里要注意,目前所有的操作都是基于定义的标签来选择执行的
rows, _ := dot.Query(db, "find-users-by-email", "[email protected]") var ( id int name string email string ) for rows.Next() { rows.Scan(&id, &name, &email) fmt.Println(id, name, email) }
Query方法返回的是*sql.Rows类型,同学们可以自行遍历取值测试,大功告成!
其他玩法
我们可以先预准备SQL语句,再在合适的时机执行
stmt, err := dot.Prepare(db, "drop-users-table") result, err := stmt.Exec()
同样,我们也可以将多个SQL文件合并再进行取值操作
dot1, err := dotsql.LoadFromFile("queries1.sql") dot2, err := dotsql.LoadFromFile("queries2.sql") dot := dotsql.Merge(dot1, dot2)
总结