Database.InfluxDB.Types

Documentation

>>> :set -XOverloadedStrings
>>> import System.Clock (TimeSpec(..))
>>> import Database.InfluxDB
>>> import qualified Database.InfluxDB.Format as F

newtype Query

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.

Constructors

Query Text

Instances

IsString Query

Defined in Database.InfluxDB.Types

Methods

fromString :: String -> Query

Show Query

Defined in Database.InfluxDB.Types

Methods

showsPrec :: Int -> Query -> ShowS

show :: Query -> String

showList :: [Query] -> ShowS

data Server

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

Constructors

Server

Fields

• _host :: !Text
• _port :: !Int
• _ssl :: !Bool

Instances

Generic Server

Defined in Database.InfluxDB.Types

Associated Types

type Rep Server :: Type -> Type

Methods

from :: Server -> Rep Server x

to :: Rep Server x -> Server

Show Server

Defined in Database.InfluxDB.Types

Methods

showsPrec :: Int -> Server -> ShowS

show :: Server -> String

showList :: [Server] -> ShowS

Eq Server

Defined in Database.InfluxDB.Types

Methods

(==) :: Server -> Server -> Bool

(/=) :: Server -> Server -> Bool

Ord Server

Defined in Database.InfluxDB.Types

Methods

compare :: Server -> Server -> Ordering

(<) :: Server -> Server -> Bool

(<=) :: Server -> Server -> Bool

(>) :: Server -> Server -> Bool

(>=) :: Server -> Server -> Bool

max :: Server -> Server -> Server

min :: Server -> Server -> Server

type Rep Server

Defined in Database.InfluxDB.Types

