bx-orm-entities

Define BoxLang ORM entities with persistent annotations and table mappings.

Updated Apr 10, 2026
One-click install
npx skills add https://github.com/ortus-boxlang/skills --skill bx-orm-entities
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bx-orm-entities
Source: https://github.com/ortus-boxlang/skills/tree/main/boxlang-modules/bx-orm/bx-orm-entities
Command: npx skills add https://github.com/ortus-boxlang/skills --skill bx-orm-entities

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manage and map BoxLang ORM entities by defining persistent annotations, entity names, and table mappings to ensure correct database integration.

Core Features & Use Cases

  • Declarative entity mapping using persistent, entityName, and table
  • Property annotations for primary keys, field types, and constraints
  • Support for composite keys, version fields, and inheritance hierarchies

Quick Start

Create a BoxLang class with persistent="true" and map it to a table using entityName and table attributes.

Frequently Asked Questions about bx-orm-entities

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

FAQPage Schema
How do I map a BoxLang class to a database table using ORM annotations?

To map a BoxLang class, set the persistent annotation to true and use the entityName and table attributes to define the database mapping. This declarative approach ensures correct ORM integration for your persistent classes.

Can I define composite keys in BoxLang ORM entities?

Yes, BoxLang ORM entities support composite keys. You can define multiple properties as primary keys within your persistent class to accurately map complex database constraints and relationships across schemas.

What annotations are available for BoxLang ORM property mappings?

BoxLang ORM provides property annotations for ormType, primary keys, field types, and constraints. These annotations fully describe database mappings, allowing precise control over how persistent classes interact with database schemas.

Does BoxLang ORM support inheritance hierarchies across different database schemas?

Yes, BoxLang ORM supports inheritance hierarchies and mapping across different schemas and databases. You can define persistent classes that inherit properties while maintaining distinct schema and table mappings for each entity.

How do I add version fields to a BoxLang ORM entity for concurrency control?

BoxLang ORM entities support version fields through property annotations. By declaring a version field in your persistent class, you enable optimistic concurrency control to manage concurrent database modifications.

What is the best way to configure schema and table mappings in BoxLang ORM?

The best way to configure schema and table mappings is by using the schema and table attributes directly on your persistent BoxLang class. This ensures the ORM accurately maps your entity properties to the correct database structures.