params 最上位 JSON オブジェクトにパラメータフィールドをエクスポートする - Amazon Neptune
可能な params フィールド一般的なフィールドProperty-graph フィールドRDF フィールド

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

params 最上位 JSON オブジェクトにパラメータフィールドをエクスポートする

Neptune エクスポート params JSON オブジェクトを使用すると、エクスポートされるデータの型と形式など、エクスポートを制御できます。

エクスポートパラメータ params オブジェクトで使用可能なフィールドのリスト

以下に、params オブジェクトで使用可能なすべての最上位フィールドを一覧表示します。1 つのオブジェクトには、これらのフィールドのサブセットのみが表示されます。

すべてのタイプのエクスポートに共通のフィールドのリスト

プロパティグラフエクスポートのフィールドリスト

RDF エクスポートのフィールドリスト

すべてのタイプのエクスポートに共通のフィールド

params の cloneCluster フィールド

(オプション) デフォルト: false。

そのファイルに cloneCluster パラメータを true と設定する場合、エクスポートプロセスでは DB クラスターの高速クローンが使用されます。

  "cloneCluster" : true

デフォルトでは、エクスポートプロセスは、endpoint、endpoints または clusterId パラメータを使用して指定した DB クラスターからデータをエクスポートします。ただし、エクスポートの実行中に DB クラスターが使用中であり、データが変更されている場合、エクスポートプロセスでエクスポートされるデータの整合性を保証することはできません。

エクスポートされたデータの整合性を確保するには、代わりに cloneCluster パラメータを使用して DB クラスターの静的クローンからエクスポートします。

クローンされた DB クラスターは、ソース DB クラスターと同じ VPC 内に作成され、ソースのセキュリティグループ、サブネットグループ、IAM データベース認証設定を継承します。エクスポートが完了すると、Neptune はクローンされた DB クラスターを削除します。

デフォルトでは、クローンされた DB クラスターは、ソース DB クラスターのプライマリインスタンスと同じインスタンスタイプの単一のインスタンスで構成されます。クローン DB クラスターに使用されるインスタンスタイプを変更するには、cloneClusterInstanceType を使用して別のインスタンスタイプを指定します。

注記

cloneCluster オプションを使用せず、メイン DB クラスターから直接エクスポートする場合は、データのエクスポート元のインスタンスのタイムアウトを増やす必要がある場合があります。大規模なデータセットの場合、タイムアウトは数時間に設定する必要があります。

params の cloneClusterInstanceType フィールド

(オプション)

そのファイルに cloneCluster パラメータが存在すれば、true を用いることができます。cloneClusterInstanceType パラメータを使用して、クローン DB クラスターに使用するインスタンスタイプを指定します。

デフォルトでは、クローンされた DB クラスターは、ソース DB クラスターのプライマリインスタンスと同じインスタンスタイプの単一のインスタンスで構成されます。

  "cloneClusterInstanceType" : "(for example, r5.12xlarge)"

params の cloneClusterReplicaCount フィールド

(オプション)

cloneCluster パラメータが存在し true に設定されている場合、cloneClusterReplicaCount パラメータを使用して、クローン DB クラスター内に作成されるリードレプリカインスタンスの数を指定できます。

  "cloneClusterReplicaCount" : (for example, 3)

デフォルトでは、クローンされた DB クラスターは 1 つのプライマリインスタンスで構成されます。cloneClusterReplicaCount パラメータを使用して、作成する追加のリードレプリカインスタンスの数を指定できます。

params の clusterId フィールド

(オプション)

clusterId パラメータは、使用する DB クラスターの ID を指定します。

  "clusterId" : "(the ID of your DB cluster)"

clusterId パラメータを使用すると、エクスポートプロセスでは、その DB クラスターで使用可能なすべてのインスタンスを使用してデータを抽出します。

注記

パラメータ endpoint、endpoints および clusterId は相互に排他的です。そのうちの 1 つだけを使用します。

params の endpoint フィールド

(オプション)

endpoint を使用してエクスポートプロセスがデータを抽出するためにクエリを実行できる DB クラスター内の Neptune インスタンスのエンドポイントを指定します (エンドポイント接続 を参照)。これは DNS 名のみで、プロトコルやポートは含まれません。

  "endpoint" : "(a DNS endpoint of your DB cluster)"

クラスターまたはインスタンスエンドポイントを使用します。メインリーダーエンドポイントは使用しないでください。

注記

パラメータ endpoint、endpoints および clusterId は相互に排他的です。そのうちの 1 つだけを使用します。

params の endpoints フィールド

(オプション)

endpoints を使用してエクスポートプロセスでデータを抽出するためにクエリを実行できる DB クラスター内のエンドポイントの JSON 配列を指定します (エンドポイント接続 を参照)。これらは DNS 名のみであり、プロトコルやポートは含まれません。

  "endpoints": [
    "(one endpoint in your DB cluster)",
    "(another endpoint in your DB cluster)",
    "(a third endpoint in your DB cluster)"
    ]

