> 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/querying/list.md).

# list

List **all** of the instances of the passed in entity class name with or without any filtering of properties, no HQL needed. It delegates to the `bx-orm` `entityLoad()` function.

You can pass in several optional arguments like a struct of filtering criteria, a `sortOrder` string, `offset`, `max`, `ignorecase`, and `timeout`. Caching for the list is based on the *`useQueryCaching`* class property and the *`cachename`* property is based on the `queryCacheRegion` class property.

## Returns

* This function returns array if **asQuery = false**
* This function returns a query if **asQuery = true**
* This function returns a Java `Stream` read from the database as it is consumed if **asStream = true** (see [Java Streams](/v5.x/advanced/java-streams.md))

## Arguments

| Key        | Type    | Required | Default          | Description                                                                   |
| ---------- | ------- | -------- | ---------------- | ----------------------------------------------------------------------------- |
| entityName | string  | Yes      | ---              | The entity to list                                                            |
| criteria   | struct  | No       |                  | A struct of filtering criteria for the listing                                |
| sortOrder  | string  | No       |                  | The sorting order of the listing                                              |
| offset     | numeric | No       | 0                | Pagination offset                                                             |
| max        | numeric | No       | 0                | Max records to return                                                         |
| timeout    | numeric | No       | 0                | Query timeout                                                                 |
| ignoreCase | boolean | No       | false            | Sort text properties case-insensitively (applies when you pass a `sortOrder`) |
| asQuery    | boolean | No       | `defaultAsQuery` | Return query or array of objects                                              |
| asStream   | boolean | No       | false            | Returns a Java `Stream` instead of an array                                   |
| options    | struct  | No       | `{}`             | More `bx-orm` `entityLoad()` options, e.g. `{ readOnly : true }`              |

## Examples

```javascript
aUsers = ormService.list( 
    entityName="User", 
    max=20, 
    offset=10
);

users = ormService.list( entityName="Art", timeout=10 );

users = ormService.list( "User", {isActive=false}, "lastName,firstName" );

users = ormService.list( "Comment", {postID=rc.postID}, "createdDate desc" );

qUsers = ormService.list( entityName="User", asQuery = true );

// A Java stream, read from the database as it is consumed
activeNames = ormService.list( entityName="User", asStream = true )
    .filter( ( user ) => user.getIsActive() )
    .map( ( user ) => user.getFullName() )
    .toList();

// Read-only entities
users = ormService.list( entityName="User", options = { readOnly : 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/querying/list.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.