­

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語言與技術原理。
關注我