クラスターに複数のインスタンス (プライマリと 1 つ以上のリードレプリカ) がある場合は、endpoints パラメータを使用して、これらのエンドポイントのリストにクエリを分散し、エクスポートパフォーマンスを向上することができます。

注記

パラメータ endpoint、endpoints および clusterId は相互に排他的です。そのうちの 1 つだけを使用します。

params の profile フィールド

(neptune_ml フィールドが additionalParams フィールドに存在しない限り、Neptune ML のトレーニングデータをエクスポートする必要があります)。

profile パラメータは、特定のワークロードに対して事前設定されたパラメータのセットを提供します。現在、エクスポートプロセスでは neptune_ml プロフィールのみをサポートしいています。

Neptune ML のトレーニングデータをエクスポートする場合は、次のパラメータを params オブジェクトに追加してください。

  "profile" : "neptune_ml"

params の useIamAuth フィールド

(オプション) デフォルト: false。

データのエクスポート元のデータベースに有効な IAM 認証がある場合、true に設定された useIamAuth パラメータを含める必要があります。

  "useIamAuth" : true

params の includeLastEventId フィールド

includeLastEventId を true 設定し、データのエクスポート元のデータベースに有効な Neptune Streams がある場合、エクスポートプロセスは lastEventId.json ファイルを指定したエクスポート場所に書き込みます。このファイルには、ストリーム内の最後のイベントの commitNum および opNum が含まれています。

  "includeLastEventId" : true

エクスポートプロセスによって作成されたクローンデータベースは、親のストリーム設定を継承します。親でストリームが有効になっている場合、クローンでも同様にストリームが有効になります。クローン上のストリームのコンテンツには、クローンが作成された時点での親の内容（同じイベント ID を含む）が反映されます。

property-graph エクスポートのフィールド

params の concurrency フィールド

(オプション) デフォルト: 4。

concurrency パラメータは、エクスポートプロセスで使用するパラレルクエリの数を指定します。

  "concurrency" : (for example, 24)

データのエクスポート元となるすべてのインスタンスで、同時実行レベルを vCPUs の数の 2 倍に設定することが適切です。たとえば、r5.xlarge インスタンスには 4 つの vCPUs があります。3 つの r5.xlarge インスタンスのクラスターからエクスポートする場合は、同時実行レベルを 24 (= 3 x 2 x 4) に設定できます。

Neptune-Export サービスを使用している場合、同時実行レベルは jobSize 設定により制限されます。たとえば、小規模なジョブは 8 の同時実行レベルをサポートします。小さなジョブの同時実行レベルを 24 に指定しようとすると、concurrency パラメータの場合、有効レベルは 8 のままです。

クローンクラスターからエクスポートする場合、エクスポートプロセスは、クローンインスタンスのサイズとジョブサイズに基づいて適切な同時実行レベルを計算します。

params の edgeLabels フィールド

(オプション)

edgeLabels を使用して指定したラベルを持つエッジのみをエクスポートします。

  "edgeLabels" : ["(a label)", "(another label"]

JSON 配列の各ラベルは、単一の単純なラベルでなければなりません。

scope パラメータが edgeLabels パラメータよりも優先されるため、scope 値にエッジが含まれない場合、edgeLabels パラメータは効果がありません。

params の filter フィールド

(オプション)

filter を使用して特定のラベルを持つノードまたはエッジのみをエクスポートするように指定し、各ノードまたはエッジに対してエクスポートされるプロパティをフィルタリングします。

filter オブジェクトの一般的な構造は、インラインまたはフィルター設定ファイルで、次のようになります。

  "filter" : {
    "nodes": [ (array of node label and properties objects) ],
    "edges": [ (array of edge definition an properties objects) ]
  }

  • nodes — ノードとノードプロパティの JSON 配列が次の形式で含まれています。

        "nodes : [
      {
        "label": "(node label)",
        "properties": [ "(a property name)", "(another property name)", ( ... ) ]
      }
    ]

    • label — ノードの property-graph ラベル (1 つまたは複数)。

      単一の値、またはノードに複数のラベルがある場合は、値の配列を取ります。

    • properties — エクスポートするノードのプロパティの名前の配列が含まれています。

  • edges — 次の形式のエッジ定義の JSON 配列が含まれます。

        "edges" : [
      {
        "label": "(edge label)",
        "properties": [ "(a property name)", "(another property name)", ( ... ) ]
      }
    ]

    • label — エッジのプロパティグラフラベル。単一の値を取ります。

    • properties -エクスポートするエッジのプロパティの名前の配列が含まれています。

params の filterConfigFile フィールド

(オプション)

