Kafka To Database Sync application


Ingest string messages seperated by '|' from configured kafka topic and writes each message as a record in DataBase. This application uses PoJoEvent as an example schema, this can be customized to use custom schema based on specific needs.

The source code is available at: https://github.com/DataTorrent/app-templates/tree/master/kafka-to-database-sync.

Please send feedback or feature requests to: feedback@datatorrent.com

This document has a step-by-step guide to configure, customize, and launch this application.

Steps to launch application

  1. Click on the AppHub tab from the top navigation bar. AppHub link from top navigation bar

  2. Page listing the applications available on AppHub is displayed. Search for Database to see all applications related to Database. AppHub search for Database

    Click on import button for Kafka to Database Sync App

  3. Notification is displayed on the top right corner after application package is successfully imported. App import Notification

  4. Click on the link in the notification which navigates to the page for this application package. App details page

    Detailed information about the application package like version, last modified time, and short description is available on this page. Click on launch button for Kafka-to-Database-Sync application.

  5. Launch Kafka-to-Database-Sync dialogue is displayed. One can configure the name of this instance of the application from this dialogue. Launch dialogue

  6. Select Use saved configuration option to display a list of pre-saved configurations. Please select sandbox-memory-conf.xml or cluster-memory-conf.xml depending on whether your environment is the DataTorrent sandbox, or other cluster. Select saved configuration

  7. Select Specify custom properties option. Click on add default properties button. Specify custom properties

  8. This expands a key-value editor pre-populated with mandatory properties for this application. Change values as needed. Properties editor

    For example, suppose we wish string messages seperated with '|' to the table test_event_table in a PostgreSQL database named testdb accessible at target-database.node.com port 5432 with credentials username=postgres, password=postgres. Properties should be set as follows:

    Name Value
    dt.operator.kafkaInput.prop.clusters kafka-source.node.com:9092
    dt.operator.kafkaInput.prop.topics transactions
    dt.operator.kafkaInput.prop.initialOffset EARLIEST
    dt.operator.JdbcOuput.prop.store.databaseDriver org.postgresql.Driver
    dt.operator.JdbcOuput.prop.store.databaseUrl jdbc:postgresql://target-database.node .com:5432/testdb
    dt.operator.JdbcOuput.prop.store.password postgres
    dt.operator.JdbcOuput.prop.store.userName postgres
    dt.operator.JdbcOuput.prop.tablename test_event_output_table

    Details about configuration options are available in Configuration options section.

  9. Click on the Launch button at the lower right corner of the dialog to launch the application. A notification is displayed on the top right corner after the application is launched successfully and includes the Application ID which can be used to monitor this instance and to find its logs. Application launch notification

  10. Click on the Monitor tab from the top navigation bar. Monitor tab

  11. A page listing all running applications is displayed. Search for the current instance based on name or application id or any other relevant field. Click on the application name or id to navigate to the details page. Apps monitor listing

  12. Application instance details page shows key metrics for monitoring the application status. logical tab shows application DAG, StrAM events, operator status based on logical operators, stream status, and a chart with key metrics. Logical tab
  13. Click on the physical tab to look at the status of physical instances of operators, containers etc. Physical tab

Configuration options


  1. Kafka configured with version 0.9.
  2. Meta-data table is required for Jdbc Output operator for transactional data and application consistency.
Table Name Column Names
dt_app_id (VARCHAR)
dt_operator_id (INT)
dt_window (BIGINT)

Query for Meta-data table creation:

CREATE TABLE dt_meta (dt_app_id varchar(100) NOT NULL, dt_operator_id int NOT NULL, dt_window bigint NOT NULL, CONSTRAINT dt_app_id UNIQUE (dt_app_id,dt_operator_id,dt_window));

Mandatory properties

End user must specify the values for these properties.

Property Description Type Example


List of Brokers for kafka input String node1.company.com:9098, node2.company.com:9098, node3.company.com:9098


Kafka topics for input String transactions


Kafka input offset String





JDBC driver class. This has to be on CLASSPATH. PostgreSQL driver is added as a dependency. String org.postgresql.Driver


JDBC connection URL String jdbc:postgresql://target-database.node.com:5432/testdb


Password for Database credentials String postgres


Username for Database credentials String postgres


Table name for output records String test_event_output_table

Advanced properties

There are pre-saved configurations based on the application environment. Recommended settings for datatorrent sandbox edition are in sandbox-memory-conf.xml and for a cluster environment in cluster-memory-conf.xml (the first 2 are integers and the rest are strings). The messages or records emitted are specified by the value of the TUPLE_CLASS attribute in the configuration file namely PojoEvent in this case.

Property Description Default for
- conf.xml
Default for


Fully qualified class name for the tuple class POJO(Plain old java objects) emitted by JDBC input com.datatorrent.apps.PojoEvent com.datatorrent.apps.PojoEvent


Fully qualified class name for the tuple class POJO(Plain old java objects) emitted by Kafka input com.datatorrent.apps.PojoEvent com.datatorrent.apps.PojoEvent


Schema for CSV parser

{"separator": "|",
"quoteChar": "\"",
"lineDelimiter": "", "fields": [
"name": "accountNumber",
"type": "Integer"
"name": "name",
"type": "String"
"name": "amount",
"type": "Integer"

{"separator": "|",
"quoteChar": "\"",
"lineDelimiter": "", "fields": [
"name": "accountNumber",
"type": "Integer"
"name": "name",
"type": "String"
"name": "amount",
"type": "Integer"

You can override default values for advanced properties by specifying custom values for these properties in the step specify custom property step mentioned in steps to launch an application.

Steps to customize the application

  1. Make sure you have following utilities installed on your machine and available on PATH in environment variable:

  2. Use following command to clone the examples repository:

    git clone git@github.com:DataTorrent/app-templates.git

  3. Change directory to examples/tutorials/kafka-to-database-sync:

    cd examples/tutorials/kafka-to-database-sync

  4. Import this maven project in your favorite IDE (e.g. eclipse).

  5. Change the source code as per your requirements. Some tips are given as commented blocks in the Application.java for this project.

  6. Make respective changes in the test case and properties.xml based on your environment.

  7. Compile this project using maven:

    mvn clean package

    This will generate the application package file with .apa extension in the target directory.

  8. Go to DataTorrent UI Management console on web browser. Click on the Develop tab from the top navigation bar. Develop tab

  9. Click on upload package button and upload the generated .apa file. Upload

  10. Application package page is shown with the listing of all packages. Click on the Launch button for the uploaded application package. Follow the steps for launching an application.