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

# deleteByID

Delete using an entity name and an incoming id, you can also flush the session if needed. The ID can be a single ID, a list of IDs or an array of IDs to batch delete using a DML style HQL delete. For an entity with a composite id, pass a struct of key values, or an array of them. Pending changes in the session are flushed before the delete runs, and a `softDelete` entity is marked deleted instead. The function also returns the number of records deleted.

{% hint style="danger" %}
No cascading will be done since the delete is done without loading the entity into session but via a DML HQL statement
{% endhint %}

## Returns

* This function returns *numeric*

## Arguments

| Key           | Type    | Required | Default       | Description                                                                        |
| ------------- | ------- | -------- | ------------- | ---------------------------------------------------------------------------------- |
| entityName    | string  | Yes      | ---           | The name of the entity to delete                                                   |
| id            | any     | Yes      | ---           | A single ID, list or array of IDs; a struct or array of structs for a composite id |
| flush         | boolean | No       | false         |                                                                                    |
| transactional | boolean | No       | From Property | Use transactions or not                                                            |

## Examples

```javascript
// just delete
count = ormService.deleteByID("User",1);

// delete and flush
count = ormService.deleteByID("User",4,true);

// Delete several records, or at least try
count = ormService.deleteByID("User",[1,2,3,4]);

// composite id
count = ormService.deleteByID( "EntryCategory", { entryId : 1, categoryId : 2 } );
```


---

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