Generated banner for Dsql
Generated logo for Dsql

Dsql

ClineOfficialPublished by Cline

  • Skill
  • Tool integration
  • Cloud and DevOps
  • Apache-2.0
  • Low risk
  • Has scripts

From the author

Build with Aurora DSQL — manage schemas, execute queries, handle migrations, diagnose query plans, load data, and develop applications with a serverless, distributed SQL database. Covers IAM auth, multi-tenant patterns, MySQL-to-DSQL and PostgreSQL-to-DSQL schema conversion, FK replacement code generation, OCC retry patterns, ORM migration (Django/Hibernate/Rails), DDL operations, query plan explainability, SQL compatibility validation, and bulk data loading. Triggers on phrases like: DSQL, Aurora DSQL, distributed SQL database, serverless PostgreSQL-compatible database, migrate to DSQL, DSQL query plan, DSQL EXPLAIN ANALYZE, DSQL ENUM, DSQL foreign key, DSQL OCC retry, DSQL multi-region, DSQL JSONB, DSQL GIN index, load into DSQL, load CSV into DSQL, bulk load DSQL, aurora-dsql-loader.
— the description by Cline

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

The dsql skill provides a structured framework for working with Amazon Aurora DSQL, a serverless, distributed SQL database. It covers the full lifecycle of database operations, including schema management, multi-tenant design, IAM-based authentication, and migration strategies from MySQL or PostgreSQL. The skill integrates with MCP tools to facilitate direct query execution, SQL linting, and documentation access, while enforcing best practices for transaction limits, OCC retry patterns, and bulk data loading.

What it does

  • Provides MCP tools for direct query execution, schema inspection, and SQL compatibility linting.
  • Offers step-by-step workflows for migrating existing MySQL and PostgreSQL databases to DSQL.
  • Guides users through implementing multi-tenant isolation and application-layer referential integrity.
  • Supplies patterns for handling OCC retries and batching DDL/DML operations within transaction limits.
  • Facilitates bulk data loading from CSV, TSV, or Parquet files using specialized loader utilities.
  • Includes diagnostic procedures for query plan explainability and performance optimization.

When to use it

  • When starting a new project or migrating an existing application to Aurora DSQL.
  • When performing schema migrations or complex DDL operations that require validation.
  • When troubleshooting performance issues or unexpected query plans.
  • When implementing secure, IAM-based access control and scoped database roles.
  • When bulk loading large datasets into a DSQL cluster.

Advantages

  • Ensures adherence to DSQL-specific constraints and best practices through linting and structured workflows.
  • Simplifies complex migrations with pre-defined type mapping and schema conversion patterns.
  • Promotes secure development by enforcing IAM authentication and least-privilege access control.
  • Reduces operational risk by providing clear procedures for transaction management and error recovery.
  • Standardizes diagnostic reporting for query performance analysis.

Usage examples

“How do I migrate my existing PostgreSQL schema to Aurora DSQL?”
The agent will guide you through using dsql_lint for compatibility checks, applying specific type mappings from the pg-migrations reference, and handling unfixable patterns manually.
“I am getting an OCC serialization error, how do I fix it?”
The agent will provide the standard OCC retry pattern and suggest checking for hot-key contention using the troubleshooting reference.
“How do I securely connect my application to DSQL using IAM?”
The agent will explain how to map IAM roles to scoped database roles and provide the command to generate a temporary DB connect token.
“Analyze this slow query plan for my DSQL cluster.”
The agent will initiate the query plan explainability workflow, requiring you to provide the plan while it guides you through diagnostic steps and produces a structured report.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/cline/dsql/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip dsql.zip -d .agents/skills

Documentation by Cline

Amazon Aurora DSQL Skill

Aurora DSQL is a serverless, PostgreSQL-compatible distributed SQL database. This skill covers direct query execution via MCP tools, schema management, migrations, multi-tenant isolation, IAM auth, and bulk data loading via aurora-dsql-loader.


Reference Files

Load these files as needed for detailed guidance:

