nop-orm-modeler

Generates .orm.xml files from MySQL schemas or natural-language descriptions.

690|99|Updated Aug 18, 2022
One-click install
npx skills add https://github.com/entropy-cloud/nop-entropy --skill nop-orm-modeler
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: nop-orm-modeler
Source: https://github.com/entropy-cloud/nop-entropy/tree/main/.opencode/skills/nop-orm-modeler
Command: npx skills add https://github.com/entropy-cloud/nop-entropy --skill nop-orm-modeler

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the generation, validation, and maintenance of Nop ORM models from MySQL DDL/SQL or business requirements, enabling consistent entity modeling, relationships, and domain/dict organization.

Core Features & Use Cases

  • Generate ORM models from DDL/SQL and create delta files for modular development.
  • Validate and refine ORM structure, including domains, dicts, and relationships.
  • Use cases include database-first ORM generation from schema changes and requirements-first modeling from design documents.

Quick Start

Run the ORM generator against a MySQL schema: python3 generate_orm_from_mysql_ddl.py --out ./my-app.orm.xml --app-name my-app --dialect mysql --sql ./schema.sql

Frequently Asked Questions about nop-orm-modeler

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

FAQPage Schema
How do I generate ORM XML files from MySQL DDL?

You generate ORM XML files from MySQL DDL by running a Python script that parses the SQL schema and outputs the model configuration. The generator processes tables, keys, and relationships to create the XML structure required for the Nop framework.

What is the best way to maintain ORM models when the database schema changes?

The best way to maintain ORM models after schema changes is to use delta files for modular development. This approach allows you to generate updates and validate the ORM structure without overwriting the main configuration, preserving custom relationships and domains.

Can I create ORM models from business requirements instead of existing SQL?

Yes, you can create ORM models from business requirements using a requirements-first workflow. The tool builds and validates the entity structure, including domains, dicts, and displayName localization, directly from design documents without needing existing SQL.

Does the Nop ORM generator support delta files for modular development?

Yes, the Nop ORM generator supports delta files for modular development. It manages both delta files and the main ORM configuration, enabling consistent entity modeling and relationship organization across different modules.

How do I validate ORM structure including domains and relationships?

You validate ORM structure by running the validation scripts provided for the Nop framework. This process checks the generated XML for correct entities, keys, relationships, domains, and dicts, ensuring the model configuration is consistent and accurate.