1. プロパティ・グラフのグラフ開発者ガイド
  2. SQLプロパティ・グラフ
  3. APEXグラフ・ビジュアライゼーション・プラグインを使用したSQLグラフ問合せの視覚化
  4. APEXグラフ・ビジュアライゼーション・プラグインの概要

8.2 APEXグラフ・ビジュアライゼーション・プラグインの概要

この項は、APEXアプリケーションでグラフ・ビジュアライゼーション・プラグインを初めて使用する場合に役立ちます。

使用を開始する前に、APEXワークスペースが次の要件を満たしていることを確認してください:
  • このプラグインのインポート先となるターゲット・アプリケーションが存在すること。
  • ビジュアライゼーションに使用するSQLプロパティ・グラフがデフォルトのデータベース・スキーマに存在すること。

    SQLワークショップ・コンポーネント内のコマンド・エディタを使用すると、CREATE PROPERTY GRAPH DDL文でSQLプロパティ・グラフを作成できます(コマンド・エディタの使用を参照)。

  1. Oracle APEX GitHubリポジトリからグラフ・ビジュアライゼーション(プレビュー)プラグインをダウンロードします。
  2. 自分のAPEXワークスペースにサインインします(ワークスペースへのサインインを参照)。
  3. ダウンロードしたプラグイン・スクリプト(region_type_plugin_graphviz.sql)ファイルをターゲットAPEXアプリケーションにインポートします(プラグインのインポートを参照)。
    このプラグインでは入力としてJSON形式のSQLグラフ問合せのみが受け入れられることを覚えておいてください。これは、ORA_SQLGRAPH_TO_JSON PL/SQL関数によってサポートされます。
  4. APEXワークスペースにORA_SQLGRAPH_TO_JSON関数を作成します。
    1. Oracle APEXプラグインページでグラフ・ビジュアライゼーション(プレビュー)をクリックします。
    2. /optional-23c-onlyフォルダからgvt_sqlgraph_to_json.sqlファイルをダウンロードします。
    3. APEXワークスペースでgvt_sqlgraph_to_json.SQLスクリプトをアップロードし実行します(SQLスクリプトのアップロードを参照)。
    この手順により、データベースにORA_SQLGRAPH_TO_JSON関数が作成されます。ORA_SQLGRAPH_TO_JSON関数では入力としてCURSORのみが受け入れられることに注意してください。したがって、ヘルパー関数を使用してSQLグラフ問合せをCURSORに提供する必要があります。
  5. SQLグラフ問合せにCURSORを提供するためのヘルパー関数(SQLコマンドの実行を参照)を作成し、その後、ORA_SQLGRAPH_TO_JSON関数からJSON出力を取得します。
    たとえば:
    CREATE OR REPLACE FUNCTION bank_sqlgraph_json (
  QUERY VARCHAR2
) RETURN CLOB
  AUTHID CURRENT_USER IS
  INCUR    SYS_REFCURSOR;
  L_CUR    NUMBER;
  RETVALUE CLOB;
BEGIN
  OPEN INCUR FOR QUERY;
  L_CUR := DBMS_SQL.TO_CURSOR_NUMBER(INCUR);
  RETVALUE := ORA_SQLGRAPH_TO_JSON(L_CUR);
  DBMS_SQL.CLOSE_CURSOR(L_CUR);
  RETURN RETVALUE;
