レイヤー設定を更新します

Data API を使用すると、一連の REST リクエストを通してデータレイヤーを再設定できます。 レイヤーを再設定するプロセスは、更新するレイヤーのタイプによって異なります。

レイヤーおよびカタログの更新は非同期であり、ダウンタイムの原因にはなりません。 詳細については 、「カタログを作成する」を参照してください

1. 認可トークン を取得します。 詳細について は、『 Identity & Access Management Guide 』を参照してください。
2. API ルックアップサービスを使用 して、 configv1API の API エンドポイントを取得します。詳細について は、『 API Lookup 開発者ガイド 』を参照してください。

3. config このリクエストを API に送信して、カタログとレイヤーを更新します。 このリクエストでは、新しいフィールドでカタログが更新されます。

   注

   configサービスの使用方法の詳細については 、『 API リファレンス』を参照してください。

   PUT /<Base path for the config API from the API Lookup Service>/catalogs/<Catalog HRN> HTTP/1.1
   Host: <Hostname for the config API from the API Lookup Service>
   Content-Type: application/json
   Authorization: Bearer <Authorization Token>
   Cache-Control: no-cache
   {
    "description": "<Describe the content and purpose of the catalog>",
    "id": "<A unique identifier>",
    "name": "<Catalog name>",
    "notifications": {
    "enabled": false
    },
    "summary": "<A short description of the content and purpose of the catalog>",
    "layers": [
      {
        "id": "<A unique ID for the layer>",
        "name": "<A user-friendly name to use for display purposes>",
        "summary": "<A short description of the content and purpose of the layer>",
        "description": "<A long description of the content and purpose of the layer>",
        "schema": {
            "hrn": "<The schema's HERE Resource Name>"
        },
        "contentType": "<The media type>",
        "contentEncoding": "<Whether to compress data>",
        "partitioning": {
          "scheme": "<The method to use to divide data in the layer into partitions>",
        },
        "layerType": "<The type of layer: index, versioned, volatile, or stream>",
        "volume": {
          "volumeType": <durable, volatile>,
          "maxMemoryPolicy": "failOnWrite"
        }
      }
    ]
   }
   

レイヤー設定の部分的な更新

Data API を使用すると、パッチ方式を使用して REST 要求を介してデータ層を再設定できます。 参照 : HTTP のパッチメソッド

1. 認可トークン を取得します。 詳細について は、『 Identity & Access Management Guide 』を参照してください。
2. API ルックアップサービスを使用 して、 configv1API の API エンドポイントを取得します。詳細について は、『 API Lookup 開発者ガイド 』を参照してください。

3. config この API へのリクエストを使用して、レイヤーのみを更新します。 このリクエストは、変更可能なフィールドのレイヤーを更新します。

   注

   config サービスの使用方法の詳細について は、『 API リファレンス 』を参照してください。

   PATCH /<Base path for the config API from the API Lookup Service>/catalogs/<Catalog HRN>/layers/<Layer ID> HTTP/1.1
   Host: <Hostname for the config API from the API Lookup Service>
   Content-Type: application/json
   Authorization: Bearer <Authorization Token>
   Cache-Control: no-cache
   {
    "schema": {
      "hrn": "<The new schema's HERE Resource Name>"
    }
   }
   

レイヤータイプごとに変更可能なプロパティ

インデックス レイヤー

データがレイヤーにすでに保存された後にレイヤー設定を更新すると、その影響を理解することが重要です。 インデックス レイヤー の例では、スキーマ アソシエーションを更新しても、新しいスキーマ を利用するようにプロセスが更新されない場合、ダウンストリームのコンシューマプロセスに悪影響を与える可能性があります。 また、 1 つのレイヤーに関連付けることができるスキーマ は 1 つだけです。そのため、スキーマ の変更内容は、そのレイヤーに保存されている新しいデータだけでなく、そのレイヤーに保存されているすべての既存のデータも表すことが重要です。 そうでない場合、データの利用者はデータを効果的に読み取ることができなくなります。

