Database.InfluxDB.Ping

Ping interface

ping :: PingParams -> IO Pong

Send a ping to InfluxDB.

It may throw an InfluxException.

Ping parameters

data PingParams

The full set of parameters for the ping API

Following lenses are available to access its fields:

• server
• manager
• timeout

Instances

HasManager PingParams

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

Defined in Database.InfluxDB.Ping

Methods

manager :: Lens' PingParams (Either ManagerSettings Manager)

HasServer PingParams

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

Defined in Database.InfluxDB.Ping

Methods

server :: Lens' PingParams Server

pingParams :: PingParams

Smart constructor for PingParams

Default parameters:

server

defaultServer

manager

Left defaultManagerSettings

timeout

Nothing

server :: HasServer a => Lens' a Server

InfluxDB server address and port that to interact with.

manager :: HasManager a => 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.

timeout :: Lens' PingParams (Maybe NominalDiffTime)

The number of seconds to wait before returning a response

>>> pingParams ^. timeout
Nothing
>>> let p = pingParams & timeout ?~ 1

Pong

data Pong

Response of a ping request

Instances

Eq Pong

Defined in Database.InfluxDB.Ping

Methods

(==) :: Pong -> Pong -> Bool

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

Ord Pong

Defined in Database.InfluxDB.Ping

Methods

compare :: Pong -> Pong -> Ordering

(<) :: Pong -> Pong -> Bool

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

(>) :: Pong -> Pong -> Bool

(>=) :: Pong -> Pong -> Bool

max :: Pong -> Pong -> Pong

min :: Pong -> Pong -> Pong

Show Pong

Defined in Database.InfluxDB.Ping

Methods

showsPrec :: Int -> Pong -> ShowS

show :: Pong -> String

showList :: [Pong] -> ShowS

roundtripTime :: Lens' Pong TimeSpec

Round-trip time of the ping

influxdbVersion :: Lens' Pong ByteString

Version string returned by InfluxDB