Database.InfluxDB.Ping

Ping interface

ping :: PingParams -> IO PingResult

Ping parameters

data PingParams

The full set of parameters for the ping API

Constructors

PingParams

Fields

• _server :: !Server
• _manager :: !(Either ManagerSettings Manager)

  HTTP connection manager

• _waitForLeader :: !(Maybe Int)

  the number of seconds to wait

Instances

HasManager PingParams

Methods

manager :: Lens' PingParams (Either ManagerSettings Manager)

HasServer PingParams

Methods

server :: Lens' PingParams Server

pingParams :: PingParams

server :: HasServer a => Lens' a Server

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.

waitForLeader :: Lens' PingParams (Maybe Int)

The number of seconds to wait before returning a response

Ping result

data PingResult

Constructors

PingResult

Fields

• _roundtripTime :: !TimeSpec
• _influxdbVersion :: !ByteString

Instances

Eq PingResult

Methods

(==) :: PingResult -> PingResult -> Bool

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

Ord PingResult

Methods

compare :: PingResult -> PingResult -> Ordering

(<) :: PingResult -> PingResult -> Bool

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

(>) :: PingResult -> PingResult -> Bool

(>=) :: PingResult -> PingResult -> Bool

max :: PingResult -> PingResult -> PingResult

min :: PingResult -> PingResult -> PingResult

Show PingResult

Methods

showsPrec :: Int -> PingResult -> ShowS

show :: PingResult -> String

showList :: [PingResult] -> ShowS

roundtripTime :: Lens' PingResult TimeSpec

Roundtrip time of the ping

influxdbVersion :: Lens' PingResult ByteString

Version string returned by the InfluxDB header