Neptune ストリームの呼び出し REST API - Amazon Neptune

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Neptune ストリームの呼び出し REST API

Neptune Streams にアクセスするには、次のいずれかのローカルエンドポイントにHTTPGETリクエストRESTAPIを送信する を使用します。

  • SPARQL グラフ DB の場合: https://Neptune-DNS:8182/sparql/stream。

  • Gremlin または openCypher グラフ DB の場合: https://Neptune-DNS:8182/propertygraph/streamまたは https://Neptune-DNS:8182/pg/stream。

注記

エンジンリリース 1.1.0.0 現在、Gremlin ストリームエンドポイント (https://Neptune-DNS:8182/gremlin/stream) は、関連する出力形式 (GREMLIN_JSON) とともに非推奨です。下位互換性のために引き続きサポートされていますが、将来のリリースで削除される可能性があります。

HTTP GET オペレーションのみが許可されます。

Neptune はレスポンスのgzip圧縮をサポートします。ただし、HTTPリクエストに、受け入れられた圧縮形式 (つまり、) gzipとして を指定するAccept-Encodingヘッダーが含まれていることが条件です"Accept-Encoding: gzip"。

パラメータ

  • limit - long、オプション。範囲:1 ～ 100,000。デフォルト: 10

    返すレコードの最大数を指定します。また、レスポンスのサイズ制限は 10 MB であり、これは変更できず、limit パラメータで指定されたレコード数よりも優先されます。10 MB の制限に達した場合、レスポンスにはしきい値超過レコードが含まれます。

  • iteratorType - 文字列、オプション。

    このパラメータには以下の値のいずれかがあります。

    • AT_SEQUENCE_NUMBER (デフォルト) - commitNum および opNum パラメータで一緒に指定されたイベントシーケンス番号から読み取りを開始することを示します。

    • AFTER_SEQUENCE_NUMBER - commitNum および opNum パラメータで一緒に指定されたイベントシーケンス番号の直後に読み取りが開始されることを示します。

    • TRIM_HORIZON - 読み取りは、システム内の最後のトリミングされていないレコードから開始することを示します。これは、変更ログストリームで最も古い (まだ削除されていない) レコードであることを示しています。このモードは、特定の開始イベントシーケンス番号がないアプリケーションの起動時に便利です。

    • LATEST - 読み取りは、システム内の最新のレコードから開始することを示します。これは、変更ログストリームで最近の (まだ削除されていない) レコードであることを示しています。これは、災害対策時やダウンタイムゼロのアップグレード時など、古いレコードを処理しないように、ストリームの現在の上位からレコードを読み取る必要がある場合に便利です。このモードでは、返されるレコードは最大 1 つだけであることに注意してください。

  • commitNum – long、 iteratorType が AT_SEQUENCE_NUMBERまたは の場合は必須ですAFTER_SEQUENCE_NUMBER。

    変更ログストリームから読み取る開始レコードのコミット番号。

    iteratorType が TRIM_HORIZON または LATEST の場合、このパラメータは無視されます。

  • opNum - long、オプション (デフォルトは 1)。

    変更ログストリームデータからの読み取りを開始するための、指定されたコミット内のオペレーションシーケンス番号。

SPARQL グラフデータを変更するオペレーションは、通常、オペレーションごとに 1 つの変更レコードのみを生成します。ただし、Gremlin グラフデータを変更するオペレーションでは、次の例のように、オペレーションごとに複数の変更レコードを生成できます。

  • INSERT - Gremlin 頂点は複数のラベルを持つことができ、Gremlin 要素は複数のプロパティを持つことができます。要素が挿入されると、ラベルとプロパティごとに個別の変更レコードが生成されます。

  • UPDATE - Gremlin 要素プロパティが変更されると、2 つの変更レコードが生成されます。1 つ目は前の値の削除で、2 つ目は新しい値の挿入です。

  • DELETE - 削除される要素プロパティごとに個別の変更レコードが生成されます。たとえば、プロパティを持つ Gremlin エッジが削除されると、プロパティごとに 1 つの変更レコードが生成されます。その後、エッジラベルの削除用に 1 つの変更レコードが生成されます。

    Gremlin 頂点が削除されると、すべての受信エッジプロパティと送信エッジプロパティが最初に削除され、次にエッジラベル、頂点プロパティ、最後に頂点ラベルが削除されます。これらの削除はそれぞれ、変更レコードを生成します。