Oracle Graph Server REST API (2023/08/25)

Oracle Graph Server REST API (2023/08/25)

https://blogs.oracle.com/database/post/oracle-graph-server-rest-api

投稿者： Rahul Tasker | Senior Product Manager



Oracle Graphは、データ内の隠れた関係を明らかにするための強力なツールです。Oracle Graphは、グラフ構造で情報を表すことで、相互接続されたデータ・エンティティから貴重なインサイトを得ることができます。Oracle Graph製品には、単純なRESTコールにより、任意のアプリケーションからOracle Graphの機能を利用するゲートウェイであるGraph Server REST APIが含まれています。このAPIにより、開発者はグラフを操作でき、グラフの作成、問合せの実行およびデータからの実用的な情報の導出が可能になります


Oracle Graph REST API v1では、Cookieベースの認証を採用し、URL内で問合せをエンコードします。Oracle Graph Server and Clientリリース23.3では、Oracle Graph REST API v2をリリースしました。このAPIでは、トークンベースの認証を採用し、JSON本文内で問合せを送信できます。Graph Server REST APIは、開発者がグラフを簡単に作成および問い合せるための重要なリソースを提供します。



次の例の背景:


Oracle Graphには、Oracle Databaseでグラフ問合せを実行する機能と、専用のインメモリー・グラフ・サーバー(PGX)でグラフ問合せおよび分析を実行する機能があります。

bank_graphの例からデータをロードし、グラフを作成するには、このgithubリポジトリを参照してください。


Graph Server REST API v2


PostmanでGraph Server REST APIのバージョン2を使用した簡単な例を体験してみましょう。次のすべてのAPIコールについて、リクエストに次のヘッダーがあることを確認します:


  • Accept: application/json、charset=UTF-8
  • Content-Type: application/json



1. 認証トークンの取得


https://<Graph_Server_IP>:7007/auth/tokenへのPOSTリクエストを作成します。ユーザー名、パスワードおよびcreateSessionパラメータを含むJSON本文を追加します。


PGXセッションを作成してインメモリー・グラフ・サーバーで問合せを実行する場合は、createSessionパラメータをTrueに設定します。データベース内で問合せを実行する場合はFalseに設定します。


レスポンスは、次のAPIコールで使用するアクセス・トークンである必要があります。





2. グラフの取得


使用するドライバの問合せパラメータ(GRAPH_SERVER_PGX、PGQL_IN_DATABASEまたはSQL_IN_DATABASE)を使用して、https:// <Graph_Server_IP>:7007/v2/graphsへのGETリクエストを作成します。結果の問合せ文字列は、https:// <Graph_Server_IP>:7007/v2/graphs?driver=PGQL_IN_DATABASEのようになります。


'Bearer <access_token>'値を持つ認可ヘッダーを追加します。


応答は、認証されたユーザーのグラフのリストである必要があります。





3. 問合せの実行


https:// <Graph_Server_IP>:7007/v2/runQueryへのPOSTリクエストを作成します。


'Bearer <access_token>'値を持つ認可ヘッダーを追加します。


次の例のように、文、ドライバ、フォーマッタ、パラメータおよびビジュアル化パラメータを含むJSON本文を追加します。


{
  "statements": [
    "SELECT v FROM MATCH (v) ON BANK_GRAPH LIMIT 1"
  ],
  "driver": "PGQL_IN_DATABASE",
  "formatter": "GVT",
  "parameters": {
    "dynamicSampling": 2,
    "parallel": 8,
    "start": 0,
    "size": 100
  },
  "visualize": true
}


結果は、問合せ実行の結果を含むJSONオブジェクトである必要があります。





4. アクセス・トークンのリフレッシュ


アクセス・トークンが期限切れになる前にリフレッシュするには、https://<Graph_Server_IP>:7007/auth/tokenへのPUTリクエストを作成します。


トークンおよびcreateSessionパラメータを含むJSON本文を追加します。トークンには、現在のアクセス・トークンの値が必要です。PGXセッションを作成してインメモリー・グラフ・サーバーで問合せを実行する場合は、createSessionパラメータをTrueに設定します。データベース内で問合せを実行する場合はFalseに設定します。