type Rep Server = D1 ('MetaData "Server" "Database.InfluxDB.Types" "influxdb-1.9.3-IFuqfyTGhfMJQN2h35ot" 'False) (C1 ('MetaCons "Server" 'PrefixI 'True) (S1 ('MetaSel ('Just "_host") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "_port") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "_ssl") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))))

host :: Lens' Server Text

Host name of the server

port :: Lens' Server Int

Port number of the server

ssl :: Lens' Server Bool

If SSL is enabled

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

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

defaultServer :: Server

Default InfluxDB server settings

Default parameters:

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

secureServer :: Server

HTTPS-enabled InfluxDB server settings

data Credentials

User credentials.

Following lenses are available to access its fields:

• user
• password

Constructors

Credentials

Fields

• _user :: !Text
• _password :: !Text

Instances

Show Credentials

Defined in Database.InfluxDB.Types

Methods

showsPrec :: Int -> Credentials -> ShowS

show :: Credentials -> String

showList :: [Credentials] -> ShowS

credentials

Arguments

:: Text

User name

-> Text

Password

-> Credentials

Smart constructor for Credentials

user :: Lens' Credentials Text

User name to access InfluxDB.

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

password :: Lens' Credentials Text

Password to access InfluxDB

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

newtype Database

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"

Constructors

Database

Fields

• databaseName :: Text

Instances

IsString Database

Defined in Database.InfluxDB.Types

Methods

fromString :: String -> Database

Show Database

Defined in Database.InfluxDB.Types

Methods

showsPrec :: Int -> Database -> ShowS

show :: Database -> String

showList :: [Database] -> ShowS

Eq Database

Defined in Database.InfluxDB.Types

Methods

(==) :: Database -> Database -> Bool

(/=) :: Database -> Database -> Bool

Ord Database

Defined in Database.InfluxDB.Types

Methods

compare :: Database -> Database -> Ordering

(<) :: Database -> Database -> Bool

(<=) :: Database -> Database -> Bool

(>) :: Database -> Database -> Bool

(>=) :: Database -> Database -> Bool

max :: Database -> Database -> Database

min :: Database -> Database -> Database

newtype Measurement

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"

Constructors

Measurement Text

Instances

IsString Measurement

Defined in Database.InfluxDB.Types

Methods

fromString :: String -> Measurement

Show Measurement

Defined in Database.InfluxDB.Types

Methods

showsPrec :: Int -> Measurement -> ShowS

show :: Measurement -> String

showList :: [Measurement] -> ShowS

Eq Measurement

Defined in Database.InfluxDB.Types

Methods

(==) :: Measurement -> Measurement -> Bool

(/=) :: Measurement -> Measurement -> Bool

Ord Measurement

Defined in Database.InfluxDB.Types

Methods

compare :: Measurement -> Measurement -> Ordering

(<) :: Measurement -> Measurement -> Bool

(<=) :: Measurement -> Measurement -> Bool

(>) :: Measurement -> Measurement -> Bool

(>=) :: Measurement -> Measurement -> Bool

max :: Measurement -> Measurement -> Measurement

min :: Measurement -> Measurement -> Measurement

newtype Key

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"

Constructors

Key Text

Instances

IsString Key

Defined in Database.InfluxDB.Types

Methods

fromString :: String -> Key

Show Key

Defined in Database.InfluxDB.Types

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

Eq Key

Defined in Database.InfluxDB.Types

Methods

(==) :: Key -> Key -> Bool

(/=) :: Key -> Key -> Bool

Ord Key

Defined in Database.InfluxDB.Types

Methods

compare :: Key -> Key -> Ordering

(<) :: Key -> Key -> Bool

(<=) :: Key -> Key -> Bool

(>) :: Key -> Key -> Bool

(>=) :: Key -> Key -> Bool

max :: Key -> Key -> Key

min :: Key -> Key -> Key

identifier :: String -> String -> Text

data Nullability

Nullability of fields.

Queries can contain nulls but the line protocol cannot.

Constructors

Nullable

NonNullable

type QueryField = Field 'Nullable

Field type for queries. Queries can contain null values.

type LineField = Field 'NonNullable

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

data Field (n :: Nullability) where

Constructors

FieldInt :: !Int64 -> Field n

Signed 64-bit integers (-9,223,372,036,854,775,808 to 9,223,372,036,854,775,807).

FieldFloat :: !Double -> Field n

IEEE-754 64-bit floating-point numbers. This is the default numerical type.

FieldString :: !Text -> Field n

String field. Its length is limited to 64KB, which is not enforced by this library.

FieldBool :: !Bool -> Field n

Boolean field.

FieldNull :: Field 'Nullable

Null field.

Note that a field can be null only in queries. The line protocol doesn't allow null values.

Instances

IsString (Field n)

Defined in Database.InfluxDB.Types

Methods

fromString :: String -> Field n

Show (Field n)

Defined in Database.InfluxDB.Types

Methods

showsPrec :: Int -> Field n -> ShowS

show :: Field n -> String

showList :: [Field n] -> ShowS

Eq (Field n)

Defined in Database.InfluxDB.Types

Methods

(==) :: Field n -> Field n -> Bool

(/=) :: Field n -> Field n -> Bool

data RequestType

Type of a request

Constructors

QueryRequest

Request for /query

WriteRequest

Request for /write

Instances

Show RequestType

Defined in Database.InfluxDB.Types

Methods

showsPrec :: Int -> RequestType -> ShowS

show :: RequestType -> String

showList :: [RequestType] -> ShowS

data Precision (ty :: RequestType) where

Predefined set of time precision.

RFC3339 is only available for QueryRequests.

Constructors

Nanosecond :: Precision ty

POSIX time in ns

Microsecond :: Precision ty

POSIX time in μs

Millisecond :: Precision ty

POSIX time in ms

Second :: Precision ty

POSIX time in s

Minute :: Precision ty

POSIX time in minutes

Hour :: Precision ty

POSIX time in hours

RFC3339 :: Precision 'QueryRequest

Nanosecond precision time in a human readable format, like 2016-01-04T00:00:23.135623Z. This is the default format for /query.

Instances

Show (Precision a)

Defined in Database.InfluxDB.Types

Methods

showsPrec :: Int -> Precision a -> ShowS

show :: Precision a -> String

showList :: [Precision a] -> ShowS

Eq (Precision a)

Defined in Database.InfluxDB.Types

Methods

(==) :: Precision a -> Precision a -> Bool

(/=) :: Precision a -> Precision a -> Bool

precisionName :: Precision ty -> Text

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"

class Timestamp time where

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

Methods

roundTo :: Precision 'WriteRequest -> time -> Int64

Round a time to the given precision and scale it to nanoseconds

scaleTo :: Precision 'WriteRequest -> time -> Int64

Scale a time to the given precision

Instances

Timestamp TimeSpec

>>> let timespec = TimeSpec 123 123456789
>>> roundTo Nanosecond timespec
123123456789
>>> roundTo Microsecond timespec
123123457000
>>> roundTo Millisecond timespec
123123000000
>>> roundTo Second timespec
123000000000
>>> roundTo Minute timespec
120000000000
>>> roundTo Hour timespec
0
>>> scaleTo Nanosecond timespec
123123456789
>>> scaleTo Microsecond timespec
123123457
>>> scaleTo Millisecond timespec
123123
>>> scaleTo Second timespec
123
>>> scaleTo Minute timespec
2
>>> scaleTo Hour timespec
0

Defined in Database.InfluxDB.Types

Methods

roundTo :: Precision 'WriteRequest -> TimeSpec -> Int64

scaleTo :: Precision 'WriteRequest -> TimeSpec -> Int64

Timestamp NominalDiffTime

>>> let dt = 123.123456789 :: NominalDiffTime
>>> roundTo Nanosecond dt
123123456789
>>> roundTo Microsecond dt
123123457000
>>> roundTo Millisecond dt
123123000000
>>> roundTo Second dt
123000000000
>>> roundTo Minute dt
120000000000
>>> roundTo Hour dt
0
>>> scaleTo Nanosecond dt
123123456789
>>> scaleTo Microsecond dt
123123457
>>> scaleTo Millisecond dt
123123
>>> scaleTo Second dt
123
>>> scaleTo Minute dt
2
>>> scaleTo Hour dt
0

Defined in Database.InfluxDB.Types

Methods

roundTo :: Precision 'WriteRequest -> NominalDiffTime -> Int64

scaleTo :: Precision 'WriteRequest -> NominalDiffTime -> Int64

Timestamp UTCTime

>>> import Data.Time.Calendar
>>> let t = UTCTime (fromGregorian 2018 04 14) 123.123456789
>>> t
2018-04-14 00:02:03.123456789 UTC
>>> roundTo Nanosecond t
1523664123123456789
>>> roundTo Microsecond t
1523664123123457000
>>> roundTo Millisecond t
1523664123123000000
>>> roundTo Second t
1523664123000000000
>>> roundTo Minute t
1523664120000000000
>>> roundTo Hour t
1523664000000000000
>>> scaleTo Nanosecond t
1523664123123456789
>>> scaleTo Microsecond t
1523664123123457
>>> scaleTo Millisecond t
1523664123123
>>> scaleTo Second t
1523664123
>>> scaleTo Minute t
25394402
>>> scaleTo Hour t
423240

Defined in Database.InfluxDB.Types

Methods

roundTo :: Precision 'WriteRequest -> UTCTime -> Int64

scaleTo :: Precision 'WriteRequest -> UTCTime -> Int64

roundAt :: RealFrac a => a -> a -> a

precisionScale :: Fractional a => Precision ty -> a

Scale of the type precision.

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

timeSpecToSeconds :: TimeSpec -> Double

data InfluxException

Exceptions used in this library.

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

Constructors

ServerError String

Server side error.

You can expect to get a successful response once the issue is resolved on the server side.

ClientError String Request

Client side error.

You need to fix your query to get a successful response.

UnexpectedResponse String Request ByteString

Received an unexpected response. The String field is a message and the ByteString field is a possibly-empty relevant payload of the response.

This can happen e.g. when the response from InfluxDB is incompatible with what this library expects due to an upstream format change or when the JSON response doesn't have expected fields etc.

HTTPException HttpException

HTTP communication error.

Typical HTTP errors (4xx and 5xx) are covered by ClientError and ServerError. So this exception means something unusual happened. Note that if checkResponse is overridden to throw an HttpException on an unsuccessful HTTP code, this exception is thrown instead of ClientError or ServerError.

Instances

Exception InfluxException

Defined in Database.InfluxDB.Types

Methods

toException :: InfluxException -> SomeException

fromException :: SomeException -> Maybe InfluxException

displayException :: InfluxException -> String

Show InfluxException

Defined in Database.InfluxDB.Types

Methods

showsPrec :: Int -> InfluxException -> ShowS

show :: InfluxException -> String

showList :: [InfluxException] -> ShowS

class HasServer a where

Class of data types that have a server field

Methods

server :: Lens' a Server

InfluxDB server address and port that to interact with.

Instances

HasServer PingParams

>>> pingParams ^. server.host
"localhost"

Defined in Database.InfluxDB.Ping

Methods

server :: Lens' PingParams Server

HasServer QueryParams

>>> let p = queryParams "foo"
>>> p ^. server.host
"localhost"

Defined in Database.InfluxDB.Query

Methods

server :: Lens' QueryParams Server

HasServer WriteParams

>>> let p = writeParams "foo"
>>> p ^. server.host
"localhost"

Defined in Database.InfluxDB.Write

Methods

server :: Lens' WriteParams Server

class HasDatabase a where

Class of data types that have a database field

Methods

database :: Lens' a Database

Database name to work on.

Instances

HasDatabase ShowQuery

>>> v <- query @ShowQuery (queryParams "_internal") "SHOW QUERIES"
>>> v ^.. each.database
...

Defined in Database.InfluxDB.Manage

Methods

database :: Lens' ShowQuery Database

HasDatabase QueryParams

>>> let p = queryParams "foo"
>>> p ^. database
"foo"

Defined in Database.InfluxDB.Query

Methods

database :: Lens' QueryParams Database

HasDatabase WriteParams

>>> let p = writeParams "foo"
>>> p ^. database
"foo"

Defined in Database.InfluxDB.Write

Methods

database :: Lens' WriteParams Database

class HasPrecision (ty :: RequestType) a | a -> ty where

Class of data types that have a precision field

Methods

precision :: Lens' a (Precision ty)

Time precision parameter.

Instances

HasPrecision 'QueryRequest QueryParams

Returning JSON responses contain timestamps in the specified precision/format.

>>> let p = queryParams "foo"
>>> p ^. precision
RFC3339

Defined in Database.InfluxDB.Query

Methods

precision :: Lens' QueryParams (Precision 'QueryRequest)

HasPrecision 'WriteRequest WriteParams

>>> let p = writeParams "foo"
>>> p ^. precision
Nanosecond

Defined in Database.InfluxDB.Write

Methods

precision :: Lens' WriteParams (Precision 'WriteRequest)

HasPrecision 'WriteRequest WriteParams

Timestamp precision.

In the UDP API, all timestamps are sent in nanosecond but you can specify lower precision. The writer just rounds timestamps to the specified precision.

Defined in Database.InfluxDB.Write.UDP

Methods

precision :: Lens' WriteParams (Precision 'WriteRequest)

