Humiex (humiex v0.1.0) View Source

Functions to query and stream requests using Humiex search API

Link to this section Summary

Link to this section Types

Link to this section Functions

Link to this function

query(client, query_string, start_time, end_time \\ nil, opts \\ [])

View Source

Specs

query(Humiex.Client.t(), String.t(), maybe_time(), maybe_time(), keyword()) ::
  {:ok, [any()], Humiex.State.t()} | {:error, any()}

See Humiex.Query.query/5.

Link to this function

query_values(client, query_string, start_time, end_time \\ nil, opts \\ [])

View Source

Specs

query_values(
  Humiex.Client.t(),
  String.t(),
  maybe_time(),
  maybe_time(),
  keyword()
) :: [any()]

See Humiex.Query.query_values/5.

Specs

stream(Humiex.State.t()) :: Enumerable.t()

See Humiex.Stream.stream/1.

Link to this function

stream(client, query_string, start_time, opts \\ [])

View Source

Specs

See Humiex.Stream.stream/4.

Specs

stream_values(Humiex.State.t()) :: Enumerable.t()

See Humiex.Stream.stream_values/1.

Link to this function

stream_values(client, query_string, start_time, opts \\ [])

View Source

Specs

stream_values(Humiex.Client.t(), String.t(), maybe_time(), keyword()) ::
  Enumerable.t()

See Humiex.Stream.stream_values/4.