InfluxDBClient: InfluxDBClient

In influxdbclient: 'InfluxDB' 2.x Client

InfluxDBClient

Description

Client for querying from and writing to InfluxDB 2.x.

Format

An R6Class object

Public fields

url

Database URL

token

Authentication token

org

Organization name

dialect

Flux dialect

retryOptions

Retry options

Methods

Public methods

• InfluxDBClient$new()

• InfluxDBClient$health()

• InfluxDBClient$query()

• InfluxDBClient$ready()

• InfluxDBClient$write()

• InfluxDBClient$clone()

---

Method new()

Creates instance of InfluxDBClient.

Usage

InfluxDBClient$new(url, token, org, retryOptions = NULL)

Arguments

url

InfluxDB instance URL

token

Authentication token

org

Organization name

org

Retry options. See RetryOptions for details. Set to TRUE for default retry options. Default is NULL which disables retries.

---

Method health()

Gets health info of the InfluxDB instance.

Usage

InfluxDBClient$health()

Returns

Named list with name, message, status, version, commit elements or error

---

Method query()

Queries data in the InfluxDB instance.

Usage

InfluxDBClient$query(
  text,
  POSIXctCol = c(`_time` = "time"),
  flatSingleResult = TRUE
)

Arguments

text

Flux query

POSIXctCol

Flux time to (new) POSIXct column mapping (named list). Default is c("_time"="time"). Use NULL to skip it.

flatSingleResult

Whether to return simple list when response contains only one result. Default is TRUE.

Returns

List of data frames. Data frame represents Flux table. It can be a named list of nested lists of data frames when query response contains multiple results (see Flux yield), or a simple list of data frames for single result response.

---

Method ready()

Gets readiness status of the InfluxDB instance.

Usage

InfluxDBClient$ready()

Returns

Named list with status, started and up elements or error

---

Method write()

Writes data to the InfluxDB instance.

Usage

InfluxDBClient$write(
  x,
  bucket,
  batchSize = 5000,
  precision = c("ns", "us", "ms", "s"),
  measurementCol = "_measurement",
  tagCols = NULL,
  fieldCols = c(`_field` = "_value"),
  timeCol = "_time",
  object = NULL,
  ...
)

Arguments

x

Data as (list of) data.frame

bucket

Target bucket name

batchSize

Batch size. Positive number or FALSE to disable. Default is 5000.

precision

Time precision

measurementCol

Name of measurement column. Default is "_measurement".

tagCols

Names of tag (index) columns

fieldCols

Names of field columns. In case of unpivoted data previously retrieved from InfluxDB, use default value ie. named list c("_field"="_value"). For all other cases, just use simple vector of column names (see Examples).

timeCol

Name of time column. The column values should be either of nanotime or POSIXct type. Default is "_time".

object

Output object name. For dry-run operation, specify the name of the object to receive the output. Default is NULL. For debugging purposes.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

InfluxDBClient$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
# Instantiation
client <- InfluxDBClient$new(url = "http://localhost:8086",
                             token = "my-token",
                             org = "my-org")

# Query
data <- client$query('from(bucket: "my-bucket") |> range(start: -1h)')

# Write
data <- data.frame(...)
client$write(data, bucket = "my-bucket", precision = "us",
             measurementCol = "name",
             tagCols = c("location", "id"),
             fieldCols = c("altitude", "temperature"),
             timeCol = "time")

# Ready status
ready <- client$ready()

# Healt info
ready <- client$health()

## End(Not run)

influxdbclient documentation built on Sept. 1, 2022, 5:07 p.m.