Package influxdbr. January 10, 2018

Transcription

1 Type Package Title R Interface to InfluxDB Version Date Package influxdbr January 10, 2018 An R interface to the InfluxDB time series database < This package allows you to fetch and write time series data from/to an InfluxDB server. Additionally, handy wrappers for the Influx Query Language (IQL) to manage and explore a remote database are provided. License GPL-3 ByteCompile TRUE URL BugReports Imports dplyr (>= 0.7.0), jsonlite, httr, magrittr, purrr (>= 0.2.3), rlang, tibble, tidyr, xts, zoo RoxygenNote Suggests testthat NeedsCompilation no Author Dominik Leutnant [aut, cre] ( ) Maintainer Dominik Leutnant <leutnant@fh-muenster.de> Repository CRAN Date/Publication :57:53 UTC R topics documented: create_database create_user influxdbr influx_nection influx_ping influx_query

2 2 create_database influx_select influx_write show_databases show_diagnostics show_stats Index 13 create_database Influx database management The folllowing functions are venient wrappers around influx_post. create_database(): creates a new database drop_database(): drops an existing database drop_series(): drops specific series delete(): deletes all points from a series in a database (supports time intervals) drop_measurement(): drops an entire measurement create_retention_policy(): create a new retention policy alter_retention_policy(): alter a retention policy drop_retention_policy(): drop a retention policy create_database(, db) drop_database(, db) drop_series(, db, measurement = NULL, where = NULL) delete(, db, measurement = NULL, where = NULL) drop_measurement(, db, measurement) create_retention_policy(, db, rp_name, duration, replication, default = FALSE) alter_retention_policy(, db, rp_name, duration, replication, default = FALSE) drop_retention_policy(, db, rp_name)

3 create_user 3 db measurement where rp_name duration replication default An influx_nection object (s. influx_nection). Sets the target database for the query. Sets a specific measurement. Apply filter on tag key values. The name of the retention policy. Determines how long InfluxDB keeps the data. The number of data nodes. logical. If TRUE, the new retention policy is the default retention policy for the database. A tibble taining post results in case of an error (or message). Otherwise NULL (invisibly). influx_nection create_user Influx authentication and authorization The folllowing functions are venient wrappers around influx_post and influx_query (show_users and show grants). create_user(): creates a new user drop_user(): drops an existing user grant_privileges(): grant privileges to an existing users revoke_privileges(): revoke privileges to an existing users show_users(): show all users show_grants(): show grants of an user

4 4 influxdbr create_user(, username, password) drop_user(, username) grant_privileges(, privilege = c("read", "WRITE", "ALL"), db, username) revoke_privileges(, privilege = c("read", "WRITE", "ALL"), db, username) show_users() show_grants(, username) username password privilege db An influx_nection object (s. influx_nection). The username to be used. The password to be used. Specifies the user privilege. Sets the target database. A tibble taining post results in case of an error (or message). Otherwise NULL (invisibly). show_users() and show_grants() return a tibble. influx_nection influxdbr influxdbr package R Interface for InfluxDB

5 influx_nection 5 influx_nection Create an influxdb_nection object Create an influxdb_nection object by specifying server nection details. Credentials can also be saved and accessed through a fig file. influx_nection(scheme = c("http", "https"), host = "localhost", port = 8086, user = "user", pass = "pass", path = "/", group = NULL, verbose = FALSE, fig_file = "~/.influxdb.cnf", curl_options = NULL) scheme host The scheme to use, either http or https. Defaults to http. Hostname of the InfluxDB server. Defaults to localhost. port numerical. Port number of the InfluxDB server. Defaults to user pass path group verbose fig_file username The username to use. Defaults to "user". password The password to use. Defaults to "pass". The prefix path on which the InfluxDB is running. Can be useful in proxy situations. The group to use within the fig file. logical. Provide additional details? The figuration file to be used if group is specified. curl_options Additional curl arguments created with fig (e.g. httr::fig(verbose = TRUE, timeout = 5, ssl_verifypeer = FALSE)). structure of figuration file A figuration file may tain several nection settings. Each setting has the following structure: [group] scheme=http host=localhost port=8086 user=username pass=password path=/

6 6 influx_query influx_ping Ping an influxdb server This function pings an influxdb server (e.g. for nection testing) influx_ping() An influx_nection object (s. influx_nection). A tibble with server information. influx_nection influx_query Query an InfluxDB server This functions queries an InfluxDB server. influx_query(, db = NULL, query = "SELECT * FROM measurement", timestamp_format = c("n", "u", "ms", "s", "m", "h"), return_xts = TRUE, chunked = FALSE, simplifylist = FALSE)

7 influx_select 7 db query An influx_nection object (s. influx_nection). Sets the target database for the query. The InfluxDB query to be sent. timestamp_format Sets the timestamp format ("n", "u", "ms", "s", "m", "h"). return_xts chunked simplifylist logical. Sets the return type. If set to TRUE, xts objects are returned, FALSE gives tibbles. Either FALSE or an integer. If FALSE, series are not requested in streamed batches. If an integer is provided, responses will be chunked by series or by every chunked points. Chunks are merged internally. logical. If only one series is returned, the result can be flatten to directly get either a tibble or an xts object (instead of a list) (default is FALSE). A list of tibble or xts objects. xts, influx_nection influx_select influx select helper This function is a venient wrapper for selecting data from a measurement by calling influx_query with the corresponding query. influx_select(, db, field_keys, rp = NULL, measurement, where = NULL, group_by = NULL, limit = NULL, slimit = FALSE, offset = NULL, order_desc = FALSE, return_xts = TRUE, simplifylist = FALSE)

