Skip to content

Connect SqlKit to a database ​

You’ll need the server’s hostname, port, and login credentials. Depending on the database, you may also need a database name or a value such as an Oracle service name. To open SQLite, use the path to the database file.

Add and test a connection ​

  1. Open Connections and select Add New Connection.
  2. Give the connection a name and select its database type.
  3. In Basic, enter the server details or choose a local database file. Use Advanced to set up TLS or connect through an SSH tunnel.
  4. Test the connection, save it, and select Connect on its connection card. Open Queries to browse objects and run SQL.

Choose a connection type ​

Use your server's configured port if it differs from the default shown here.

DatabaseDefault port or fileDetails
MySQL3306Host and SQL credentials. Specify a database when you want to open it by default.
PostgreSQL5432Host, role credentials, and the database to connect to.
SQL Server1433Host, the instance's TCP port, and a SQL Server login.
Oracle Database1521 for a basic connectionJDBC. Use a service name, SID, TNS alias, or cloud wallet according to your setup.
SQLiteLocal fileSelect the database file on disk.
MariaDB3306Choose MariaDB as the database type.
DuckDBLocal fileUses the JDBC bridge.
ClickHouse8123 for HTTPUse your server's HTTP or HTTPS endpoint and configured port.

See supported databases and drivers for additional engines and their setup requirements.

Java and JDBC drivers ​

Oracle, DuckDB, and other JDBC engines use a Java runtime, the SqlKit JDBC bridge, and an engine-specific driver. The connection test checks for these components and attempts to download missing ones. Use Settings → JRE & Drivers to check their status or retry a download. If your network restricts outbound downloads, check that SqlKit can reach the package sources before retrying the connection test.

Troubleshoot a failed connection ​

SymptomWhat to check
Connection refused or timed outConfirm the server is listening on that host and port. Check whether access requires a VPN, SSH tunnel, or an IP allowlist. SSH tunneling in SqlKit requires Ultimate.
Authentication failedCheck the username and password. Confirm the account can sign in from your machine and access the selected database.
TLS certificate errorMatch your server's TLS requirements in Advanced. Use the trusted CA certificate and the hostname on the certificate when verification is required.
Connected, but tables are missingSelect the intended database and schema in Queries, refresh the object tree, and check that your account can see the objects.

Once connected, run a read-only query to verify your session.