Write a Line.

>>> let p = writeParams "test-db"
>>> write p $ Line "room_temp" Map.empty (Map.fromList [("temp", FieldFloat 25.0)]) (Nothing :: Maybe UTCTime)

Write multiple Lines in a batch.

This is more efficient than calling write multiple times.

>>> let p = writeParams "test-db"
>>> :{
writeBatch p
  [ Line "temp" (Map.singleton "city" "tokyo") (Map.fromList [("temp", FieldFloat 25.0)]) (Nothing :: Maybe UTCTime)
  , Line "temp" (Map.singleton "city" "osaka") (Map.fromList [("temp", FieldFloat 25.2)]) (Nothing :: Maybe UTCTime)
  ]
:}

Write a raw ByteString

The full set of parameters for the HTTP writer.

Smart constructor for WriteParams

Default parameters:

server

defaultServer

precision

Nanosecond

retentionPolicy

Nothing

manager

Left defaultManagerSettings

Target retention policy for the write.

InfluxDB writes to the default retention policy if this parameter is set to Nothing.

>>> let p = writeParams "foo" & retentionPolicy .~ Just "two_hours"
>>> p ^. retentionPolicy
Just "two_hours"

Placeholder for the Line Protocol

See https://docs.influxdata.com/influxdb/v1.2/write_protocols/line_protocol_tutorial/ for the concrete syntax.

Name of the measurement that you want to write your data to.

Tag(s) that you want to include with your data point. Tags are optional in the Line Protocol, so you can set it empty.

Field(s) for your data point. Every data point requires at least one field in the Line Protocol, so it shouldn't be empty.

Timestamp for your data point. You can put whatever type of timestamp that is an instance of the Timestamp class.

Field type for the line protocol. The line protocol doesn't accept null values.

Field type for queries. Queries can contain null values.

A Timestamp is something that can be converted to a valid InfluxDB timestamp, which is represented as a 64-bit integer.

Scale of the type precision.

>>> precisionScale RFC3339
1.0e-9
>>> precisionScale Microsecond
1.0e-6

Name of the time precision.

>>> precisionName Nanosecond
"n"

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.

Format a Query.

>>> formatQuery "SELECT * FROM series"
"SELECT * FROM series"
>>> formatQuery ("SELECT * FROM "%key) "series"
"SELECT * FROM \"series\""

Format specific synonym of (.).

This is typically easier to use than (.) is because it doesn't conflict with Prelude.(.).

The full set of parameters for the query API

Smart constructor for QueryParams

Default parameters:

server

defaultServer

precision

RFC3339

authentication

Nothing

manager

Left defaultManagerSettings

User name and password to be used when sending requests to InfluxDB.

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.

Get a field value from a column name

Get a tag value from a tag name

Parse either a POSIX timestamp or RFC3339 formatted timestamp as UTCTime.

Parse either a POSIX timestamp or RFC3339 formatted timestamp as POSIXTime.

Parse a QueryField.

Send a database management query to InfluxDB.

>>> let db = "manage-test"
>>> let p = queryParams db
>>> manage p $ F.formatQuery ("CREATE DATABASE "%F.database) db

Predefined set of time precision.

RFC3339 is only available for QueryRequests.

Database name.

formatDatabase can be used to construct a Database.

Format a Database.

>>> formatDatabase "test-db"
"test-db"

String type that is used for measurements, tag keys and field keys.

formatKey can be used to construct a Key.

Format a Key.

>>> formatKey "test-key"
"test-key"

Default server settings.

Default parameters:

• host: "localhost"
• port: 8086
• ssl: False

Host name of the server

Port number of the server

If SSL is enabled

User credentials

User name to access InfluxDB.

>>> let creds = credentials "john" "passw0rd"
>>> creds ^. user
"john"

Password to access InfluxDB

Exceptions used in this library.

In general, the library tries to convert exceptions from the dependent libraries to the following types of errors.