8 8 influx_write db field_keys rp measurement where group_by limit slimit offset order_desc return_xts simplifylist An influx_nection object (s. influx_nection). Sets the target database for the query. Specifies the fields to be selected. The name of the retention policy. Sets the name of the measurement. Apply filter on tag key values. The group_by clause in InfluxDB is used not only for grouping by given values, but also for grouping by given time buckets. Limits the number of the n oldest points to be returned. logical. Sets limiting procedure (slimit vs. limit). Offsets the returned points by the value provided. logical. Change sort order to descending. logical. Sets the return type. If set to TRUE, a list of xts objects is returned, FALSE gives list of tibbles. logical. If only one series is returned, the result can be flatten to directly get either a tibble or an xts object (instead of a list) (default is FALSE). A list of xts or tibbles. influx_write Write an xts or data.frame object to an InfluxDB server This function writes either an xts object or a data.frame to an InfluxDB server. In case of an xts object, columnnames of the xts object are used as InfluxDB s field keys, xts s coredata represent field values. Attributes are preserved and written as tag keys and values, respectively. In case of a data.frame, columns may represent times and both tag and field values. Columnnames of the data.frame object are used as InfluxDB s tag and field keys. Times and tags are optional. Use parameter time_col and tag_col to define the interpretation. By specifiying one of the arguments measurement or measurement_col, a data.frame may tain data from one measurement or multiple measurements, respectively.

9 influx_write 9 influx_write(x,, db, measurement, rp = NULL, precision = c("s", "ns", "u", "ms", "m", "h"), sistency = c(null, "one", "quroum", "all", "any"), max_points = 5000, use_integers = FALSE,...) ## S3 method for class 'xts' influx_write(x,, db, measurement, rp = NULL, precision = c("s", "ns", "u", "ms", "m", "h"), sistency = c(null, "one", "quroum", "all", "any"), max_points = 5000, use_integers = FALSE,...) ## S3 method for class 'data.frame' influx_write(x,, db, measurement = NULL, rp = NULL, precision = c("s", "ns", "u", "ms", "m", "h"), sistency = c(null, "one", "quroum", "all", "any"), max_points = 5000, use_integers = FALSE, time_col = NULL, tag_cols = NULL, measurement_col = NULL,...) x db measurement rp precision sistency The object to write to an InfluxDB server (either of class xts or data.frame). An influx_nection object (s. influx_nection). Sets the target database for the query. Sets the name of the measurement (data.frame has data to write to one measurement only). If both arguments measurement and measurement_col are given, measurement gets overridden. Sets the target retention policy for the write. If not present the default retention policy is used. Sets the precision of the supplied Unix time values ("s", "ns", "u", "ms", "m", "h"). If not present timestamps are assumed to be in seds. Set the number of nodes that must firm the write. If the requirement is not met the return value will be partial write if some points in the batch fail, or write failure if all points in the batch fail. max_points Defines the maximum points per batch (defaults to 5000). use_integers Should integers (instead of doubles) be written if present?... to be passed to methods. time_col A character scalar naming the time index column. tag_cols A character vector naming tag columns. measurement_col A character scalar naming the measurement column (data.frame has data to write to multiple measurements). Overrides measurement argument. A list of server responses.

10 10 show_databases xts, influx_nection show_databases Influx schema exploration The folllowing functions are venient wrappers around influx_query. show_databases(): returns database names show_measurements(): returns measurement names show_series(): returns unambiguous series show_tag_keys(): returns tag keys show_tag_values(): returns tag values show_field_keys(): returns field keys show_retentions_policies(): returns retention policies show_databases() show_measurements(, db, where = NULL) show_series(, db, measurement = NULL, where = NULL) show_tag_keys(, db, measurement = NULL) show_tag_values(, db, measurement = NULL, key) show_field_keys(, db, measurement = NULL) show_retention_policies(, db) db where measurement key An influx_nection object (s. influx_nection). Sets the target database for the query. Apply filter on tag key values. Query a specific measurement. The key to be queried.

11 show_diagnostics 11 A tibble taining query results. influx_nection show_diagnostics Show diagnostics This function calls influx_query to receive some diagnostics. show_diagnostics() An influx_nection object (s. influx_nection). A tibble with diagnostics. influx_nection

12 12 show_stats show_stats Show stats This function calls influx_query to receive some stats. show_stats() An influx_nection object (s. influx_nection). A tibble. Warning InfluxDB response might take some time. influx_nection

13 Index alter_retention_policy (create_database), 2 xts, 7, 10 fig, 5 create_database, 2 create_retention_policy (create_database), 2 create_user, 3 delete (create_database), 2 drop_database (create_database), 2 drop_measurement (create_database), 2 drop_retention_policy (create_database), 2 drop_series (create_database), 2 drop_user (create_user), 3 grant_privileges (create_user), 3 influx_nection, 3, 4, 5, 6 12 influx_ping, 6 influx_query, 6 influx_select, 7 influx_write, 8 influxdbr, 4 influxdbr-package (influxdbr), 4 revoke_privileges (create_user), 3 show_databases, 10 show_diagnostics, 11 show_field_keys (show_databases), 10 show_grants (create_user), 3 show_measurements (show_databases), 10 show_retention_policies (show_databases), 10 show_series (show_databases), 10 show_stats, 12 show_tag_keys (show_databases), 10 show_tag_values (show_databases), 10 show_users (create_user), 3 13