The OpenSearch list APIs — every endpoint tagged List in the OpenSearch OpenAPI specification.

Built on Dowser.Client. These endpoints take no request body and no required attribute: each one's optional path parameter is an option, so every function has the same opts-only signature.

How this differs from CAT

These are OpenSearch's own addition, and have no Elasticsearch counterpart. They answer the same questions as Dowser.Opensearch.Cat.indices/1 and Dowser.Opensearch.Cat.shards/1, but paginated: on a cluster with thousands of indices, the cat endpoints build the whole table in the coordinating node's heap before sending it, while these return one page and a next_token for the following one.

Prefer these where the number of indices or shards is large or unbounded, and CAT where you know it is small and want the single-response simplicity.

Paging

A response carries next_token until the last page, which returns it as null. Feed it back through params: [next_token: token]:

def all_indices(token \\ nil, acc \\ []) do
  params = if token, do: [next_token: token], else: []
  page = Dowser.Opensearch.List.indices!(params: params ++ [size: 100])

  case page["next_token"] do
    nil -> acc ++ page["indices"]
    next -> all_indices(next, acc ++ page["indices"])
  end
end

Shared options

Passed through :params:

• size — how many rows per page.
• next_token — the page to continue from, as above.
• v — add the column headers.
• h — the columns to return, e.g. h: "index,docs.count".
• s — the columns to sort on, e.g. s: "docs.count:desc".
• bytes / time — the unit sizes and durations are expressed in.
• format — see below.

Like the cat APIs, these are meant for humans at a terminal and answer in aligned text by default, but honour the accept header Dowser.Client sends, so the response comes back as JSON. For the aligned text, ask for it explicitly — the format query parameter wins over the header, and resp_format: :raw keeps the body from being parsed:

Dowser.Opensearch.List.indices!(params: [format: "text", v: true], resp_format: :raw)

All remaining options are forwarded to Dowser.Client.request/4, e.g. :context, :params (query-string parameters), :format, :keys and :http_opts (including :headers).

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. Each function has a bang variant that returns the body directly or raises the error exception.