oceanbase-examples

What problem does it solve?

This Skill provides guidelines for creating SQL examples in OceanBase documentation, enabling writers to produce consistent, realistic, and well-formatted samples.

Core Features & Use Cases

• Structured example templates: Standardized templates for SQL examples, including statements, results, and narrative descriptions.
• Quality-oriented conventions: Naming conventions, scenario design, and output expectations to ensure clarity and realism.
• Workflow guidance: Step-by-step workflows for creating, validating, and documenting OceanBase examples, including error scenarios and best practices.

Quick Start

To create a solid OceanBase example, start with a meaningful business scenario, define tables and queries, and include expected results. Example steps:

• Set up users, databases, and schemas to mirror a real environment.
• Create representative objects such as tables and sample data.
• Write SQL statements with clear prompts and expected outputs.