Graph Studio: Interactive, Self-Service User Interface

Graph Studio is the primary user interface (UI) for creating, querying, analyzing, and visualizing property graphs and RDF graphs.

It includes a Modeler for creating and editing property graphs, along with Graph Assistant, which uses natural language prompts for building property graphs.

Graph Studio also provides Graph Explorer for querying and visualizing property graphs. In addition, it includes notebooks and developer APIs where you can execute SQL graph queries, PGQL (Property Graph Query Language) queries, and RDF graph queries using SPARQL. It offers over 80 built-in graph algorithms and dozens of visualizations, including native graph visualization.

The following figure shows the Graph Studio landing page.

Description of the illustration ui_graph_studio.png

The overall layout of Graph Studio consists of:

• A header at the top of the page. See Header for more information.

• A main navigation panel that opens from the top of the page when you click the hamburger icon:

  Description of the illustration main_navigation_menu.png

  Note: The Compute Environment Management and Credentials menu options are available only to Graph Studio administrators.

• A page body that displays the content for the selected menu item.

• Overview

• Graph Explorer

• Modeler

• Graphs

• Notebooks

• Templates

• Jobs

• Compute Environment Management

• Credentials

Header

The header comprises the following items:

• : Click to view the main navigation menu.

• : Click the help icon to link to the documentation to get started with the Graph Studio user interface.

• : Displays the status of the compute environment. See Inspect the Compute Environment for more information.

• : Click the user profile to view the drop-down menu with the following options:

  • Database: Displays the name of the database connected to Graph Studio.

  • Compute Environment: Allows you to Manually Manage the Compute Environment.

  • Preferences: Allows you to configure your application Preferences.

  • About: Allows you to view the version of Graph Studio and the versions of other components integrated with it.

Preferences

You can adjust the Graph Studio application settings in Preferences.

Description of the illustration preferences.png

As seen in the preceding figure, you can configure the following application settings:

• General: To change the displayed language in Graph Studio using the Language drop-down.

• Accessibility Mode: To switch on or off accessibility mode. See Use Accessibility Mode

• Notebook Iframe View: To open a notebook in iframe view by enabling or disabling the actions shown in the preceding figure.

• Graph Panel: By default Minimized Panel is switched off.

• Navigation: By default Minimized Navigation is switched on.

Overview

The Overview menu link opens the Graph Studio landing page, where you can resume recent work or start a new task.

Description of the illustration graph_studio_return_user.png

The page includes the following sections:

• Quickstart: Provides shortcuts to create a graph, create a notebook, open Graph Explorer, and configure the compute environment.

• Jobs: Displays recent Graph Studio jobs. Click View All to open the Jobs page.

• Recently Updated Graphs: Displays recently updated graphs. Click View All to open the Graphs page.

• Recent Notebooks: Displays recently updated notebooks. Click View All to open the Notebooks page.

• Resources: Provides links to Graph Studio documentation, blogs, and tutorials.

Graph Explorer

The Graph Explorer user interface lets you query property graphs in the database and graphs loaded into the graph server (PGX), and view results as either a graph visualization or a table.

The following shows the user interface for Graph Explorer:

Description of the illustration explorer_ui.png

1. Tree view: Displays all the available property graphs (to which you have access), grouped by type:

   • SQL Property Graphs (supported only on Oracle AI Database 26ai)

   • PGQL Property Graphs

   • Graph Server

   Within each type, the graphs are grouped by database schema. Expand a graph to view its labels and expand a label to view its properties. Right-click on a specific graph to open a context menu.

   The following options are supported for SQL property graphs:

   • Generate basic query: Generates a basic query for the selected SQL property graph.

   • Copy graph name: Copies the name of the selected SQL property graph.

   • Schema visualization: Opens the schema visualization for the selected SQL property graph.

   • Load graph into memory: Loads the selected SQL property graph into graph server (PGX) memory.

   The following options are supported for PGQL property graphs:

   • Generate basic query: Generates a basic query for the selected PGQL property graph.

   • Copy graph name: Copies the name of the selected PGQL property graph.

   • Schema visualization: Opens the schema visualization for the selected PGQL property graph.

   • Migrate to SQL graph: Migrates the selected PGQL property graph to a SQL property graph.

   • Load graph into memory: Loads the selected PGQL property graph into graph server (PGX) memory.

   The following actions are supported for graphs loaded into the graph server (PGX) memory:

   • Generate basic query: Generates a basic query for the selected property graph.

   • Copy graph name: Copies the name of the selected property graph.

   • Schema visualization: Opens the schema visualization for the selected property graph.

   • Unload graph from memory: Unloads the selected property graph from graph server (PGX) memory.

