cockroachdb-sql

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

CockroachDB SQL Skill

Converts natural language questions into CockroachDB-compliant SQL queries, following CockroachDB best practices. Use it for schema design, writing queries and optimizing query.

将自然语言问题转换为符合CockroachDB规范的SQL查询，并遵循CockroachDB最佳实践。可用于Schema设计、查询编写及查询优化。

When to Use This Skill

何时使用此技能

Activate this skill when:

User asks for SQL query generation for CockroachDB
User provides natural language descriptions of database operations
User asks questions like:
- "How do I query recent orders in CockroachDB?"
- "Generate a CockroachDB table for user management"
- "Convert this to CockroachDB SQL: [description]"
- "What's the CockroachDB way to [operation]?"
When you encounter:
- CREATE TABLE statements
- ALTER TABLE modifications
- DML Operations (INSERT, UPDATE, DELETE)
- SELECT queries
- Performance optimization requests
- Backup/restore operations

在以下场景激活此技能：

用户请求为CockroachDB生成SQL查询
用户提供数据库操作的自然语言描述
用户提出如下问题：
- "如何在CockroachDB中查询最近的订单？"
- "生成一个用于用户管理的CockroachDB表"
- "将此转换为CockroachDB SQL：[描述]"
- "执行[操作]的CockroachDB方式是什么？"
当遇到以下操作时：
- CREATE TABLE语句
- ALTER TABLE修改操作
- DML操作（INSERT、UPDATE、DELETE）
- SELECT查询
- 性能优化请求
- 备份/恢复操作

How to Apply this Skill

如何应用此技能

Connection Detection — already performed on skill invocation; reuse active connection.
Parse Natural Language Intent
- Identify the operation type (SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, etc.)
Context Gathering
- Check for existing schema context in conversation
- If connected to DB, query existing schema:
  - ```
  SHOW TABLES;
```
  to see existing tables
- ```
SHOW CREATE TABLE table_name;
```
    for existing structure
- Ask clarifying questions if needed:
  - Table structure if not provided
  - Data types for columns
  - Index requirements
  - Multi-region needs
  - Performance characteristics
Apply CockroachDB Rules
- Reference rules in
```
references/cockroachdb-rules/
```
- Ensure compliance with CockroachDB best practices
- Determine rule category based on operation and apply the relavant rules:
  - ```
  00-fundamental-principles.md
```
  - Always apply these first
- ```
01-schema-design.md
```
    - Table creation and structure
  - ```
  02-dml-operations.md
```
  - Data modification
- ```
03-query-patterns.md
```
    - Query construction
  - ```
  04-optimization.md
```
  - Performance, Optimization and anti-patterns
- ```
05-operational.md
```
    - Admin and maintenance
- Validate against anti-patterns in 04-optimization.md
Validate against DB(MANDATORY)
- ALWAYS run EXPLAIN on every generated SQL query when connected to DB.
- If EXPLAIN returns a parsing/syntax error, fix the query and re-run EXPLAIN until it passes.
- Include the EXPLAIN output in the response.

连接检测 — 技能调用时已执行；复用现有连接。
解析自然语言意图
- 识别操作类型（SELECT、INSERT、UPDATE、DELETE、CREATE、ALTER等）
上下文收集
- 检查对话中是否存在现有Schema上下文
- 如果已连接到数据库，查询现有Schema：
  - ```
  SHOW TABLES;
```
  查看现有表
- ```
SHOW CREATE TABLE table_name;
```
    获取现有表结构
- 必要时提出澄清问题：
  - 未提供的表结构
  - 列的数据类型
  - 索引要求
  - 多区域需求
  - 性能特性
应用CockroachDB规则
- 参考
```
references/cockroachdb-rules/
```
  中的规则
- 确保符合CockroachDB最佳实践
- 根据操作确定规则类别并应用相关规则：
  - ```
  00-fundamental-principles.md
```
  - 始终优先应用这些规则
- ```
01-schema-design.md
```
    - 表创建与结构
  - ```
  02-dml-operations.md
```
  - 数据修改
- ```
03-query-patterns.md
```
    - 查询构建
  - ```
  04-optimization.md
```
  - 性能、优化及反模式
- ```
05-operational.md
```
    - 管理与维护
- 根据04-optimization.md中的内容验证是否存在反模式
针对数据库进行验证（必填）
- 连接到数据库时，务必对每个生成的SQL查询运行EXPLAIN。
- 如果EXPLAIN返回解析/语法错误，修复查询并重新运行EXPLAIN直至通过。
- 在响应中包含EXPLAIN输出结果。

Response Behavior

响应行为

Initial Response

初始响应

When skill is invoked, ALWAYS:

Immediately detect connection before any other action or response:
- Check if connection string is provided in the prompt (postgresql://...).
  - If provided, use
```
cockroach sql --url "<provided-url>" -e "SQL"
```
    to run queries. Do not use psql.
- Else check COCKROACH_URL environment variable (
```
echo $COCKROACH_URL
```
  ).
  - If set, use
```
cockroach sql --url $COCKROACH_URL -e "SQL"
```
    to run queries. Do not use psql.
- Else check for cockroach-cloud MCP server availability
Focus exclusively on CockroachDB
Emphasize "natural language to CockroachDB SQL" not "database conversion"
Keep user-facing content CockroachDB-specific regardless of internal PostgreSQL rules.

调用技能时，务必：

在执行任何其他操作或响应前立即检测连接：
- 检查提示中是否提供了连接字符串（postgresql://...）。
  - 如果提供，使用
```
cockroach sql --url "<provided-url>" -e "SQL"
```
    执行查询。请勿使用psql。
- 否则检查COCKROACH_URL环境变量（
```
echo $COCKROACH_URL
```
  ）。
  - 如果已设置，使用
```
cockroach sql --url $COCKROACH_URL -e "SQL"
```
    执行查询。请勿使用psql。
- 否则检查cockroach-cloud MCP服务器是否可用
专注于CockroachDB相关内容
强调“自然语言转CockroachDB SQL”而非“数据库转换”
无论内部PostgreSQL规则如何，面向用户的内容需保持CockroachDB专属特性

Output Format

输出格式

Show generated SQL with explanatory comments
List CockroachDB-specific features used
Include performance considerations
When optimizing, at each step 1- Explain the step's purpose. 2- Execute the step and report the outcome. 3- Summarize all findings and actions taken.
Provide references used including the rules

展示带有解释性注释的生成SQL
列出所使用的CockroachDB特定功能
包含性能考量因素
优化时，每一步需：1- 说明步骤目的。2- 执行步骤并报告结果。3- 总结所有发现及采取的操作。
提供所使用的参考资料，包括规则文档

Supporting Documentation

支持文档

```
references/cockroachdb-rules/
```
- CockroachDB SQL rules
```
references/EXAMPLES.md
```
- SQL examples and patterns

```
references/cockroachdb-rules/
```
- CockroachDB SQL规则
```
references/EXAMPLES.md
```
- SQL示例与模式