filterConfigFile を使用して filter パラメータと同じ形式のフィルター設定を含む JSON ファイルを指定します。

  "filterConfigFile" : "s3://(your Amazon S3 bucket)/neptune-export/(the name of the JSON file)"

filterConfigFile ファイルの形式については、フィルター を参照してください。

params の property-graph データに使用される format フィールド

(オプション) デフォルト: csv (カンマ区切り値)

format パラメータは、エクスポートされたプロパティグラフデータの出力形式を指定します。

  "format" : (one of: csv, csvNoHeaders, json, neptuneStreamsJson)

params の gremlinFilter フィールド

(オプション)

gremlinFilter パラメータを使用すると、has() ステップのように、Gremlin スニペットを指定でき、これはノードとエッジの両方をフィルタリングするために使用します。

  "gremlinFilter" : (a Gremlin snippet)

フィールド名と文字列値は、エスケープされた二重引用符で囲む必要があります。日付と時刻については、datetime メソッドを使用できます。

次の例では、日付作成プロパティの値が 2021-10-10 より大きいノードとエッジのみをエクスポートします。

  "gremlinFilter" : "has(\"created\", gt(datetime(\"2021-10-10\")))"

params の gremlinNodeFilter フィールド

(オプション)

gremlinNodeFilter パラメータを使用して、has() ステップのように、Gremlin スニペットを指定でき、これはノードをフィルタリングするために使用します。

  "gremlinNodeFilter" : (a Gremlin snippet)

フィールド名と文字列値は、エスケープされた二重引用符で囲む必要があります。日付と時刻については、datetime メソッドを使用できます。

次の例では、これらのノードのみをエクスポートしています。値が true である deleted ブールプロパティ。

  "gremlinNodeFilter" : "has(\"deleted\", true)"

params の gremlinEdgeFilter フィールド

(オプション)

gremlinEdgeFilter パラメータを使用すると、Gremlin スニペットを指定できます。エッジをフィルタリングする has() ステップを使用します。

  "gremlinEdgeFilter" : (a Gremlin snippet)

フィールド名と文字列値は、エスケープされた二重引用符で囲む必要があります。日付と時刻については、datetime メソッドを使用できます。

次の例では、strength 値が 5 の数値プロパティであるエッジのみをエクスポートしています。

  "gremlinEdgeFilter" : "has(\"strength\", 5)"

params の nodeLabels フィールド

(オプション)

nodeLabels を使用して指定したラベルを持つノードのみをエクスポートします。

  "nodeLabels" : ["(a label)", "(another label"]

JSON 配列の各ラベルは、単一の単純なラベルでなければなりません。

scope パラメータが nodeLabels パラメータよりも優先されるため、scope 値にノードが含まれない場合、nodeLabels パラメータは効果がありません。

params の scope フィールド

(オプション) デフォルト: all。

scope パラメータは、ノードのみ、エッジのみ、またはノードとエッジの両方をエクスポートするかどうかを指定します。

  "scope" : (one of: nodes, edges, or all)

  • nodes — ノードとそのプロパティのみをエクスポートします。

  • edges — エッジとそのプロパティのみをエクスポートします。

  • all — ノードとエッジの両方とそのプロパティをエクスポートします (デフォルト)。

RDF エクスポート用のフィールド

params の RDF データに使用されるフィールド format

(オプション) デフォルト: turtle

format パラメータは、エクスポートされた RDF データの出力形式を指定します。

  "format" : (one of: turtle, nquads, ntriples, neptuneStreamsJson)

  • turtle — Turtle 形式の出力。

  • nquads — 列見出しのない N-Quads 形式のデータ。

  • ntriples — N-Triples 形式のデータ。

  • neptuneStreamsJson — SPARQL NQUADS 変更シリアル化フォーマットを使用する JSON 形式のデータ。

params の rdfExportScope フィールド

(オプション) デフォルト: graph。

rdfExportScope パラメータは、RDF エクスポートのスコープを指定します。

  "rdfExportScope" : (one of: graph, edges, or query)

  • graph — すべての RDF データをエクスポートします。

  • edges— エッジを表すトリプルだけをエクスポートします。

  • query — sparql フィールドを使って SPARQL クエリによって取得されたデータをエクスポートします。。

params の sparql フィールド

(オプション)

sparql パラメータを使用すると、エクスポートするデータを取得するための SPARQL クエリを指定できます。

  "sparql" : (a SPARQL query)

sparql フィールドを使用してクエリを指定した場合、rdfExportScope フィールドを query に設定する必要があります。

params の namedGraph フィールド

(オプション)

namedGraph パラメータを使用すると、エクスポートを単一の名前付きグラフに制限する IRI を指定できます。

  "namedGraph" : (Named graph IRI)

namedGraph パラメータは、 rdfExportScopeフィールドを に設定した場合にのみ使用できますgraph。