# BX-ORM

## BXORM 1.x

- [Introduction](https://bxorm.ortusbooks.com/readme.md): The BoxLang ORM module allows your BoxLang application to integrate with the powerful Hibernate ORM
- [About This Book](https://bxorm.ortusbooks.com/readme/about-this-book.md): More info on this documentation gitbook for bx-orm
- [Release History](https://bxorm.ortusbooks.com/release-history.md): Release history for all bx-orm versions
- [1.x](https://bxorm.ortusbooks.com/release-history/1x.md): Version 1.x release notes for the BoxLang ORM Module
- [Installation](https://bxorm.ortusbooks.com/getting-started/installation.md): Get up and running in seconds!
- [Configuration](https://bxorm.ortusbooks.com/getting-started/configuration.md): Easily configure Hibernate with BL
- [Custom Hibernate Config](https://bxorm.ortusbooks.com/getting-started/configuration/custom-hibernate-config.md)
- [Secondary Caches](https://bxorm.ortusbooks.com/getting-started/configuration/secondary-caches.md)
- [Logging](https://bxorm.ortusbooks.com/getting-started/configuration/logging.md): How do Hibernate logs work in bx-orm?
- [Naming Strategies](https://bxorm.ortusbooks.com/getting-started/configuration/naming-strategies.md)
- [ACF/Lucee Migration Guide](https://bxorm.ortusbooks.com/getting-started/migration-from-cfml.md): Migrating to BoxLang ORM from Adobe ColdFusion and Lucee
- [Performance](https://bxorm.ortusbooks.com/getting-started/performance.md)
- [Entities](https://bxorm.ortusbooks.com/modeling/entities.md): Learn the basics of modeling ORM entities
- [Properties](https://bxorm.ortusbooks.com/modeling/properties.md)
- [Identifiers](https://bxorm.ortusbooks.com/modeling/identifiers.md): All about entity identifiers, from primary keys, and generators to composite keys and field types.
- [Relationships](https://bxorm.ortusbooks.com/modeling/relationships.md): Entity relationships let you define an association between two entity types.
- [Queries and HQL](https://bxorm.ortusbooks.com/usage/querying.md)
- [Events](https://bxorm.ortusbooks.com/usage/events.md): Easily run actions on entity insertion, update, and more with event listeners
- [Session Management](https://bxorm.ortusbooks.com/usage/session-management.md)
- [Transactions](https://bxorm.ortusbooks.com/usage/transactions.md): Learn transaction management with bx-orm
- [Caching](https://bxorm.ortusbooks.com/usage/caching.md): Improve your database performance with secondary caching in Hibernate ORM.
- [Built-in Functions](https://bxorm.ortusbooks.com/reference/built-in-functions.md)
- [EntityDelete](https://bxorm.ortusbooks.com/reference/built-in-functions/entitydelete.md)
- [EntityLoad](https://bxorm.ortusbooks.com/reference/built-in-functions/entityload.md)
- [EntityLoadByExample](https://bxorm.ortusbooks.com/reference/built-in-functions/entityloadbyexample.md)
- [EntityLoadByPK](https://bxorm.ortusbooks.com/reference/built-in-functions/entityloadbypk.md)
- [EntityMerge](https://bxorm.ortusbooks.com/reference/built-in-functions/entitymerge.md)
- [EntityNameArray](https://bxorm.ortusbooks.com/reference/built-in-functions/entitynamearray.md)
- [EntityNameList](https://bxorm.ortusbooks.com/reference/built-in-functions/entitynamelist.md)
- [EntityNew](https://bxorm.ortusbooks.com/reference/built-in-functions/entitynew.md)
- [EntityReload](https://bxorm.ortusbooks.com/reference/built-in-functions/entityreload.md)
- [EntitySave](https://bxorm.ortusbooks.com/reference/built-in-functions/entitysave.md)
- [EntityToQuery](https://bxorm.ortusbooks.com/reference/built-in-functions/entitytoquery.md)
- [ORMClearSession](https://bxorm.ortusbooks.com/reference/built-in-functions/ormclearsession.md)
- [ORMCloseAllSessions](https://bxorm.ortusbooks.com/reference/built-in-functions/ormcloseallsessions.md)
- [ORMCloseSession](https://bxorm.ortusbooks.com/reference/built-in-functions/ormclosesession.md)
- [ORMEvictCollection](https://bxorm.ortusbooks.com/reference/built-in-functions/ormevictcollection.md)
- [ORMEvictEntity](https://bxorm.ortusbooks.com/reference/built-in-functions/ormevictentity.md)
- [ORMEvictQueries](https://bxorm.ortusbooks.com/reference/built-in-functions/ormevictqueries.md)
- [ORMExecuteQuery](https://bxorm.ortusbooks.com/reference/built-in-functions/ormexecutequery.md)
- [ORMFlush](https://bxorm.ortusbooks.com/reference/built-in-functions/ormflush.md)
- [ORMFlushAll](https://bxorm.ortusbooks.com/reference/built-in-functions/ormflushall.md)
- [ORMGetHibernateVersion](https://bxorm.ortusbooks.com/reference/built-in-functions/ormgethibernateversion.md)
- [ORMGetSession](https://bxorm.ortusbooks.com/reference/built-in-functions/ormgetsession.md)
- [ORMGetSessionFactory](https://bxorm.ortusbooks.com/reference/built-in-functions/ormgetsessionfactory.md)
- [ORMReload](https://bxorm.ortusbooks.com/reference/built-in-functions/ormreload.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://bxorm.ortusbooks.com/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.