Query Avro Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for Avro, DataGrip can work with live Avro data. This article shows how to establish a connection to Avro data in DataGrip.

Create a New Driver Definition for Avro

The steps below describe how to create a new Data Source in DataGrip for Avro.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Avro Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.avro.jar).
   • Set Class to cdata.jdbc.avro.Avro.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Avro

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Avro Driver" to create a new Avro Data Source.
2. In the new window, configure the connection to Avro with a JDBC URL.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.avro.jar

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

   Connect to your local Avro file(s) by setting the URI connection property to the location of the Avro file.
3. Set URL to the connection string, e.g., jdbc:avro:URI=C:/folder/table.avroInitiateOAuth=GETANDREFRESH
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Avro

To browse through the Avro entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT Id, Column1 FROM SampleTable_1 WHERE Column2 = 'value_2'

Download a free, 30-day trial of the CData JDBC Driver for Avro and start working with your live Avro data in DataGrip. Reach out to our Support Team if you have any questions.