# Configuration Reference for Kudu Source Connector for Confluent Platform To use this connector, specify the name of the connector class in the `connector.class` configuration property. ```properties connector.class=io.confluent.connect.kudu.KuduSourceConnector ``` Connector-specific configuration properties are described below. ## Database Connection Security In the connector configuration you will notice there are no security parameters. This is because SSL is not part of the JDBC standard and will depend on the JDBC driver in use. In general, you will need to configure SSL using the `connection.url` parameter. In Kudu database specifically, we are using Impala JDBC driver, and you need to set up a LDAP server to do username plus password authentication. Pass the Impala server hostname and port and Kudu database name to Kudu connector, And `connection.url` will be automatically generated, which would be something resemble: ```properties connection.url="jdbc:impala://:/" ``` Check the following links for setting up the LDAP server: - [Setting up a LDAP server using Apache Directory Studio](https://docs.craftercms.org/en/3.0/developers/cook-books/how-tos/setting-up-an-ldap-server-for-dev.html) - [Add entries to LDAP server](https://directory.apache.org/apacheds/basic-ug/2.1.1-adding-entries.html) Once you set up the LDAP server and have Kudu and Impala deployed properly, complete the following steps: 1. Start Impala daemon with the following flags: ```text --enable_ldap_auth=true --ldap_uri= --ldap_bind_pattern="uid=#UID,dc=..." --ldap_passwords_in_clear_ok ``` 2. Insert in your LDAP URI and DCs in your LDAP server. LDAP URI should resemble: `ldap://:10389`. ## Connection `impala.server` : The server address to use to format JDBC URL for connection
* Type: string * Importance: high `impala.port` : The port to use to format JDBC URL for connection; By default, Impala uses port 21050.
* Type: int * Default: 21050 * Valid Values: [0,…] * Importance: high `kudu.database` : The Kudu database to connect
* Type: string * Default: default * Importance: high `impala.ldap.user` : Username to do LDAP authentication with Impala
* Type: string * Importance: high `impala.ldap.password` : Password to do LDAP authentication with Impala
* Type: password * Importance: high `kudu.tablet.replicas` : The number of replicas of Kudu tablets
* Type: int * Default: 3 * Valid Values: [1,…] * Importance: medium ## Database `connection.attempts` : Maximum number of attempts to retrieve a valid JDBC connection.
* Type: int * Default: 3 * Importance: low `connection.backoff.ms` : Backoff time in milliseconds between connection attempts.
* Type: long * Default: 10000 * Importance: low `table.whitelist` : List of tables to include in copying. If specified, table.blacklist may not be set.
* Type: list * Default: “” * Importance: medium `table.blacklist` : List of tables to exclude from copying. If specified, table.whitelist may not be set.
* Type: list * Default: “” * Importance: medium `catalog.pattern` : Catalog pattern to fetch table metadata from the database. “” retrieves table metadata without a catalog. Null (the default) means that the catalog name should not be used to narrow the search, and that all table metadata is fetched (regardless of the catalog).
* Type: string * Default: null * Importance: medium `schema.pattern` : Schema pattern to fetch table metadata from the database. “” retrieves table metadata without a schema. Null (the default) means that the schema name should not be used to narrow the search, and that all table metadata is fetched (regardless of the schema).
* Type: string * Default: null * Importance: medium ## Mode `mode` : The mode for updating a table each time it is polled. Options include:
> * bulk - perform a bulk load of the entire table each time it is polled > * incrementing - use a strictly incrementing column on each table to detect only new rows. Note that this will not detect modifications or deletions of existing rows. > * timestamp - use a timestamp (or timestamp-like) column to detect new and modified rows. This assumes the column is updated with each write, and that values are monotonically incrementing, but not necessarily unique. > * timestamp+incrementing - use two columns, a timestamp column that detects new and modified rows and a strictly incrementing column which provides a globally unique ID for updates so each row can be assigned a unique stream offset. * Type: string * Default: “” * Valid Values: [bulk, timestamp, incrementing, timestamp+incrementing] * Importance: high * Dependents: `incrementing.column.name`, `timestamp.column.name`, `validate.non.null` `incrementing.column.name` : The name of the strictly incrementing column to use to detect new rows. If `mode` is set to timestamp or timestamp+incrementing, The value of this config cannot be empty.
* Type: string * Default: “” * Importance: medium `timestamp.column.name` : Comma separated list of one or more timestamp columns to detect new or modified rows using the COALESCE SQL function. Rows whose first non-null timestamp value is greater than the largest previous timestamp value seen will be discovered with each poll. At least one column should not be nullable. If `mode` is set to timestamp or timestamp+incrementing, The value of this config cannot be empty.
* Type: list * Default: “” * Importance: medium `validate.non.null` : By default, the JDBC connector will validate that all incrementing and timestamp tables have NOT NULL set for the columns being used as their ID/timestamp. If the tables don’t, JDBC connector will fail to start. Setting this to false will disable these checks.
* Type: boolean * Default: true * Importance: low `query` : If specified, the query to perform to select new or updated rows. Use this setting if you want to join tables, select subsets of columns in a table, or filter data. If used, this connector will only copy data using this query – whole-table copying will be disabled. Different query modes may still be used for incremental updates, but in order to properly construct the incremental query, it must be possible to append a WHERE clause to this query (that is, no WHERE clauses may be used). If you use a WHERE clause, it must handle incremental queries itself. Records will be put to a topic named exactly as `topic.prefix`.
* Type: string * Default: “” * Importance: medium `quote.sql.identifiers` : When to quote table names, column names, and other identifiers in SQL statements. For backward compatibility, the default is ‘always’.
* Type: string * Default: ALWAYS * Importance: medium ## Connector `table.types` : By default, the JDBC connector will only detect tables with type TABLE from the source Database. This config allows a comma-separated list of table types to extract. Options include:
* TABLE * VIEW * SYSTEM TABLE * GLOBAL TEMPORARY * LOCAL TEMPORARY * ALIAS * SYNONYM
In most cases it only makes sense to have either TABLE or VIEW.
* Type: list * Default: TABLE * Importance: low `poll.interval.ms` : Frequency in ms to poll for new data in each table.
* Type: int * Default: 5000 * Importance: high `batch.max.rows` : Maximum number of rows to include in a single batch when polling for new data. This setting can be used to limit the amount of data buffered internally in the connector.
* Type: int * Default: 100 * Importance: low `table.poll.interval.ms` : Frequency in ms to poll for new or removed tables, which may result in updated task configurations to start polling for data in added tables or stop polling for data in removed tables.
* Type: long * Default: 60000 * Importance: low `topic.prefix` : Prefix to prepend to table names to generate the name of the Kafka topic to publish data to, or in the case of a custom query, the full name of the topic to publish to.
* Type: string * Importance: high `timestamp.delay.interval.ms` : How long to wait after a row with certain timestamp appears before we include it in the result. You may choose to add some delay to allow transactions with earlier timestamp to complete. The first execution will fetch all available records (i.e. starting at timestamp 0) until current time minus the delay. Every following execution will get data from the last time we fetched until current time minus the delay.
* Type: long * Default: 0 * Importance: high ## Auto topic creation For more information about Auto topic creation, see [Configuring Auto Topic Creation for Source Connectors](/kafka-connectors/self-managed/userguide.html#connect-source-auto-topic-creation). Configuration properties accept regular expressions (regex) that are defined as [Java regex](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html). `topic.creation.groups` : A list of group aliases that are used to define per-group topic configurations for matching topics. A `default` group always exists and matches all topics.
* Type: List of String types * Default: empty * Possible Values: The values of this property refer to any additional groups. A `default` group is always defined for topic configurations. `topic.creation.$alias.replication.factor` : The replication factor for new topics created by the connector. This value must not be larger than the number of brokers in the Kafka cluster. If this value is larger than the number of Kafka brokers, an error occurs when the connector attempts to create a topic. This is a **required property** for the `default` group. This property is optional for any other group defined in `topic.creation.groups`. Other groups use the Kafka broker default value.
* Type: int * Default: n/a * Possible Values: `>= 1` for a specific valid value or `-1` to use the Kafka broker’s default value. `topic.creation.$alias.partitions` : The number of topic partitions created by this connector. This is a **required property** for the `default` group. This property is optional for any other group defined in `topic.creation.groups`. Other groups use the Kafka broker default value.
* Type: int * Default: n/a * Possible Values: `>= 1` for a specific valid value or `-1` to use the Kafka broker’s default value. `topic.creation.$alias.include` : A list of strings that represent regular expressions that match topic names. This list is used to include topics with matching values, and apply this group’s specific configuration to the matching topics. `$alias` applies to any group defined in `topic.creation.groups`. This property does not apply to the `default` group.
* Type: List of String types * Default: empty * Possible Values: Comma-separated list of exact topic names or regular expressions. `topic.creation.$alias.exclude` : A list of strings representing regular expressions that match topic names. This list is used to exclude topics with matching values from getting the group’s specfic configuration. `$alias` applies to any group defined in `topic.creation.groups`. This property does not apply to the `default` group. Note that exclusion rules override any inclusion rules for topics.
* Type: List of String types * Default: empty * Possible Values: Comma-separated list of exact topic names or regular expressions. `topic.creation.$alias.${kafkaTopicSpecificConfigName}` : Any of the [Changing Broker Configurations Dynamically](/platform/current/kafka/dynamic-config.html#changing-broker-configurations-dynamically) for the version of the Kafka broker where the records will be written. The broker’s topic-level configuration value is used if the configuration is not specified for the rule. `$alias` applies to the `default` group as well as any group defined in `topic.creation.groups`.
* Type: property values * Default: Kafka broker value ## Confluent Platform license `confluent.topic.bootstrap.servers` : A list of host/port pairs to use for establishing the initial connection to the Kafka cluster used for licensing. All servers in the cluster will be discovered from the initial connection. This list should be in the following form:
```text host1:port1,host2:port2,... ```
Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down).
* Type: list * Importance: high `confluent.topic` : Name of the Kafka topic used for Confluent Platform configuration, including licensing information.
* Type: string * Default: \_confluent-command * Importance: low `confluent.topic.replication.factor` : The replication factor for the Kafka topic used for Confluent Platform configuration, including licensing information. This is used only if the topic does not already exist, and the default of 3 is appropriate for production use. If you are using a development environment with less than 3 brokers, you must set this to the number of brokers (often 1).
* Type: int * Default: 3 * Importance: low ## CSFLE and CSPE configurations `csfle.enabled` Accepts a boolean value. CSFLE is enabled for the connector if `csfle.enabled` is set to True. * Type: boolean * Default: False `auto.register.schemas` Specifies if the Serializer should attempt to register the Schema with Schema Registry. * Type: boolean * Default: true * Importance: medium `use.latest.version` Only applies when `auto.register.schemas` is set to false. If `auto.register.schemas` is set to false and `use.latest.version` is set to true, then instead of deriving a schema for the object passed to the client for serialization, Schema Registry uses the latest version of the schema in the subject for serialization. * Type: boolean * Default: true * Importance: medium ### Confluent license properties You can put license-related properties in the connector configuration, or in license-related properties in the [Connect worker configuration](https://docs.confluent.io/kafka-connectors/self-managed/license.html#centralized-license-in-the-kconnect-long-worker) instead of in each connector configuration. This connector is proprietary and requires a license. The license information is stored in the `_confluent-command` topic. If the broker requires SSL for connections, you must include the security-related `confluent.topic.*` properties as described below. `confluent.license` : Confluent issues enterprise license keys to each subscriber. The license key is text that you can copy and paste as the value for `confluent.license`. A trial license allows using the connector for a 30-day trial period. A developer license allows using the connector indefinitely for single-broker development environments.
If you are a subscriber, contact Confluent Support for more information.
* Type: string * Default: “” * Valid Values: Confluent Platform license * Importance: high `confluent.topic.ssl.truststore.location` : The location of the trust store file.
* Type: string * Default: null * Importance: high `confluent.topic.ssl.truststore.password` : The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled.
* Type: password * Default: null * Importance: high `confluent.topic.ssl.keystore.location` : The location of the key store file. This is optional for client and can be used for two-way authentication for client.
* Type: string * Default: null * Importance: high `confluent.topic.ssl.keystore.password` : The store password for the key store file. This is optional for client and only needed if ssl.keystore.location is configured.
* Type: password * Default: null * Importance: high `confluent.topic.ssl.key.password` : The password of the private key in the key store file. This is optional for client.
* Type: password * Default: null * Importance: high `confluent.topic.security.protocol` : Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.
* Type: string * Default: “PLAINTEXT” * Importance: medium ### License topic configuration A Confluent enterprise license is stored in the `_confluent-command` topic. This topic is created by default and contains the license that corresponds to the license key supplied through the `confluent.license` property. No public keys are stored in Kafka topics. The following describes how the default `_confluent-command` topic is generated under different scenarios: * A 30-day trial license is automatically generated for the `_confluent-command` topic if you do not add the `confluent.license` property or leave this property empty (for example, `confluent.license=`). * Adding a valid license key (for example, `confluent.license=`) adds a valid license in the `_confluent-command` topic. Here is an example of the minimal properties for development and testing. You can change the name of the `_confluent-command` topic using the `confluent.topic` property (for instance, if your environment has strict naming conventions). The example below shows this change and the configured Kafka bootstrap server. ```none confluent.topic=foo_confluent-command confluent.topic.bootstrap.servers=localhost:9092 ``` The example above shows the minimally required bootstrap server property that you can use for development and testing. For a production environment, you add the normal producer, consumer, and topic configuration properties to the connector properties, prefixed with `confluent.topic.`. ### License topic ACLs The `_confluent-command` topic contains the license that corresponds to the license key supplied through the `confluent.license` property. It is created by default. Connectors that access this topic require the following ACLs configured: * CREATE and DESCRIBE on the resource cluster, if the connector needs to create the topic. * DESCRIBE, READ, and WRITE on the `_confluent-command` topic. #### IMPORTANT You can also use DESCRIBE and READ without WRITE to restrict access to read-only for license topic ACLs. If a topic exists, the LicenseManager will not try to create the topic. You can provide access either individually for each principal that will use the license or use a [wildcard entry](/platform/current/kafka/authorization.html#acl-wildcard-principals) to allow all clients. The following examples show commands that you can use to configure ACLs for the resource cluster and `_confluent-command` topic. 1. Set a CREATE and DESCRIBE ACL on the resource cluster: ```none kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \ --add --allow-principal User: \ --operation CREATE --operation DESCRIBE --cluster ``` 2. Set a DESCRIBE, READ, and WRITE ACL on the `_confluent-command` topic: ```none kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \ --add --allow-principal User: \ --operation DESCRIBE --operation READ --operation WRITE --topic _confluent-command ``` ### Override Default Configuration Properties You can override the replication factor using `confluent.topic.replication.factor`. For example, when using a Kafka cluster as a destination with less than three brokers (for development and testing) you should set the `confluent.topic.replication.factor` property to `1`. You can override producer-specific properties by using the `producer.override.*` prefix (for source connectors) and consumer-specific properties by using the `consumer.override.*` prefix (for sink connectors). You can use the defaults or customize the other properties as well. For example, the `confluent.topic.client.id` property defaults to the name of the connector with `-licensing` suffix. You can specify the configuration settings for brokers that require SSL or SASL for client connections using this prefix. You cannot override the cleanup policy of a topic because the topic always has a single partition and is compacted. Also, do not specify serializers and deserializers using this prefix; they are ignored if added.