oceanbase-syntax

Create OceanBase SQL syntax definitions with standardized notation and no semicolons.

9|1|Updated Jan 16, 2026

Search Tags:#documentation #guidelines #technical-writing #notation #oceanbase #sql-syntax

Ready to run

npx skills add https://github.com/amber-moe/oceanbase-doc-skills --skill oceanbase-syntax

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: oceanbase-syntax
Source: https://github.com/amber-moe/oceanbase-doc-skills/tree/main/skills/oceanbase-syntax
Command: npx skills add https://github.com/amber-moe/oceanbase-doc-skills --skill oceanbase-syntax

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill guides technical writers to craft OceanBase SQL syntax definitions that describe structure without executable statements, ensuring consistent documentation.

Core Features & Use Cases

Notation rules: standardize optional parameters, alternatives, and repetition markers.
Syntax vs. examples: separate syntax definitions from executable examples to align with documentation standards.
Review & consistency: provide checklists and templates to verify correctness across multiple syntax sections.

Quick Start

Define a basic syntax block for a single OceanBase statement (e.g., CREATE TABLE) using the formatting conventions described in this skill.

Frequently Asked Questions about oceanbase-syntax

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I write OceanBase SQL syntax definitions for technical documentation?▼

To write OceanBase SQL syntax definitions, you describe statement structure without execution, using standardized notation for optional parameters, alternatives, and repetition to ensure consistency across documentation.

What notation rules apply to OceanBase SQL syntax blocks?▼

OceanBase SQL syntax blocks require standardized notation for optional parameters, alternatives, and repetition markers, while enforcing a strict rule of no semicolons within the syntax definitions.

How do I separate OceanBase SQL syntax from executable examples?▼

You separate OceanBase SQL syntax from executable examples by defining structural syntax blocks independently, ensuring the syntax section describes the statement form and the examples section handles execution.

Are semicolons allowed in OceanBase SQL syntax documentation?▼

Semicolons are not allowed in OceanBase SQL syntax documentation blocks; this constraint ensures the syntax definitions describe structural forms purely without implying statement execution.

Can I use this approach for multi-line OceanBase SQL statement variants?▼

Yes, this approach applies to both single- and multi-line forms of OceanBase SQL statements, covering variants and notation to align with established syntax documentation standards.

What's the best way to review OceanBase SQL syntax for consistency?▼

The best way to review OceanBase SQL syntax for consistency is to use provided checklists and templates to verify correctness across multiple syntax sections, aligning with documentation standards.

amber-moe

oceanbase-examples

Create structured OceanBase SQL examples with standardized templates and naming conventions.

Community

Basic

amber-moe

oceanbase-sql-doc

Standardize OceanBase SQL reference documentation with frontmatter metadata and a reusable template.

Community

Basic

amber-moe

oceanbase-sql-optimization

Provides SQL optimization for OceanBase databases including tuning, indexing, execution analysis, and slow-query mitigation across MySQL and Oracle modes.

Community

Advanced

amber-moe