JDBC Driver

This section describes the JDBC driver provided by Exasol to connect third party applications to Exasol.

System Requirements

JRE Requirement

The JDBC driver requires a Java runtime environment. You can use the driver on any platform with JRE version 1.8.0_282 or later.

Tested Systems

The driver has been tested on the following systems using the specified Java version with the latest available updates.

• Windows (64-bit)

  • Windows 10

  • Windows Server 2016

  • Windows Server 2019
    JDBC driver is tested on Windows platforms for the Java 8, Java 11 and Java 17.

• Linux (64-bit)

  • Red Hat / CentOS 7

  • Red Hat / CentOS 8 Stream

  • OpenSUSE Leap 15.2

  • Debian 10

  • Ubuntu 18.04 LTS

  • Ubuntu 20.04 LTS
    JDBC driver is tested on Linux platforms for the OpenJDK JVM 8 and OpenJDK JVM 11.

• macOS (64-bit)

  • macOS Catalina (10.15)

  • macOS Big Sur (11.6.1)

  • macOS Monterey (12.0.1)
    JDBC driver is tested on Mac OS for the JVM 8 and JVM 16.

• Free BSD (64-bit)

  • Free BSD 12.2
    JDBC driver is tested on Free BSD for the OpenJDK JVM 8.

Download JDBC Driver

1. Go to the Exasol Downloads portal and download the required driver for your operating system.
2. Run the downloaded executable file and follow the setup wizard to complete the installation.

Installing JDBC Driver

On Windows

The driver is installed as a .jar archive in the installation directory.

On Linux/Unix

The driver is included in the delivered .tgz file. Depending on the application this archive must be added to the search path for the Java classes (CLASSPATH).

All classes of the JDBC driver belong to the Java com.exasol.jdbc package. The main class of the driver is com.exasol.jdbc.EXADriver

License

Each driver package includes the latest version of the license for the driver. The license allows you to bundle the driver with third-party software, for example when creating plugins for a BI tool. For more details, refer to the license file which is located in the folder where the driver was installed.

Integrating JDBC Driver using Maven

The JDBC driver is also available on Maven Central (https://search.maven.org/artifact/com.exasol/exasol-jdbc). Add the following dependency to the build configuration of your project (for example, pom.xml for Maven)

<dependencies>
    <dependency>
        <groupId>com.exasol</groupId>
        <artifactId>exasol-jdbc</artifactId>
        <version>7.1.0</version>
    </dependency>
</dependencies>

Exasol URL

The JDBC Driver uses the following URL structure for Exasol:

jdbc:exa:<host>/<fingerprint>:<port>[;<prop_1>=<value_1>]...[;<prop_n>=<value_n>]

The following table explains the elements of the URL structure.

Example from a Java program

import java.sql.*;
import com.exasol.jdbc.*;

public class jdbcsample
{
    public static void main(String[] args)
    {
        try { Class.forName("com.exasol.jdbc.EXADriver");
    } catch (ClassNotFoundException e) { 
            e.printStackTrace();
    }
    Connection con=null; 
    Statement stmt=null; 
    try {
        con = DriverManager.getConnection( 
            "jdbc:exa:192.168.6.11..14:8563;schema=SYS",
            "sys", 
            "exasol"
            );
        stmt = con.createStatement();
        ResultSet rs = stmt.executeQuery("SELECT * FROM CAT"); 
        System.out.println("Schema SYS contains:"); 
        while(rs.next())
        {
            String str1 = rs.getString("TABLE_NAME"); 
            String str2 = rs.getString("TABLE_TYPE"); 
            System.out.println(str1 + ", " + str2);
        }
    } catch (SQLException e) { 
        e.printStackTrace();
    } finally {
        try {stmt.close();} catch (Exception e) {e.printStackTrace();} 
        try {con.close();} catch (Exception e) {e.printStackTrace();}
        }
    }
}

The above code sample builds a JDBC connection to Exasol, that runs on servers 192.168.6.11 up to 192.168.6.14 on port 8563. User sys with the password exasol is logged-in and the schema sys is opened. After that, all tables in this schema are shown.

Schema SYS contains: 
EXA_SQL_KEYWORDS, TABLE 
DUAL, TABLE 
EXA_PARAMETERS, TABLE
...

Supported Interfaces

Exasol provides the following interfaces:

• EXADataSource

• EXASocketFactory

EXADataSource

The JDBC driver provides a CommonDataSource interface called EXADataSource. Use EXADataSource to pass arguments using the setProperty() method. For example:

EXADataSource ds = new EXADataSource();
ds.setProperty("socketfactory", "myTool.MySocketFactory");
ds.setProperty("<User>", "<MyDBUser");
...

EXASocketFactory

The JDBC driver provides a SocketFactory interface called EXASocketFactory. With EXASocketFactory you can use the Exasol specific method createCustomSocket to connect with a set timeout for the connection. For example:

public abstract class EXASocketFactory extends SocketFactory {
    public abstract Socket createCustomSocket(<InetAddressHost>, <Port>, <Timeout>) throws IOException;        

When more than one host is specified in a connection string, the connect attempts to each of these hosts are made using the SocketFactory specified by the user and the timeout (if given) until one host is connected.

Supported Driver Standards

The JDBC driver supports JDBC 4.2 Core API. Detailed information about the supported interfaces are provided in the API Reference which you can find in the html folder of the driver installation directory. If you want to learn more about JDBC, see JDBC Basics.

The standard includes the following:

• Access to the driver through the DriverManager API and configuration of the driver using the DriverPropertyInfo interface.
• Direct execution of SQL statements as a prepared statement and in batch mode.
• Support of more than one open ResultSet.
• Support of the DatabaseMetaData and ResultSetMetaData metadata APIs.

The following features are not supported:

• Savepoints
• User-defined data types and the types Blob, Clob, Array, and Ref.
• Stored procedures
• Read-only connections
• The API ParameterMetaData

If the rowcount of a query exceeds 2147483647 (2³¹-1), the JDBC driver will return the value 2147483647. This is because of the 32-bit limitation for this return value defined by the JDBC standard.

Supported Driver Properties

You can transfer the following properties to the JDBC driver through the URL. Property names are case sensitive.

Best Practices