An InfluxDB query.

A spec of the format is available at https://docs.influxdata.com/influxdb/v1.2/query_language/spec/.

A Query can be constructed using either

• the IsString instance with -XOverloadedStrings
• or formatQuery.

>>> :set -XOverloadedStrings
>>> "SELECT * FROM series" :: Query
"SELECT * FROM series"
>>> import qualified Database.InfluxDB.Format as F
>>> formatQuery ("SELECT * FROM "%F.key) "series"
"SELECT * FROM \"series\""

NOTE: Currently this library doesn't support type-safe query construction.

Query data from InfluxDB.

It may throw InfluxException.

Same as query but it instructs InfluxDB to stream chunked responses rather than returning a huge JSON object. This can be lot more efficient than query if the result is huge.

It may throw InfluxException.

The full set of parameters for the query API

Smart constructor for QueryParams

Default parameters:

server

defaultServer

precision

RFC3339

authentication

Nothing

manager

Left defaultManagerSettings

InfluxDB server address and port that to interact with.

Database name to work on.

Time precision parameter.

HTTP manager settings or a manager itself.

If it's set to ManagerSettings, the library will create a Manager from the settings for you.

Types that can be converted from an JSON object returned by InfluxDB.

For example the h2o_feet series in the official document can be encoded as follows:

>>> :{
data H2OFeet = H2OFeet
  { time :: UTCTime
  , levelDesc :: T.Text
  , location :: T.Text
  , waterLevel :: Double
  }
instance QueryResults H2OFeet where
  parseResults prec = parseResultsWith $ \_ _ columns fields -> do
    time <- getField "time" columns fields >>= parseUTCTime prec
    String levelDesc <- getField "level_description" columns fields
    String location <- getField "location" columns fields
    FieldFloat waterLevel <-
      getField "water_level" columns fields >>= parseQueryField
    return H2OFeet {..}
:}

A helper function to parse a JSON response in parseResults.