Oracle Cloud Infrastructure Documentation

Set Up DBeaver as a SQL Development Tool

Follow these steps to download, install, and connect DBeaver to a Data Flow SQL Endpoint with a JDBC driver.

  1. Download and install DBeaver and the JDBC driver.
  2. Configure DBeaver.
  3. Create a Database Connection.
  4. Connect DBeaver to the Data Flow SQL Endpoints.

Downloading and Installing DBeaver and a JDBC Driver

Follow these steps to download and install DBeaver and a JDBC driver.

  1. Download the DBeaver client from its download site. You can use either Community or Enterprise versions, but they must be at least 22.x.
    Note

    DBeaver is only available for Windows, Mac OS X, Eclipse Plugin, and Linux.
  2. Install it.
  3. Download the Simba JDBC driver from the Data Flow SQL Endpoint details page.
    1. In the global search bar, search for Data Flow and select Data Flow Service.
    2. Select SQL Endpoints in the leftmost side navigation.
    3. Select the name of the SQL Endpoint from the list. The details page for the SQL Endpoint is displayed.
    4. Under Connect, select Drivers.
    5. Under JDBC, select Download JDBC driver.
  4. Unzip the downloaded driver.
    It creates documentation and sparkSimba.zip.
  5. Unzip sparkSimba.zip.

Configuring DBeaver with the Spark Simba JDBC Driver

Follow these steps to configure DBeaver with the Spark Simba JDBC driver.

  1. Select DBeaver icon to open DBeaver.
  2. Select Database Navigator.
  3. Select Driver Manager.
  4. Select New.
  5. Enter Data Flow as the Driver Name.
  6. Select Libraries.
  7. Select Add Folder.
  8. Browse to the location of the sparkSimba.zip extract.
  9. Select Find Class.
  10. Select OK.
  11. Set Driver class to com.simba.spark.jdbc.Driver.
  12. Select Settings.
    Verify that Class Name is set to com.simba.spark.jdbc.Driver.
  13. If Class Name isn't set to com.simba.spark.jdbc.Driver, then add it.
  14. Select OK.

Creating a Database Connection

Follow these steps to create a database connection for DBeaver.

  1. Open DBeaver.
  2. Select Database.
  3. Select New Database Connection.
  4. Select All.
  5. Select Data Flow, the driver you configured in Configuring DBeaver with the Spark Simba JDBC Driver.
  6. Select Next.
  7. In JDBC URL, enter the URL of the JDBC driver.
    If you don't know it, you can find out the URL from the SQL Endpoint's details page.
    1. Under Resources, select Connect.
    2. Under Connect with JDBC, select Show Details.
    3. To copy the JDBC URL, select Copy.
    4. Select Close.
  8. Select Finish.

Connecting DBeaver to a Data Flow SQL Endpoint Using JDBC

Follow these steps to connect DBeaver to a Data Flow SQL Endpoint with the JDBC driver.

  1. Open DBeaver.
  2. Select Connect.
  3. Follow the steps in Connecting to a Data Flow SQL Endpoint and connect using:
    • A token, by not specifying any profile in the URL if you don't have the DEFAULT profile.
    • An API key, by specifying the OCI Profile with ociProfile=<profile_name> in the connection URL.
  4. (Optional) DBeaver creates a connection for reading metadata, and a connection for all the other operations. If you're limited for connections, you can disable the second one so that DBeaver uses one connection for all operations.
    1. Select Preferences.
    2. Select Common.
    3. Select Metadata.
    4. Clear the check box Open separate connection for metadata reads.