Download TarantoolDB JDBC Driver

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

About the TarantoolDB JDBC driver

A JDBC driver is a Java .jar library that lets applications connect to TarantoolDB. 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 TarantoolDB driver uses its own syntax — see the connection details below.

The TarantoolDB JDBC driver

TarantoolDB is an in-memory computing platform that combines a fast NoSQL database with a Lua application server, enabling sub-millisecond transactional workloads. It supports both key-value and relational data models, and includes a SQL interface for structured queries. Tarantool is widely used for caching, session storage, and high-frequency transaction processing.

The TarantoolDB JDBC URL

• Required File(s): tarantool-jdbc-xxx.jar
• Java Driver Class: org.tarantool.jdbc.SQLDriver
• JDBC URL: jdbc:tarantool://{HOST}[:{PORT}]
• Website: Tarantool

Tarantool uses port 3301 by default. The SQL interface must be enabled in Tarantool's configuration. Authentication uses a Tarantool username and password. The JDBC driver connects using the binary protocol.

Connecting to TarantoolDB

Tarantool is configured by a Lua script rather than by a settings file, so what it listens on and who may connect are both decided in that script.

1. Check what the instance binds. The listen option in the instance's Lua configuration sets the address and port — 3301 conventionally, which is what DbSchema prefills. An instance listening on 127.0.0.1:3301 refuses remote clients.
2. Grant the user rights. The guest user has almost none by default. Either grant it what it needs or create a user with a password, otherwise the connection succeeds and every read is denied.
3. Expect SQL only on recent versions. Tarantool's SQL support arrived in 2.x. Against a 1.x instance the JDBC driver has nothing to talk to.
4. Open port 3301 in the server's firewall. The database listens on port 3301 unless it was installed with a different one. A host firewall on the server blocks incoming connections on that port until a rule allows them. The firewall guide has the commands for Windows, ufw, firewalld and iptables.
5. 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.

DbSchema and TarantoolDB

DbSchema connects to TarantoolDB using the Tarantool JDBC driver, enabling visualization of Tarantool space schemas through the SQL interface, SQL query execution against in-memory data, and interactive data exploration for Tarantool-powered applications.