Skip to content

Commit 526723e

Browse files
authored
Update README: v1.4 [Redis Cluster]
1 parent eb6d98d commit 526723e

File tree

1 file changed

+27
-14
lines changed

1 file changed

+27
-14
lines changed

README.md

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# Redis JDBC Driver
22

33
[![Apache licensed](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg)](./LICENSE)
4-
[![Latest Release](https://img.shields.io/github/v/release/datagrip/redis-jdbc-driver?label=latest)](https://github.com/DataGrip/redis-jdbc-driver/releases/tag/v1.3)
4+
[![Latest Release](https://img.shields.io/github/v/release/datagrip/redis-jdbc-driver?label=latest)](https://github.com/DataGrip/redis-jdbc-driver/releases/tag/v1.4)
55
[![CI](https://github.com/datagrip/redis-jdbc-driver/workflows/CI/badge.svg?branch=main)](https://github.com/datagrip/redis-jdbc-driver/actions?query=workflow%3ACI+branch%3Amain)
66

77
Type 4 JDBC driver based on [Jedis](https://github.com/redis/jedis) that allows Java programs to connect to a Redis database.
88

99
This driver is embedded into [DataGrip](https://www.jetbrains.com/datagrip/).
1010

11+
1112
## Get The Driver
1213

1314
### Download
@@ -26,6 +27,7 @@ gradlew.bat jar
2627

2728
You will find driver jar in ```build/libs```
2829

30+
2931
## Get Started
3032

3133
```java
@@ -52,12 +54,13 @@ try (Connection connection = DriverManager.getConnection("jdbc:redis://localhost
5254
}
5355
```
5456

57+
5558
## Connectivity
5659

5760
| Server | Status |
5861
| ------------------- | ------------------- |
5962
| Redis Standalone | ***Supported*** |
60-
| Redis Cluster | *Not supported yet* |
63+
| Redis Cluster | ***Supported*** |
6164
| Redis Sentinel | *Not supported yet* |
6265

6366
Default host and port: ```127.0.0.1:6379```
@@ -69,21 +72,29 @@ Default host and port: ```127.0.0.1:6379```
6972
jdbc:redis://[[<user>:]<password>@][<host>[:<port>]][/<database>][?<property1>=<value>&<property2>=<value>&...]
7073
```
7174

75+
#### Redis Cluster
76+
```
77+
jdbc:redis:cluster://[[<user>:]<password>@][<host1>[:<port1>],<host2>[:<port2>],...][/<database>][?<property1>=<value>&<property2>=<value>&...]
78+
```
79+
7280
### Properties
7381

74-
| Property | Type | Default | Description |
75-
| ----------------------- | ------- | ------- | ----------------------------------- |
76-
| user | String | null | |
77-
| password | String | null | |
78-
| database | Integer | 0 | |
79-
| connectionTimeout | Integer | 2000 | Connection timeout in milliseconds. |
80-
| socketTimeout | Integer | 2000 | Socket timeout in milliseconds. |
81-
| blockingSocketTimeout | Integer | 0 | Socket timeout (in milliseconds) to use during blocking operation. Default is '0', which means to block forever. |
82-
| clientName | String | null | |
83-
| ssl | Boolean | false | Enable SSL. |
84-
| verifyServerCertificate | Boolean | true | Configure a connection that uses SSL but does not verify the identity of the server. |
82+
| Property | Type | Default | Description |
83+
| ----------------------- | ------------------- | ------- | ----------------------------------- |
84+
| user | String | null | |
85+
| password | String | null | |
86+
| database | Integer | 0 | |
87+
| connectionTimeout | Integer | 2000 | Connection timeout in milliseconds. |
88+
| socketTimeout | Integer | 2000 | Socket timeout in milliseconds. |
89+
| blockingSocketTimeout | Integer | 0 | Socket timeout (in milliseconds) to use during blocking operation. Default is '0', which means to block forever. |
90+
| clientName | String | null | |
91+
| ssl | Boolean | false | Enable SSL. |
92+
| verifyServerCertificate | Boolean | true | Configure a connection that uses SSL but does not verify the identity of the server. |
93+
| hostAndPortMapping | Map<String, String> | null | Host and port mapping. |
94+
| verifyConnectionMode | Boolean | true | Verify that the mode specified for a connection in the URL prefix matches the server mode (standalone, cluster, sentinel). |
8595

8696
### SSL
97+
8798
Set property `ssl=true`.
8899

89100
Pass arguments for your keystore and trust store:
@@ -97,8 +108,8 @@ Pass arguments for your keystore and trust store:
97108

98109
To disable server certificate verification set property `verifyServerCertificate=false`.
99110

100-
## Commands Execution
101111

112+
## Commands Execution
102113

103114
| Commands | Status |
104115
| --------------- | ------------------- |
@@ -109,6 +120,7 @@ To disable server certificate verification set property `verifyServerCertificate
109120
| RedisJSON | *Not supported yet* |
110121
| RedisTimeSeries | *Not supported yet* |
111122

123+
112124
## Classes
113125

114126
| Interface | Class | Comment |
@@ -121,6 +133,7 @@ To disable server certificate verification set property `verifyServerCertificate
121133
|```java.sql.ResultSet``` |```jdbc.resultset.RedisResultSetBase```| |
122134
|```java.sql.ResultSetMetaData``` |```jdbc.resultset.RedisResultSetMetaData```| **Partial implementation**: it contains only information about columns. |
123135

136+
124137
## References
125138

126139
* [DataGrip 2022.3](https://www.jetbrains.com/datagrip/whatsnew/2022-3/): Redis support

0 commit comments

Comments
 (0)