ExecuteInfluxDBQuery

Description:

Processor to execute InfluxDB query from the content of a FlowFile (preferred) or a scheduled query. Please check details of the supported queries in InfluxDB documentation (https://www.influxdb.com/).

Tags:

influxdb, measurement, get, read, query, timeseries

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Database Nameinfluxdb-dbnameInfluxDB database to connect to
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
InfluxDB connection URLinfluxdb-urlhttp://localhost:8086InfluxDB URL to connect to. Eg: http://influxdb:8086
Supports Expression Language: true (will be evaluated using variable registry only)
InfluxDB Max Connection Time Out (seconds)InfluxDB Max Connection Time Out (seconds)0 secondsThe maximum time for establishing connection to the InfluxDB
Query Result Time Unitsinfluxdb-query-result-time-unitNANOSECONDS
  • MILLISECONDS
  • MICROSECONDS
  • HOURS
  • SECONDS
  • NANOSECONDS
  • DAYS
  • MINUTES
The time unit of query results from the InfluxDB
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
InfluxDB Queryinfluxdb-queryThe InfluxDB query to execute. Note: If there are incoming connections, then the query is created from incoming FlowFile's content otherwise it is created from this property.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Results chunk sizeinfluxdb-query-chunk-size0Chunking can be used to return results in a stream of smaller batches (each has a partial results up to a chunk size) rather than as a single response. Chunking queries can return an unlimited number of rows. Note: Chunking is enable when result chunk size is greater than 0
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Usernameinfluxdb-usernameUsername for accessing InfluxDB
Supports Expression Language: true (will be evaluated using variable registry only)
Passwordinfluxdb-passwordPassword for user
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Character Setinfluxdb-charsetUTF-8Specifies the character set of the document data.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

NameDescription
retryFailed queries that are retryable exception are routed to this relationship
successSuccessful InfluxDB queries are routed to this relationship
failureFalied InfluxDB queries are routed to this relationship

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
influxdb.error.messageInfluxDB error message
influxdb.executed.queryInfluxDB executed query

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component allows an incoming relationship.

System Resource Considerations:

None specified.