使用sqlc生成Go语言pgx驱动PostgreSQL代码指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00405/article/details/148377568

使用sqlc生成Go语言pgx驱动PostgreSQL代码指南

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

前言

在Go语言生态中，PostgreSQL数据库驱动经历了从lib/pq到pgx的演进。pgx作为新一代纯Go实现的PostgreSQL驱动和工具包，因其高性能和丰富的功能特性，已成为许多Gopher的首选。本文将详细介绍如何利用sqlc工具生成基于pgx的PostgreSQL数据库访问代码。

pgx驱动简介

pgx是专为PostgreSQL设计的Go语言驱动，相比传统的database/sql接口，它提供了更多PostgreSQL特有的功能支持，包括：

更高效的二进制协议支持
内置连接池管理
对PostgreSQL特有数据类型的原生支持
更精细的错误处理机制

sqlc从v1.18.0版本开始全面支持pgx v5，为开发者提供了更现代化的数据库访问方案。

项目配置

要使用sqlc生成pgx兼容的代码，需要在项目配置文件中明确指定sql_package字段：

version: "2"
sql:
  - engine: "postgresql"
    queries: "query.sql"
    schema: "query.sql"
    gen:
      go:
        package: "db"
        sql_package: "pgx/v5"
        out: "db"

关键配置项说明：

sql_package: 设置为"pgx/v5"表示使用pgx v5驱动
package: 生成的Go代码包名
out: 代码输出目录

数据库模式定义

在query.sql文件中定义数据库表结构和查询语句：

CREATE TABLE authors (
  id   BIGSERIAL PRIMARY KEY,
  name text      NOT NULL,
  bio  text
);

-- name: GetAuthor :one
SELECT * FROM authors
WHERE id = $1 LIMIT 1;

-- name: ListAuthors :many
SELECT * FROM authors
ORDER BY name;

-- name: CreateAuthor :one
INSERT INTO authors (
  name, bio
) VALUES (
  $1, $2
)
RETURNING *;

-- name: DeleteAuthor :exec
DELETE FROM authors
WHERE id = $1;

sqlc会根据SQL注释中的特殊标记生成对应的方法：

:one: 返回单条记录
:many: 返回多条记录
:exec: 执行但不返回记录

代码生成与使用

执行生成命令：

sqlc generate

生成的代码可以直接使用pgx进行数据库操作：

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/jackc/pgx/v5"
	"example.com/sqlc-tutorial/db"
)

func main() {
	conn, err := pgx.Connect(context.Background(), os.Getenv("DATABASE_URL"))
	if err != nil {
		fmt.Fprintf(os.Stderr, "Unable to connect to database: %v\n", err)
		os.Exit(1)
	}
	defer conn.Close(context.Background())

	queries := db.New(conn)
	
	// 查询单个作者
	author, err := queries.GetAuthor(context.Background(), 1)
	if err != nil {
		fmt.Fprintf(os.Stderr, "GetAuthor failed: %v\n", err)
		os.Exit(1)
	}
	fmt.Println(author.Name)
	
	// 创建新作者
	newAuthor, err := queries.CreateAuthor(context.Background(), 
		db.CreateAuthorParams{
			Name: "John Doe",
			Bio:  "Technical Writer",
		})
	if err != nil {
		fmt.Fprintf(os.Stderr, "CreateAuthor failed: %v\n", err)
		os.Exit(1)
	}
	fmt.Printf("Created author with ID: %d\n", newAuthor.ID)
}

最佳实践

连接管理：建议使用pgxpool管理数据库连接池，而非直接使用pgx.Connect
事务处理：sqlc生成的代码天然支持事务

tx, err := conn.Begin(context.Background())
if err != nil {
    // 处理错误
}
defer tx.Rollback(context.Background())

qtx := queries.WithTx(tx)
// 在事务中执行操作