sqlc 项目教程

苗素鹃Rich

于 2024-09-26 08:16:26 发布

阅读量880

点赞数 8

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_01003/article/details/142543526

sqlc 项目教程

sqlc sqlc-dev/sqlcsqlc-dev/sqlcli: 是一个用于 PostgreSQL 和 SQLite 数据库的跨平台命令行工具，它提供了一个简单易用的界面用于管理 PostgreSQL 和 SQLite 数据库。适合用于管理 PostgreSQL 和 SQLite 数据库，特别是对于需要轻量级、跨平台的数据库管理工具的场景。特点是轻量级、跨平台、支持 PostgreSQL 和 SQLite 数据库。项目地址: https://gitcode.com/gh_mirrors/sq/sqlc

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

sqlc 项目的目录结构如下：

sqlc/
├── cmd/
│   ├── generate/
│   ├── init/
│   └── version/
├── internal/
│   ├── codegen/
│   ├── config/
│   ├── importer/
│   ├── parser/
│   ├── printer/
│   ├── runner/
│   └── util/
├── pkg/
│   ├── ast/
│   ├── compiler/
│   ├── config/
│   ├── importer/
│   ├── parser/
│   ├── printer/
│   ├── runner/
│   └── util/
├── sqlc.yaml
├── go.mod
├── go.sum
└── README.md

目录结构介绍

cmd/: 包含项目的命令行工具入口文件。
- generate/: 生成代码的命令入口。
- init/: 初始化项目的命令入口。
- version/: 版本信息命令入口。
internal/: 包含项目的内部实现代码。
- codegen/: 代码生成相关逻辑。
- config/: 配置文件解析逻辑。
- importer/: 导入器相关逻辑。
- parser/: SQL 解析器相关逻辑。
- printer/: 代码打印相关逻辑。
- runner/: 运行器相关逻辑。
- util/: 工具函数。
pkg/: 包含项目的公共包。
- ast/: 抽象语法树相关逻辑。
- compiler/: 编译器相关逻辑。
- config/: 配置文件解析逻辑。
- importer/: 导入器相关逻辑。
- parser/: SQL 解析器相关逻辑。
- printer/: 代码打印相关逻辑。
- runner/: 运行器相关逻辑。
- util/: 工具函数。
sqlc.yaml: 项目的配置文件。
go.mod 和 go.sum: Go 模块依赖文件。
README.md: 项目说明文档。

2. 项目的启动文件介绍

sqlc 项目的启动文件位于 cmd/ 目录下。主要的启动文件包括：

cmd/generate/main.go: 负责生成代码的命令入口。
cmd/init/main.go: 负责初始化项目的命令入口。
cmd/version/main.go: 负责显示版本信息的命令入口。

这些文件通过命令行参数来调用相应的功能模块，实现项目的启动和运行。

3. 项目的配置文件介绍

sqlc 项目的配置文件是 sqlc.yaml。该文件定义了项目的基本配置和生成代码的规则。

配置文件示例

version: "1"
sql:
  - schema: "schema.sql"
    queries: "query.sql"
    engine: "postgresql"
    gen:
      go:
        package: "models"
        out: "internal/models"

配置文件说明

version: 配置文件的版本号。
sql: 定义 SQL 文件的相关配置。
- schema: 数据库 schema 文件路径。
- queries: SQL 查询文件路径。
- engine: 使用的数据库引擎，如 postgresql。
- gen: 生成代码的配置。
  - go: Go 语言的生成配置。
    - package: 生成的 Go 包名。
    - out: 生成的 Go 文件输出路径。