InfluxDBClient Class Reference


                    
                    
                    version

Version of client.

Declaration

Swift

public static var version: String

url

InfluxDB host and port.

Declaration

Swift

public let url: String


                    
                    
                    debugging

Enable debugging for HTTP request/response.

Declaration

Swift

public let debugging: Bool


                    
                    
                    session

Shared URLSession across the client.

Declaration

Swift

public let session: URLSession


                    
                    
                    queryAPI

Lazy initialized QueryAPI.

Declaration

Swift

public lazy var queryAPI: QueryAPI { get set }


                    
                    
                    deleteAPI

Lazy initialized DeleteAPI.

Declaration

Swift

public lazy var deleteAPI: DeleteAPI { get set }


                    
                    
                    invokableScriptsApi

Lazy initialized InvokableScriptsApi.

Declaration

Swift

public lazy var invokableScriptsApi: InvokableScriptsAPI { get set }


                    
                    
                    init(url:token:options:debugging:protocolClasses:)

Create a new client for a InfluxDB.

Declaration

Swift

public init(url: String,
            token: String,
            options: InfluxDBOptions? = nil,
            debugging: Bool? = nil,
            protocolClasses: [AnyClass]? = nil)

Parameters

`url`	InfluxDB host and port.
`token`	Authentication token.
`options`	optional `InfluxDBOptions` to use for this client.
`debugging`	optional Enable debugging for HTTP request/response. Default `false`.
`protocolClasses`	optional array of extra protocol subclasses that handle requests.


                    
                    
                    init(url:username:password:database:retentionPolicy:precision:protocolClasses:)

Create a new client for InfluxDB 1.8 compatibility API.

Declaration

Swift

public convenience init(url: String,
                        username: String,
                        password: String,
                        database: String,
                        retentionPolicy: String,
                        precision: TimestampPrecision = TimestampPrecision.ns,
                        protocolClasses: [AnyClass]? = nil)

Parameters

`url`	InfluxDB host and port.
`username`	Username for authentication.
`password`	Password for authentication.
`database`	Target database.
`retentionPolicy`	Target retention policy.
`precision`	Default precision for the unix timestamps within the body line-protocol.
`protocolClasses`	optional array of extra protocol subclasses that handle requests.


                    
                    
                    makeWriteAPI(pointSettings:)

Creates WriteApi with supplied default settings.

Declaration

Swift

public func makeWriteAPI(pointSettings: PointSettings? = nil) -> WriteAPI

Parameters


                                pointSettings

default settings for DataPoint, useful for default tags

Return Value

WriteAPI instance


                    
                    
                    close()

Release all allocated resources.

Declaration

Swift

public func close()


                    
                    
                    InfluxDBOptions

Options to use when creating a InfluxDBClient.

Declaration

Swift

public struct InfluxDBOptions


                    
                    
                    InfluxDBError

The general InfluxDB error.

Declaration

Swift

public enum InfluxDBError : Error, CustomStringConvertible


                    
                    
                    defaultTimestampPrecision

Default Write Precision is Nanoseconds.

Declaration

Swift

public static let defaultTimestampPrecision: InfluxDBClient.TimestampPrecision


                    
                    
                    TimestampPrecision

An enum represents the precision for the unix timestamps within the body line-protocol.

Declaration

Swift

public enum TimestampPrecision : String, Codable, CaseIterable


                    
                    
                    HTTPLogger

The logger for logging HTTP request/response.

Declaration

Swift

public class HTTPLogger


                    
                    
                    Point

Point defines the values that will be written to the database.

See also

http://bit.ly/influxdata-point

Declaration

Swift

public class Point

extension InfluxDBClient.Point: CustomStringConvertible


                    
                    
                    PointSettings

Settings to store default tags.

Example:

let defaultTags = InfluxDBClient.PointSettings()
        .addDefaultTag(key: "id", value: "132-987-655")
        .addDefaultTag(key: "customer", value: "California Miner")
        .addDefaultTag(key: "data_center", value: "${env.DATA_CENTER_LOCATION}")

Declaration

Swift

public class PointSettings