Database.InfluxDB.Write

Writers

The code snippets in this module assume the following imports.

import qualified Data.Map as Map
import Data.Time

write :: Timestamp time => WriteParams -> Line time -> IO ()

Write a Line.

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

writeBatch :: (Timestamp time, Foldable f) => WriteParams -> f (Line time) -> IO ()

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)
  ]
:}

writeByteString :: WriteParams -> ByteString -> IO ()

Write a raw ByteString

Writer parameters

data WriteParams

The full set of parameters for the HTTP writer.

Following lenses are available to access its fields:

• server
• database
• retentionPolicy
• precision
• authentication
• manager

Instances

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)

HasManager WriteParams

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

Defined in Database.InfluxDB.Write

Methods

manager :: Lens' WriteParams (Either ManagerSettings Manager)

HasDatabase WriteParams

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

Defined in Database.InfluxDB.Write

Methods

database :: Lens' WriteParams Database

HasServer WriteParams

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

Defined in Database.InfluxDB.Write

Methods

server :: Lens' WriteParams Server

HasPrecision WriteRequest WriteParams

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

Defined in Database.InfluxDB.Write

Methods

precision :: Lens' WriteParams (Precision WriteRequest)

writeParams :: Database -> WriteParams

Smart constructor for WriteParams

Default parameters:

server

defaultServer

retentionPolicy

Nothing

precision

Nanosecond

authentication

Nothing

manager

Left defaultManagerSettings

server :: HasServer a => Lens' a Server

InfluxDB server address and port that to interact with.

database :: HasDatabase a => Lens' a Database

Database name to work on.

retentionPolicy :: Lens' WriteParams (Maybe Key)

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"

precision :: HasPrecision ty a => Lens' a (Precision ty)

Time precision parameter.

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.