Getting started

Learn how to install and get started with the CrateDB JDBC driver.

Table of contents

Prerequisites

The CrateDB JDBC driver requires Java 8, preferably update 20 or later. We recommend using Oracle’s Java on macOS and OpenJDK on Linux Systems.

Consult the compatibility notes for additional information.

Install

Following the sunsetting of Bintray/JCenter, crate-jdbc has moved to Maven Central. Versions < 2.6.0 will not be migrated. If you are using an older version, please consider upgrading, or building the artifacts manually.

Note

These instructions show you how to do a conventional install.

To build the CrateDB JDBC driver from the source code, follow the instructions on GitHub.

There are two ways to install the driver.

The regular CrateDB JDBC driver JAR files crate-jdbc are hosted on Maven Central.

Alternatively, you can download a single, standalone JAR file that bundles the driver dependencies, called crate-jdbc-standalone.

Caution

The standalone JAR file should not be used in a Maven project. It does, however, function nicely as a plugin for tools such as SQuirreL.

Set up as a dependency

This section shows you how to set up the CrateDB JDBC driver as a dependency using Maven or Gradle; two popular build tools for Java projects.

Maven

Add crate-jdbc as a dependency, like so:

...
<dependencies>
    ...
    <dependency>
        <groupId>io.crate</groupId>
        <artifactId>crate-jdbc</artifactId>
        <version>...</version>
    </dependency>
</dependencies>
...

Gradle

If you’re using Gradle, you first need to add the Maven Central repository to your build.gradle file:

repositories {
    ...
    mavenCentral()
}

Then add crate-jdbc as a dependency, like so:

dependencies {
    compile 'io.crate:crate-jdbc:...'
    ...
}

Next steps

Once the JDBC driver is set up, you probably want to connect to CrateDB.

Feedback

How helpful was this page?