Core:
ReferenceWhen to LoadContains
development-guide.mdALWAYS before schema changes or DB operationsBest practices, DDL rules, transaction limits, app-layer referential integrity
language.mdMUST load for language-specific choicesDriver selection, DSQL Connectors, connection code
access-control.mdMUST load for roles, grants, or sensitive dataScoped role setup, IAM-to-database role mapping
troubleshooting.mdSHOULD load for errors or unexpected behaviorOCC errors, connection failures, cluster state errors, token expiry, DDL rejection causes
dsql-examples.mdLoad for implementation examplesMulti-tenant schema examples, batch operations, FK validation patterns, connection pooling
onboarding.mdUser requests "Get started with DSQL"Interactive step-by-step guide
occ-retry-patterns.mdMUST load for OCC retry code or conflict mitigationDSQL Connectors, manual retry pattern, idempotent design
MCP:
ReferenceWhen to LoadContains
mcp-setup.mdAlways for MCP server guidanceSetup instructions, 2 configuration options
mcp-tools.mdFor MCP tool syntax and examplesTool parameters, input validation
dsql-lint.mdMUST load before running dsql_lint or processing external SQLTool reference, fix statuses, unfixable error resolution
DDL Migrations:
ReferenceWhen to LoadContains
ddl-migrations/overview.mdMUST load for DROP COLUMN, ALTER TYPE, DROP CONSTRAINTTable recreation pattern, verify & swap
ddl-migrations/column-operations.mdDROP COLUMN, ALTER TYPE, SET/DROP NOT NULL/DEFAULTColumn-level migration patterns
ddl-migrations/constraint-operations.mdADD/DROP CONSTRAINT, MODIFY PRIMARY KEYConstraint and structural changes
ddl-migrations/batched-migration.mdTables exceeding 3,000 rowsBatching patterns, progress tracking
MySQL Migrations:
ReferenceWhen to LoadContains
mysql-migrations/type-mapping.mdMUST load for MySQL → DSQL migrationData type mappings, feature alternatives
mysql-migrations/ddl-operations.mdTranslating MySQL DDL to DSQLAUTO_INCREMENT, ENUM, SET, FK patterns
mysql-migrations/full-example.mdComplete MySQL table migrationEnd-to-end example with decision summary
PostgreSQL Migrations:
ReferenceWhen to LoadContains
pg-migrations/type-mapping.mdMUST load for PG → DSQL type questionsC collation rules, NUMERIC precision, JSON/JSONB
pg-migrations/fk-replacement.mdMUST load for FK validation code generationTenant-scoped validate_fk_*() template, cascade
pg-migrations/index-conversion.mdMUST load for unfixable index diagnosticsGIN/GiST/BRIN → btree, partial, expression indexes
pg-migrations/schema-objects.mdMUST load for ENUM, materialized views, extensions, multi-schemaENUM → CHECK, views, role/IAM mapping
pg-migrations/multi-region.mdMulti-region, active-active, or HA questionsArchitecture, geographic partitioning
ORM Guides:
ReferenceWhen to LoadContains
orm-guides/overview.mdMigrating any ORM to DSQLAdapter names, key gotchas for Django/Hibernate/Rails/SQLAlchemy
Data Loading:
ReferenceWhen to LoadContains
data-loading.mdPlanning or running bulk loads with aurora-dsql-loaderFresh-vs-warm partitions, resume/retry, --on-conflict semantics, throughput diagnostics
Query Plan Explainability:
ReferenceWhen to LoadContains
query-plan/plan-interpretation.mdMUST load at Workflow 9 Phase 0DSQL node types, Node Duration math, estimation-error bands
query-plan/catalog-queries.mdMUST load at Workflow 9 Phase 0pg_class/pg_stats/pg_indexes SQL, correlated-predicate verification
query-plan/guc-experiments.mdMUST load at Workflow 9 Phase 0GUC experiment procedures, 30-second skip protocol
query-plan/report-format.mdMUST load at Workflow 9 Phase 0Required report structure, element checklist, support request template

MCP Tools Available

The aurora-dsql MCP server provides these tools:

Database Operations:

  1. readonly_query - Execute SELECT queries (returns list of dicts)

  2. transact - Execute DDL/DML statements in transaction (takes list of SQL statements)

  3. get_schema - Get table structure for a specific table

SQL Validation:

  1. dsql_lint - Validate SQL for DSQL compatibility and optionally auto-fix issues. Use before executing externally-sourced SQL.

Documentation & Knowledge:

  1. dsql_search_documentation - Search Aurora DSQL documentation

  2. dsql_read_documentation - Read specific documentation pages

  3. dsql_recommend - Get DSQL best practice recommendations

Note: There is no list_tables tool. Use readonly_query with information_schema.

