The JDBC Driver Manager dialog shows the JDBC drivers built into the app for each DBMS and adds driver JAR files of other versions or other vendors as custom drivers. You pick an added driver in the JDBC Driver field of the connection dialog. Only the desktop app can add drivers. The web app connects only with the built-in drivers on the NeoSQL server.
Where you can use itWebDesktopWithout signing inSigned inLocal projectsAccount projects
What's on the screen
| No. | Name | Description |
|---|---|---|
| 1 | DBMS list | The DBMSs that have drivers. Click one to see its drivers on the right. |
| 2 | Driver table | Each driver's name, version and driver class. |
| 3 | Default column | The driver chosen first when you pick this DBMS for a new connection has a default badge. |
| 4 | Type column | Drivers built into the app show built-in; drivers you added show custom. Only custom drivers have a trash button. |
| 5 | Add Custom Driver button | Opens the dialog for adding a custom driver (below). |
- Open the dialog with the gear button next to the JDBC Driver field of the connection dialog. In the web app the dialog also opens and shows the built-in drivers, but clicking Add Custom Driver shows the Custom driver addition is only supported in desktop version. notice.
- Built-in drivers cannot be removed or replaced.
- Besides the MySQL 8 driver chosen by default, MySQL also comes with a MySQL 5 (Legacy) driver for old servers.
Adding a custom driver
| No. | Name | Description |
|---|---|---|
| 1 | DBMS Type | The DBMS this driver connects to. It starts with the DBMS chosen in the manager. |
| 2 | Driver ID | A name that identifies the driver. An existing ID cannot be used; it is checked as soon as you leave the field. |
| 3 | Label | The name shown in the driver list of the connection dialog. |
| 4 | Driver Class | The JDBC driver class name inside the JAR (for example, oracle.jdbc.OracleDriver). |
| 5 | Version | The version shown in the list. It can be left empty. |
| 6 | JAR Files | Drop the driver JAR files here or click to pick them. You can upload several files at once; only .jar files are accepted. |
- In the connection dialog, click the gear button next to the JDBC Driver field to open the JDBC Driver Manager dialog.
- In the DBMS list, choose the DBMS to add a driver for and click the Add Custom Driver button.
- Fill in the Driver ID, Label and Driver Class fields. Check the driver class name in the driver's documentation.
- Drop the JAR files on the JAR Files area (6). If the driver needs other JARs, drop them too.
- Click the Save button. The dialog closes and the driver appears in the table with a custom badge.
- Pick the new driver in the JDBC Driver field of the connection dialog and click the Test Connection button.
- A custom driver's JARs are stored in the NeoSQL settings folder on this computer. They do not move to other computers.
- The connection stores the chosen driver's ID, name, class and version.
When another computer does not have the driver
When you open an account project on another computer, or a teammate opens it, the custom driver a connection uses may not be on that computer.
- The desktop app shows the Install Missing Driver dialog when the project opens. It is filled with the driver information stored in the connection, so you only drop the JAR files and save. Choosing Replace with bundled driver JAR registers a copy of the same DBMS's built-in driver under that ID instead of a JAR. You can also skip it with the Skip button.
- A skipped connection gets a warning icon in the explorer. When connecting, the built-in driver with the same driver class is used. If the class name differs from every built-in driver, it cannot connect, so install the driver or switch the connection to a built-in driver in the connection dialog.
- On the web, connections use a built-in driver with the same driver class. The JDBC Driver field of the connection dialog shows the Missing badge and the Custom drivers cannot be added in the web app. The built-in driver with the same driver class is used if there is one; otherwise the connection fails. notice, and the built-in driver with the same driver class is used.
Things to keep in mind
- The trash button opens the Remove Driver dialog. If connections in open projects use the driver, the dialog lists the project and connection names. Connections in projects that are not open are not checked. Connections that chose the removed driver are left without a driver, so switch them to a built-in driver before removing it.
- If the built-in driver connects to your database, you do not need a custom driver. Add one only when you really need a specific version, for example when an old database version does not accept the new driver.
- If the driver class name is wrong, saving still works but connecting with the Test Connection button fails.
Related screens
- Create and edit a connection: pick the driver in the JDBC Driver field.
- Web and desktop: what only the desktop app can do.
- Database reference: the built-in drivers for each DBMS.