influxr_connection: Define a connection to InfluxDB instance

In influxr/influxr: An R interface to influxDB time series databases.

Description

influxr_connection Creates an 'Influx_client' object which contains connection parameters and facilitates connecting to an InfluxDB server.

Usage

influxr_connection(
  host = "localhost",
  port = 8086,
  username = Sys.getenv("INFLUX_USERNAME"),
  password = Sys.getenv("INFLUX_PASSWORD"),
  ssl = TRUE,
  ssl_verifypeer = TRUE,
  timeout = 0,
  retries = 3,
  chunk_size = 20000L,
  post_chunk_size = 50000L,
  server_timezone = "UTC"
)

Arguments

host	character string. Hostname of InfluxDB server, default is 'localhost'
port	numeric. Port number to connect to InfluxDB instance, default is 8086
username	character string. User name to use for authentication, default is getting it from the environment variable INFLUX_USERNAME
password	character, password to use for authentication, default is getting it from the environment variable INFLUX_PASSWORD
ssl	logical. Whether https should be used instead of http to connect to InfluxDB, defaults to TRUE.
ssl_verifypeer	logical. Whether to verify SSL peer.
timeout	numeric. Number of seconds requests will wait for the client to establish a connection, default is 0 (unlimited).
retries	numeric. Number of retries the client will try to connect before aborting, default is 3, NULL indicates try until success.
chunk_size	numeric. Number of data points to fetch from influxDB server per chunk, default to 20000.
post_chunk_size	numeric. Number of data points uploaded at each chunk when posting data to influxDB server.
server_timezone	character string. The timezone code of the data in the server. Uploaded data will be converted to it. InfluxDB keeps data in 'UTC' - currently only 'UTC' is supported.

Details

The returned object will hold all the information necessary to connect to InfluxDB and shall be passed to functions responsible for connecting to the database. Use 'summary()' on the client object to view basic information.

influxr/influxr documentation built on Aug. 5, 2020, 9:03 p.m.