See mcp-setup.md for detailed setup instructions. See mcp-tools.md for detailed usage and examples.

AWS Knowledge MCP (awsknowledge)

Consult for verifying DSQL service limits before advising users. The numeric limits below are defaults that may change — when a user's decision depends on an exact limit, verify it first:

LimitDefaultVerify query
Max rows per transaction3,000aurora dsql transaction limits
Max data size per transaction10 MiBaurora dsql transaction limits
Max transaction duration5 minutesaurora dsql transaction limits
Max connections per cluster10,000aurora dsql connection limits
Auth token expiry15 minutesaurora dsql authentication token
Max connection duration60 minutesaurora dsql connection limits
Max indexes per table24aurora dsql index limits
Max columns per index8aurora dsql index limits
IDENTITY/SEQUENCE CACHE values1 or >= 65536aurora dsql sequence cache
Supported column data typesSee docsaurora dsql supported data types

When to verify: Before recommending batch sizes, connection pool settings, or schema designs where hitting a limit would cause failures; any time the exact number can affect user decision.

Fallback: If awsknowledge is unavailable, use the defaults above and flag that limits should be verified against DSQL documentation.

CLI Tools

Use the AWS CLI, psql, and aurora-dsql-loader directly for cluster management, SQL connections, and bulk data loading from local or S3 CSV/TSV/Parquet files. Load data-loading.md for loader guidance.


Quick Start

  1. Explore: Use readonly_query with information_schema to list tables. Use get_schema for table structure.

  2. Query: Use readonly_query for SELECT queries. MUST include tenant_id in WHERE for multi-tenant apps. MUST build SQL with safe_query.build().

  3. Schema changes: Use transact with one DDL per transaction. MUST batch DML under 3,000 rows. MUST use CREATE INDEX ASYNC in a separate call. Use dsql_lint to validate first.

  4. Bulk load data: Use aurora-dsql-loader for CSV/TSV/Parquet. Load data-loading.md for details. Use --dry-run first.


Common Workflows

Workflow 1: Create Multi-Tenant Schema
  1. Create main table with tenant_id column using transact

  2. Create async index on tenant_id in separate transact call

  3. Create composite indexes for common query patterns (separate transact calls)

  4. Verify schema with get_schema

  • MUST include tenant_id in all tables

  • MUST use CREATE INDEX ASYNC exclusively

  • MUST issue each DDL in its own transact call: transact(["CREATE TABLE ..."])

  • MUST serialize arrays as JSONB; expand at query time with jsonb_array_elements_text(data)

Workflow 2: Safe Data Migration

MUST validate every DDL with dsql_lint(fix=true) before executing. DML does not require linting.

  1. Validate DDL with dsql_lint(sql=..., fix=true) — handle diagnostics per dsql-lint.md

  2. Add column: transact(["ALTER TABLE ... ADD COLUMN ..."])

  3. Populate existing rows with UPDATE (batched under 3,000 rows)

  4. Verify with readonly_query COUNT

  5. Create index if needed: validate then transact(["CREATE INDEX ASYNC ..."])

  • MUST issue each ALTER TABLE in its own transact call — DSQL rejects multi-DDL transactions with multiple ddl statements not supported in a transaction

  • MUST add column with only name and type; apply DEFAULT via separate UPDATE

  • MUST batch updates under 3,000 rows in separate transact calls

Recovery: Resume failed batches by filtering WHERE new_column IS NULL.

Workflow 3: Bulk Data Loading

Use aurora-dsql-loader for CSV, TSV, or Parquet loads. MUST load data-loading.md before advising on throughput or diagnosing slow loads.

  1. Validate with --dry-run first

  2. Run with --manifest-dir on persistent storage (not /tmp — tmpfs on AL2023, lost on crash) and --header if file has a header row

  3. On failure: resume with --resume-job-id; for duplicates use --on-conflict do-nothing

  4. For large tables: create secondary indexes after load using CREATE INDEX ASYNC

Workflow 4: Application-Layer Referential Integrity

INSERT: MUST validate parent exists with readonly_query → throw error if not found → insert child with transact.

DELETE: MUST check dependents with readonly_query COUNT → return error if dependents exist → delete with transact if safe.

