bx-orm-bif-development

Standardize ORM built-in function development with BaseORMBIF and context resolution.

2|Updated Apr 11, 2024
One-click install
npx skills add https://github.com/ortus-boxlang/bx-orm --skill bx-orm-bif-development
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bx-orm-bif-development
Source: https://github.com/ortus-boxlang/bx-orm/tree/main/.agents/skills-custom/bx-orm-bif-development
Command: npx skills add https://github.com/ortus-boxlang/bx-orm --skill bx-orm-bif-development

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the creation and maintenance of ORM built-in functions (BIFs) by providing a standardized framework for interacting with Hibernate sessions, entity CRUD operations, and HQL execution within the BoxLang ecosystem.

Core Features & Use Cases

  • Standardized BIF Architecture: Provides the BaseORMBIF parent class to ensure consistent access to ORM services and context resolution.
  • Comprehensive CRUD Support: Facilitates the implementation of entity lifecycle methods like EntityNew, EntitySave, and EntityDelete.
  • Session & Query Management: Simplifies the logic for managing ORM sessions, flushing, clearing, and executing complex HQL queries.

Quick Start

Use the bx-orm-bif-development skill to generate a new ORM BIF class that extends BaseORMBIF and implements the required invoke method for custom entity operations.

Frequently Asked Questions about bx-orm-bif-development

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

FAQPage Schema
How do I create custom ORM built-in functions in BoxLang?

To create custom ORM built-in functions in BoxLang, you generate a new class that extends the BaseORMBIF parent class and implements the required invoke method for your specific entity operations. This ensures consistent access to ORM services and proper context resolution.

What is the standard architecture for BoxLang ORM BIFs?

The standard architecture for BoxLang ORM BIFs uses the BaseORMBIF inheritance model to provide a structured base class and explicit ORM context lookup. This framework standardizes Hibernate session interactions and ensures thread-safe database operations.

How do I manage Hibernate sessions and HQL queries in a BoxLang module?

You manage Hibernate sessions and HQL queries in a BoxLang module by utilizing the standardized framework provided by the ORM BIF architecture. This simplifies the logic for flushing, clearing sessions, and executing complex HQL queries safely.

Does BoxLang provide built-in functions for entity CRUD operations?

Yes, BoxLang provides built-in functions for entity CRUD operations such as EntityNew, EntitySave, and EntityDelete. The BaseORMBIF framework facilitates the implementation of these entity lifecycle methods within your custom modules.

Why do BoxLang ORM built-in functions require explicit ORM context lookup?

BoxLang ORM built-in functions require explicit ORM context lookup to ensure thread-safe database interactions. Adhering to this pattern and the BaseORMBIF inheritance model guarantees that Hibernate sessions are managed securely across concurrent requests.