12.2 Using Autonomous Database Graph Client
Using the AdbGraphClient
API, you can access Graph Studio
features in Autonomous Database programmatically using the Oracle Graph Client or through
your Java or Python application.
This API provides the following capabilities:
- Authenticate with Autonomous Database
- Manage the Graph Studio environment
- Execute graph queries and algorithms against the graph server (PGX)
- Execute graph queries directly against Oracle Database
To use the AdbGraphClient
API, you must have access to
Oracle Graph Client installation. The API is provided by the Oracle Graph Client
library which is a part of the Oracle Graph Server and Client distribution. See
Installing Oracle Graph Client on how to
install and get started with the graph client shell CLIs for Java or Python.
AdbGraphClient
API to establish a connection to Graph Studio, start an environment with allocated
memory, load a PGQL property graph into memory,
execute PGQL queries and run algorithms against the graph.
Parent topic: Getting Started with the Client Tools
12.2.1 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 - Open the OCI console and click Oracle Database in the left navigation menu.
- Click Autonomous Database and navigate to the Autonomous Databases page.
- Select the required Autonomous Database under the Display Name column and navigate to the Autonomous Database Details page.
- Note the Database Name under "General Information" in the Autonomous Database Information tab.
database OCID The Oracle Cloud ID (OCID) of your Autonomous Database - Open the OCI console and click Oracle Database in the left navigation menu.
- Click Autonomous Database and navigate to the Autonomous Databases page.
- Select the required Autonomous Database under the Display Name column and navigate to the Autonomous Database Details page.
- 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 - Select your Autonomous Database instance and navigate to the Autonomous Database Details page.
- Click the Tools tab.
- Click on Graph Studio.
- Copy the URL of the new tab that opens the Graph Studio login screen.
- 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.
Parent topic: Using Autonomous Database Graph Client