The OpenSearch reindex and by-query APIs — the endpoints tagged Reindex in the OpenSearch OpenAPI specification.

Built on Dowser.Client. Required OpenSearch attributes are positional arguments; everything optional lives in opts.

OpenSearch groups _reindex, _delete_by_query and _update_by_query under one tag, along with the _rethrottle endpoint each of them has, so they all live here — where Elasticsearch tags them as document APIs.

Shared conventions

• Endpoints that accept a request body take it as their first argument, required — pass %{} to send nothing. The argument is named query when the body is an OpenSearch query DSL document and body otherwise.
• The by-query endpoints require an index target, so they take it as an argument rather than an option.

All remaining options are forwarded to Dowser.Client.request/4, e.g. :context, :params (query-string parameters), :format, :keys and :http_opts (including :headers) — plus :codec, this package's own, which picks the per-field codec for this one request (see Dowser.Opensearch.Codec).

None of these endpoints is marked retryable: each one writes, and a _reindex or _update_by_query that timed out may well have applied part of its work, so re-sending it would redo that part. Pass retry: [idempotent: true] to override that for a call you know is safe to repeat.

Running long operations in the background

Every endpoint here can take longer than a request should, so OpenSearch accepts params: [wait_for_completion: false] on all of them: the response is then a task id, which _tasks reports on and the *_rethrottle functions below can slow down or speed up.

On a 2xx response every function returns {:ok, body} with the decoded response body. A non-2xx response returns {:error, %Dowser.Opensearch.Error{}}; a transport, encoding or decoding failure returns {:error, exception} from Dowser.Client. A required argument that is missing or empty is reported the same way, before any request is made: {:error, %ArgumentError{}}. Each function has a bang variant that returns the body directly or raises the error exception.