JDBC Sink properties reference

Review the following reference for a comprehensive list of the connector properties that are specific to the JDBC Sink connector.

The properties listed in this reference must be added to the connector configuration with the following prefix:
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.

Database Connection URL

Description
The database specific connection URL used for connecting to the database For example, jdbc:postgresql://localhost:5432/postgres.
Default Value
Accepted Values
Required
true

Database Driver Class Name

Description
The database driver class name For example, org.postgresql.Driver.
Default Value
Accepted Values
Required
true

Database Driver Location

Description
A comma-separated list of files or folders containing the JDBC client libraries.
Default Value
Accepted Values
Required
true

Database Schema Name

Description
The name of the database schema containing the table to load data.
Default Value
Accepted Values
Required
false

Database Table Name

Description
The name of the database table to load data.
Default Value
Accepted Values
Required
true

Database Type

Description
The database type used for generating database specific SQL queries.
Default Value
Generic
Accepted Values
Generic, Oracle, Oracle 12+, MS SQL 2008, MS SQL 2012+, MySQL, PostgreSQL
Required
true

Database User Name

Description
The database user name. If username/password authentication is not required by the database server, this property must be completely removed from the configuration JSON.
Default Value
Accepted Values
Required
false

Database User Password

Description
The database user password. If username/password authentication is not required by the database server, this property must be completely removed from the configuration JSON.
Default Value
Accepted Values
Required
false

Date Format

Description
Specifies the format to use when reading date fields from JSON.
Default Value
yyyy-MM-dd
Accepted Values
Required
true

Kafka Message Data Format

Description
Specifies the format of the messages the connector receives from Kafka.
Default Value
Avro
Accepted Values
Avro, JSON, Raw
Required
true

Kerberos Keytab

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

Description
The Kerberos principal used for authenticating to Schema Registry.
Default Value
default
Accepted Values
Required
true

Quote Column Names

Description
Specifies whether to use quotes around the column names in the generated SQL statement.
Default Value
false
Accepted Values
true, false
Required
true

Quote Table Name

Description
Specifies whether to use quotes around the table name in the generated SQL statement.
Default Value

false

Accepted Values
true, false
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 if Kafka Message Data Format is JSON.

If set to Embedded Schema, the schema embedded in the input is used. This setting can only be used if Kafka Message Data Format is AVRO.

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. If Schema Registry is not used, this property must be completely removed from the configuration JSON.
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 to Schema 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, this property must be completely removed from the configuration JSON.
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. If Schema Registry is not used, this property must be completely removed from the configuration JSON.
Default Value
Accepted Values
Required
false

Statement Type

Description
Specifies the type of SQL statement that is generated to put data into the database.
Default Value
INSERT
Accepted Values
INSERT, INSERT_IGNORE, UPDATE, UPSERT
Required
true

Time Format

Description

Specifies the format to use when reading Time fields from JSON.

Default Value
HH:mm:ss
Accepted Values
Required
true

Timestamp Format

Description
Specifies the format to use when reading Timestamp fields from JSON.
Default Value
yyyy-MM-dd HH:mm:ss.SSS
Accepted Values
Required
true

Truststore Filename

Description
The fully-qualified filename of a truststore. This truststore is used to establish a secure connection with Schema Registry using HTTPS.
Default Value
The location of the default truststore which is empty and can only be used for unsecure connections.
Accepted Values
Required
true

Truststore Password

Description
The password used to access the contents of the truststore configured in the Truststore Filename property
Default Value
password
Accepted Values
Required
true

Truststore Type

Description
The type of the truststore configured in the Truststore Filename property.
Default Value
JKS
Accepted Values
BCFKS, PKCS12, JKS
Required
true