> For the complete documentation index, see [llms.txt](https://bxorm.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bxorm.ortusbooks.com/bxorm-2.x/reference/built-in-functions/entityloadasstruct.md). # EntityLoadAsStruct Load entities straight into structs with projection queries Load entities straight into structs, without loading the entities: one projection query for the plain values and to-one associations (left joins), plus one query per to-many association, limited to the ids just read. The structs match what `entityToStruct()` builds for the same includes: the entity's `this.memento`, includes, excludes, mappers, defaults, profiles and ISO 8601 dates. * An id returns a struct, or `null` when no row matches. * A filter struct (property values to match, `null` for `is null`) returns an array of structs, or one struct (or `null`) with the `unique` option. Several matching rows with `unique` raise `orm.query.nonUnique`. * Collections come back in id order. A property whose getter you wrote is read through that getter, as in `entityToStruct()`: the row's plain values are copied into a scratch instance and the getter is called on it (associations are not loaded there). Includes that are only getters, not properties, need a loaded entity: one listed in the entity's `this.memento` defaults is left out, and one you ask for in `includes` raises `orm.argument` (use `entityToStruct()`, or compute the key with a mapper). Value collections (`fieldtype="collection"`) and entities with a composite id raise `orm.argument` too. An unknown include raises `orm.property.unknown`. See [Entities as Structs](/bxorm-2.x/working-with-entities/structs.md). ## Method Signature ``` EntityLoadAsStruct(entityName=[String], idOrFilter=[Any], includes=[Any], options=[Struct]) ``` ### Arguments | Argument | Type | Required | Description | Default | | ------------ | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | | `entityName` | `String` | `true` | The name of the entity. | | | `idOrFilter` | `Any` | `true` | The primary key value, or a struct of property values to match. | | | `includes` | `Any` | `false` | Properties and dotted association paths to add to the entity's defaults, as a list or array. Empty for the defaults only. | | | `options` | `Struct` | `false` | `sortOrder`, `maxResults`, `offset`, `unique`, and the struct options of `entityToStruct()`: `excludes`, `mappers`, `defaults`, `ignoreDefaults`, `profile`. | | Returns a struct or `null` for an id (or a filter with `unique`), else an array of structs. ## Examples By id, with the entity's defaults and one association field: ```java user = entityLoadAsStruct( "User", 42, "role.name" ); // { id : 42, firstName : "Ann", ..., role : { name : "admin" } } ``` By filter, with a collection, sorted and limited: ```java users = entityLoadAsStruct( "User", { active : true }, "orders", { sortOrder : "lastName", maxResults : 20 } ); ``` A profile and no extra includes: ```java rows = entityLoadAsStruct( "User", { active : true }, "", { profile : "list" } ); ``` One struct from a filter: ```java user = entityLoadAsStruct( "User", { email : "ann@example.com" }, "", { unique : true } ); ``` ## Related * [EntityCriteria](/bxorm-2.x/reference/built-in-functions/entitycriteria.md) * [EntityDelete](/bxorm-2.x/reference/built-in-functions/entitydelete.md) * [EntityEvict](/bxorm-2.x/reference/built-in-functions/entityevict.md) * [EntityGetDatasource](/bxorm-2.x/reference/built-in-functions/entitygetdatasource.md) * [EntityGetDirtyProperties](/bxorm-2.x/reference/built-in-functions/entitygetdirtyproperties.md) * [EntityGetId](/bxorm-2.x/reference/built-in-functions/entitygetid.md) * [EntityGetMetadata](/bxorm-2.x/reference/built-in-functions/entitygetmetadata.md) * [EntityGetName](/bxorm-2.x/reference/built-in-functions/entitygetname.md) * [EntityGetReference](/bxorm-2.x/reference/built-in-functions/entitygetreference.md) * [EntityIsAttached](/bxorm-2.x/reference/built-in-functions/entityisattached.md) * [EntityIsDirty](/bxorm-2.x/reference/built-in-functions/entityisdirty.md) * [EntityLoad](/bxorm-2.x/reference/built-in-functions/entityload.md) * [EntityLoadByExample](/bxorm-2.x/reference/built-in-functions/entityloadbyexample.md) * [EntityLoadByPK](/bxorm-2.x/reference/built-in-functions/entityloadbypk.md) * [EntityLoadByPKOrFail](/bxorm-2.x/reference/built-in-functions/entityloadbypkorfail.md) * [EntityLoadOrFail](/bxorm-2.x/reference/built-in-functions/entityloadorfail.md) * [EntityLoadOrNew](/bxorm-2.x/reference/built-in-functions/entityloadornew.md) * [EntityLoadOrSave](/bxorm-2.x/reference/built-in-functions/entityloadorsave.md) * [EntityLoadReadOnly](/bxorm-2.x/reference/built-in-functions/entityloadreadonly.md) * [EntityLock](/bxorm-2.x/reference/built-in-functions/entitylock.md) * [EntityMerge](/bxorm-2.x/reference/built-in-functions/entitymerge.md) * [EntityNameArray](/bxorm-2.x/reference/built-in-functions/entitynamearray.md) * [EntityNameList](/bxorm-2.x/reference/built-in-functions/entitynamelist.md) * [EntityNew](/bxorm-2.x/reference/built-in-functions/entitynew.md) * [EntityReload](/bxorm-2.x/reference/built-in-functions/entityreload.md) * [EntitySave](/bxorm-2.x/reference/built-in-functions/entitysave.md) * [EntityToQuery](/bxorm-2.x/reference/built-in-functions/entitytoquery.md) * [EntityToStruct](/bxorm-2.x/reference/built-in-functions/entitytostruct.md) * [ORMClearSession](/bxorm-2.x/reference/built-in-functions/ormclearsession.md) * [ORMCloseAllSessions](/bxorm-2.x/reference/built-in-functions/ormcloseallsessions.md) * [ORMCloseSession](/bxorm-2.x/reference/built-in-functions/ormclosesession.md) * [ORMDiagnostics](/bxorm-2.x/reference/built-in-functions/ormdiagnostics.md) * [ORMEvictCollection](/bxorm-2.x/reference/built-in-functions/ormevictcollection.md) * [ORMEvictEntity](/bxorm-2.x/reference/built-in-functions/ormevictentity.md) * [ORMEvictQueries](/bxorm-2.x/reference/built-in-functions/ormevictqueries.md) * [ORMExecuteQuery](/bxorm-2.x/reference/built-in-functions/ormexecutequery.md) * [ORMFlush](/bxorm-2.x/reference/built-in-functions/ormflush.md) * [ORMFlushAll](/bxorm-2.x/reference/built-in-functions/ormflushall.md) * [ORMGetHibernateVersion](/bxorm-2.x/reference/built-in-functions/ormgethibernateversion.md) * [ORMGetSQLFunctions](/bxorm-2.x/reference/built-in-functions/ormgetsqlfunctions.md) * [ORMGetSession](/bxorm-2.x/reference/built-in-functions/ormgetsession.md) * [ORMGetSessionFactory](/bxorm-2.x/reference/built-in-functions/ormgetsessionfactory.md) * [ORMGetSessionStatistics](/bxorm-2.x/reference/built-in-functions/ormgetsessionstatistics.md) * [ORMIsSessionDirty](/bxorm-2.x/reference/built-in-functions/ormissessiondirty.md) * [ORMReadOnly](/bxorm-2.x/reference/built-in-functions/ormreadonly.md) * [ORMReload](/bxorm-2.x/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 that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://bxorm.ortusbooks.com/bxorm-2.x/reference/built-in-functions/entityloadasstruct.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.