10 Connect to Compute

This section covers connecting compute in your AI Data Platform Workbench to other business intelligence tools.

Topics:

Connections

You can connect your AI Data Platform Workbench with Oracle Analytics Cloud or other business intelligence tools.

You can connect to Oracle AI Data Platform Workbench from different business intelligence tools using a custom JDBC or ODBC provided by the AI Data Platform Workbench. AI Data Platform Workbench also supports connections from third party commercial BI tools (Tableau, Power BI) or open source BI tools like DBeaver. In order to connect from these tools, you need the connection details of the compute cluster in your AI Data Platform Workbench, which you can find in the Connection details tab. The required information varies depending on the product you are connecting from.


Connection details tab for the Dev_cluster_1 compute cluster

Connect Oracle Analytics to Oracle AI Data Platform Workbench

You can connect to the catalog or tables managed by your AI Data Platform Workbench instance from an Oracle Analytics Cloud instance.

In order to create a connection from Oracle Analytics to AI Data Platform Workbench, you need a connection file from AI Data Platform and an API key from Oracle Analytics Cloud.

Get an Oracle Analytics Connection Configuration File

You need to download a config.json file from your Oracle AI Data Platform Workbench instance to connect it to Oracle Analytics.

You need a compute cluster with at least 2 OCPUs, 32 GB of memory for both driver and worker nodes, and at least 2 workers.
  1. Navigate to your workspace and click Compute.

    Compute page open with Cluster_High compute cluster highlighted

  2. Click the cluster you want to connect to Oracle Analytics.
  3. In the Connection details tab, click the Download icon underneath the Oracle Analytics Cloud logo. A config.json file is downloaded to your machine.

    Compute page for Cluster_High cluster open with Connection details tab and Oracle Analytics Cloud download highlighted

Connect to Oracle Analytics

You can connect to the catalog or tables managed by your AI Data Platform Workbench instance from an Oracle Analytics instance.

Ensure you have a connection configuration file from AI Data Platform before creating your connection in Oracle Analytics. See Get an Oracle Analytics Connection Configuration File.
Oracle Analytics connections to AI Data Platform Workbench instances only support one catalog per connection. You need to create additional connections to use more than one catalog.
  1. On the Oracle Analytics home page, click Create then click Connection.
  2. Click Oracle AI Data Platform.
  3. Enter a name and description for your connection.
  4. In Location, specify where to save the connection. To share the connection with other users, save it in /Shared Folders.
  5. In Oracle Analytics Cloud, for Connection Details, click Select, navigate to your config.json file, and click Open.
  6. Select API Key as the authentication type.
  7. Under Public API Key, click Generate, then Copy.
  8. In OCI, add an API Key.
    1. In OCI, click the user icon, then click User Settings.
    2. In My profile, click Tokens and keys, then click Add API key.
    3. Select Paste a public key, and copy in the key that you generated in Step 7, then click Add.
    Wait two to three minutes for the API key to synchronize.
  9. In Catalog, specify the Catalog name to be used in your datasets.
    If the Catalog list doesn't load and you see the alert message "User does not have sufficient privileges to perform the operation", wait a little longer for the API key to synchronize.
  10. Click Save.
  11. Test your new connection by creating a dataset.

If you have followed the instructions and are still having issues saving your connection or listing your schemas, a cluster restart may be required.

Download JDBC Driver

You can download the JDBC driver from the Connection details tab and configure it for different BI tools.

  1. Navigate to your workspace and click Compute.
  2. Click the cluster you want to connect to a JDBC compatible BI tool and click Connections.
  3. Click Download JDBC Driver.

Configure DBeaver

You need to install DBeaver and prepare files downloaded from Oracle AI Data Platform Workbench before you can connect it to a compute cluster in your AI Data Platform Workbench.

  1. Download and install the DBeaver client. You can use either Community or Enterprise versions, but they must be at least 22.x.DBeaver is only available for Windows, Mac OS X, Eclipse Plugin, and Linux.
  2. Unzip the file from Download JDBC Driver.
  3. From the unzipped files, unzip the simbaSpark.zip driver file.

Configure DBeaver with the Spark Simba JDBC Driver

You can configure DBeaver to connect to a compute cluster in your Oracle AI Data Platform Workbench.

You must have installed DBeaver and extracted the simbaSpark.zip files downloaded from AI Data Platform Workbench.
  1. Open DBeaver.
  2. Click Database Navigator.
  3. Click Driver Manager.
  4. Click New.
  5. Enter AI Data Platform as the Driver Name.
  6. Click Libraries.
  7. Click Add Folder.
  8. Browse to the location of the sparkSimba.zip extract.
  9. Click Find Class.
  10. Select OK.
  11. Set Driver class to com.simba.spark.jdbc.Driver.
  12. Click Settings.
  13. Set Class Name to com.simba.spark.jdbc.Driver.
  14. Click OK.

Create a Database Connection in DBeaver

To connect DBeaver to a compute cluster in your Oracle AI Data Platform Workbench, you need to first create a database connection in DBeaver.

You must have configured DBeaver with the Spark Simba JDBC driver downloaded from AI Data Platform Workbench. For more information, see Configure DBeaver with the Spark Simba JDBC Driver.
  1. Open DBeaver.
  2. Click Database.
  3. Click New Database Connection.
  4. Click All.
  5. Select AI Data Platform.
  6. Click Next.
  7. Enter the URL of the JDBC driver. You can find the JDBC URL on the Connection details tab of your compute cluster in AI Data Platform Workbench.
  8. Click Finish.

Connect DBeaver to Oracle AI Data Platform Workbench using JDBC

Once DBeaver is configured and has a database connection to your AI Data Platform Workbench, you can complete the connection between DBeaver and AI Data Platform Workbench.

  1. Open DBeaver.
  2. Click Connect.
  3. Choose to connect with an authorization token or an API key.
    • Connect using authorization token
      • Use a token by not specifying any profile in the URL if you don't have a DEFAULT profile. For example: jdbc:spark://gateway.aidp.me-riyadh-1.oci.oraclecloud.com/default;SparkServerType=AIDP;httpPath=cliservice/cf18b4ef-b83e-41dd-82b6-8d391584f6c5

        The URL opens a browser window.

        Sign in to the tenancy where the AI Data Platform Workbench instance is created.

        For more information, see Token-based Authentication for the CLI.

    • Connect using an API key, by specifying the OCI Profile with ociProfile=<profile_name> in the connection URL.

      • Use API key authentication to connect to an AI Data Platform Workbench instance.

        Use API key by specifying the OCI Profile with ociProfile=<profile_name> in the connection URL. For example, to use OCI Profile name Demo: jdbc:spark://gateway.aidp.me-riyadh-1.oci.oraclecloud.com/default;SparkServerType=AIDP;httpPath=cliservice/cf18b4ef-b83e-41dd-82b6-8d391584f6c5 ;ociProfile=Demo

        For more information, see Required Keys and OCIDs.

  4. 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. Click Preferences.
    2. Click Common.
    3. Click Metadata.
    4. Deselect Open separate connection for metadata reads.

Download ODBC Driver

You can download the ODBC driver from the Connection details tab and configure it for different BI tools.

  1. Navigate to your workspace and click Compute.
  2. Click the cluster you want to connect to an ODBC compatible BI tool and click Connections.
  3. Click Download ODBC Driver.
  4. Select the appropriate OS from the list.

    ODBC Driver OS dropdown open with Mac, Windows, and Linx options displayed