Go语言sqlc代码生成器_Golang SQL到类型安全Go代码

P粉328763957

P粉328763957

2026-06-03

477人浏览

原创

sqlc生成代码需严格满足格式:sql文件中每条语句必须以顶格-- name: xxx :many开头(空格不可少、不可缩进、不可重复),且语句间需空行;:one/:many/:exec须小写;路径需用glob如./query/*.sql;emit_db_tags: true和emit_context: true须显式启用,否则字段扫描失败或无context支持。

go语言sqlc代码生成器_golang sql到类型安全go代码

别用 ORM 或手写模板生成 CRUD——sqlc 是当前最稳的 Go SQL 代码生成方案。它不运行时拼 SQL,不反射,不 magic string,只把 SELECT id, name FROM users 编译成 func (q *Queries) GetUsers(ctx context.Context) ([]User, error),类型错、字段改名、JOIN 结构嵌套问题全在编译期暴露。

sqlc generate 报 “no statements found” 怎么办

这不是语法错误,是 sqlc 根本没读到有效 SQL 语句。它只认一种入口:顶格写的 -- name: GetUsers :many 注释,且必须带空格、不能缩进、不能重复。

  • --name: GetUser(缺空格)、 -- name: GetUser(有缩进)、-- name: GetUser 出现两次 → 全部静默跳过
  • .sql 文件里每条语句之间必须有空行;:one/:many/:exec 必须小写,写成 :ONE:One 就无效
  • VS Code 的 SQLTools 插件可能插入不可见 Unicode 字符,建议用 cat -A query/users.sql 检查
  • 确保 sqlc.yamlqueries 路径是 glob 形式,比如 ./query/*.sql,不是 ./query/users.sql(除非你真只读一个文件)

生成的代码编译失败:undefined User 或 missing db tag

常见原因是 schema 没加载或字段映射崩了。sqlc 不会凭空造 struct,它靠解析 CREATE TABLE DDL 来推字段类型和名字。

Go语言(Golang)1.26.0
Go语言(Golang)1.26.0

Go语言(Golang)1.26.0版本提供 Go 官方 Windows amd64 MSI 安装包下载入口,版本号 1.26.0,可用于旧项目维护、兼容性测试和指定版本开发环境配置。

下载
  • schema 路径下必须是真实 DDL(如 CREATE TABLE users (id SERIAL PRIMARY KEY, name TEXT)),不能是空文件、连接串或 CREATE EXTENSION(PostgreSQL 用户务必删掉或注释掉这类语句)
  • 启用 emit_db_tags: true(默认开),否则生成的 struct 字段没有 db:"user_id" 标签,database/sqlScan 会失败
  • 字段名含下划线(如 user_id_v2)默认映射为 UserIDV2;若数据库列是 user_id_2,则映射成 UserID2 —— 命名不一致会导致 scan 零值
  • 如果用了 AS 别名(SELECT name AS full_name),struct 字段的 db 标签必须写成 db:"full_name"

怎么让生成函数带 context.Context 参数

老项目升级或新建时容易漏掉这个开关:emit_context: true 不开,所有方法签名都是 GetUser(id int) (User, error),没法超时控制,线上易出长尾请求。

  • 必须显式加在 sqlc.yamlpackages 下(v1.14+ 默认不开启)
  • 开了之后签名变成 GetUser(ctx context.Context, id int) (User, error),但 sqlc 不管你传的是 context.Background() 还是 context.WithTimeout(),只负责透传
  • 事务场景下,ctx 应该来自外层 handler,不是在 Queries 初始化时塞进去的
  • 别手动改生成代码加 ctx——下次 sqlc generate 就被覆盖

PostgreSQL jsonb / uuid / timestamptz 字段生成后怎么用

sqlc 默认把 jsonb[]byteuuidstringtimestamptztime.Time,看着能跑,实际常踩坑。

  • jsonb 字段想映射成 map[string]interface{}?不行。得自己实现 sql.Scannerdriver.Valuer,或用 pgtype.JSONB 配合
  • 要让 uuid 字段生成 github.com/google/uuid.UUID 类型,必须在 sqlc.yamloverrides
overrides:
- db_type: "uuid"
  go_type: "github.com/google/uuid.UUID"
  go_imports:
    - "github.com/google/uuid"
  • timestamptz 映射为 time.Time 没问题,但时区丢失往往是因为数据库连接串没加 timezone=UTC,不是 sqlc 的锅
  • 数组类型(如 text[])默认也是 []byte,需同理 override 或自定义扫描逻辑
  • 最常被忽略的一点:sqlc 生成的是纯函数,不管理连接、不注册驱动、不初始化 pool。你传进去的 *sql.DB 必须已调用 sql.Open 并完成 SetMaxOpenConns 等配置,否则运行时报 nil pointerdriver: bad connection —— 这些错误跟 sqlc 本身无关,但新手总以为是生成器坏了。

    golang免费学习笔记(深入):立即使用
    在学习笔记中,你将探索golang的核心概念和高级技巧!

    相关文章

    PHP速学视频免费教程(入门到精通)
    PHP速学视频免费教程(入门到精通)

    PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

    下载

    相关标签:

    golang go语言

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

    相关专题

    更多
    C语言变量命名
    C语言变量命名

    c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

    2023.06.20

    1372

    3

    c语言入门自学零基础
    c语言入门自学零基础

    C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

    2023.07.25

    1560

    9

    c语言运算符的优先级顺序
    c语言运算符的优先级顺序

    c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

    2023.08.02

    692

    5

    c语言数据结构
    c语言数据结构

    数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

    2023.08.09

    551

    4

    c语言random函数用法
    c语言random函数用法

    c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

    2023.09.05

    910

    5

    c语言const用法
    c语言const用法

    const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

    2023.09.20

    1128

    7

    c语言get函数的用法
    c语言get函数的用法

    get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

    2023.09.20

    1683

    8

    c数组初始化的方法
    c数组初始化的方法

    c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

    2023.09.22

    5634

    6

    c语言中null和NULL的区别
    c语言中null和NULL的区别

    c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

    2023.09.22

    420

    3

    热门下载

    更多
    网站特效
    /
    网站源码
    /
    网站素材
    /
    前端模板

    精品课程

    更多
    相关推荐
    /
    热门推荐
    /
    最新课程
    golang入门到项目实战教程
    golang入门到项目实战教程

    共0课时 | 0人学习

    golang socket 编程
    golang socket 编程

    共2课时 | 0.2万人学习