使用 sqlc 生成类型安全的Go代码与SQL数据库交互

小小小熊猫5

已于 2023-10-06 21:13:54 修改

阅读量972

点赞数

CC 4.0 BY-SA版权

分类专栏：代码生成器文章标签：数据库安全 golang

于 2023-10-06 21:07:17 首次发布

本文链接：https://blog.csdn.net/trinityleo5/article/details/132112084

本文介绍了sqlc，一个用于从SQL查询生成类型安全Go代码的工具，详细讲解了安装、配置、创建SQL文件、生成代码以及在Go项目中使用的步骤。

什么是sqlc

sqlc 官方文档

sqlc 是一个用于生成类型安全的 Go 代码的工具，用于与 SQL 数据库进行交互。它通过分析 SQL 查询语句来生成 Go 代码，该代码映射数据库表和列，并提供类型安全的方法来执行查询、插入、更新和删除等操作。

sqlc 支持多种 SQL 数据库，包括 PostgreSQL、MySQL、SQLite、Microsoft SQL Server 等。它通过配置文件定义数据库模式，并生成 Go 代码以便与数据库进行交互。这使得在 Go 项目中使用 SQL 数据库变得更加容易和类型安全。

安装sqlc：`brew install sqlc`

在 macOS 上，可以使用 Homebrew 进行安装，只需运行以下命令：

brew install sqlc

安装完成后，可以验证是否成功安装 sqlc，运行以下命令检查版本信息：

sqlc version

查看命令帮助

sqlc help

使用sqlc

1. 创建SQL文件

首先，在你的项目中创建 SQL 文件，以定义数据库表结构和 SQL 查询语句。例如，你可以创建一个 create.sql 文件，用于定义数据库表结构，并创建一个 query.sql 文件，用于包含查询语句。在这些 SQL 文件中，你可以定义数据库表、列以及各种 SQL 查询，如创建、查询、更新和删除等。

/sql/create.sql

# 数据库初始化
-- 创建库
create database if not exists dbnamexxx;

-- 切换库
use dbnamexxx;

-- 用户表
create table if not exists user
(
    id           bigint auto_increment comment 'id' primary key,
    userAccount  varchar(256)                           not null comment '账号',
    userPassword varchar(512)                           not null comment '密码',
    userRole     varchar(256) default 'user'            not