Workflow 5: Query with Tenant Isolation
  1. MUST authorize the caller against the tenant — format validation does not establish authorization

  2. MUST build SQL with safe_query.build() — use allow()/regex() for values (emits 'v'), ident() for table/column names (emits "v"). See input-validation.md

  3. MUST include tenant_id in the WHERE clause; reject cross-tenant access at the application layer

Workflow 6: Set Up Scoped Database Roles

MUST load access-control.md for role setup, IAM mapping, and schema permissions.

Workflow 7: Table Recreation DDL Migration

Use the Table Recreation Pattern for ALTER COLUMN TYPE, DROP COLUMN, DROP CONSTRAINT, or MODIFY PRIMARY KEY. This is a destructive workflow that requires user confirmation at each step. Every generated DDL in the pattern (CREATE new, INSERT ... SELECT, DROP old, RENAME) MUST be validated with dsql_lint(sql=..., fix=true) before execution.

MUST load ddl-migrations/overview.md before attempting any of these operations.

Workflow 8: Validate and Migrate to DSQL

MUST load dsql-lint.md before running dsql_lint. Run dsql_lint(sql=source_sql, fix=true) to validate and auto-convert. For MySQL-origin SQL, MUST cross-check against mysql-migrations/type-mapping.md even when lint returns clean. On parse_error, fall back to manual conversion then re-lint.

Workflow 9: Query Plan Explainability

Explains why the DSQL optimizer chose a particular plan. Triggered by slow queries, high DPU, unexpected Full Scans, or plans the user doesn't understand. REQUIRES a structured Markdown diagnostic report as the deliverable.

MUST load all four reference files at Phase 0: query-plan/plan-interpretation.md, query-plan/catalog-queries.md, query-plan/guc-experiments.md, query-plan/report-format.md. The phase procedures (capture plan, gather evidence, experiment, produce report) are defined in those files.

Safety. Plan capture uses readonly_query exclusively. Rewrite DML to SELECT for plan capture. MUST NOT use transact --allow-writes for plan capture.

Workflow 10: Full PostgreSQL → DSQL Schema Migration

MUST load pg-migrations/type-mapping.md and pg-migrations/schema-objects.md. Run dsql_lint(fix=true) first for mechanical fixes, then apply semantic conversions from the pg-migrations references for unfixable diagnostics and patterns the linter cannot handle. Re-lint the final output before deploying.

Workflow 11: ORM Migration (Django/Hibernate/Rails)

Load orm-guides/overview.md for adapter names and framework-specific gotchas.

Error Scenarios

  • awsknowledge returns no results: Use the default limits in the table above and note that limits should be verified against DSQL documentation.

  • dsql_lint unavailable or timing out: See the Error Handling section of dsql-lint.md. Do not silently skip validation — inform the user and require explicit confirmation before proceeding with manual rules from development-guide.md.

  • OCC serialization error: Retry the transaction. If persistent, check for hot-key contention — see troubleshooting.md.

  • Transaction exceeds limits: Split into batches under 3,000 rows — see batched-migration.md.

  • Token expiration mid-operation: Generate a fresh IAM token — see authentication-guide.md. See troubleshooting.md for other issues.

Additional Resources

Files

references/data-loading.md

Data Loading with the DSQL Loader

Part of DSQL Development Guide.

The DSQL Loader (aurora-dsql-loader) is the recommended tool for bulk-loading CSV, TSV, or Parquet data into Aurora DSQL.

For installation and basic invocation, see connectivity-tools.md.

Table of Contents

  • Fresh-vs-Warm Partition Behavior

  • Resume and Retry Mechanics

  • Conflict Handling

  • CSV/TSV Header Handling

  • Schema Inference Caveats

  • Index Count Affects Throughput

  • Diagnostic Decision Tree


Fresh-vs-Warm Partition Behavior

DSQL tables start on a single partition and auto-split under sustained write heat. Fresh tables absorb a few thousand rec/s regardless of client concurrency — this is normal, not a problem to fix. Throughput accelerates as partitions split. See Primary keys in Aurora DSQL for partition distribution guidelines.

Agent guidance: when a user reports low throughput on a fresh table, do NOT recommend adding workers. Advise them to keep the load running or run a pre-pass to drive splits.


Resume and Retry Mechanics

The loader writes a manifest tracking committed chunks. On resume, it restarts from the last committed chunk.

--manifest-dir <persistent-path>

You MUST set --manifest-dir to a persistent path. Default /tmp is tmpfs on AL2023 — manifests are lost on process death.