2. Search: Use the search box to filter the list of available graphs in the tree view.

3. Query editor: Enter SQL graph queries, SQL statements, or PGQL graph queries.

   If you used Generate Basic Query, you can edit the generated query or replace it with your own.

4. Query actions: An action panel at the top of the query editor to:

   • Driver selector: Select the driver for the query you are running.

     • SQL: Select to run SQL graph queries on SQL property graphs or to execute any SQL statements.

     • PGQL: Select to run PGQL queries on PGQL property graphs.

     • Graph Server: Select to run PGQL queries on graphs loaded into the graph server (PGX).

   • Visualize Graph: Click to run the latest query in the query editor and visualize the results.

   • Run Statement: Click to run the latest query and view the output in tabular format.

   • Cancel: Click to cancel an in-progress visualization query or a table-only query.

   • ...: Click Reset to defaults in the actions menu to reset Graph Explorer to defaults.

5. Query result tabs: Displays the output in one of the following tabs:

   • Schema Visualization: Visualization of the underlying database schema for a property graph.

   • Query Visualization: Graph visualization for:

     • SQL property graphs: See Query and Visualize SQL Property Graphs.

     • PGQL property graphs: See Query and Visualize PGQL Property Graphs.

     • Graph Server: See Query and Visualize Graphs Loaded Into the Graph Server Memory.

   • Table Result: Tabular output for SQL statements, SQL graph queries, or PGQL graph queries. See View Query Results in a Table for more information.

   • Output: Text output for statements such as CREATE PROPERY GRAPH, INSERT, UPDATE, DELETE, or DROP PROPERTY GRAPH statements.

6. Query visualization panel: The main canvas where graph query results are visualized.

   You can right-click a vertex or an edge to open a property tooltip and view the properties associated with the selected graph element. Property tooltips can be pinned, repositioned, and resized to support comparison of multiple graph elements. See View Vertex and Edge Properties for more information.

7. Graph visualization toolbar: Controls graph visualization modes and the different graph interaction options in the Query Visualization tab.

8. Search: Search within the visualization results; includes support for keyword or conditional search. See Search a Graph Visualization for more information.

9. Additional result controls:

   • Information: Shows the executed query (available in Query Visualization and Table Result tabs).

   • Settings: View and edit graph visualization settings in Query Visualization tab. See Query Visualization Settings for more information.

10. Legend panel: Displays legend items for the graph visualization. See About the Graph Visualization Legend Panel for more information.

11. Display size: Controls the display size of the graph. See Manage the Graph Display Size for more information.

Modeler

The Modeler user interface lets you create new property graphs and edit existing ones.

The following shows the Modeler landing page:

Description of the illustration modeler_landing_page.png

You can perform any of the following actions:

• Click New Graph to get started creating a new property graph.

• Click the Edit icon on an existing graph to modify it.

• Expand the Graph Assistant panel by clicking the arrow on the left side of the page, and then create a property graph using natural language.

The following shows the user interface for the graph modeling page:

Description of the illustration graph_modeling_page_ui.png

1. Modeler Toolbar: Supported actions are:

   • Auto-map: Invoke this feature to automatically generate a SQL or PGQL property graph from selected database tables by detecting foreign key relationships.

   • Sync Database: Click to refresh the graph model with changes to the underlying database schema. You can configure automatic synchronization by enabling Auto Sync and specifying the synchronization interval as described in Configure Modeler Settings.

   • Settings: Click to configure the settings for the Visual Editor, Graph Assistant, and database synchronization.

   • Graph Actions: Select one of the following:

     • New graph: Select to get started modeling a new property graph.

     • Create a copy: Select to create a copy of an existing property graph.

   • Create Graph: Click to create a new property graph in the database.

2. Graph Tabs: Displays the currently open property graph model. Click the + icon to create additional graph tabs. If Auto-name New Graphs is enabled in Settings, a default graph name is generated automatically and displayed as the tab name. Otherwise, you can specify the graph name before creating the graph.

3. Canvas / Code View toggle: Switch between the visual editor and code editor.

4. Graph Type: Select the graph type for creation:

   • SQL Property Graph: The option to create a SQL property graph is available only if you are using an Oracle Autonomous AI database instance with Oracle AI Database 26ai.

   • PGQL Property Graph: The option to create a PGQL property graph is available on all supported database versions.

