Tags · Functions · Objects
Lucee Function Reference
Choose a function:

Function ENTITYLOADBYPK

Loads and returns an array of objects for given primary key.

Example

entityloadbypk(string name,string id,[boolean unique]):any

Arguments

The arguments for this function are set. You can not use other arguments except the following ones.
Name Type Required Description
name string  Yes Name of the entity to be loaded.  
id string  Yes The primary key value of the entity that must be loaded  
unique boolean  No If unique is set to true, then the entity is returned.
If you are sure that only one record exists that matches this filtercriteria, then you can specify unique=true, so that a single entity is returned instead of an array.
If you set unique=true and multiple records are returned, then an exception occurs.