Go语言如何用sqlc_Go语言sqlc代码生成教程【精通】

千晨酱_9684

千晨酱_9684

2026-03-28

176人浏览

原创

sqlc只生成查询逻辑代码,不自动导入database/sql或数据库驱动,需手动配置驱动注册、连接池及context支持;占位符必须用$1格式,且driver配置仅影响sql解析与类型映射。

go语言如何用sqlc_go语言sqlc代码生成教程【精通】

sqlc 生成的代码为什么跑不起来?

常见现象是 go run 报错:找不到 QueryRow 方法,或类型不匹配——根本原因不是 sqlc 用错了,而是它只生成「查询逻辑」,不帮你配数据库驱动和连接池。

  • sqlc 不会自动 import "database/sql" 或具体驱动(如 "github.com/lib/pq"),你得自己加
  • 生成的 struct 和方法依赖 sql.NullString 这类类型,但如果你没在 db.go 里注册驱动,sql.Open 会 panic
  • 别直接 go run main.go 就完事,先确认 sqlc generate 后生成的 db/ 下有 queries.sql.go 和 models.go,且路径被 go mod 正确识别

sqlc.yaml 配置里 driver: postgres 是什么意思?

它只告诉 sqlc:「按 PostgreSQL 的语法解析 SQL、按 pg 的类型映射生成 Go 类型」,和运行时用什么数据库无关。哪怕你最终连的是 CockroachDB 或本地 SQLite(通过适配层),只要 SQL 写法兼容 pg,这个配置就成立。

  • driver: "postgresql"(注意不是 postgres)才是 sqlc v1.20+ 推荐写法,旧版写 postgres 会警告
  • 如果 SQL 文件里用了 RETURNING *,而你配了 driver: "mysql",sqlc 会直接报错:不支持该语法 —— 它真正在意的是「SQL 能不能被它 parse 通」
  • 生成的代码里不会出现 pgx 或 pq,所有 DB 操作仍走标准 *sql.DB,换驱动只需改 sql.Open("pgx", ...) 这一行

怎么让 sqlc 生成带 context 的方法?

默认生成的是无 context 版本(比如 GetUser(id int) (User, error)),要启用 context 支持,必须在 sqlc.yaml 里显式打开:

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

Go语言(Golang)1.26.0版本官方下载,版本号 1.26.0,适合旧项目维护、兼容性测试和指定版本开发环境搭建。

下载
version: "2"
packages:
- name: "db"
  path: "./db"
  queries: "./query/*.sql"
  schema: "./schema.sql"
  engine: "postgresql"
  emit_json_tags: true
  emit_interface: true
  emit_exact_table_names: true
  emit_empty_slices: true
  <strong>emit_method_comments: true</strong><strong>emit_pointers_for_null_types: true</strong><strong>emit_db_tags: true</strong><strong>emit_exported_queries: true</strong><strong>emit_interface: true</strong>
  # ?关键项
  <strong>emit_context: true</strong>

加了 emit_context: true 后,方法签名变成 GetUser(ctx context.Context, id int) (User, error),且所有内部调用都透传 ctx —— 但注意:sqlc 不管你传进来的是 context.Background() 还是带 timeout 的,它只负责把参数接住、往下传。

  • 没开这个选项,硬在调用侧加 context.WithTimeout 也没用,底层还是阻塞式调用
  • 开了之后,若你用的是 pgx/v5 驱动,context 才真正生效;用 lib/pq 则仅对连接建立阶段起作用(执行阶段不中断)
  • 别指望 sqlc 自动生成 WithCancel 或超时逻辑,那是你业务层的事

SQL 文件里写 $1 还是 ?,会不会影响生成?

sqlc 强制要求使用 PostgreSQL 风格的占位符:$1, $2…… 它不认 MySQL 的 ? 或命名参数 :name。写错直接报错:error: unsupported placeholder "?": only "$N" style is supported。

  • 即使你最终连的是 MySQL,只要配置 driver: "postgresql",SQL 就得按 pg 写法来(比如用 ILIKE 而非 LIKE + LOWER())
  • WHERE id = $1 AND name ILIKE $2 这种写法会被正确映射为两个参数,顺序严格对应,别指望它自动重排
  • 嵌套 CTE 或 VALUES 子句里也得用 $1,例如 INSERT INTO users VALUES ($1, $2) —— sqlc 不做语义分析,只做语法树解析

sqlc 的边界很清晰:它是个 SQL 到 Go 的翻译器,不是 ORM,也不封装连接管理。最容易卡住的地方,往往是以为它“该干的都干了”,结果发现连 sql.Open 都得自己写三行。

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

相关专题

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

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

2023.06.20

3269

3

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

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

2023.07.25

2348

9

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

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

2023.08.02

1280

5

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

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

2023.08.09

1238

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

1376

5

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

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

2023.09.20

2218

7

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

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

2023.09.20

3580

8

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

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

2023.09.22

16415

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程