JDBC Source properties reference

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 Source 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 Source properties reference.

Additional WHERE clause

Description: Specifies a custom condition to add in the WHERE clause of the SQL query.
Default Value
Accepted Values
Required: false

Columns to Return

Description: A comma-separated list of column names to be returned by the query. All columns are returned if it is not specified.
Default Value
Accepted Values
Required: false

Custom Query

Description: Specifies a custom SQL query to use instead of generating the query from the table and column names.
Default Value
Accepted Values
Required: false

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 Table Name

Description: The name of the database table to query.
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 writing Date fields to JSON.
Default Value: yyyy-MM-dd
Accepted Values
Required: true

Initial Load Strategy

Description: Specifies how existing rows in the database table are handled when the connector is started for the first time.
Default Value: Start at Beginning
Accepted Values: Start at Beginning, Start at Current Maximum Values
Required: true

Kafka Message Data Format

Description: Specifies the format of the messages the connector sends to Kafka. The database row is converted to this format. If the output format is Avro and Schema Access Strategy is set to Inherit Schema, the schema is embedded in the output message. If the output format is Avro and Schema Access Strategy is set to Schema Registry, the schema is not embedded in the output message.
Default Value: Avro
Accepted Values: Avro, JSON
Required: true

Kafka Message Key Column

Description: Specifies a database table column. The value of the column specified is used as the key of the Kafka message.
Default Value
Accepted Values
Required: false

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

Maximum-value Columns

Description: A comma-separated list of column names used for incremental loading.
Default Value
Accepted Values
Required: false

Schema Access Strategy

Description

Specifies the strategy used for determining the schema of the database record.

If set to Inherit Schema, the schema is determined from the database schema.
If set to Schema Registry, the schema is read from Schema Registry.
If set to HWX Content-Encoded Schema Reference, the schema is read from Schema Registry. This setting can only be used if Kafka Message Data Format is Avro. In this case the Avro messages are expected to have a reference to the schema in Schema Registry encoded within the message content.

Default Value

Inherit Schema

Accepted Values

Inherit Schema, Schema Registry, HWX Content-Encoded Schema Reference

Required

true

Schema Branch

Description: The name of the branch to use when looking up the schema in Schema Registry. Schema Branch and Schema 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 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. Schema Branch and Schema 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

Time Format

Description: Specifies the format to use when writing Time fields to JSON.
Default Value: HH:mm:ss
Accepted Values
Required: true

Timestamp Format

Description: Specifies the format to use when writing Timestamp fields to 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: tue

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