[[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 || || || || || || || =========================================================================================================================== //////// [discrete] [[client.deleteByQuery]] === 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 ---- [discrete] ==== Request [pass] ++++ 
++++
interface DeleteByQueryRequest extends <> {
  index: <>
  allow_no_indices?: boolean
  analyzer?: string
  analyze_wildcard?: boolean
  conflicts?: <>
  default_operator?: <>
  df?: string
  expand_wildcards?: <>
  from?: <>
  ignore_unavailable?: boolean
  lenient?: boolean
  preference?: string
  refresh?: boolean
  request_cache?: boolean
  requests_per_second?: <>
  routing?: <>
  q?: string
  scroll?: <>
  scroll_size?: <>
  search_timeout?: <>
  search_type?: <>
  slices?: <>
  sort?: string[]
  stats?: string[]
  terminate_after?: <>
  timeout?: <>
  version?: boolean
  wait_for_active_shards?: <>
  wait_for_completion?: boolean
  max_docs?: <>
  query?: <>
  slice?: <>
}

[pass]
++++
++++ [discrete] ==== Response [pass] ++++ 
++++
interface DeleteByQueryResponse {
  batches?: <>
  deleted?: <>
  failures?: <>[]
  noops?: <>
  requests_per_second?: <>
  retries?: <>
  slice_id?: <>
  task?: <>
  throttled?: <>
  throttled_millis?: <><<>>
  throttled_until?: <>
  throttled_until_millis?: <><<>>
  timed_out?: boolean
  took?: <><<>>
  total?: <>
  version_conflicts?: <>
}

[pass]
++++
++++