Documentation

An InfluxDB query.

A spec of the format is available at https://docs.influxdata.com/influxdb/v1.7/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.

InfluxDB server to connect to.

Following lenses are available to access its fields:

• host: FQDN or IP address of the InfluxDB server
• port: Port number of the InfluxDB server
• ssl: Whether or not to use SSL

Host name of the server

Port number of the server

If SSL is enabled

For secure connections (HTTPS), consider using one of the following packages:

• http-client-tls
• http-client-openssl

Default InfluxDB server settings

Default parameters:

>>> defaultServer ^. host
"localhost"
>>> defaultServer ^. port
8086
>>> defaultServer ^. ssl
False

HTTPS-enabled InfluxDB server settings

User credentials.

Following lenses are available to access its fields:

• user
• password

Smart constructor for Credentials

User name to access InfluxDB.

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

Password to access InfluxDB

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

Database name.

formatDatabase can be used to construct a Database.

>>> "test-db" :: Database
"test-db"
>>> formatDatabase "test-db"
"test-db"
>>> formatDatabase ("test-db-"%F.decimal) 0
"test-db-0"

String name that is used for measurements.

formatMeasurement can be used to construct a Measurement.

>>> "test-series" :: Measurement
"test-series"
>>> formatMeasurement "test-series"
"test-series"
>>> formatMeasurement ("test-series-"%F.decimal) 0
"test-series-0"

String type that is used for tag keys/values and field keys.

formatKey can be used to construct a Key.

>>> "test-key" :: Key
"test-key"
>>> formatKey "test-key"
"test-key"
>>> formatKey ("test-key-"%F.decimal) 0
"test-key-0"

Nullability of fields.

Queries can contain nulls but the line protocol cannot.

Field type for queries. Queries can contain null values.

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

Type of a request

Predefined set of time precision.

RFC3339 is only available for QueryRequests.

Name of the time precision.

>>> precisionName Nanosecond
"n"
>>> precisionName Microsecond
"u"
>>> precisionName Millisecond
"ms"
>>> precisionName Second
"s"
>>> precisionName Minute
"m"
>>> precisionName Hour
"h"
>>> precisionName RFC3339
"rfc3339"

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

Exceptions used in this library.

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

Class of data types that have a server field

Class of data types that have a database field

Class of data types that have a precision field

Class of data types that have a manager field

Class of data types that has an authentication field