SQLC项目代码生成指南：从基础配置到高级分析-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01070/article/details/148377508

SQLC项目代码生成指南：从基础配置到高级分析

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

什么是SQLC代码生成

SQLC是一个强大的SQL转代码工具，它能将SQL查询直接转换为类型安全的代码。通过sqlc generate命令，开发者可以自动生成与数据库交互的代码，显著提高开发效率并减少手动编写数据访问层的工作量。

基础配置

要使用SQLC生成代码，首先需要创建一个配置文件sqlc.yaml。这个文件定义了SQLC如何解析SQL并生成代码。

version: "2"
sql:
  - engine: "postgresql"
    queries: "query.sql"    # SQL查询文件路径
    schema: "schema.sql"   # 数据库模式定义文件路径
    gen:
      go:
        package: "tutorial" # 生成的Go包名
        out: "tutorial"    # 输出目录
        sql_package: "pgx/v5" # 使用的PostgreSQL驱动

这个基础配置告诉SQLC：

使用PostgreSQL作为数据库引擎
从query.sql读取SQL查询
从schema.sql读取数据库模式定义
生成Go代码到tutorial目录
使用pgx/v5作为PostgreSQL驱动

查询类型支持

SQLC支持生成各种类型的数据库操作代码，包括但不限于：

数据检索（SELECT查询）
数据插入（INSERT语句）
数据更新（UPDATE语句）
数据删除（DELETE语句）

每种操作类型都有特定的代码生成规则，确保生成的代码既类型安全又高效。

分析引擎选项

SQLC提供两种分析SQL查询的方式：

1. 内置分析引擎（默认）

特点：

速度快，无需外部依赖
适合大多数简单到中等复杂度的查询
对复杂查询和类型推断能力有限

2. 数据库辅助分析（增强模式）

特点：

利用实际数据库的元数据进行更精确的分析
支持更复杂的查询和更准确的类型推断
目前仅支持PostgreSQL（MySQL和SQLite支持正在开发中）

使用托管数据库增强分析

SQLC提供了托管数据库选项，可以自动创建临时的托管数据库来改进查询分析：

version: "2"
servers:
- engine: postgresql
  uri: "postgres://locahost:5432/postgres?sslmode=disable"
sql:
  - engine: "postgresql"
    queries: "query.sql"
    schema: "schema.sql"
    database:
      managed: true    # 启用托管数据库
    gen:
      go:
        out: "db"
        sql_package: "pgx/v5"

优势：

自动创建临时数据库实例
使用真实数据库元数据进行精确分析
本地缓存分析结果加速后续生成
无需自行维护数据库实例

使用自有数据库增强分析

开发者也可以配置SQLC使用自己的数据库进行分析：

version: "2"
sql:
  - engine: "postgresql"
    queries: "query.sql"
    schema: "schema.sql"
    database:
      uri: "postgres://postgres:${PG_PASSWORD}@localhost:5432/postgres"
    gen:
      go:
        out: "db"
        sql_package: "pgx/v5"

重要注意事项：