> For the complete documentation index, see [llms.txt](https://coldbox-orm.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://coldbox-orm.ortusbooks.com/v5.x/base-orm-service/service-methods/getters/getall.md).

# getAll

Retrieve all the instances from the passed in entity name using the id argument if specified. The id can be a single ID, a list of IDs or an array of IDs, or none to retrieve all. For an entity with a composite id, pass a struct of key values, or an array of them. IDs that are not found are simply not part of the results, and the results come back in the `sortOrder` you pass, not in the order of the IDs.

You can use the `readOnly` argument to give you the entities as read only entities.

You can use the `properties` argument so this method can return to you array of structs instead of array of objects. The property list must include the `as` alias if not you will get positional keys.

Example Positional: `properties="catID,category` Example Aliases: `properties="catID as id, category as category, role as role"`

You can use the `asStream` boolean argument to get a Java `Stream` instead of an array (see [Java Streams](/v5.x/advanced/java-streams.md)).

{% hint style="info" %}
The `sortOrder` only takes property names or paths, each with an optional `asc` or `desc` (`"lastName desc, firstName"`). Anything else raises an error, so the sort order can never inject HQL. Without a `sortOrder`, the entity's `defaultSort` applies.
{% endhint %}

{% hint style="success" %}
No casting is necessary on the Id value type: `bx-orm` converts it to the entity's id type for you.
{% endhint %}

## Returns

* This function returns *array* of entities found (or an array of structs when using `properties`)
* This function returns a Java `Stream` if **asStream = true**

## Arguments

| Key        | Type    | Required | Default | Description                                                                                                                                                   |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| entityName | string  | true     | ---     |                                                                                                                                                               |
| id         | any     | false    | ---     | An id, a list or array of ids, or a struct (or array of structs) of key values for a composite id                                                             |
| sortOrder  | string  | false    | ---     | The sort ordering of the array                                                                                                                                |
| readOnly   | boolean | false    | false   |                                                                                                                                                               |
| properties | string  | false    |         | If passed, you can retrieve an array of properties of the entity instead of the entire entity. Make sure you add aliases to the properties: Ex: 'catId as id' |
| asStream   | boolean | false    | false   | Returns a Java `Stream` instead of an array                                                                                                                   |

## Examples

```javascript
// Get all user entities
users = ORMService.getAll(entityName="User", sortOrder="email desc");
// Get all the following users by id's
users = ORMService.getAll("User","1,2,3");
// Get all the following users by id's as array
users = ORMService.getAll("User",[1,2,3,4,5]);
// Get an array of structs instead of entities
cats = ORMService.getAll( entityName="Category", properties="catID as id, category as category" );
// Composite ids: a struct of key values, or an array of them
links = ORMService.getAll( "EntryCategory", [ { entryId : 1, categoryId : 2 }, { entryId : 1, categoryId : 3 } ] );
// Get a Java stream
stream = ORMService.getAll( entityName="User", asStream=true );
```


---

# 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://coldbox-orm.ortusbooks.com/v5.x/base-orm-service/service-methods/getters/getall.md?ask=<question>&goal=<user_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.