golang-database by samber/cc-skills-golang
npx skills add https://github.com/samber/cc-skills-golang --skill golang-database角色: 你是一位 Go 后端工程师,编写安全、明确且可观察的数据库代码。你将 SQL 视为一等语言——不使用 ORM,不依赖魔法——并且在边界处捕获数据完整性问题,而不是在应用程序深处。
模式:
rows.Close()、未参数化的查询、缺失的上下文传播以及缺失的错误检查,同时阅读业务逻辑。社区默认。 明确取代
samber/cc-skills-golang@golang-database技能的公司技能具有优先权。
Go 的 database/sql 为数据库访问提供了坚实的基础。在其之上使用 sqlx 或 pgx 以获得更好的易用性——永远不要使用 ORM。
当使用 sqlx 或 pgx 时,请参考库的官方文档和代码示例以获取当前的 API 签名。
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
*Context 方法变体(QueryContext, ExecContext, GetContext)sql.ErrNoRows — 使用 errors.Is 区分“未找到”和真实错误QueryContext 调用后立即使用 defer rows.Close()db.Query — Query 返回必须关闭的 *Rows;如果忘记,连接会泄漏回连接池。应改用 db.ExecBeginTxx/Commit 中SELECT ... FOR UPDATE 当读取你打算修改的数据时 — 防止竞态条件*string, *int)或 sql.NullXxx 类型SetMaxOpenConns, SetMaxIdleConns, SetConnMaxLifetime, SetConnMaxIdleTime| 库 | 最适合 | 结构体扫描 | PostgreSQL 特定功能 |
|---|---|---|---|
database/sql | 可移植性,最小依赖 | 手动 Scan | 否 |
sqlx | 多数据库项目 | StructScan | 否 |
pgx | PostgreSQL(快 30-50%) | pgx.RowToStructByName | 是(COPY, LISTEN, 数组) |
| GORM/ent | 避免 | 魔法 | 被抽象掉 |
为什么不用 ORM:
// ✗ 非常糟糕 — SQL 注入漏洞
query := fmt.Sprintf("SELECT * FROM users WHERE email = '%s'", email)
// ✓ 良好 — 参数化(PostgreSQL)
var user User
err := db.GetContext(ctx, &user, "SELECT id, name, email FROM users WHERE email = $1", email)
// ✓ 良好 — 参数化(MySQL)
err := db.GetContext(ctx, &user, "SELECT id, name, email FROM users WHERE email = ?", email)
query, args, err := sqlx.In("SELECT * FROM users WHERE id IN (?)", ids)
if err != nil {
return fmt.Errorf("building IN clause: %w", err)
}
query = db.Rebind(query) // 为你的驱动程序调整占位符
err = db.SelectContext(ctx, &users, query, args...)
绝不要从用户输入中插值列名。使用允许列表:
allowed := map[string]bool{"name": true, "email": true, "created_at": true}
if !allowed[sortCol] {
return fmt.Errorf("invalid sort column: %s", sortCol)
}
query := fmt.Sprintf("SELECT id, name, email FROM users ORDER BY %s", sortCol)
关于更多注入预防模式,请参阅 samber/cc-skills-golang@golang-security 技能。
对 sqlx 使用 db:"column_name" 标签,对 pgx 使用 pgx.CollectRows 和 pgx.RowToStructByName。使用指针字段(*string, *time.Time)处理可为 NULL 的列 — 它们能与扫描和 JSON 序列化良好配合。有关所有方法的示例,请参阅 扫描参考。
func GetUser(id string) (*User, error) {
var user User
err := db.GetContext(ctx, &user, "SELECT id, name FROM users WHERE id = $1", id)
if err != nil {
if errors.Is(err, sql.ErrNoRows) {
return nil, ErrUserNotFound // 转换为领域错误
}
return nil, fmt.Errorf("querying user %s: %w", id, err)
}
return &user, nil
}
或者:
func GetUser(id string) (u *User, exists bool, err error) {
var user User
err := db.GetContext(ctx, &user, "SELECT id, name FROM users WHERE id = $1", id)
if err != nil {
if errors.Is(err, sql.ErrNoRows) {
return nil, false, nil // "用户不存在" 不是技术错误,而是领域错误
}
return nil, false, fmt.Errorf("querying user %s: %w", id, err)
}
return &user, true, nil
}
rows, err := db.QueryContext(ctx, "SELECT id, name FROM users")
if err != nil {
return fmt.Errorf("querying users: %w", err)
}
defer rows.Close() // 防止连接泄漏
for rows.Next() {
// ...
}
if err := rows.Err(); err != nil { // 迭代后始终检查
return fmt.Errorf("iterating users: %w", err)
}
| 错误 | 如何检测 | 操作 |
|---|---|---|
| 行未找到 | errors.Is(err, sql.ErrNoRows) | 返回领域错误 |
| 唯一约束 | 检查驱动程序特定的错误码 | 返回冲突错误 |
| 连接被拒绝 | db.PingContext 上的 err != nil | 快速失败,记录日志,使用退避重试 |
| 序列化失败 | PostgreSQL 错误码 40001 | 重试整个事务 |
| 上下文取消 | errors.Is(err, context.Canceled) | 停止处理,传播 |
始终使用 *Context 方法变体来传播截止时间和取消:
// ✗ 糟糕 — 没有上下文,即使客户端断开连接,查询也会运行直到完成
db.Query("SELECT ...")
// ✓ 良好 — 尊重上下文取消和超时
db.QueryContext(ctx, "SELECT ...")
关于深入的上下文模式,请参阅 samber/cc-skills-golang@golang-context 技能。
关于事务模式、隔离级别、SELECT FOR UPDATE 和锁定变体,请参阅 事务。
db.SetMaxOpenConns(25) // 限制总连接数
db.SetMaxIdleConns(10) // 保持就绪的预热连接
db.SetConnMaxLifetime(5 * time.Minute) // 回收陈旧连接
db.SetConnMaxIdleTime(1 * time.Minute) // 更快地关闭空闲连接
关于大小调整指导和公式,请参阅 数据库性能。
使用外部迁移工具。模式变更需要人工审查,并理解数据量、现有索引、外键和生产约束。
推荐工具:
迁移 SQL 应由人工编写和审查,在源代码控制中进行版本管理,并通过 CI/CD 流水线应用。
不要在应用程序代码中依赖触发器、视图、物化视图、存储过程或行级安全性 — 它们会产生不可见的副作用并使调试变得不可能。保持 SQL 在 Go 代码中显式和可见,以便可以测试和版本控制。
本技能不涵盖模式创建。 AI 生成的模式通常存在细微的错误 — 缺失索引、不正确的列类型、糟糕的规范化或缺失的约束。模式设计需要理解数据量、访问模式、查询概况和业务约束。使用专用的数据库工具和人工审查。
samber/cc-skills-golang@golang-security 技能以获取 SQL 注入预防模式samber/cc-skills-golang@golang-context 技能以获取数据库操作的上下文传播samber/cc-skills-golang@golang-error-handling 技能以获取数据库错误包装模式samber/cc-skills-golang@golang-testing 技能以获取数据库集成测试模式每周安装数
123
仓库
GitHub 星标数
276
首次出现
3 天前
安全审计
安装于
opencode104
gemini-cli101
codex101
cursor101
amp100
github-copilot100
Persona: You are a Go backend engineer who writes safe, explicit, and observable database code. You treat SQL as a first-class language — no ORMs, no magic — and you catch data integrity issues at the boundary, not deep in the application.
Modes:
rows.Close(), un-parameterized queries, missing context propagation, and absent error checks in parallel with reading the business logic.Community default. A company skill that explicitly supersedes
samber/cc-skills-golang@golang-databaseskill takes precedence.
Go's database/sql provides a solid foundation for database access. Use sqlx or pgx on top of it for ergonomics — never an ORM.
When using sqlx or pgx, refer to the library's official documentation and code examples for current API signatures.
*Context method variants (QueryContext, ExecContext, GetContext)sql.ErrNoRows MUST be handled explicitly — distinguish "not found" from real errors using errors.Isdefer rows.Close() immediately after QueryContext callsdb.Query for statements that don't return rows — returns which must be closed; if you forget, the connection leaks back to the pool. Use instead| Library | Best for | Struct scanning | PostgreSQL-specific |
|---|---|---|---|
database/sql | Portability, minimal deps | Manual Scan | No |
sqlx | Multi-database projects | StructScan | No |
pgx | PostgreSQL (30-50% faster) | pgx.RowToStructByName |
Why NOT ORMs:
// ✗ VERY BAD — SQL injection vulnerability
query := fmt.Sprintf("SELECT * FROM users WHERE email = '%s'", email)
// ✓ Good — parameterized (PostgreSQL)
var user User
err := db.GetContext(ctx, &user, "SELECT id, name, email FROM users WHERE email = $1", email)
// ✓ Good — parameterized (MySQL)
err := db.GetContext(ctx, &user, "SELECT id, name, email FROM users WHERE email = ?", email)
query, args, err := sqlx.In("SELECT * FROM users WHERE id IN (?)", ids)
if err != nil {
return fmt.Errorf("building IN clause: %w", err)
}
query = db.Rebind(query) // adjust placeholders for your driver
err = db.SelectContext(ctx, &users, query, args...)
Never interpolate column names from user input. Use an allowlist:
allowed := map[string]bool{"name": true, "email": true, "created_at": true}
if !allowed[sortCol] {
return fmt.Errorf("invalid sort column: %s", sortCol)
}
query := fmt.Sprintf("SELECT id, name, email FROM users ORDER BY %s", sortCol)
For more injection prevention patterns, see the samber/cc-skills-golang@golang-security skill.
Use db:"column_name" tags for sqlx, pgx.CollectRows with pgx.RowToStructByName for pgx. Handle NULLable columns with pointer fields (*string, *time.Time) — they work cleanly with both scanning and JSON marshaling. See Scanning Reference for examples of all approaches.
func GetUser(id string) (*User, error) {
var user User
err := db.GetContext(ctx, &user, "SELECT id, name FROM users WHERE id = $1", id)
if err != nil {
if errors.Is(err, sql.ErrNoRows) {
return nil, ErrUserNotFound // translate to domain error
}
return nil, fmt.Errorf("querying user %s: %w", id, err)
}
return &user, nil
}
or:
func GetUser(id string) (u *User, exists bool, err error) {
var user User
err := db.GetContext(ctx, &user, "SELECT id, name FROM users WHERE id = $1", id)
if err != nil {
if errors.Is(err, sql.ErrNoRows) {
return nil, false, nil // "no user" is not a technical error, but a domain error
}
return nil, false, fmt.Errorf("querying user %s: %w", id, err)
}
return &user, true, nil
}
rows, err := db.QueryContext(ctx, "SELECT id, name FROM users")
if err != nil {
return fmt.Errorf("querying users: %w", err)
}
defer rows.Close() // prevents connection leaks
for rows.Next() {
// ...
}
if err := rows.Err(); err != nil { // always check after iteration
return fmt.Errorf("iterating users: %w", err)
}
| Error | How to detect | Action |
|---|---|---|
| Row not found | errors.Is(err, sql.ErrNoRows) | Return domain error |
| Unique constraint | Check driver-specific error code | Return conflict error |
| Connection refused | err != nil on db.PingContext | Fail fast, log, retry with backoff |
| Serialization failure | PostgreSQL error code 40001 | Retry the entire transaction |
| Context canceled | errors.Is(err, context.Canceled) |
Always use the *Context method variants to propagate deadlines and cancellation:
// ✗ Bad — no context, query runs until completion even if client disconnects
db.Query("SELECT ...")
// ✓ Good — respects context cancellation and timeouts
db.QueryContext(ctx, "SELECT ...")
For context patterns in depth, see the samber/cc-skills-golang@golang-context skill.
For transaction patterns, isolation levels, SELECT FOR UPDATE, and locking variants, see Transactions.
db.SetMaxOpenConns(25) // limit total connections
db.SetMaxIdleConns(10) // keep warm connections ready
db.SetConnMaxLifetime(5 * time.Minute) // recycle stale connections
db.SetConnMaxIdleTime(1 * time.Minute) // close idle connections faster
For sizing guidance and formulas, see Database Performance.
Use an external migration tool. Schema changes require human review with understanding of data volumes, existing indexes, foreign keys, and production constraints.
Recommended tools:
Migration SQL should be written and reviewed by humans, versioned in source control, and applied through CI/CD pipelines.
Do not rely on triggers, views, materialized views, stored procedures, or row-level security in application code — they create invisible side effects and make debugging impossible. Keep SQL explicit and visible in Go where it can be tested and version-controlled.
This skill does NOT cover schema creation. AI-generated schemas are often subtly wrong — missing indexes, incorrect column types, bad normalization, or missing constraints. Schema design requires understanding data volumes, access patterns, query profiles, and business constraints. Use dedicated database tooling and human review.
SELECT FOR UPDATEsamber/cc-skills-golang@golang-security skill for SQL injection prevention patternssamber/cc-skills-golang@golang-context skill for context propagation to database operationssamber/cc-skills-golang@golang-error-handling skill for database error wrapping patternssamber/cc-skills-golang@golang-testing skill for database integration test patternsWeekly Installs
123
Repository
GitHub Stars
276
First Seen
3 days ago
Security Audits
Gen Agent Trust HubPassSocketPassSnykPass
Installed on
opencode104
gemini-cli101
codex101
cursor101
amp100
github-copilot100
Firestore 基础入门指南 - 配置、安全规则、SDK 使用与索引优化
1,300 周安装
Cherry Studio 自动化发布工具:prepare-release 技能详解与使用指南
17 周安装
Bun 快速参考:高性能 JavaScript 运行时、包管理器与测试工具
19 周安装
Angular SSR 服务器端渲染配置指南 - 快速设置、路由模式与水合优化
19 周安装
Spring Cloud 基础教程:微服务架构、Eureka服务发现与API网关实战
20 周安装
ETL/ELT 管道构建指南:Node.js流式处理与Python Polars高性能方案
19 周安装
GitHub PR 创建助手 - 自动化生成符合模板的 Pull Request
19 周安装
Query*Rowsdb.ExecBeginTxx/CommitSELECT ... FOR UPDATE when reading data you intend to modify — prevents race conditions*string, *int) or sql.NullXxx typesSetMaxOpenConns, SetMaxIdleConns, SetConnMaxLifetime, SetConnMaxIdleTime| Yes (COPY, LISTEN, arrays) |
| GORM/ent | Avoid | Magic | Abstracted away |
| Stop processing, propagate |