plantuml-er-modeler

Generate a PlantUML ER diagram from the ORE Studio SQL schema.

25|5|Updated Jun 15, 2024
One-click install
npx skills add https://github.com/OreStudio/OreStudio --skill plantuml-er-modeler
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: plantuml-er-modeler
Source: https://github.com/OreStudio/OreStudio/tree/main/.claude/skills/plantuml-er-modeler
Command: npx skills add https://github.com/OreStudio/OreStudio --skill plantuml-er-modeler

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automatically generates PlantUML Entity-Relationship diagrams from the ORE Studio SQL schema, eliminating manual diagramming and keeping visuals in sync with the database structure.

Core Features & Use Cases

  • Generate a PlantUML ER diagram from the ORE Studio schema (ores.sql).
  • Read table definitions, primary keys, foreign keys, and junction tables to produce accurate relationships.
  • Output is placed at projects/ores.sql/modeling/ores_schema.puml and can be validated via the project build target.

Quick Start

Identify and review the SQL create scripts under projects/ores.sql/create/ to understand the schema, then run the generator to produce ores_schema.puml under projects/ores.sql/modeling/ and confirm with the cmake build target for diagram generation.

Frequently Asked Questions about plantuml-er-modeler

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

FAQPage Schema
How do I generate a PlantUML ER diagram from SQL schema files?

You can generate a PlantUML ER diagram by running the generator against SQL create scripts placed under projects/ores.sql/create/, which parses table definitions, primary keys, foreign keys, and junction tables to output a styled .puml file in the modeling directory.

What is the best way to keep ER diagrams in sync with database schema changes?

The best way to keep ER diagrams in sync with database schema changes is to apply the generator whenever the schema updates, automatically parsing modified table definitions, primary keys, and foreign keys to output the current ores_schema.puml file.

How do I document database tables and their relationships using PlantUML?

You can document database tables and their relationships using PlantUML by parsing SQL create scripts to detect foreign keys and junction tables, then generating an Entity-Relationship diagram file with PlantUML skeleton and styling guidance.

Does the PlantUML ER diagram generator detect junction tables and foreign keys?

Yes, the PlantUML ER diagram generator detects junction tables and foreign keys by parsing the SQL create scripts under the create directory, ensuring accurate relationship mapping in the final diagram output.

Can I validate the generated PlantUML ER diagram via the project build target?

Yes, you can validate the generated PlantUML ER diagram via the cmake build target for diagram generation, confirming that the ores_schema.puml file placed under projects/ores.sql/modeling/ is syntactically correct.

What are the limitations of automatically generating ER diagrams from SQL scripts?

A limitation of automatically generating ER diagrams from SQL scripts is the strict dependency on the structure of create scripts under projects/ores.sql/create/ for parsing primary and foreign keys, meaning non-standard schema definitions may not be accurately mapped into the PlantUML output.