END;
  6. アプリケーション・ページにこのプラグインを実装して様々なグラフ・ビジュアライゼーションを実行します。

    次の基本的な例では、グラフ・ビジュアライゼーション・プラグインを使用してデータベース内にあるグラフを視覚化する手順を説明します。

    1. ページ・デザイナでアプリケーション・ページを開きます。
    2. ページ・デザイナの左ペインで「レンダリング」タブを選択します。
    3. 既存のコンポーネントを右クリックし、新しいリージョン・コンポーネントを追加します。
    4. 新しいリージョンを選択し、ページ・デザイナの右ペインにある「プロパティ・エディタ」の「リージョン」タブで次の属性を構成します。
      1. 識別の「タイトル」を入力します。
      2. 識別の「タイプ」としてグラフ・ビジュアライゼーション(プレビュー)を選択します。
      3. ソースの「場所」として「ローカル・データベース」を選択します。
      4. 「タイプ」として「SQL問合せ」を選択します。
      5. グラフ・データを取得するSQLグラフ問合せを埋め込みます。

        たとえば、次の例でのSQLグラフ問合せは、前の手順で作成したbank_sqlgraph_jsonヘルパー関数への入力として提供されます。 

        SELECT bank_sqlgraph_json('SELECT id_a, id_e, id_b FROM GRAPH_TABLE (bank_sql_pg
  MATCH (a IS accounts) -[e IS transfers]-> (b IS accounts)
    WHERE a.id = 816
    COLUMNS (vertex_id(a) AS id_a, edge_id(e) AS id_e, vertex_id(b) AS id_b)
  )'
) AS result_column FROM DUAL;

        なお、この関数の後に列の別名を指定する必要があります。

    5. アプリケーション・ページを実行して、このプラグインによってレンダリングされたグラフを視覚化します。

      図8-1 APEXアプリケーションでのSQLグラフ問合せの視覚化

      図8-1の説明が続きます
      「図8-1 APEXアプリケーションでのSQLグラフ問合せの視覚化」の説明
  7. オプションで、Sample Graph VisualizationsアプリケーションをOracle APEX GitHubリポジトリからインポートして実行できます。

親トピック: APEXグラフ・ビジュアライゼーション・プラグインを使用したSQLグラフ問合せの視覚化

8.2.1 APEXでのSample Graph Visualizationsアプリケーションのインポート

Sample Graph Visualizationsアプリケーションでは、グラフ・ビジュアライゼーション・プラグインの使用例を実際に確認できます。

次の手順を実行してSample Graph Visualizationsアプリケーションをインポートします。
  1. Sample Graph VisualizationsアプリケーションをOracle APEX GitHubリポジトリからダウンロードします。
  2. アプリケーションのインポートで示した手順に従って、ダウンロードしたsample-graph-visualizations.zipをAPEXインスタンスにインポートします。
    このサンプル・アプリケーションは、インストールした後に直接実行できます。

    図8-2 Sample Graph Visualizationのホーム・ページ

    図8-2の説明が続きます
    「図8-2 Sample Graph Visualizationのホーム・ページ」の説明

    また、このサンプル・アプリケーションにはセキュアなHTTPS接続が必要であることに注意してください。セキュアな接続を無効にする場合は、次の手順を実行します。

    注意:

    本番デプロイメントでセキュアな接続を無効にすることはお薦めしません。
    1. アプリケーション・ビルダーでサンプル・アプリケーションのホームページに移動します。
    2. 「共有コンポーネント」をクリックします。
    3. 「セキュリティ」で「認証スキーム」をクリックします。
    4. 「現行」認証スキームをクリックします。
    5. セッション共有タブをクリックし、「セキュア」スイッチをオフにします。
    6. 「変更の適用」をクリックしてから、アプリケーションを実行します。

