CrateDB JDBC Driver¶

Introduction¶

A JDBC driver for CrateDB, based on the PostgreSQL JDBC Driver which is adhering to the JDBC 4.1 specification. It is written in pure Java, and communicates with the database using the PostgreSQL Wire Protocol.

Synopsis¶

Connect to CrateDB instance running on localhost:

import java.sql.Connection;
import java.sql.DriverManager;

Connection conn = DriverManager.getConnection("jdbc:crate://localhost:5432/");

Connect to CrateDB Cloud:

import java.sql.Connection;
import java.sql.DriverManager;
import java.util.Properties;

Properties connectionProps = new Properties();
connectionProps.put("user", "admin");
connectionProps.put("password", "<PASSWORD>");
connectionProps.put("tcpKeepAlive", true);

Connection conn = DriverManager.getConnection("jdbc:crate://example.aks1.westeurope.azure.cratedb.net:5432/?user=crate", connectionProps);

Examples¶

The Basic example for connecting to CrateDB and CrateDB Cloud using JDBC demonstrates CrateDB’s PostgreSQL wire protocol compatibility by exercising a basic example using both the vanilla pgJDBC Driver and the CrateDB JDBC Driver.
The sample application and the corresponding sample application documentation demonstrate the use of the driver on behalf of an example “guestbook” application, using Spring Data JDBC.
The article Build a data ingestion pipeline using Kafka, Flink, and CrateDB, and the accompanying repositories Apache Kafka, Apache Flink, and CrateDB and Flink example jobs for CrateDB.

Documentation¶

For general help about JDBC, please consult the JDBC tutorial and the JDBC API documentation.