Description and usage of ExecuteInfluxDBQuery processor:
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, whether a property supports the Expression Language Guide, and whether a property is considered “sensitive”, meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.
Name |
Default Value |
Allowable Values |
Description |
Database Name |
InfluxDB database to connect to Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
||
InfluxDB connection URL |
http://localhost:8086 |
InfluxDB 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) |
0 seconds | The maximum time for establishing connection to the InfluxDB | |
Query Result Time Units |
NANOSECONDS |
* 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 Query |
The 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 size |
0 |
Chunking 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) |
|
Username |
Username for accessing InfluxDB Supports Expression Language: true (will be evaluated using variable registry only) |
||
Password |
Password for user Sensitive Property: true Supports Expression Language: true (will be evaluated using variable registry only) |
||
Character Set |
UTF-8 |
Specifies the character set of the document data. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Relationships:
Name |
Description |
retry | Failed queries that are retryable exception are routed to this relationship |
success | Successful InfluxDB queries are routed to this relationship |
failure | Failed InfluxDB queries are routed to this relationship |
Reads Attributes:
None specified.
Writes Attributes:
Name |
Description |
influxdb.error.message | InfluxDB error message |
influxdb.executed.query | InfluxDB executed query |
State management:
This component does not store state.
Restricted:
This component is not restricted.
Input requirement:
This component requires an incoming relationship.
System Resource Considerations:
None specified.