class HasManager a where

Class of data types that have a manager field

Methods

manager :: Lens' a (Either ManagerSettings Manager)

HTTP manager settings or a manager itself.

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

Instances

HasManager PingParams

>>> let p = pingParams & manager .~ Left HC.defaultManagerSettings

Defined in Database.InfluxDB.Ping

Methods

manager :: Lens' PingParams (Either ManagerSettings Manager)

HasManager QueryParams

>>> let p = queryParams "foo" & manager .~ Left HC.defaultManagerSettings

Defined in Database.InfluxDB.Query

Methods

manager :: Lens' QueryParams (Either ManagerSettings Manager)

HasManager WriteParams

>>> let p = writeParams "foo" & manager .~ Left HC.defaultManagerSettings

Defined in Database.InfluxDB.Write

Methods

manager :: Lens' WriteParams (Either ManagerSettings Manager)

class HasCredentials a where

Class of data types that has an authentication field

Methods

authentication :: Lens' a (Maybe Credentials)

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

Instances

HasCredentials QueryParams

Authentication info for the query

>>> let p = queryParams "foo"
>>> p ^. authentication
Nothing
>>> let p' = p & authentication ?~ credentials "john" "passw0rd"
>>> p' ^. authentication.traverse.user
"john"

Defined in Database.InfluxDB.Query

Methods

authentication :: Lens' QueryParams (Maybe Credentials)

HasCredentials WriteParams

Authentication info for the write

>>> let p = writeParams "foo"
>>> p ^. authentication
Nothing
>>> let p' = p & authentication ?~ credentials "john" "passw0rd"
>>> p' ^. authentication . traverse . user
"john"

Defined in Database.InfluxDB.Write

Methods

authentication :: Lens' WriteParams (Maybe Credentials)