> 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/deleting-entities/deletebyquery.md).

# deleteByQuery

Delete entities by using an HQL query. Do not add the `delete` keyword to your query, it is added automatically for you, so you pass the `from ... where ...` part. The query runs as a single DML HQL `delete` statement and returns the number of records deleted.

{% hint style="danger" %}
No cascading will be done and no ORM events are fired, since the entities are not loaded into the session.
{% endhint %}

## Returns

* This function returns *numeric* (the number of records deleted)

## Arguments

| Key           | Type    | Required | Default            | Description                                                                 |
| ------------- | ------- | -------- | ------------------ | --------------------------------------------------------------------------- |
| query         | string  | Yes      | ---                | The HQL query without the `delete` keyword                                  |
| params        | any     | No       | `{}`               | Named (struct) or positional (array) parameters                             |
| flush         | boolean | No       | false              | Flush the session after deleting                                            |
| transactional | boolean | No       | From Property      | Wrap the call in a BoxLang `transaction{}` (joins an active one if present) |
| datasource    | string  | No       | Service datasource | The datasource to use                                                       |

## Examples

```javascript
// delete all blog posts
ormService.deleteByQuery( "from Post" );

// delete query with positional parameters
ormService.deleteByQuery( "from Post as b where b.author = ?1 and b.isActive = ?2", [ "Luis Majano", false ] );

// examples with named parameters
ormService.deleteByQuery( "from Post as p where p.author = :author", { author : "Luis Majano" } );

// delete and flush
ormService.deleteByQuery(
    query  = "from User as u where u.isActive = :active",
    params = { active : false },
    flush  = 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/deleting-entities/deletebyquery.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.
