https://github.com/datagrip/redis-jdbc-driver
Redis JDBC Driver
https://github.com/datagrip/redis-jdbc-driver
jdbc redis
Last synced: 5 months ago
JSON representation
Redis JDBC Driver
- Host: GitHub
- URL: https://github.com/datagrip/redis-jdbc-driver
- Owner: DataGrip
- License: apache-2.0
- Created: 2022-08-23T11:31:35.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-10T15:23:50.000Z (over 2 years ago)
- Last Synced: 2025-04-06T09:24:17.489Z (about 1 year ago)
- Topics: jdbc, redis
- Language: Java
- Homepage:
- Size: 446 KB
- Stars: 48
- Watchers: 3
- Forks: 16
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Redis JDBC Driver
[](./LICENSE)
[](https://github.com/DataGrip/redis-jdbc-driver/releases/tag/v1.5)
[](https://github.com/datagrip/redis-jdbc-driver/actions?query=workflow%3ACI+branch%3Amain)
Type 4 JDBC driver based on [Jedis](https://github.com/redis/jedis) that allows Java programs to connect to a Redis database.
This driver is embedded into [DataGrip](https://www.jetbrains.com/datagrip/).
## Get The Driver
### Download
You can download the precompiled driver (jar) on the [releases page](https://github.com/DataGrip/redis-jdbc-driver/releases).
### Build
```
# Linux, MacOs
./gradlew jar
# Windows
gradlew.bat jar
```
You will find driver jar in ```build/libs```
## Get Started
```java
// Load the driver
try {
Class.forName("jdbc.RedisDriver");
} catch (ClassNotFoundException e) {
e.printStackTrace();
return;
}
// Create a connection
try (Connection connection = DriverManager.getConnection("jdbc:redis://localhost:6379/0", null, null)) {
// Execute a query
try (Statement statement = connection.createStatement()) {
try (ResultSet resultSet = statement.executeQuery("SET key value")) {
// Process the result set
while (resultSet.next()) {
String result = resultSet.getString("value");
System.out.println("result: " + result);
}
}
}
}
```
## Connectivity
| Server | Status |
| ------------------- | -------------------------------------- |
| Redis Standalone | :white_check_mark: *Supported* |
| Redis Cluster | :white_check_mark: *Supported* |
| Redis Sentinel | :heavy_minus_sign: *Not supported yet* |
Default host and port: ```127.0.0.1:6379```
### URL templates
#### Redis Standalone
```
jdbc:redis://[[:]@][[:]][/][?=&=&...]
```
#### Redis Cluster
```
jdbc:redis:cluster://[[:]@][[:],[:],...][/][?=&=&...]
```
### Properties
| Property | Type | Default | Description |
| ----------------------- | ------------------ | ------- | ----------------------------------- |
| user | String | null | |
| password | String | null | |
| database | Integer | 0 | |
| connectionTimeout | Integer | 2000 | Connection timeout in milliseconds. |
| socketTimeout | Integer | 2000 | Socket timeout in milliseconds. |
| blockingSocketTimeout | Integer | 0 | Socket timeout (in milliseconds) to use during blocking operation. Default is '0', which means to block forever. |
| clientName | String | null | |
| ssl | Boolean | false | Enable SSL. |
| verifyServerCertificate | Boolean | true | Configure a connection that uses SSL but does not verify the identity of the server. |
| hostAndPortMapping | Map | null | |
| verifyConnectionMode | Boolean | true | Verify that the mode specified for a connection in the URL prefix matches the server mode (standalone, cluster, sentinel). |
### SSL
Set the property `ssl` to `true`.
Pass arguments for your keystore and trust store:
```
-Djavax.net.ssl.trustStore=/path/to/client.truststore
-Djavax.net.ssl.trustStorePassword=password123
# If you're using client authentication:
-Djavax.net.ssl.keyStore=/path/to/client.keystore
-Djavax.net.ssl.keyStorePassword=password123
```
To disable server certificate verification set the property `verifyServerCertificate` to `false`.
### Port Forwarding
Set the property `hostAndPortMapping` to `{:=:, …}`.
Example:
```
{172.18.0.2:6379=localhost:6372, 172.18.0.3:6379=localhost:6373, 172.18.0.4:6379=localhost:6374, 172.18.0.5:6379=localhost:6375, 172.18.0.6:6379=localhost:6376, 172.18.0.7:6379=localhost:6377}
```
For using port forwarding with **Redis Standalone**, providing `hostAndPortMapping` **is not mandatory**.
it is sufficient to specify `fromHost` and `fromPort` in the URL.
For using port forwarding with **Redis Cluster**, providing `hostAndPortMapping` **is mandatory**.
The hosts and ports from the URL are used only for connection initialization, during which the hosts and ports of the cluster's nodes are obtained from the server. When sending commands, these obtained hosts and ports are transformed by applying `hostAndPortMapping` and then used.
## Sending Commands
| Commands | Status |
| --------------- | ------------------------------ |
| Native | :white_check_mark: *Supported* |
| RedisJSON | :white_check_mark: *Supported* |
| RediSearch | :white_check_mark: *Supported* |
| RedisBloom | :white_check_mark: *Supported* |
| RedisTimeSeries | :white_check_mark: *Supported* |
## Classes
| Interface | Class | Comment |
| ------------------------------- | ------------------------------- | ----------------------------------------------------------------------------------- |
|```java.sql.Driver``` |```jdbc.RedisDriver``` | |
|```java.sql.Connection``` |```jdbc.RedisConnection``` | |
|```java.sql.Statement``` |```jdbc.RedisStatement``` | |
|```java.sql.PreparedStatement``` |```jdbc.RedisPreparedStatement```| **Dummy implementation**: it is equivalent to ```jdbc.RedisStatement```. |
|```java.sql.DatabaseMetaData``` |```jdbc.RedisDatabaseMetaData``` | **Minimal implementation**: it does not contain information about database objects. |
|```java.sql.ResultSet``` |```jdbc.resultset.RedisResultSetBase```| |
|```java.sql.ResultSetMetaData``` |```jdbc.resultset.RedisResultSetMetaData```| **Partial implementation**: it contains only information about columns. |
## References
* [DataGrip 2022.3](https://www.jetbrains.com/datagrip/whatsnew/2022-3/): Redis support
+ [DataGrip 2022.3 EAP 2](https://blog.jetbrains.com/datagrip/2022/11/02/datagrip-2022-3-eap-2-redis-support/): Redis support (in details)
+ [DataGrip 2022.3.3](https://blog.jetbrains.com/datagrip/2023/01/12/datagrip-2022-3-3/): Connect to Redis with SSL/TLS enabled
* [DataGrip 2023.2](https://www.jetbrains.com/datagrip/whatsnew/2023-2/): Redis Cluster support
+ [DataGrip 2023.2 EAP 2](https://blog.jetbrains.com/datagrip/2023/07/06/datagrip-2023-2-eap-2-redis-cluster-new-schema-migration-dialog-and-more/): Redis Cluster support (in details)
* [DataGrip 2024.1](https://www.jetbrains.com/datagrip/whatsnew/2024-1/): Redis Stack modules support