5. Open Auto-map: Click to invoke this feature to automatically generate a SQL or PGQL property graph from selected database tables by detecting foreign key relationships.

6. Graph Modeling Canvas: The interactive workspace where you visually model the property graph by creating, connecting, and arranging vertices and edges.

7. Visual Editor tools: Tools for manually building the graph, including adding vertices and edges to the canvas.

8. Layout Controls: Automatically arranges the property graph on the canvas. Click F to apply a force-directed layout. Use the directional arrows to orient the concentric layout on the canvas.

9. Status Bar: The status bar can display warnings, indicate when the graph is ready for creation, and can also show database syncing messages.

Notebooks

The Notebooks menu link takes you to the Notebooks page that lists the existing notebooks.

Description of the illustration notebooks_page.png

Graphs

The Graphs menu link directs you to the Graphs page which contains the following two tabs:

• Property Graph

• RDF Graph All existing graphs corresponding to the selected graph type are listed on the Graphs page. Clicking on any graph displays the graph details in the bottom panel.

Description of the illustration graphs_page.png

Depending on the graph, you can perform any of the following actions on this page:

• Property Graph

  • Create a new SQL or PGQL property graph.

  • Query an existing SQL or PGQL property graph. See Query Playground for more information.

  • You can also use any of the following supported options in the graph details section:

    • Explore the Summary of the graph and optionally load the graph into memory, share the graph with other users, rename or delete the graph.

    • Preview the graph.

    • View the graph Properties.

    • View the graph Source.

• RDF Graph

  • Create a new RDF graph.

  • Query an existing RDF graph using SPARQL.

  • Explore the RDF graph properties (RDF statements) in the graph details section.

Query Playground

Clicking </> Query on the Graphs page will direct you to the Query Playground page. It serves as a notepad for entering and executing simple SQL or PGQL queries on a SQL or PGQL property graph, or SPARQL queries for an RDF graph. It is not meant for testing complex queries or for use in a production environment.

Note: The </> Query Playground page for property graphs will be desupported in a future Graph Studio release. It is recommended that you use Graph Explorer for querying and visualizing property graphs.

Queries submitted in the playground are executed directly against the graph stored in the Autonomous AI Database as shown:

Description of the illustration sql_pg_qp_page.png

This means you do not require Graph Studio to be attached to the internal compute environment or initially have the graph loaded into memory in case of property graphs.

The Query Playground page can comprise one or both of the following tabs depending on the database version used in your Autonomous AI Database instance:

• SQL: This default tab is displayed only for Oracle AI Database 26ai. You can run SQL graph queries on SQL property graphs in this tab.

• PGQL: You can run PGQL queries on PGQL property graphs in this tab. This is the only tab for Oracle Database 19c.

In case of RDF graphs, the Query Playground interface allows you to select the RDF graph against which the SPARQL query is to be executed as shown:

Description of the illustration query_playground_rdf.png

Templates

The Templates menu link directs you to the Templates page. This page consists of a left pane that lists all the existing templates. They are custom built templates with predefined graph visualization and notebook settings. Clicking on an existing template displays the custom data settings on the right pane. These template formats are applied to a notebook.

The page also contains the following buttons:

• Create: To build a new template

• Update: To update a template

• Delete: To delete a template

• Share: To share a template

• Import: To import a template

• Export: To export a template

Description of the illustration templates_page.png

Jobs

The Jobs menu link directs you to the Jobs page that lists previous and current jobs.

Description of the illustration jobs_page.png

Compute Environment Management

The Compute Environment Management menu option is available for Graph Studio administrators only. The console allows Graph Studio administrators view and manage active compute environments of your Autonomous AI Database instance.

Description of the illustration compute_env_mgmnt_page.png

The main panel at the top of the page displays the number of running compute environments for the current database. The top panel lists the compute environments for the current database. When you select a compute environment, the details panel displays its associated containers.

As an administrator, you can detach a selected compute environment or detach all compute environments for the current database. A confirmation dialog is displayed before either action is performed.

See Also: Manage the Compute Environment

Credentials

The Credentials menu option is available for Graph Studio administrators only.

As a Graph Studio administrator, you can attach Oracle Cloud Infrastructure (OCI) Vault secret credentials to Graph Studio which can be later accessed in a Python notebook paragraph.

Description of the illustration credentials_page.png

See Use OCI Vault Secret Credentials for more information.