レスポンスは新しいアクセス・トークンである必要があります。



Graph Server REST APIのv2および機能の完全なリストの詳細は、公式ドキュメントを参照してください。



Graph Server REST API v1


PostmanでGraph Server REST APIのバージョン1を使用した簡単な例を体験してみましょう。次のすべてのAPIコールについて、リクエストに次のヘッダーがあることを確認します:


  • Accept: application/json、charset=UTF-8
  • Content-Type: application/json



1. ユーザーの認証


https://<Graph_Server_IP>:7007/ui/v1/login/へのPOSTリクエストを作成します。


ユーザー名、パスワード、pgqlDriverおよびbaseUrlパラメータを含むJSON本文を追加します。pgqlDriverパラメータは、pgqlDriverを使用してデータベースに接続するか、またはpgxDriverを使用してグラフ・サーバーに接続するかを指定します。baseUrlパラメータは、pgxDriverを使用している場合はグラフ・サーバーのURLに、pgqlDriverを使用している場合はデータベースのJDBC URLにする必要があります。


応答は、認証されたユーザーのユーザー名である必要があります。正常にログインすると、サーバー・セッションCookieはCookieファイルcookie.txtに格納されます。





2. グラフのリスト


https://<Graph_Server_IP>:7007/ui/v1/graphsへのGETリクエストを作成します。Cookieは、自動的にヘッダーとしてPostmanに追加される必要があります。


応答は、認証されたユーザーのグラフのリストである必要があります。





3. 問合せの実行


pgql、graph、parallelismおよびsizeパラメータを使用して、https://<Graph_Server_IP>:7007/ui/v1/queryに対するGetリクエストを作成します。結果のURLは次のようになります。


https://<Graph_Server_IP>:7007/ui/v1/query?pgql=<PGQL_query>&graph=<graph_name>&parallelism= <parallelism_value>&size=<size>


たとえば、bank_graphから5つのエッジを問い合せるには、https://<Graph_Server_IP>:7007/ui/v1/query?pgql=SELECT%20e%0AMATCH%20()-%5Be%5D-%3E()%0ALIMIT%205&graph=BANK_GRAPH&parallelism=&size=100を使用します。


結果には、JSON形式で問い合せた結果の頂点およびエッジが含まれます。





4. Graph Serverのログアウト


https://<Graph_Server_IP>:7007/ui/v1/logout/へのPOSTリクエストを作成します。


ログアウトが成功すると、サーバーはHTTPステータス・コード200を返し、cookie.txtファイルのセッション・トークンが無効になります。




Graph Server REST APIのv1および機能の完全なリストの詳細は、公式ドキュメントを参照してください。


コメント

コメントを投稿

このブログの人気の投稿

Oracle Database 19cサポート・タイムラインの重要な更新 (2024/11/20)

イメージ
Oracle Database 19cサポート・タイムラインの重要な更新 (2024/11/20) https://mikedietrichde.com/2024/11/20/important-update-to-oracle-database-19c-support-timelines/ 長い沈黙は、私が隠れているという意味ではありません。つまり、今はとても忙しいということです。そして、より少ない旅行で、私はあなたのコメントにもブログと返信するより多くの時間を持っていることを願っています。それでも、Oracle Database 19cサポート・タイムラインの非常に重要な更新について説明します。 * 更新された内容 2024年11月19日現在、Oracle Database 19cのサポート・タイムラインが調整されています。 MOSノート: 742060.1 – 現在のデータベース・リリースのリリース・スケジュールを見ると、新しい日付が表示されます。 Premier Support、2029年12月31日まで 2030年1月1日から2032年12月31日までの拡張サポート 2033年1月1日から2034年12月31日までのアップグレード・サポート これは知ることがとても大切です。 他のリリースの更新はありますか。 MOSノートの終わりにある変更ログ: 742060.1 – 現在のデータベース・リリースのリリース・スケジュールでは、Oracle Database 21cの最新の更新も確認できます。このリリースのPremier Support期間は、2027年7月31日まで延長されました。 また、Oracle Database 23aiのパッチ適用終了日は2032年12月31日に設定されています。 Lifetime Support Policy 更新は、Oracle Technology Productsの Oracle Lifetime Support Policy (6ページ)でも確認できます。 From: Oracle Lifetime Support Policy for Oracle Technology Product s – page 6 – Nov 19, 2024 特に、次の表に示す制限事項に注意してください。 Oracle Database 1...
続きを読む

