InfluxDB Sink properties reference
Review the following reference for a comprehensive list of the connector properties that are specific to the InfluxDB Sink connector.
parameter.[***CONNECTOR NAME***] Parameters:
In addition to the properties listed here, this connector also accepts certain properties of the Kafka Connect framework as well as the properties of the NiFi Stateless Sink connector. When creating a new connector using the SMM UI, all valid properties are presented in the default configuration template. You can view the configuration template to get a full list of valid properties. In addition, for more information regarding the accepted properties not listed here, you can review the Apache Kafka documentation and the Stateless NiFi Sink properties reference.
Batch Size
- Description
- Maximum size of records merged together and put to InfluxDB in one batch. Example values: 100 MB, 1 GB
- Default Value
- 1 MB
- Accepted Values
- Required
- true
Consistency Level
- Description
- Specifies the InfluxDB consistency level
- Default Value
- ONE
- Accepted Values
- ONRE ANY, ALL, QUORUM
- Required
- true
Date Format
- Description
- Specifies the format to use when reading date fields from JSON. If
Forward Raw Data
is set tofalse
, the format defined here also applies to the date fields in the output JSON message. - Default Value
- yyyy-MM-dd
- Accepted Values
- Required
- true
InfluxDB Connection URL
- Description
- Specifies the InfluxDB URL to connect to.
- Default Value
- http://localhost:8086
- Accepted Values
- Required
- true
InfluxDB Database Name
- Description
- The name of the InfluxDB database to connect to.
- Default Value
- Accepted Values
- Required
- true
InfluxDB User Name
- Description
- The username for accessing InfluxDB.
- Default Value
- Accepted Values
- Required
- false
InfluxDB User Password
- Description
- The password for InfluxDB user.
- Default Value
- Accepted Values
- Required
- false
Kafka Message Data Format
- Description
- Specifies the format of the messages the connector receives from Kafka. If the
Forward Raw Data
property is set totrue
then this property is ignored. However, even in a case like this, this property must be assigned a valid value. - Default Value
- AVRO
- Accepted Values
- AVRO, JSON
- Required
- true
Kerberos Keytab for Schema Registry
- Description
- The fully-qualified filename of the Kerberos keytab associated with the principal for accessing Schema Registry.
- Default Value
- The location of the default keytab which is empty and can only be used for unsecure connections.
- Accepted Values
- Required
- true
Kerberos Principal for Schema Registry
- Description
- The Kerberos principal used for authenticating to Schema Registry.
- Default Value
- default
- Accepted Values
- Required
- true
Line Protocol Query
- Description
- A record schema based query which returns the attributes in line protocol format.
- Default Value
- Accepted Values
- Required
- true
Retention Policy
- Description
- Specifies the retention policy for saving records in InfluxDB.
- Default Value
- autogen
- Accepted Values
- Required
- true
Schema Access Strategy
- Description
- Specifies the strategy used for determining the schema of the Kafka record. The value
you set here depends on the data format set in
Kafka Message Data Format
.If set to
Schema Registry
, the schema is read from Schema Registry. This setting can be used with both Avro and JSON formats.If set to
Infer Schema
, the schema is inferred based on the input file. This setting can only be used ifKafka Message Data Format
isJSON
.If set to
Embedded Schema
, the schema embedded in the input is used. This setting can only be used ifKafka Message Data Format
isAVRO
. - Default Value
- Schema Registry
- Accepted Values
- Schema Registry, Infer Schema, Embedded Schema
- Required
- true
Schema Branch
- Description
- The name of the branch to use when looking up the schema in Schema Registry.
Schema Branch
andSchema Version
cannot be specified at the same time. If one is specified, the other needs to be removed from the configuration. If Schema Registry is not used, this property must be completely removed from the configuration. - Default Value
- Accepted Values
- Required
- false
Schema Name
- Description
- The schema name to look up in Schema Registry.
If the
Schema Access Strategy
property is set toSchema Registry
, this property must contain a valid schema name.If
Schema Registry
is not used, this property must be completely removed from the configuration JSON. - Default Value
- Accepted Values
- Required
- false
Schema Registry URL
- Description
- The URL of the Schema Registry server. If Schema Registry is not used, use the default value.
- Default Value
- http://localhost:7788/api/v1
- Accepted Values
- Required
- true
Schema Version
- Description
- The version of the schema to look up in Schema Registry. If Schema Registry is used
and a schema version is not specified, the latest version of the schema is retrieved.
Schema Branch
andSchema Version
cannot be specified at the same time. If one is specified, the other needs to be removed from the configuration. If Schema Registry is not used, this property must be completely removed from the configuration. - Default Value
- Accepted Values
- Required
- false
Schema Write Strategy
- Description
- Specifies if the record schema should be written to the output data file.
Applicable only for Avro output (Output File Data Format is set to Avro).
- Default Value
- No Schema
- Accepted Values
- No Schema, Embed Avro Schema
- Required
- false
Time Format
- Description
- Specifies the format to use when reading time fields from JSON. If
Forward Raw Data
is set to false, the format defined here also applies to the time fields in the output JSON message. - Default Value
- HH:mm:ss
- Accepted Values
- Required
- true
Timestamp Format
- Description
- Specifies the format to use when reading timestamp fields from JSON. If
Forward Raw Data
is set to false, the format defined here also applies to the timestamp fields in the output JSON message. - Default Value
- HH:mm:ss.SSS
- Accepted Values
- Required
- true
Truststore Filename for Schema Registry
- Description
- The fully-qualified filename of a truststore. This truststore is used to establish a secure connection with Schema Registry using TLS.
- Default Value
- The location of the default truststore which is empty and can only be used for unsecure connection.
- Accepted Values
- Required
- true
Truststore Password for Schema Registry
- Description
- The password used to access the contents of the truststore configured in the
Truststore Filename for Schema Registry
property. - Default Value
- password
- Accepted Values
- Required
- true
Truststore Type for Schema Registry
- Description
- The type of the truststore configured in the
Truststore Filename for Schema Registry
property. - Default Value
- JKS
- Accepted Values
- BCFKS, PKCS12, JKS
- Required
- true