sqlc-migration

星标12

分支6

更新时间2026年7月1日 20:07

Add or change a database schema in a PROMPT 2.0 Go service using golang-migrate + sqlc — write the migration and queries, regenerate type-safe Go, and stay green on the migration CI check. Use when adding a table/column, writing SQL queries, or running sqlc.

安装

用 Codex 或 Claude 帮你安装复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。

来源

prompt-edu

prompt-edu/prompt

打开 GitHub 仓库查看创作者相关仓库

下载

1. Write the migration

Migrations are in servers/<service>/db/migration/, numbered sequentially: NNNN_short_description.up.sql (zero-padded 4 digits, next number after the highest existing one).
Down migrations are OPTIONAL and inconsistent across services — only add a matching NNNN_short_description.down.sql if that service already ships .down.sql files (ls servers/<service>/db/migration/*.down.sql). If it doesn't, stay up-only to match convention.
Keep one logical change per migration; never edit an already-merged migration — add a new one.

2. Write queries

Add/extend SQL in servers/<service>/db/query/*.sql with sqlc annotations, e.g.:
```
-- name: GetTutors :many
SELECT * FROM tutors WHERE course_phase_id = $1;
```
Use :one, :many, :exec, :execrows as appropriate.

3. Regenerate Go

From servers/<service>/: sqlc generate (config in sqlc.yaml; output lands in db/sqlc/, package db, pgx/v5). Or make sqlc-<service> from the repo root.

Use generated methods in services:

import db "github.com/prompt-edu/prompt/servers/<service>/db/sqlc"
tutors, err := queries.GetTutors(ctx, coursePhaseID)

4. Verify (matches CI)

cd servers/<service> && go build ./... && go test ./... (tests use testcontainers-go).
The detect-migrations.yml workflow flags migration changes — ensure new files follow the NNNN_*.up.sql naming and that db/sqlc/ was regenerated and committed alongside the migration.
Never commit a migration without its regenerated db/sqlc/ changes.

同仓库更多 Skills

同仓库

new-course-phase

prompt-edu/prompt

Scaffold a new PROMPT 2.0 course phase end-to-end — a micro-frontend (clients/) plus a Go microservice (servers/) wired into Module Federation, the workspaces, and docker-compose. Use when asked to add a new course phase, component, or phase module/service.

2026-07-1512

add-shared-ui-component

prompt-edu/prompt

Add or reuse a shared UI component in PROMPT 2.0 — install shadcn/ui primitives into the shared_library and surface them via @tumaet/prompt-ui-components instead of writing custom UI. Use when adding a button/dialog/table/form or any reusable UI element.

2026-07-0112

address-pr-comments

prompt-edu/prompt

Address unresolved review comments on the current branch's GitHub PR — fetch the open threads, fix the code, and push. Use when asked to handle, resolve, or respond to PR review comments/feedback.

2026-07-0112

docker-patterns

prompt-edu/prompt

Docker Compose patterns for PROMPT's local multi-service stack — networking, volumes, container security, and debugging. Use when editing docker-compose*.yml, adding a service, or troubleshooting containers.

2026-07-0112

github-release-creation

prompt-edu/prompt

Create a GitHub release for the PROMPT 2.0 repository. Use this when asked to create, draft, or publish a GitHub release.

2026-07-0112

golang-patterns

prompt-edu/prompt

Deeper idiomatic Go patterns for PROMPT's services — concurrency (errgroup, context, goroutine leaks), error wrapping, and performance idioms. The go/ rules point here for these; they own the Gin/pgx/sqlc conventions.

2026-07-0112

name	sqlc-migration
description	Add or change a database schema in a PROMPT 2.0 Go service using golang-migrate + sqlc — write the migration and queries, regenerate type-safe Go, and stay green on the migration CI check. Use when adding a table/column, writing SQL queries, or running sqlc.
argument-hint	<server name, e.g. core \| assessment \| interview>

1. Write the migration

Migrations are in servers/<service>/db/migration/, numbered sequentially: NNNN_short_description.up.sql (zero-padded 4 digits, next number after the highest existing one).
Down migrations are OPTIONAL and inconsistent across services — only add a matching NNNN_short_description.down.sql if that service already ships .down.sql files (ls servers/<service>/db/migration/*.down.sql). If it doesn't, stay up-only to match convention.
Keep one logical change per migration; never edit an already-merged migration — add a new one.

2. Write queries

Add/extend SQL in servers/<service>/db/query/*.sql with sqlc annotations, e.g.:
```
-- name: GetTutors :many
SELECT * FROM tutors WHERE course_phase_id = $1;
```
Use :one, :many, :exec, :execrows as appropriate.

3. Regenerate Go

From servers/<service>/: sqlc generate (config in sqlc.yaml; output lands in db/sqlc/, package db, pgx/v5). Or make sqlc-<service> from the repo root.

Use generated methods in services:

import db "github.com/prompt-edu/prompt/servers/<service>/db/sqlc"
tutors, err := queries.GetTutors(ctx, coursePhaseID)

4. Verify (matches CI)

cd servers/<service> && go build ./... && go test ./... (tests use testcontainers-go).
The detect-migrations.yml workflow flags migration changes — ensure new files follow the NNNN_*.up.sql naming and that db/sqlc/ was regenerated and committed alongside the migration.
Never commit a migration without its regenerated db/sqlc/ changes.