View Source Avalanche.StatusRequest (Avalanche v0.12.2)

The check query status request struct.

Struct fields:

  • :url - the HTTP request URL (e.g.

  • :path - the HTTP request path.

  • :headers - the HTTP request headers.

  • :body - the HTTP request body.

  • :token - the HTTP Bearer authentication token.

  • :row_types - an array of objects that describe the columns in the set of results. used for decoding.

  • :options - options to customize HTTP pipeline steps

Link to this section Summary


Builds a query status request to run.

Runs a query status request.

Link to this section Types

@type row_types() :: [map()] | nil
@type t() :: %Avalanche.StatusRequest{
  headers: keyword(),
  options: keyword(),
  path: String.t(),
  row_types: row_types(),
  statement_handle: String.t(),
  token: String.t() | keyword(),
  url: url()
@type url() :: String.t() | URI.t()

Link to this section Functions

Link to this function

build(statement_handle, row_types \\ nil, options)

View Source
@spec build(String.t(), row_types(), keyword()) :: t()

Builds a query status request to run.

Link to this function

run(request, async \\ false, partition \\ 0)

View Source

Runs a query status request.

Returns {:ok, response} or {:error, exception}.