Query Amazon DynamoDB 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 Amazon DynamoDB, DataGrip can work with live Amazon DynamoDB data. This article shows how to establish a connection to Amazon DynamoDB data in DataGrip and use the table editor to load Amazon DynamoDB data.

Create a New Driver Definition for Amazon DynamoDB

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

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 Amazon DynamoDB 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.amazondynamodb.jar).
   • Set Class to cdata.jdbc.amazondynamodb.AmazonDynamoDB.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 Amazon DynamoDB

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

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.amazondynamodb.jar

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

   The connection to Amazon DynamoDB is made using your AccessKey, SecretKey, and optionally your Domain and Region. Your AccessKey and SecretKey can be obtained on the security credentials page for your Amazon Web Services account. Your Region will be displayed in the upper left-hand corner when you are logged into DynamoDB.

3. Set URL to the connection string, e.g., jdbc:amazondynamodb:Access Key=xxx;Secret Key=xxx;Domain=amazonaws.com;Region=OREGON;
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 Amazon DynamoDB

To browse through the Amazon DynamoDB 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 Industry, Revenue FROM Lead

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