プロパティグラフスキーマ

neptune.graph.pg_schema() この手順では、プロパティグラフ構造の包括的な概要を示します。すべてのノードラベル、エッジラベル、データ型を持つプロパティ、ラベルトリプル ({~from, ~type, ~to}ノード型がエッジ型を介して接続する方法を説明するパターン) を返します。

この手順は現在 openCypher エンドポイントを介してのみ使用でき、すべてのプロパティグラフデータのスキーマを検出します。

この手順は、次のようなタスクに使用します。

Neptune Analytics との比較

Neptune Analytics では、 neptune.graph.pg_schema()は同期です。呼び出しごとにスキーマを計算します。

Neptune データベースでは、 を呼び出して非同期スキーマ計算を明示的にトリガーします。neptune.graph.pg_schema.compute()これはすぐに を返します。計算は、 を使用して完了をポーリングしている間にバックグラウンドで実行されますneptune.graph.pg_schema()。計算後、Neptune はスキーマを保持し、再計算せずに後続の読み取りですぐに返します。計算がまだ進行中は、部分的な結果も使用できます。実行中の計算を停止し、後で再開することもできます。

Graph Summary API との比較

Graph Summary API は、ラベルトリプルまたはプロパティデータ型を提供しません。プロパティグラフスキーマプロシージャはこのギャップを埋めます。ラベルトリプルは、グラフ内の特定の関係パターンを表示します。たとえば、 はworksAtエッジCompanyを介して Personに接続します。この情報は、LLMs が意味的に正しいクエリを生成するために重要です。

前提条件

エンジンバージョン

プロパティグラフスキーマプロシージャには、Neptune エンジンバージョン 1.4.8.0 以降が必要です。

IAM アクセス許可

スキーマオペレーションごとに、次の IAM アクションが必要です。

compute() および stop()オペレーションでは、スキーマのキャッシュと保持に使用される内部状態を変更するため、書き込みアクセス許可が必要です。

{
  "Version": "2012-10-17",
  "Statement": [{
    "Effect": "Allow",
    "Action": [
      "neptune-db:ReadDataViaQuery",
      "neptune-db:WriteDataViaQuery"
    ],
    "Resource": "arn:aws:neptune-db:us-east-1:123456789012:cluster-resource-id/*"
  }]
}

