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

Create a New Driver Definition for Redis

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

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 Redis 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.redis.jar).
   • Set Class to cdata.jdbc.redis.Redis.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 Redis

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

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.redis.jar

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

   Set the following connection properties to connect to a Redis instance:

   • Server: Set this to the name or address of the server your Redis instance is running on. You can specify the port in Port.
   • Password: Set this to the password used to authenticate with a password-protected Redis instance , using the Redis AUTH command.

   Set UseSSL to negotiate SSL/TLS encryption when you connect.

3. Set URL to the connection string, e.g., jdbc:redis:Server=127.0.0.1;Port=6379;Password=myPassword;
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 Redis

To browse through the Redis 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 City, CompanyName FROM Customers

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