aurora-dsql-loader load \
  --endpoint your-cluster.dsql.us-east-1.on.aws \
  --source-uri data.csv \
  --table my_table \
  --manifest-dir /var/lib/dsql-loader/manifests
--resume-job-id <id>

Re-runs continue from the last committed chunk. The job id is printed in the loader's log on the line beginning Starting load job:.

aurora-dsql-loader load \
  --endpoint your-cluster.dsql.us-east-1.on.aws \
  --source-uri data.csv \
  --table my_table \
  --manifest-dir /var/lib/dsql-loader/manifests \
  --resume-job-id <job-id-from-log> \
  --keep-manifest
--keep-manifest

Retains the manifest after a successful load. Useful for auditing or idempotent re-runs.


Conflict Handling: --on-conflict do-nothing

--on-conflict do-nothing silently skips rows that violate any unique constraint (primary key or any UNIQUE index) on the target table.

The agent MUST verify these preconditions before recommending --on-conflict do-nothing:

  1. The target table MUST have at least one unique constraint on the conflict column(s).

  2. The load MUST be idempotent — the same source row produces the same target row, so skipping duplicates yields the correct final state.

  3. The source data MUST NOT have changed since the original run if using do-nothing for crash recovery. Changed source rows are silently kept at their old values.


CSV/TSV Header Handling

You MUST pass --header if the CSV/TSV file has a header row. The loader treats every row as data by default.

aurora-dsql-loader load \
  --endpoint your-cluster.dsql.us-east-1.on.aws \
  --source-uri sales_with_header.csv \
  --table sales \
  --header

Symptoms of a missing --header:

  • invalid input syntax for type <T>: "<column_name>" — header values inserted as data.

  • First batch fails entirely while subsequent batches succeed.

Legacy behavior (v2.x): older versions defaulted to assuming a header row. If upgrading from v2.x, add --header to invocations loading header-bearing files.


Schema Inference Caveats

These produce successful loads with no error or warning. You MUST validate with --dry-run against any new table.

Schema inference silently produces wrong types for:

  • Mixed nullability across files — column infers as TEXT instead of numeric/date.

  • Numeric-looking identifiers (ZIP codes, phone numbers with leading zeros) — infers as integer, losing leading characters.

  • Non-ISO date formats — falls back to TEXT silently.

aurora-dsql-loader load \
  --endpoint your-cluster.dsql.us-east-1.on.aws \
  --source-uri data.csv \
  --table my_table \
  --dry-run

If the inferred schema is wrong, create the table explicitly and re-run without --if-not-exists.


Index Count Affects Throughput

  • For large loads, SHOULD create secondary indexes after the bulk load using CREATE INDEX ASYNC.

  • For tables queried during ingestion, keep indexes in place — throughput cost is preferable to incorrect query results.


Diagnostic Decision Tree

Symptom: throughput stuck at a few thousand rec/s; host CPU is low

Cause: partition-constrained (fresh/few partitions). Action: keep the load running. Throughput accelerates as DSQL splits. For recurring fresh-table loads, run a pre-pass to drive splits.

Symptom: throughput below expected; host CPU > 90%

Cause: host-bound. Action: reduce concurrency (--workers, --batch-concurrency) or use a larger host.

Symptom: throughput below expected; host CPU ~50%; persists past 15 minutes

Cause: hot-key — many rows hashing to the same partition. Action: inspect source for PK skew. Verify UUIDs are genuinely random (v1 UUIDs share high-order prefix).

Symptom: "Records loaded" exceeds SELECT count(*) on target

Cause: duplicate keys in source + --on-conflict do-nothing. Action: check source for duplicate-PK rows. De-duplicate or document the gap.

Symptom: loader crashed; manifest is gone

Cause: manifest was in /tmp (tmpfs) and cleared on exit. Action: re-run from beginning. If table has a unique constraint and load is idempotent, use --on-conflict do-nothing to skip already-committed rows. For future loads, MUST set --manifest-dir to persistent path.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs an MCP server, Needs Python, Needs Node.js

Security

What our scanner noticed· Low risk

  • Instructions that use the network
  • Scripts that your agent may run

This skill includes scripts that your agent may run. Read them before you use it.

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Published by
Cline
Publisher
Cline (Official)
Source
cline/skills · skills/dsql · commit 2637846
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Cline or Cline.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download dsql.zip