Skip to content

Latest commit

 

History

History
157 lines (115 loc) · 7.44 KB

README.md

File metadata and controls

157 lines (115 loc) · 7.44 KB
Raw

Redis JDBC Driver

Apache licensed Latest Release CI

Type 4 JDBC driver based on Jedis that allows Java programs to connect to a Redis database.

This driver is embedded into DataGrip.

Get The Driver

Download

You can download the precompiled driver (jar) on the releases page.

Build

# Linux, MacOs
./gradlew jar

# Windows
gradlew.bat jar

You will find driver jar in build/libs

Get Started

// 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 ✅ Supported
Redis Cluster ✅ Supported
Redis Sentinel ➖ Not supported yet

Default host and port: 127.0.0.1:6379

URL templates

Redis Standalone

jdbc:redis://[[<user>:]<password>@][<host>[:<port>]][/<database>][?<property1>=<value>&<property2>=<value>&...]

Redis Cluster

jdbc:redis:cluster://[[<user>:]<password>@][<host1>[:<port1>],<host2>[:<port2>],...][/<database>][?<property1>=<value>&<property2>=<value>&...]

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<String,String> 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 {<toHost1>:<toPort1>=<fromHost1>:<fromPort1>, …}.

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 ✅ Supported
RedisJSON ✅ Supported
RediSearch ✅ Supported
RedisBloom ✅ Supported
RedisTimeSeries ✅ 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