Help Manual

JDBC Driver Pack

Documentation for Using from Tools the KingswaySoft Drivers

The Java community offers a wide range of JDBC tools designed for managing and operating various database systems. You can use these tools with the KingswaySoft JDBC Driver Pack to connect to your API data—once properly configured. In this guide, we’ll walk you through integrating our JDBC drivers with popular tools like DbVisualizer, Squirrel SQL, and DBeaver. We also explain how to set up your connection and use the table editor for data editing, saving, and executing SQL commands.

DbVisualizer

DbVisualizer is a widely used database tool in the Java community. When configured correctly, it lets you connect to your API data just as if you were working with a traditional database. You can directly edit table data and execute SQL commands right from within the tool.

Adding the JDBC Driver

  1. Go to Tools > Driver Manager.
  2. Click the + button and select Custom as the template.
  3. Enter a name for your driver.
  4. Set URL Format to jdbc:kingswaysoft:.
  5. In the Driver Artifacts and JAR Files section, click the + button and choose Add Files. Then, navigate to your installation directory and select the kingswaysoft.jdbc.jar file.

Creating a Database Connection

  1. Go to Database > Create Database Connection.
  2. The Driver Name selector will appear; double-click the name of the JDBC driver you created earlier.
  3. Set the Database Type to Generic.
  4. Set Driver Type to match the name you gave to the JDBC driver.
  5. In the Database URL field, enter the full JDBC URL. The URL should start with jdbc:kingswaysoft: and be followed by connection properties formatted as a semicolon-separated list of name-value pairs. You can also use the Connection Manager to generate this URL. For more details, see the Building the JDBC URL section of the documentation.
  6. To view or update additional connection settings, click Properties. For a detailed guide on specific connection settings, navigate to the help page for the driver you are using and review the Connection Settings section.
  7. Click Connect.

Discovering Schemas and Querying Data Now that you are connected, follow these steps to explore your data and run SQL queries:

  1. Expand the connection tree under the Databases tab to view available tables and views.
  2. Right-click a table to open it in a new tab and inspect both its data and metadata.
  3. To run SQL queries, go to SQL Commander > New SQL Commander, then select the appropriate Database Connection, Database, and Schema.

Note: If you update the JDBC driver JAR, please restart DbVisualizer before continuing.

Squirrel SQL

Squirrel SQL is another popular tool for accessing API data similarly to traditional databases.

Adding the JDBC Driver

  1. Open the Add Driver wizard by clicking the + icon in the Drivers pane.
  2. Enter a user-friendly name for the driver in the Name box.
  3. Enter jdbc:kingswaysoft: in the Example URL box.
  4. Switch to the Extra Class Path tab and click Add.
  5. Browse to the installation directory’s lib folder and select the kingswaysoft.jdbc.jar file.
  6. Click List Drivers to populate the Class Name menu. The driver class should be com.kingswaysoft.jdbc.Drivers.

Creating a JDBC Data Source

  1. Click + icon in the Aliases pane.
  2. In the Add Alias wizard, provide the following details:
    • Name: Enter a name for your alias.
    • Driver: Select the driver definition you set up earlier.
    • URL: Enter the full JDBC URL. The URL should start with jdbc:kingswaysoft: and be followed by connection properties formatted as a semicolon-separated list of name-value pairs. You can also use the Connection Manager to generate this URL. For more details, see the Building the JDBC URL section of the documentation.
    • User Name: (Optional) Enter a username for authentication.
    • Password: (Optional) Enter a password for authentication.
  3. Alternatively, add connection properties by opening the Driver Properties dialog:
    • Check the "Use Driver Properties" box.
    • In the Specify column, check the boxes for the required connection properties and enter their values.
  4. Click Connect in the dialog that appears after you click OK to test the connection.

Discovering Schemas and Querying Data Now that you are connected, follow these steps to explore your data and run SQL queries:

  1. Right-click your alias in the Aliases pane and select Connect. When the metadata loads, a new tab will open for the data source.
  2. Go to the Objects subtab to review schema information, including available tables and views.
  3. Click a table in the Objects tab to view its data and metadata in the Content tab.
  4. To execute an SQL query, switch to the SQL tab, enter your query, and click Run SQL (the runner icon).

DBeaver

DBeaver is yet another popular database tool that can be used to access your API data when used with the JDBC Driver Pack.

Adding the JDBC Driver

  1. Open DBeaver and go to the Database menu. Select Driver Manager, then click New to open the Create New Driver form.
  2. Enter a user-friendly name for the driver in the Name box.
  3. Enter "jdbc:kingswaysoft:" in URL Template field.
  4. In the Libraries tab, click Add File, then browse to the installation directory’s lib folder and select the kingswaysoft.jdbc.jar file.
  5. Click Find Class and choose "com.kingswaysoft.jdbc.Drivers" from the list. If the driver class isn’t displayed, save the driver, then edit it by selecting the Libraries tab and clicking Find Class again.

Creating a JDBC Data Source

  1. In the main DBeaver window, select Database > New Connection.
  2. Choose the driver definition you created.
  3. Enter the complete JDBC URL in the JDBC URL field. The URL should start with jdbc:kingswaysoft: and be followed by connection properties formatted as a semicolon-separated list of name-value pairs. You can also use the Connection Manager to generate this URL. For more details, see the Building the JDBC URL section of the documentation.
  4. On the next page of the wizard, click the Driver Properties tab.
  5. Enter any necessary connection properties to connect to API. For a detailed guide on using specific connection settings, refer to the Connection Settings section in the documentation for each driver.

Discovering Schemas and Querying Data Now that you are connected, follow these steps to explore your data and run SQL queries:

  1. Expand the connection node to view the database metadata.
  2. Right-click a table and choose Edit Table to review its metadata and modify data.
  3. To execute an SQL query, go to SQL Editor > New SQL Editor and select the connection you created, then type your query.

Note: DBeaver version 23.0 and later comes with an OpenJDK 17 bundle, which may lack the javax.xml.crypto package. This can cause a ClassNotFoundException when using JDBC drivers. To fix this, install a local JDK and update the dbeaver.ini file by adding the following line at the top (after any comments):

-vm JDK_HOME\bin

Replace JDK_HOME with the path to your JDK installation (for example, C:\Program Files\Java\jdk-17).