Go語言庫系列之dotsql
阿新 • • 發佈：2020-04-02
> 導讀：能單獨拎出SQL檔案的某一行或幾行執行，是不是非常有趣？今天我們來介紹一下這個有意思的庫--dotsql。
### 背景介紹
dotsql不是ORM，也不是SQL查詢語句的構建器，而是可以在一個SQL檔案中拎出某幾行來執行的工具，非常類似於ini配置檔案的讀取。如果還不理解，我們來看如下內容。
```sql
-- 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`的方式打上了“註解”，而作為開發人員，可以根據打了標記的名稱挑選語句執行。
### 快速上手
#### 準備工作
目錄結構概覽
```shell
.
├── data.sql
├── go.mod
├── go.sum
└── main.go
```
初始化專案
```shell
go mod init dotsql
```
建立data.sql檔案，鍵入如下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驅動
```shell
go get github.com/mattn/go-sqlite3
```
#### 程式碼演示
現在來寫程式碼，匯入go-sqlite3庫
```go
import _ "github.com/mattn/go-sqlite3"
```
獲取sqlite3的資料庫控制代碼
```go
db, _ := sql.Open("sqlite3", ":memory:")
```
載入data.sql檔案
```go
dot, _ := dotsql.LoadFromFile("data.sql")
```
挑選檔案中的一個標籤來執行，Exec方法的第一個引數需要傳入控制代碼
```go
dot.Exec(db, "create-users-table")
```
從註釋可以找到對應的語句，是一個建立表的操作
```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)
);
```
再來執行第二條語句，插入表資料
```go
dot.Exec(db, "create-user", "User Name", "[email protected]")
```
我們再來嘗試查詢表資料，這裡要注意，目前所有的操作都是基於定義的標籤來選擇執行的
```go
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語句，再在合適的時機執行
```go
stmt, err := dot.Prepare(db, "drop-users-table")
result, err := stmt.Exec()
```
同樣，我們也可以將多個SQL檔案合併再進行取值操作
```go
dot1, err := dotsql.LoadFromFile("queries1.sql")
dot2, err := dotsql.LoadFromFile("queries2.sql")
dot := dotsql.Merge(dot1, dot2)
```
---
感謝大家的觀看，如果覺得文章對你有所幫助，歡迎關注公眾號「平也」，聚焦Go語言與技術原理。
![關注我](https://img2020.cnblogs.com/other/1471773/202004/1471773-20200402151600485-1236827