Prerequisites for Using Autonomous Database Graph Client

As a prerequisite requirement to get started with the AdbGraphClient API, you must:

  • Provision an Autonomous Database instance in Oracle Autonomous Database.
  • Obtain the following information if you are configuring the AdbGraphClient using the tenancy details. Otherwise, skip this step.
    Key Description More Information
    tenancy OCID The Oracle Cloud ID (OCID) of your tenancy To determine the OCID for your tenancy, see "Where to Find your Tenancy's OCID" in: Oracle Cloud Infrastructure Documentation.
    database Database name of your Autonomous Database instance
    1. Open the OCI console and click Oracle Database in the left navigation menu.
    2. Click Autonomous Database and navigate to the Autonomous Databases page.
    3. Select the required Autonomous Database under the Display Name column and navigate to the Autonomous Database Details page.
    4. Note the Database Name under "General Information" in the Autonomous Database Information tab.
    database OCID The Oracle Cloud ID (OCID) of your Autonomous Database
    1. Open the OCI console and click Oracle Database in the left navigation menu.
    2. Click Autonomous Database and navigate to the Autonomous Databases page.
    3. Select the required Autonomous Database under the Display Name column and navigate to the Autonomous Database Details page.
    4. Note the Database OCID under "General Information" in the Autonomous Database Information tab.
    username Graph enabled Autonomous Database username, used for logging into Graph Studio See Create a Graph User for more information.
    password Database password for the graph user If the password for a graph user is forgotten, then you can always reset password for the graph user by logging into Database Actions as the ADMIN user. See Edit User for more information.
    endpoint Graph Studio endpoint URL
    1. Select your Autonomous Database instance and navigate to the Autonomous Database Details page.
    2. Click the Tools tab.
    3. Click on Graph Studio.
    4. Copy the URL of the new tab that opens the Graph Studio login screen.
    5. Edit the URL to remove the part after oraclecloudapps.com to obtain the endpoint URL.

      For example, the following shows the format of a sample endpoint URL:

      https://<hostname_prefix>.adb.<region_identifier>.oraclecloudapps.com
  • Access Graph Studio and create a PGQL property graph.
  • Download, install and start the Oracle Graph Java or Python client.