AGENT SKILL

rust-sqlx-postgres-service

Use when adding, changing, testing, or reviewing Postgres persistence in Rust services that use sqlx, especially when designing migrations, query! or query_as! calls, PgPool injection, transactions, compile-time checked SQL, SQLx offline mode, repository boundaries, or database-backed integration tests.

License 许可
MIT
最近更新
2026-11-14
Stars
★ 1.6k
Forks
491

01 前言 Front Matter

name
rust-sqlx-postgres-service
license
MIT
metadata
{ "tags": "rust,sqlx,postgres,migrations,persistence", "version": "0.1.0", "category": "Rust", "displayName": "Rust SQLx Postgres Service" }
description
Use when adding, changing, testing, or reviewing Postgres persistence in Rust services that use sqlx, especially when designing migrations, query! or query_as! calls, PgPool injection, transactions, compile-time checked SQL, SQLx offline mode, repository boundaries, or database-backed integration tests.
compatibility
Codex, Claude Code, and other Agent Skills-compatible clients.

02 资源文件 4

03 SKILL.md 正文

Rust SQLx Postgres Service

Use this skill to make Rust/Postgres changes schema-first, compile-checked, and testable. Prefer explicit migrations, injected pools, narrow repository functions, and transaction boundaries that match the business operation.

Core Workflow

  1. Inspect Cargo.toml, migrations/, .sqlx/, docker-compose.yml, CI, and existing database helper modules before changing code.
  2. Design the schema change first. Create or update a migration before writing repository code that depends on it.
  3. Prefer sqlx::query! and query_as! for compile-time checked SQL. Use dynamic SQL only when the query shape truly changes at runtime.
  4. Inject PgPool, PgConnection, or Transaction explicitly. Do not create a pool inside handlers or repository functions.
  5. Keep repository functions small and named by behavior. Return domain types or persistence DTOs instead of leaking raw rows through the app.
  6. Use a transaction for multi-step operations that must commit or roll back together.
  7. Add or update integration tests that run migrations and exercise the public behavior when the change affects API semantics.
  8. Run the bundled preflight script or the repository's equivalent SQLx/Cargo CI commands.

Migration Rules

Read references/migration-safety.md before changing existing tables or data.

Default migration preferences:

  • Use additive changes first: new nullable columns, new tables, new indexes.
  • Backfill separately from schema creation when a table may be large.
  • Add not null, uniqueness, and foreign-key constraints only after existing data satisfies them.
  • Name constraints and indexes deliberately when they will appear in errors or operations.
  • Keep down migrations if the project uses them; otherwise document rollback expectations in the migration review.

Query Rules

Read references/sqlx-patterns.md for SQLx macro, transaction, and offline mode details.

  • Prefer bind parameters over string interpolation.
  • Use fetch_optional for lookup-by-key operations.
  • Use execute for inserts/updates where row data is not needed.
  • Use RETURNING when the caller needs generated IDs or timestamps.
  • Check affected row counts for updates and deletes that should target exactly one row.
  • Map database uniqueness conflicts to domain errors near the repository edge.

Verification

Run from the Rust project root when the standard SQLx workflow applies:

path/to/rust-sqlx-postgres-service/scripts/sqlx-preflight.sh

The script is conservative: it checks formatting and tests, inspects SQLx migration state when the CLI and DATABASE_URL are available, verifies SQLx offline metadata with cargo sqlx prepare --check when .sqlx/ or DATABASE_URL is available, and only applies migrations when RUST_SQLX_PREFLIGHT_RUN_MIGRATIONS=1 is set.

If the repository has a different CI command, use that command and explain why.

Reference Files

  • references/sqlx-patterns.md: query!, query_as!, pools, transactions, feature flags, and offline mode.
  • references/migration-safety.md: safe migration sequencing and rollout checks.

04 同仓库更多 Skills

hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-review-with-annotations

Create, inspect, reply to, update, or resolve situated Worktable annotations. Use when feedback belongs to a Doc section, block, text range, or HTML Doc, or when the user asks to address existing review feedback and coordinate a requested artifact edit.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-find-and-synthesize-context

Find, assess, and synthesize context from Worktable Docs and Records. Use when the user asks what a workspace contains, wants workspace-backed research, needs current facts reconciled across artifacts, or requests a cited synthesis without changing workspace state.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-create-or-update-docs

Create, edit, rename, or maintain narrative Worktable Docs. Use for plans, decisions, briefs, notes, research syntheses, and other durable prose when the user requests a new artifact or a safe update to an existing one.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-create-or-manage-records

Organize repeated structured information as durable Worktable Records. Use for research datasets, inventories, directories, pipelines, trackers, and other collections whose items need identity, fields, filtering, links, validation, or individual updates.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-create-or-manage-interactive-html

Create or improve durable visual and interactive artifacts in Worktable. Use for dashboards, trackers, calculators, mini apps, slide presentations, and other requests that benefit from a polished HTML Doc.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-collaborate-threads

Read, answer, and hand off messages through durable Worktable threads with users or other authenticated participants. Use when the user asks to check addressed messages, reply to a participant, continue a thread, request another agent's help, wait briefly for a response, or watch for comments and messages sent to the agent.

★ 1.6k