ORA_SQLGRAPH_TO_JSON関数(前の図で強調表示されている)を使用してSQLプロパティ・グラフ問合せのビジュアライゼーションを表示するには、次の手順をさらに実行する必要があります。

  1. ORA_SQLGRAPH_TO_JSON関数がAPEXワークスペースにまだ追加されていない場合は、その関数を作成します。
    1. Oracle APEXプラグインページでグラフ・ビジュアライゼーション(プレビュー)をクリックします。
    2. /optional-23c-onlyフォルダからgvt_sqlgraph_to_json.sqlファイルをダウンロードします。
    3. APEXワークスペースでgvt_sqlgraph_to_json.SQLスクリプトをアップロードし実行します(SQLスクリプトのアップロードを参照)。
  2. サンプル・アプリケーションによって使用されるSQLプロパティ・グラフを作成します。
    SQLワークショップ・コンポーネント内のコマンド・エディタを使用して、次のCREATE PROPERTY GRAPH DDL文を実行します。
    CREATE PROPERTY GRAPH EBA_SAMPLE_GRAPH
  VERTEX TABLES (
    eba_graphviz_countries
      KEY ( country_id )
      LABEL country PROPERTIES ( country_id, country_name, region_id ),
    eba_graphviz_departments
      KEY ( department_id )
      LABEL department PROPERTIES ( department_id, department_name, location_id, manager_id ),
    eba_graphviz_locations
      KEY ( location_id )
      LABEL location PROPERTIES ( city, country_id, location_id, postal_code, state_province, street_address ),
    eba_graphviz_job_history
      KEY ( employee_id, end_date, job_id, start_date )
      PROPERTIES ( department_id, employee_id, end_date, job_id, start_date ),
    eba_graphviz_jobs
      KEY ( job_id )
      LABEL job PROPERTIES ( job_id, job_title, max_salary, min_salary ),
    eba_graphviz_regions
      KEY ( region_id )
      LABEL region PROPERTIES ( region_id, region_name ),
    eba_graphviz_employees
      KEY ( employee_id )
      LABEL employee PROPERTIES ( commission_pct, department_id, email, employee_id, first_name, hire_date, job_id, last_name, manager_id, phone_number, salary )
  )
  EDGE TABLES (
    eba_graphviz_countries AS country_located_in
      SOURCE KEY ( country_id ) REFERENCES eba_graphviz_countries (country_id)
      DESTINATION KEY ( region_id ) REFERENCES eba_graphviz_regions (region_id)
      NO PROPERTIES,
    eba_graphviz_departments AS department_located_in
      SOURCE KEY ( department_id ) REFERENCES eba_graphviz_departments (department_id)
      DESTINATION KEY ( location_id ) REFERENCES eba_graphviz_locations ( location_id )
      NO PROPERTIES,
    eba_graphviz_locations AS location_located_in
      SOURCE KEY ( location_id ) REFERENCES eba_graphviz_locations ( location_id )
      DESTINATION KEY ( country_id ) REFERENCES eba_graphviz_countries ( country_id )
      NO PROPERTIES,
    eba_graphviz_employees AS works_as
      SOURCE KEY ( employee_id ) REFERENCES eba_graphviz_employees ( employee_id )
      DESTINATION KEY ( job_id ) REFERENCES eba_graphviz_jobs ( job_id )
      NO PROPERTIES,
    eba_graphviz_employees AS works_at
      SOURCE KEY ( employee_id ) REFERENCES eba_graphviz_employees  ( employee_id ) 
      DESTINATION KEY ( department_id ) REFERENCES eba_graphviz_departments ( department_id ) 
      NO PROPERTIES,
    eba_graphviz_employees AS works_for
      SOURCE KEY ( employee_id ) REFERENCES eba_graphviz_employees ( employee_id )
      DESTINATION KEY ( manager_id ) REFERENCES eba_graphviz_employees  ( employee_id )
      NO PROPERTIES,
    eba_graphviz_job_history AS for_job KEY ( employee_id, start_date )
      SOURCE KEY ( employee_id, start_date ) REFERENCES eba_graphviz_job_history ( employee_id, start_date )
      DESTINATION KEY ( job_id ) REFERENCES eba_graphviz_jobs ( job_id )
      NO PROPERTIES,
    eba_graphviz_job_history AS for_department KEY ( employee_id, start_date )
      SOURCE KEY ( employee_id, start_date ) REFERENCES eba_graphviz_job_history ( employee_id, start_date )
      DESTINATION KEY ( department_id ) REFERENCES eba_graphviz_departments ( department_id )
      NO PROPERTIES,
    eba_graphviz_job_history AS for_employee KEY ( employee_id, start_date )
      SOURCE KEY ( employee_id, start_date ) REFERENCES eba_graphviz_job_history ( employee_id, start_date ) 
      DESTINATION KEY ( employee_id ) REFERENCES eba_graphviz_employees  ( employee_id )
      NO PROPERTIES
  )
  3. SQLグラフ問合せにCURSORを提供するためにサンプル・アプリケーションで使用する、次のヘルパー関数(SQLコマンドの実行を参照)を作成します。
    CREATE OR REPLACE FUNCTION CUST_SQLGRAPH_JSON (
  QUERY VARCHAR2
) RETURN CLOB
  AUTHID CURRENT_USER IS
  INCUR    SYS_REFCURSOR;
  L_CUR    NUMBER;
  RETVALUE CLOB;
