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

# executeQuery

Allows the execution of **Custom HQL** queries with binding, pagination, and many options. Underlying mechanism is the `bx-orm` `ormExecuteQuery()` function. The **params** filtering can be using named or positional.

{% hint style="info" %}
Positional parameters can be written as plain `?` or numbered `?1`, `?2` (JPA style), and named parameters as `:name`. Entity and property names in the HQL can be in any case: `bx-orm` resolves them to their declared case.
{% endhint %}

{% hint style="warning" %}
**Changed in cborm 6**: with `unique = true`, more than one matching row raises an `orm.query.nonUnique` error instead of returning the first row. Use [`findIt()`](/v5.x/base-orm-service/service-methods/finders/findit.md), or pass `options = { uniqueFirst : true }`, if you just want the first result.
{% endhint %}

## Returns

This function returns multiple formats:

* array of objects
* array of structs (when you `select new map(...)`)
* a single value or entity (when `unique = true`)
* query (when `asQuery = true`)
* a Java `Stream` read from the database as it is consumed (when `asStream = true`, see [Java Streams](/v5.x/advanced/java-streams.md))
* the number of affected records for DML statements (`update`, `insert`, `delete`)

## Arguments

| Key        | Type            | Required | Default            | Description                                                                                                        |
| ---------- | --------------- | -------- | ------------------ | ------------------------------------------------------------------------------------------------------------------ |
| query      | string          | Yes      | ---                | The valid HQL to process                                                                                           |
| params     | array or struct | No       | `{}`               | Positional or named parameters                                                                                     |
| offset     | numeric         | No       | 0                  | Pagination offset                                                                                                  |
| max        | numeric         | No       | 0                  | Max records to return                                                                                              |
| timeout    | numeric         | No       | 0                  | Query timeout                                                                                                      |
| ignoreCase | boolean         | No       | false              | Ignored, kept for compatibility: use `lower()` in the HQL                                                          |
| asQuery    | boolean         | No       | `defaultAsQuery`   | Return query or array of objects                                                                                   |
| unique     | boolean         | No       | false              | Return a unique result                                                                                             |
| datasource | string          | No       | Service datasource | Use a specific or default datasource                                                                               |
| asStream   | boolean         | No       | false              | Returns a Java `Stream` instead of an array. Not allowed with `unique` or DML                                      |
| options    | struct          | No       | `{}`               | More `bx-orm` `ormExecuteQuery()` options: `readOnly`, `lock`, `uniqueFirst`, `fetchSize`, `comment`, `hints`, ... |

The service announces the `beforeOrmExecuteQuery` and `afterOrmExecuteQuery` interception points around the query when `eventHandling` is enabled.

## Examples

```javascript
// simple query
ormService.executeQuery( "select distinct a.accountID from Account a" );

// using with list of parameters
ormService.executeQuery(
    "select distinct e.employeeID from Employee e where e.department = ? and e.created > ?",
    [ 'IS', '01/01/2010' ]
);

// same query but with numbered positional parameters and paging
ormService.executeQuery(
    "select distinct e.employeeID from Employee e where e.department = ?1 and e.created > ?2",
    [ 'IS', '01/01/2010' ],
    1,
    30
);

// same query but with named params and paging
ormService.executeQuery(
    "select distinct e.employeeID from Employee e where e.department = :dep and e.created > :created",
    { dep='Accounting', created='01/01/2010' },
    10,
    20
);

// a unique result
var total = ormService.executeQuery(
    query  = "select count(*) from Employee e where e.department = :dep",
    params = { dep : 'IS' },
    unique = true
);

// the first row, even when several match
var newest = ormService.executeQuery(
    query   = "from Employee e order by e.created desc",
    unique  = true,
    options = { uniqueFirst : true }
);

// a stream
var ids = ormService.executeQuery( query = "from Employee", asStream = true )
    .map( ( e ) => e.getEmployeeID() )
    .toList();
```


---

# 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/executequery.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.