Dotsql 项目教程

Dotsql 项目教程

dotsqlA Golang library for using SQL.项目地址:https://gitcode.com/gh_mirrors/do/dotsql

1. 项目的目录结构及介绍

Dotsql 项目的目录结构如下：

dotsql/
├── LICENSE
├── README.md
├── compareCalls_test.go
├── dotsql.go
├── dotsql_test.go
├── examples_test.go
├── go.mod
├── go.sum
├── integration_test.go
├── mock_test.go
├── scanner.go
├── scanner_test.go
├── test_schema.sql
└── ...

• LICENSE: 项目的许可证文件。
• README.md: 项目的介绍和使用说明。
• compareCalls_test.go: 测试文件，用于比较调用。
• dotsql.go: 项目的主要实现文件。
• dotsql_test.go: 项目的主要测试文件。
• examples_test.go: 示例测试文件，展示如何使用项目。
• go.mod 和 go.sum: Go 模块文件，用于管理依赖。
• integration_test.go: 集成测试文件。
• mock_test.go: 模拟测试文件。
• scanner.go 和 scanner_test.go: 扫描器实现及其测试文件。
• test_schema.sql: 测试用的 SQL 文件。

2. 项目的启动文件介绍

Dotsql 项目的启动文件是 dotsql.go。这个文件包含了项目的主要功能实现，包括加载 SQL 文件、执行查询、准备语句等。以下是 dotsql.go 文件的部分代码示例：

package dotsql

import (
	"database/sql"
	"fmt"
	"io/ioutil"
	"strings"
)

// Dotsql represents a collection of SQL queries.
type Dotsql struct {
	queries map[string]string
}

// LoadFromFile loads queries from a SQL file.
func LoadFromFile(path string) (*Dotsql, error) {
	content, err := ioutil.ReadFile(path)
	if err != nil {
		return nil, err
	}
	return LoadFromString(string(content)), nil
}

// LoadFromString loads queries from a string.
func LoadFromString(content string) *Dotsql {
	dot := &Dotsql{
		queries: make(map[string]string),
	}
	dot.parse(content)
	return dot
}

// Exec executes a named query.
func (d *Dotsql) Exec(db *sql.DB, name string, args ...interface{}) (sql.Result, error) {
	query, ok := d.queries[name]
	if !ok {
		return nil, fmt.Errorf("query not found: %s", name)
	}
	return db.Exec(query, args...)
}

3. 项目的配置文件介绍

Dotsql 项目没有专门的配置文件，所有的配置和查询都通过代码和 SQL 文件来完成。SQL 文件中定义了所有的查询，每个查询都有一个名称标签（--name:<some name>），用于在代码中唯一标识每个查询。

例如，一个典型的 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 文件并执行其中的查询：

// Get a database handle
db, err := sql.Open("sqlite3", ":memory:")
if err != nil {
	log.Fatal(err)
}

// Loads queries from file
dot, err := dotsql.LoadFromFile("queries.sql")
if err != nil {
	log.Fatal(err)
}

// Execute a query
res, err := dot.Exec(db, "create-users-table")
if err != nil {
	log.Fatal(err)
}

通过这种方式，你可以灵活地管理和执行 SQL 查询。

dotsqlA Golang library for using SQL.项目地址:https://gitcode.com/gh_mirrors/do/dotsql