oraclegraph API Reference

This section provides the Python API reference information on the different classes supported in the oraclegraph package.

• GraphVisualization
  The GraphVisualization class displays the widget for interactive graph visualization.

• SqlGraphVisualization
  The SqlGraphVisualization class applies for visualizing SQL graph queries on SQL property graphs in Oracle AI Database.

• PgqlGraphVisualization
  The PgqlGraphVisualization class applies for visualizing PGQL graph queries on PGQL property graphs in the database.

• PgxGraphVisualization
  The PgxGraphVisualization class applies for visualizing PGQL graph queries on graphs loaded in to the graph server (PGX).

GraphVisualization

The GraphVisualization class displays the widget for interactive graph visualization.

Format:

GraphVisualization(data=None, height=600, feature_flags=None, settings=None)

Parameters:

Parameter	Type	Description
data	(dict, optional)	Initial graph data (JSON-like).
height	(int, optional)	Display height in pixels. Default is 600.
feature_flags	(dict, optional)	UI and interaction flags.
settings	(dict, optional)	Visualization configuration and style options.

Methods:

• set_feature_flag(key, value): Updates a feature flag (nesting supported).

• set_setting(key, value): Updates a setting (nesting supported).

• close(): Releases resources; cleans up database cursors if applicable.

Usage Notes

To display the graph visualization, use display(graph) or place graph as the last line in a cell.

Examples

• Basic Example with GraphVisualization

• Custom Styling Example with GraphVisualization

• Example of Applying Styles Programmatically with GraphVisualization

SqlGraphVisualization

The SqlGraphVisualization class applies for visualizing SQL graph queries on SQL property graphs in Oracle AI Database.

Format:

SqlGraphVisualization(connection)

Attributes:

Attribute	Type	Description
connection	oracledb.Connection	Database connection object.

Methods:

• visual_query(query): Executes the SQL query and return a cursor object for graph data.

• close(): Closes the graph queries executed using SqlGraphVisualization and release associated resources.

Example Example Using SqlGraphVisualization and PgxGraphVisualization

PgqlGraphVisualization

The PgqlGraphVisualization class applies for visualizing PGQL graph queries on PGQL property graphs in the database.

Format:

PgqlGraphVisualization(username, password, dsn, props=None)

Attributes:

Parameter	Type	Description
username	(str)	Database username.
password	(str)	Database password.
dsn	(str)	Data source name for database connection.
props	(dict, optional)	Additional properties for the visual query.

Methods:

• visual_query(query): Executes the PGQL query and return graph data as JSON.

• close(): Closes the graph queries executed using PgqlGraphVisualization and release associated resources.

Example

See Using the Jupyter Notebook Interface for PGQL Property Graphs for an example using PgqlGraphVisualization.

PgxGraphVisualization

The PgxGraphVisualization class applies for visualizing PGQL graph queries on graphs loaded in to the graph server (PGX).

Format:

PgxGraphVisualization(session, props=None)

Attributes:

Parameter	Type	Description
session	(object)	PGX session object.
props	(dict, optional)	Additional properties for the visual query.

Methods:

• visual_query(query): Executes the PGQL query and return the graph data as JSON.

• close(): Closes the graph queries executed using PgxGraphVisualization and release associated resources.

Example Example Using SqlGraphVisualization and PgxGraphVisualization