BEGIN
  OPEN INCUR FOR QUERY;
  L_CUR := DBMS_SQL.TO_CURSOR_NUMBER(INCUR);
  RETVALUE := ORA_SQLGRAPH_TO_JSON(L_CUR);
  DBMS_SQL.CLOSE_CURSOR(L_CUR);
  RETURN RETVALUE;
END;
  4. アプリケーション・ビルダーに移動し、サンプル・アプリケーションのホームページからページ・デザイナ内のORA_SQLGRAPH_TO_JSON問合せページを開きます。
    1. ページ・デザイナの左ペインにある「レンダリング」タブでORA_SQLGRAPH_TO_JSON関数を使用するグラフコンポーネントを選択します。
    2. ページ・デザイナ(プロパティ・エディタ)の右ペインにある「リージョン」タブの「ソース」で、そのSQL問合せ(CUST_SQLGRAPH_JSONヘルパー関数を使用)をコメント解除します。

      また、次に示すように、「SQL問合せ」入力に1つの問合せのみが含まれていることを確認します。 

      SELECT CUST_SQLGRAPH_JSON('SELECT employee, e, manager
    FROM GRAPH_TABLE ( EBA_SAMPLE_GRAPH
    MATCH (worker is employee) -[w is works_for]-> (boss is employee)
    COLUMNS (vertex_id(worker) AS employee, edge_id(w) AS e, vertex_id(boss) AS manager )
)') as result_column FROM DUAL;
    3. 「保存」をクリックし、アプリケーション・ページを実行して、このプラグインによってレンダリングされたSQLグラフ問合せのビジュアライゼーションを表示します。

親トピック: APEXグラフ・ビジュアライゼーション・プラグインの概要

8.2.2 ページ区切りを使用したグラフ・ビジュアライゼーション

ORA_SQLGRAPH_TO_JSON関数を使用している場合はページ区切りを実装できます。

「APEXグラフ・ビジュアライゼーション・プラグインの概要」内の手順で、APEXアプリケーションでグラフ・ビジュアライゼーション・プラグインを設定する方法が示されています。ただし、ORA_SQLGRAPH_TO_JSON関数でのページ区切りを使用するには、次のことを確認する必要があります。
  • APEXアプリケーション内のグラフ・ビジュアライゼーション・コンポーネントについて、「プロパティ・エディタ」の「属性」タブでSQL問合せでページ区切りをサポートする設定をオンにします。
  • 次のコード例で示すように、このヘルパー関数にpage_startパラメータとpage_sizeパラメータを追加します。
    CREATE OR REPLACE FUNCTION bank_sqlgraph_json (
  QUERY VARCHAR2,
  PAGE_START NUMBER DEFAULT -1,
  PAGE_SIZE NUMBER DEFAULT -1
  ) RETURN CLOB
  AUTHID CURRENT_USER IS
  INCUR    SYS_REFCURSOR;
  L_CUR    NUMBER;
  RETVALUE CLOB;
BEGIN
  OPEN INCUR FOR QUERY;
  L_CUR := DBMS_SQL.TO_CURSOR_NUMBER(INCUR);
  RETVALUE := ORA_SQLGRAPH_TO_JSON(L_CUR, PAGE_START, PAGE_SIZE);
  DBMS_SQL.CLOSE_CURSOR(L_CUR);
  RETURN RETVALUE;
END;
  • 「プロパティ・エディタ」の「リージョン」タブにある「SQL問合せ」入力でこのヘルパー関数をコールするときに、変数をpage_startとpage_sizeにバインドします。
    SELECT bank_sqlgraph_json('SELECT id_a, id_e, id_b FROM GRAPH_TABLE (bank_sql_pg
  MATCH (a IS accounts) -[e IS transfers]-> (b IS accounts)
    WHERE a.id = 816
    COLUMNS (vertex_id(a) AS id_a, edge_id(e) AS id_e, vertex_id(b) AS id_b)
  )',
  :page_start,
  :page_size
) AS result_column FROM DUAL;

    なお、page_start値は自動的に設定されます。「プロパティ・エディタ」の「属性」タブで、page_sizeの値を設定できます。

親トピック: APEXグラフ・ビジュアライゼーション・プラグインの概要