Built-in Functions

bx-orm ships a set of Built-in Functions (BIFs) for working with entities and the underlying Hibernate session. They fall into two groups:

Entity Functions

Function	Description
EntityDelete	Delete an entity from the database.
EntityIsAttached	Check whether an entity is attached to the current ORM session.
EntityLoad	Load an entity or array of entities from the database.
EntityLoadByExample	Load entities matching an example entity.
EntityLoadByPK	Load an array of entities by the primary key.
EntityMerge	Merge the state of the given entity into the current persistence context (session).
EntityNameArray	Retrieve an array of entity names for this ORM application.
EntityNameList	Retrieve a list of entity names for this ORM application.
EntityNew	Instantiate a new entity, optionally with a struct of properties.
EntityReload	Reload an entity from the database.
EntitySave	Save the provided entity to the persistence context.
EntityToQuery	Convert an entity or array of entities to a Query object.

ORM Session Functions

Function	Description
ORMClearSession	Clear the Hibernate session for the current context and provided (or default) datasource.
ORMCloseAllSessions	Close all Hibernate sessions for the current context on all datasources.
ORMCloseSession	Close the Hibernate session for the current context and provided (or default) datasource.
ORMEvictCollection	Evict all entity data for a given collection on a given entity type from the second-level cache.
ORMEvictEntity	Evict all entity data for this entity name from the second-level cache.
ORMEvictQueries	Evict all queries from the named or default cache on the named or default datasource.
ORMExecuteQuery	Execute an HQL query with (optional) parameters and specific query options.
ORMFlush	Flush the Hibernate session, synchronizing the in-memory state with the database.
ORMFlushAll	Flush all open Hibernate sessions in the current request.
ORMGetHibernateVersion	Retrieve the installed Hibernate version.
ORMGetSession	Retrieve the Hibernate Session configured for this datasource or default datasource.
ORMGetSessionFactory	Retrieve the Hibernate SessionFactory configured for this datasource or default datasource.
ORMReload	Reload the ORM application.