Download Couchbase JDBC Driver

Download the Couchbase JDBC driver, copy the JDBC URL into DbSchema, and start designing schemas with ER diagrams — free Community Edition.

About the Couchbase JDBC driver

A JDBC driver is a Java .jar library that lets applications connect to Couchbase. DbSchema uses JDBC to reverse engineer schemas, run SQL, and generate documentation. Driver files are usually published by the database vendor or an open-source project.

JDBC URL format

Host, port, database name, and SSL options are passed in a URL starting with jdbc:. Each Couchbase driver uses its own syntax — see the connection details below.

The Couchbase JDBC driver

Couchbase is a distributed NoSQL cloud database that combines the flexibility of JSON document storage with the power of SQL-like querying via N1QL. It is designed for mission-critical applications requiring high availability, elastic scalability, and low-latency data access. Couchbase supports key-value, document, full-text search, analytics, and eventing workloads in a single platform.

The Couchbase JDBC URL

• Required File(s): couchbase-jdbc-driver-xxx.jar
• Java Driver Class: com.couchbase.jdbc.CouchbaseDriver
• JDBC URL: jdbc:couchbase://{HOST}:{PORT}
• Website: Couchbase

The JDBC driver connects to the Couchbase Analytics Service on port 8095 (or the Query Service on port 8093 for N1QL). Authentication uses a Couchbase username and password. Ensure the Analytics or Query service is enabled on your cluster before connecting.

Connecting to Couchbase

The JDBC driver talks to Couchbase Analytics, which is a separate service from the key-value and query services. It has to be running before any URL works.

1. Enable the Analytics service on the cluster. It is chosen per node when the node joins, so a cluster built without it has nothing for the driver to connect to. Adding it later means editing the node's services.
2. Create the analytics collections you want to see. Analytics works on datasets linked to buckets, and until those are created and connected the schema is empty even though the buckets hold data.
3. Use a cluster user with analytics rights. Couchbase's role-based access control is per service, so a user who can read a bucket may still be refused by Analytics.
4. Connect from DbSchema. In the Connection Dialog choose Remote computer or custom port, fill in the server host and the port, then press Test Connection to check that the server answers before you connect.

Confirm the Analytics port against your cluster's configuration — Couchbase assigns a different port to each service, and a secure cluster moves them again.

DbSchema and Couchbase

DbSchema connects to Couchbase via its JDBC driver, allowing visualization of bucket and collection schemas, N1QL query authoring in the SQL editor, and interactive browsing of JSON document collections through the data explorer.