さらに、実行中のアプリケーションまたはパイプラインがスキーマ設定の更新を動的に取得することはありません。 これらの変更を取得するには、ダウンストリームのパイプラインを再起動する必要があります。

スキーマアソシエーション

スキーマ関連付けの更新は可能ですが、リスクが高くなります。 詳細については、上記のインデックス レイヤースキーマの変更例を参照してください。

ダイジェスト

ダイジェストフィールドは、このような変更によってデータが破損する可能性のある重要度が高いため、一度設定すると変更できません。 サーバーは、この設定の更新をこれ以上試行しません。

TTL

この設定は変更可能です。 変更内容は保存されるとただちに有効になります。 インデックス レイヤー TTL の変更は、保存されているすべてのオブジェクトに適用されます。

バージョン付レイヤー

バージョン付レイヤーに対する更新は、サーバーの確認後ただちに有効になります。 バージョン管理されたレイヤーへの設定の変更は、依存する複数のバージョン管理されたレイヤーにわたるデータの破損や幅広い影響を防ぐために、非常に限定されています

スキーマアソシエーション

スキーマ関連付けの更新は可能ですが、リスクが高くなります。 1 つのレイヤーに関連付けることができるスキーマは 1 つだけで、そのスキーマはレイヤー内のすべてのデータを表す必要があります。 スキーマの変更によって、ダウンストリームの依存関係も更新されるまで、ダウンストリームのプロセスおよびサービスが中断されます。

ダイジェスト

ダイジェストフィールドは、このような変更によってデータが破損する可能性のある重要度が高いため、一度設定すると変更できません。 サーバーは、この設定の更新をこれ以上試行しません。

ストリーム レイヤー

並列化

並列化は Kafka トピックのパーティション数として実装されます。 一度設定すると変更できません。 変更するには、レイヤーを再作成する必要があります。

dataInThroughputKbps

この設定は変更可能です。 変更内容は保存されるとただちに有効になります。

dataOutThroughputKbps

この設定は変更可能です。 変更内容は保存されるとただちに有効になります。

TTL

この設定は変更可能です。 変更内容は保存されるとただちに有効になります。 ストリーム レイヤー TTL の変更は、保存されているすべてのオブジェクトに適用されます。

contentType および ContentEncoding

contentType および Encoding の設定は、 Kafka トピックの処理に影響を与えることはありません。 これらの設定は変更可能で、レイヤー作成後の簡単なレイヤー設定の誤りを修正できます。

これらの変更が行われる前にデータがすでにストリーム レイヤーに保存されている場合、これらの設定を更新すると、データのダウンストリームコンシューマに変更が反映されなくなります。 これらの変更よりも前にレイヤーにすでに保存されているデータは、古い設定を使用して保存されます。 これらの変更内容が新しい設定で保存された後にレイヤーに保存された新しいデータにより、データセット全体に混合が含まれます。 これらの変更がデータに与える大きな影響を把握してから、変更を行うことが重要です。 ストリームレイヤーの性質（メッセージの継続的なフィード）を考慮すると、これらの影響は永続的ではありませんが、古いレイヤー設定でエンコードされたメッセージがストリームから削除されるのを待ってから、ダウンストリームのパイプラインおよびサービスを再起動する必要があります。

スキーマアソシエーション

スキーマ関連付けの更新は可能ですが、リスクが高くなります。 1 つのレイヤーに関連付けることができるスキーマは 1 つだけで、そのスキーマはレイヤー内のすべてのデータを表す必要があります。 スキーマの変更によって、ダウンストリームの依存関係も更新されるまで、ダウンストリームのプロセスおよびサービスが中断されます。

Interactive マップ レイヤー

検索可能なプロパティ

検索可能なプロパティは文字列のリストで、高速検索のためにインデックスを作成するプロパティが含まれています。 検索可能なプロパティはいつでも更新できます。

レイヤーに含まれるフィーチャーが 10,000 未満の場合、すべてのプロパティが検索可能になります。