スキーマへの読み取り専用アクセスを許可するには (計算をトリガーできない）、 のみを使用しますneptune-db:ReadDataViaQuery。

ライターインスタンスとリーダーインスタンス

スキーマ計算は、ライターインスタンスでのみトリガーできます。リードレプリカインスタンスはスキーマ (ライターからレプリケート) を読み取ることができますが、 compute()または を実行することはできませんstop()。

API リファレンス

スキーマの読み取り

現在のスキーマと計算ステータスを取得します。

構文:

動作: 現在のスキーマとステータスですぐに を返します。常にノンブロッキングです。スキーマが計算されていない場合、 は空のスキーマフィールド"NotStarted"で state: を返します。計算が進行中の場合、 は状態 の部分的な結果を返します"InProgress"。

レスポンス形式:

レスポンスには、次のフィールドを持つスキーマオブジェクトが含まれます。

ステータスオブジェクト:

スキーマオブジェクト:

サポートされているデータ型: String、Int、、Long、DoubleBool、 Date

プロパティに異なるノード間で複数のデータ型がある場合 (たとえば、一部のノードは ageとして格納Intされ、他のノードは として格納されますString)、観測されたすべての型がdatatypes配列に一覧表示されます。

コンピューティングスキーマ

バックグラウンドスキーマ計算をトリガーします。

構文:

必要な IAM アクション: neptune-db:ReadDataViaQueryおよび neptune-db:WriteDataViaQuery

パラメータ :

動作:

レスポンス: 状態を示すステータスオブジェクトを返します。 "InProgress" concurrencyフィールドと progressPercentageフィールドがあります。

スキーマ計算の停止

実行中のバックグラウンド計算を停止します。

構文:

必要な IAM アクション: neptune-db:ReadDataViaQueryおよび neptune-db:WriteDataViaQuery

動作:

レスポンス: 状態を示すステータスオブジェクトを返します。現在の "Stopped"を使用しますprogressPercentage。

スキーマ結果での YIELD の使用

を使用してスキーマフィールドYIELDを抽出し、他のクエリと組み合わせることができます。次の の例では、すべてのノードラベルを取得し、各ラベルのノード数をカウントします。collSort() 関数はリストをアルファベット順にソートします。

CALL neptune.graph.pg_schema()
  YIELD schema
  WITH schema.nodeLabels as nl
  UNWIND collSort(nl) as label
  MATCH (n)
  WHERE label in labels(n)
  RETURN label, COUNT(n) as count

サンプル出力:

{
  "results": [{
      "label": "airport",
      "count": 3503
    }, {
      "label": "continent",
      "count": 7
    }, {
      "label": "country",
      "count": 237
    }, {
      "label": "version",
      "count": 1
    }]
}

スキーマ計算のライフサイクル

非同期オペレーション

スキーマ計算は非同期オペレーションです。を呼び出すとneptune.graph.pg_schema.compute()、現在のステータスですぐに が返されます。計算はバックグラウンドで実行されます。現在の状態と を返す を呼び出してneptune.graph.pg_schema()、進行状況と完了をポーリングしますprogressPercentage。

状態

スキーマ計算は次の状態を移動します。

永続化と再起動の動作

計算されたスキーマは保持され、エンジンの再起動後も存続します。再起動動作は、再起動時の状態によって異なります。

部分的な結果

計算の進行中、 は部分的な結果pg_schema()を返します。これには、現在の計算でこれまでに検出されたラベル、プロパティ、トリプルとマージされた、以前に完了したスキーマが含まれます。つまり、有用なスキーマ情報を取得する前に、完全な計算が完了するまで待つ必要はありません。

リードレプリカ

リードレプリカインスタンスは、 を使用してスキーマを読み取ることができますCALL neptune.graph.pg_schema()。Neptune は、ライターインスタンスからスキーマをレプリケートし、ライターでスキーマ要素が検出されるとすぐにレプリカで使用できるようにします。

リードレプリカは compute()または を実行できませんstop()。これらの呼び出しはエラーを返します。

ベストプラクティス

制限事項

サンプル出力

次の例は、エアルートデータセットのスキーマ出力を示しています。

awscurl -X POST https://your-neptune-endpoint:port/openCypher \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --region us-east-1 --service neptune-db \
  -d 'query=CALL neptune.graph.pg_schema()'

{
  "results": [{
      "schema": {
        "edgeLabelDetails": {
          "route": {
            "properties": {
              "dist": ["Int"]
            }
          },
          "contains": {
            "properties": {}
          }
        },
        "edgeLabels": ["route", "contains"],
        "status": {
          "concurrency": "16",
          "lastComputedTimestamp": "2026-06-04T23:58:17Z",
          "state": "Completed",
          "progressPercentage": "100"
        },
        "nodeLabels": ["version", "continent", "airport", "country"],
        "labelTriples": [{
            "~type": "route",
            "~from": "airport",
            "~to": "airport"
          }, {
            "~type": "contains",
            "~from": "country",
            "~to": "airport"
          }, {
            "~type": "contains",
            "~from": "continent",
            "~to": "airport"
          }],
        "nodeLabelDetails": {
          "continent": {
            "properties": {
              "type": ["String"],
              "code": ["String"],
              "desc": ["String"]
            }
          },
          "airport": {
            "properties": {
              "type": ["String"],
              "city": ["String"],
              "icao": ["String"],
              "code": ["String"],
              "country": ["String"],
              "lat": ["Double"],
              "longest": ["Int"],
              "runways": ["Int"],
              "desc": ["String"],
              "lon": ["Double"],
              "region": ["String"],
              "elev": ["Int"]
            }
          },
          "country": {
            "properties": {
              "type": ["String"],
              "code": ["String"],
              "desc": ["String"]
            }
          },
          "version": {
            "properties": {
              "date": ["String"],
              "desc": ["String"],
              "author": ["String"],
              "type": ["String"],
              "code": ["String"]
            }
          }
        }
      }
    }]
}