[[reference-delete_by_query]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
=== client.deleteByQuery

Delete documents. Deletes documents that match the specified query.

{ref}/docs-delete-by-query.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(DeleteByQueryRequest, options?): Promise<DeleteByQueryResponse>
----

[discrete]
===== `DeleteByQueryRequest`

[source,ts]
----
interface DeleteByQueryRequest extends <<shared-type-request-base, RequestBase>> {
  index: <<shared-type-indices, Indices>>
  allow_no_indices?: boolean
  analyzer?: string
  analyze_wildcard?: boolean
  conflicts?: <<shared-type-conflicts, Conflicts>>
  default_operator?: QueryDslOperator
  df?: string
  expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
  from?: <<shared-type-long, long>>
  ignore_unavailable?: boolean
  lenient?: boolean
  preference?: string
  refresh?: boolean
  request_cache?: boolean
  requests_per_second?: <<shared-type-float, float>>
  routing?: <<shared-type-routing, Routing>>
  q?: string
  scroll?: <<shared-type-duration, Duration>>
  scroll_size?: <<shared-type-long, long>>
  search_timeout?: <<shared-type-duration, Duration>>
  search_type?: <<shared-type-search-type, SearchType>>
  slices?: <<shared-type-slices, Slices>>
  sort?: string[]
  stats?: string[]
  terminate_after?: <<shared-type-long, long>>
  timeout?: <<shared-type-duration, Duration>>
  version?: boolean
  wait_for_active_shards?: <<shared-type-wait-for-active-shards, WaitForActiveShards>>
  wait_for_completion?: boolean
  max_docs?: <<shared-type-long, long>>
  query?: QueryDslQueryContainer
  slice?: <<shared-type-sliced-scroll, SlicedScroll>>
}
----

[discrete]
===== `DeleteByQueryResponse`

[source,ts]
----
interface DeleteByQueryResponse {
  batches?: <<shared-type-long, long>>
  deleted?: <<shared-type-long, long>>
  failures?: <<shared-type-bulk-index-by-scroll-failure, BulkIndexByScrollFailure>>[]
  noops?: <<shared-type-long, long>>
  requests_per_second?: <<shared-type-float, float>>
  retries?: <<shared-type-retries, Retries>>
  slice_id?: <<shared-type-integer, integer>>
  task?: <<shared-type-task-id, TaskId>>
  throttled?: <<shared-type-duration, Duration>>
  throttled_millis?: <<shared-type-duration-value, DurationValue>><<<shared-type-unit-millis, UnitMillis>>>
  throttled_until?: <<shared-type-duration, Duration>>
  throttled_until_millis?: <<shared-type-duration-value, DurationValue>><<<shared-type-unit-millis, UnitMillis>>>
  timed_out?: boolean
  took?: <<shared-type-duration-value, DurationValue>><<<shared-type-unit-millis, UnitMillis>>>
  total?: <<shared-type-long, long>>
  version_conflicts?: <<shared-type-long, long>>
}
----