bx-orm-configuration

Configure bx-orm ormSettings in BoxLang applications for ORM lifecycle management.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill streamlines configuring bx-orm in BoxLang applications, enabling rapid setup of Application.bx ormSettings, datasource wiring, and ORM lifecycle controls to improve startup reliability and runtime consistency.

Core Features & Use Cases

  • Centralized ORM activation: toggles bx-orm, selects the active datasource, and wires entityPaths for persistence.
  • Flexible DB schema management: supports dbcreate options (none, update, dropcreate) to align development and production migrations.
  • Multi-datasource and event support: enables separate datasources and event handling configurations for complex apps.
  • Session and cache basics: provides settings for autoManageSession, flushAtRequestEnd, and secondary cache configuration.

Quick Start

Create an Application.bx configuration snippet that sets ormSettings with entityPaths and dbcreate, then enable ORM by setting ORMenabled to true.

Frequently Asked Questions about bx-orm-configuration

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

FAQPage Schema
How do I configure ORM settings in a BoxLang application?

Configure ORM in a BoxLang application by defining ormSettings within Application.bx, specifying entityPaths, dbcreate, dialect, and session controls, then setting ORMenabled to true to activate persistence.

What is the best way to manage database schema creation with bx-orm?

Manage database schema creation in bx-orm using the dbcreate setting, which supports none, update, and dropcreate options to align development and production database migrations.

Can I use multiple datasources with bx-orm in BoxLang?

Yes, bx-orm supports multi-datasource configurations in BoxLang applications, enabling separate datasource wiring and event handling configurations for complex application environments.

How does session management work for ORM in BoxLang?

ORM session management in BoxLang is controlled via ormSettings, providing options for autoManageSession and flushAtRequestEnd to handle session lifecycle and runtime consistency.

Do I need to configure caching for bx-orm entities?

Configuring caching for bx-orm entities is optional, utilizing secondary cache configuration settings within ormSettings to improve data access performance across multiple environments.

Why is my BoxLang ORM failing to discover persistence entities?

ORM entity discovery fails in BoxLang when ormSettings lacks properly mapped entityPaths, preventing the framework from locating and wiring persistence entities during application startup.