sqlc 项目使用教程

sqlc 项目使用教程

sqlc项目地址:https://gitcode.com/gh_mirrors/sql/sqlc

项目的目录结构及介绍

sqlc 项目的目录结构如下：

sqlc/
├── cmd/
│   └── sqlc/
│       └── main.go
├── internal/
│   ├── compiler/
│   ├── config/
│   ├── engine/
│   ├── parser/
│   ├── plugin/
│   ├── printer/
│   ├── reader/
│   ├── renderer/
│   ├── schema/
│   ├── template/
│   └── writer/
├── scripts/
├── sqlc.yaml
├── go.mod
├── go.sum
└── README.md

目录介绍

• cmd/: 包含项目的入口文件。
• internal/: 包含项目的内部实现，如编译器、配置、引擎等。
• scripts/: 包含一些辅助脚本。
• sqlc.yaml: 项目的配置文件。
• go.mod 和 go.sum: Go 模块文件，用于管理依赖。
• README.md: 项目的说明文档。

项目的启动文件介绍

项目的启动文件位于 cmd/sqlc/main.go。该文件是 sqlc 命令行工具的入口点，负责解析命令行参数并调用相应的功能模块。

package main

import (
    "github.com/kyleconroy/sqlc/internal/cmd"
)

func main() {
    cmd.Execute()
}

项目的配置文件介绍

项目的配置文件是 sqlc.yaml。该文件用于配置 sqlc 的行为，包括数据库连接信息、生成的代码路径、查询文件路径等。

配置文件示例

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

配置项介绍

• version: 配置文件的版本。
• sql: 包含一个或多个 SQL 配置块。
  • schema: 数据库 schema 文件的路径。
  • queries: 查询文件的路径。
  • engine: 数据库引擎类型，如 postgresql、mysql 等。
  • gen: 生成的代码配置。
    • go: Go 代码生成配置。
      • package: 生成的 Go 包名。
      • out: 生成的 Go 代码输出路径。

以上是 sqlc 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。

sqlc项目地址:https://gitcode.com/gh_mirrors/sql/sqlc