11.6 oraclegraph APIリファレンス

この項では、oraclegraphパッケージでサポートされている様々なクラスのPython APIリファレンス情報を提供します。

  • GraphVisualization
    GraphVisualizationクラスは、対話型グラフ・ビジュアライゼーション用のウィジェットを表示します。
  • SqlGraphVisualization
    SqlGraphVisualizationクラスは、Oracle AI DatabaseのSQLプロパティ・グラフでSQLグラフの問合せをビジュアル化するために使用します。
  • PgqlGraphVisualization
    PgqlGraphVisualizationクラスは、データベース内のPGQLプロパティ・グラフでPGQLグラフの問合せをビジュアル化するために使用します。
  • PgxGraphVisualization
    PgxGraphVisualizationクラスは、グラフ・サーバー(PGX)にロードされたグラフでPGQLグラフの問合せをビジュアル化するために使用します。

親トピック: Jupyter環境のグラフ・ビジュアライゼーション拡張機能のスタート・ガイド

11.6.1 GraphVisualization

GraphVisualizationクラスは、対話型グラフ・ビジュアライゼーション用のウィジェットを表示します。

フォーマット:

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

パラメータ:

パラメータ 型 説明
data (dict, optional) 初期グラフ・データ(JSONライク)。
height (int, optional) 表示の高さ(ピクセル数)。デフォルトは600です。
feature_flags (dict, optional) UIおよび対話型処理フラグ。
settings (dict, optional) ビジュアライゼーション構成およびスタイルのオプション。

メソッド:

  • set_feature_flag(key, value): 機能フラグを更新します(ネストがサポートされています)。
  • set_setting(key, value): 設定を更新します(ネストがサポートされています)。
  • close(): リソースを解放します。該当する場合はデータベース・カーソルをクリーン・アップします。

使用上のノート

グラフ・ビジュアライゼーションを表示するには、display(graph)を使用するか、graphをセルの最後の行に配置します。

例

親トピック: oraclegraph APIリファレンス

11.6.2 SqlGraphVisualization

SqlGraphVisualizationクラスは、Oracle AI DatabaseのSQLプロパティ・グラフでSQLグラフの問合せをビジュアル化するために使用します。

フォーマット:

SqlGraphVisualization(connection)

属性:

属性 型 説明
connection oracledb.Connection データベース接続オブジェクト。

メソッド:

  • visual_query(query): SQL問合せを実行し、グラフ・データのカーソル・オブジェクトを返します。
  • close(): SqlGraphVisualizationを使用して実行されたグラフ問合せをクローズし、関連付けられているリソースを解放します。

例

SqlGraphVisualizationおよびPgxGraphVisualizationの使用例

親トピック: oraclegraph APIリファレンス

11.6.3 PgqlGraphVisualization

PgqlGraphVisualizationクラスは、データベース内のPGQLプロパティ・グラフでPGQLグラフの問合せをビジュアル化するために使用します。

フォーマット:

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

属性:

パラメータ 型 説明
username (str) データベース・ユーザー名。
password (str) データベースのパスワード。
dsn (str) データベース接続のデータ・ソース名。
props (dict, optional) ビジュアル問合せの追加プロパティ。

メソッド:

  • visual_query(query): PGQL問合せを実行し、グラフ・データをJSONで返します。
  • close(): PgqlGraphVisualizationを使用して実行されたグラフ問合せをクローズし、関連付けられているリソースを解放します。

例

PgqlGraphVisualizationの使用例は、PGQLプロパティ・グラフ用のJupyter Notebookインタフェースの使用を参照してください。

親トピック: oraclegraph APIリファレンス

11.6.4 PgxGraphVisualization

PgxGraphVisualizationクラスは、グラフ・サーバー(PGX)にロードされたグラフでPGQLグラフの問合せのビジュアル化をビジュアル化するために使用します。

フォーマット:

PgxGraphVisualization(session, props=None)

属性:

パラメータ 型 説明
session (object) PGXセッション・オブジェクト。
props (dict, optional) ビジュアル問合せの追加プロパティ。

メソッド:

  • visual_query(query): PGQL問合せを実行し、グラフ・データをJSONで返します。
  • close(): PgxGraphVisualizationを使用して実行されたグラフ問合せをクローズし、関連付けられているリソースを解放します。

例

SqlGraphVisualizationおよびPgxGraphVisualizationの使用例

親トピック: oraclegraph APIリファレンス