Database.InfluxDB.Types

Documentation

newtype Query

Constructors

Query Text

Instances

Show Query

Methods

showsPrec :: Int -> Query -> ShowS

show :: Query -> String

showList :: [Query] -> ShowS

IsString Query

Methods

fromString :: String -> Query

data Server

Constructors

Server

Fields

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

Instances

Eq Server

Methods

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

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

Show Server

Methods

showsPrec :: Int -> Server -> ShowS

show :: Server -> String

showList :: [Server] -> ShowS

Generic Server

Associated Types

type Rep Server :: * -> *

Methods

from :: Server -> Rep Server x

to :: Rep Server x -> Server

type Rep Server

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

localServer :: Server

Default server settings.

Default parameters:

• host: "localhost"
• port: 8086
• ssl: False

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

data Credentials

User credentials

Constructors

Credentials

Fields

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

user :: Lens' Credentials Text

User name to access InfluxDB

password :: Lens' Credentials Text

Password to access InfluxDB

newtype Database

Database name

Constructors

Database

Fields

• databaseName :: Text

Instances

Eq Database

Methods

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

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

Ord Database

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

Show Database

Methods

showsPrec :: Int -> Database -> ShowS

show :: Database -> String

showList :: [Database] -> ShowS

IsString Database

Methods

fromString :: String -> Database

newtype Key

String type that is used for measurements, tag keys and field keys.

Constructors

Key Text

Instances

Eq Key

Methods

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

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

Ord Key

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

Show Key

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

IsString Key

Methods

fromString :: String -> Key

fromNonEmptyString :: String -> String -> Text

data FieldValue

Constructors

FieldInt !Int64

FieldFloat !Double

FieldString !Text

FieldBool !Bool

FieldNull

Instances

Eq FieldValue

Methods

(==) :: FieldValue -> FieldValue -> Bool

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

Data FieldValue

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FieldValue -> c FieldValue

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FieldValue

toConstr :: FieldValue -> Constr

dataTypeOf :: FieldValue -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c FieldValue)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FieldValue)

gmapT :: (forall b. Data b => b -> b) -> FieldValue -> FieldValue

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FieldValue -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FieldValue -> r

gmapQ :: (forall d. Data d => d -> u) -> FieldValue -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> FieldValue -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FieldValue -> m FieldValue

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FieldValue -> m FieldValue

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FieldValue -> m FieldValue

Show FieldValue

Methods

showsPrec :: Int -> FieldValue -> ShowS

show :: FieldValue -> String

showList :: [FieldValue] -> ShowS

IsString FieldValue

Methods

fromString :: String -> FieldValue

Generic FieldValue

Associated Types

type Rep FieldValue :: * -> *

Methods

from :: FieldValue -> Rep FieldValue x

to :: Rep FieldValue x -> FieldValue

type Rep FieldValue

type Rep FieldValue = D1 (MetaData "FieldValue" "Database.InfluxDB.Types" "influxdb-1.1.2-eCsD6I1ufwCmOwVM7BHZs" False) ((:+:) ((:+:) (C1 (MetaCons "FieldInt" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int64))) (C1 (MetaCons "FieldFloat" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Double)))) ((:+:) (C1 (MetaCons "FieldString" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:+:) (C1 (MetaCons "FieldBool" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))) (C1 (MetaCons "FieldNull" PrefixI False) U1))))

data RequestType

Type of a request

Constructors

QueryRequest

Request for /query

WriteRequest

Request for /write

Instances

Show RequestType

Methods

showsPrec :: Int -> RequestType -> ShowS

show :: RequestType -> String

showList :: [RequestType] -> ShowS

data Precision ty 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)

Methods

showsPrec :: Int -> Precision a -> ShowS

show :: Precision a -> String

showList :: [Precision a] -> ShowS

precisionName :: Precision ty -> Text

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.

Minimal complete definition

roundTo, scaleTo

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 UTCTime

Methods

roundTo :: Precision WriteRequest -> UTCTime -> Int64

scaleTo :: Precision WriteRequest -> UTCTime -> Int64

Timestamp NominalDiffTime

Methods

roundTo :: Precision WriteRequest -> NominalDiffTime -> Int64

scaleTo :: Precision WriteRequest -> NominalDiffTime -> Int64

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

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

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.

BadRequest String Request

Client side error.

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

IllformedJSON String ByteString

Unexpected JSON response.

This can happen e.g. when the response from InfluxDB is incompatible with what this library expects due to an upstream format change etc.

Instances

Show InfluxException

Methods

showsPrec :: Int -> InfluxException -> ShowS

show :: InfluxException -> String

showList :: [InfluxException] -> ShowS

Exception InfluxException

Methods

toException :: InfluxException -> SomeException

fromException :: SomeException -> Maybe InfluxException

displayException :: InfluxException -> String

class HasServer a where

Minimal complete definition

server

Methods

server :: Lens' a Server

Instances

HasServer PingParams

Methods

server :: Lens' PingParams Server

HasServer WriteParams

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

Methods

server :: Lens' WriteParams Server

HasServer QueryParams

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

Methods

server :: Lens' QueryParams Server

class HasDatabase a where

Minimal complete definition

database

Methods

database :: Lens' a Database

Instances

HasDatabase WriteParams

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

Methods

database :: Lens' WriteParams Database

HasDatabase QueryParams

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

Methods

database :: Lens' QueryParams Database

HasDatabase ShowQuery

>>> v <- query (queryParams "_internal") "SHOW QUERIES" :: IO (V.Vector ShowQuery)
>>> v ^.. each.database
["_internal"]

Methods

database :: Lens' ShowQuery Database

class HasPrecision ty a | a -> ty where

Minimal complete definition

precision

Methods

precision :: Lens' a (Precision ty)

Instances

HasPrecision QueryRequest QueryParams

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

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

Methods

precision :: Lens' QueryParams (Precision QueryRequest)

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.

Methods

precision :: Lens' WriteParams (Precision WriteRequest)

HasPrecision WriteRequest WriteParams

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

Methods

precision :: Lens' WriteParams (Precision WriteRequest)

class HasManager a where

Minimal complete definition

manager

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

Methods

manager :: Lens' PingParams (Either ManagerSettings Manager)

HasManager WriteParams

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

Methods

manager :: Lens' WriteParams (Either ManagerSettings Manager)

HasManager QueryParams

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

Methods

manager :: Lens' QueryParams (Either ManagerSettings Manager)

class HasCredentials a where

Minimal complete definition

authentication

Methods

authentication :: Lens' a (Maybe Credentials)

Instances

HasCredentials WriteParams

Methods

authentication :: Lens' WriteParams (Maybe Credentials)

HasCredentials QueryParams

Methods

authentication :: Lens' QueryParams (Maybe Credentials)