Go语言库系列之dotsql

导读：能单独拎出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", "main@example.com")

我们再来尝试查询表数据，这里要注意，目前所有的操作都是基于定义的标签来选择执行的

	rows, _ := dot.query(db, "find-users-by-email", "main@example.com")
	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)

感谢大家的观看，如果觉得文章对你有所帮助，欢迎关注公众号「平也」，聚焦go语言与技术原理。