Oracle APEXのInteractive Gridで、Oracle Formsと比較して、重複行の検証を制御/通過させる方法 (2022/07/21)

イメージ
Oracle APEXのInteractive Gridで、Oracle Formsと比較して、重複行の検証を制御/通過させる方法 (2022/07/21) https://medium.com/oracledevs/how-to-control-or-pass-validation-for-duplicate-rows-in-interactive-grid-of-oracle-apex-as-compare-18f453f750bf 投稿者： Jignesh oracle Formsでは、データブロックの重複行を制御するのは非常に簡単ですが、IGの検証を制御するにはどうすればよいでしょうか。 必要な出力 ステップ1：インタラクティブグリッドのある白紙ページを作成します（私は1つの領域「IG」を作成し、インタラクティブグリッドとしてタイプを選択しました） ステップ 2: リージョンに Static ID を定義する (私の場合、リージョンは IG で、Static ID も IG です) ステップ3：複製を制御したいカラムのStatic IDを定義します ステップ4：関数とグローバル変数に移動します コード： var validity, message, ui = this.data; (function($) { function update(model) { var projKey = model.getFieldKey(“PROJECT_ID”), recObj = [], recArray = []; model.forEach(function(record, index, id) { var projid = parseInt(record[projKey], 10), // record[salKey] should be a little faster than using model.getValue in a loop meta = model.getRecordMetadata(id); if (!isNaN(projid) && !meta.deleted && !meta.agg) { recObj = {ID: id, project_id: projid}; recArray.push(recObj)...
続きを読む

Oracle APEX 24.1の一般提供の発表 (2024/06/17)

イメージ
Oracle APEX 24.1の一般提供の発表 (2024/06/17) https://blogs.oracle.com/apex/post/announcing-oracle-apex-241 投稿者： Ashish Mohindroo | Vice President, Product Management APEX Low Code Application Platform Oracle APEX 24.1は、 ダウンロード が一般的に可能になり、世界中のOCI APEX Application DevelopmentおよびAutonomous Database Cloud Serviceリージョンにロールアウトされています。この最新リリースで、GenAIを使用して最初のローコード・アプリケーションを構築する方法を学習します。リリースのお知らせのリプレイはこちらからご覧いただけます。 このリリースでは、優れたエンタープライズ・グレードのアプリケーションを簡単に構築できるイノベーションの3つの主要な柱(AI支援アプリケーション開発、Oracleの次世代データ・プラットフォームのパワー活用、高度なWebおよびモバイル・アプリケーションを構築するための強力なエンタープライズ・グレードのコンポーネント)が提供されています。 AI支援アプリ開発 このリリースでは、AIをローコード開発に直接取り込み、すべての開発者が高度なクラウドおよびモバイル・アプリケーションを簡単に構築できるようにしています。開発者は、AIをアシスタントとして使用して、時間と労力を削減してアプリを構築できるようになりました。APEX AIアシスタントを使用すると、開発者は複数のウィンドウを使用して表名と列名を検索する必要がなくなります。 APEX 24.1 では、クラウドおよびモバイル・アプリの自然言語ベースの開発を可能にするネイティブAI搭載APEX AIアシスタントを導入しました。APEX AIアシスタントを使用すると、すべての開発者は自然言語を使用してSQLを生成できるため、アプリケーションをより簡単に構築したり、ワンクリックで構文修正を実行したり、表名を覚える必要がなくなります。開発者は、自然言語プロンプトを使用して目的の機能とコンポーネントを指定し、直感的な会話型インタフェースを使用し...
続きを読む