Connect to Kafka Data in Aqua Data Studio

The CData JDBC Driver for Kafka integrates Kafka data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Kafka data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Kafka data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Kafka.
   • Driver Location: Click the Browse button and select the cdata.jdbc.apachekafka.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.apachekafka.ApacheKafkaDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:apachekafka: and is followed by a semicolon-separated list of connection properties.

     Set BootstrapServers and the Topic properties to specify the address of your Apache Kafka server, as well as the topic you would like to interact with.

     Authorization Mechanisms

     • SASL Plain: The User and Password properties should be specified. AuthScheme should be set to 'Plain'.
     • SASL SSL: The User and Password properties should be specified. AuthScheme should be set to 'Scram'. UseSSL should be set to true.
     • SSL: The SSLCert and SSLCertPassword properties should be specified. UseSSL should be set to true.
     • Kerberos: The User and Password properties should be specified. AuthScheme should be set to 'Kerberos'.

     You may be required to trust the server certificate. In such cases, specify the TrustStorePath and the TrustStorePassword if necessary.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Kafka JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.apachekafka.jar
     

     Fill in the connection properties and copy the connection string to the clipboard.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     A typical JDBC URL is below:

     jdbc:apachekafka:User=admin;Password=pass;BootStrapServers=https://localhost:9091;Topic=MyTopic;

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query Kafka Data

You can now query the tables exposed.