Microsoft Azure Cosmos DB SQL APIコネクタ > Microsoft Azure Cosmos DB SQL APIのマッピング > Microsoft Azure Cosmos DB SQL APIのターゲットプロパティ
  

Microsoft Azure Cosmos DB SQL APIのターゲットプロパティ

Microsoft Azure Cosmos DB SQL APIのターゲットを表すターゲットトランスフォーメーションを設定できます。
以下の表に、ターゲットトランスフォーメーションで設定できるターゲットトランスフォーメーションで設定できるMicrosoft Azure Cosmos DB SQL APIターゲットプロパティ。
プロパティ
説明
接続
ターゲット接続の名前。
既存の接続の選択、新しい接続の作成、またはターゲット接続プロパティのパラメータ値の定義ができます。
実行時にターゲット接続プロパティを上書きするには、[実行時にパラメータのオーバーライドを許可する]オプションを選択します。
ターゲットタイプ
ターゲットオブジェクトのタイプ。[単一オブジェクト]または[パラメータ]を選択します。
オブジェクト
タスクのターゲットオブジェクト。ターゲットオブジェクトを選択します。
既存のターゲットオブジェクトを選択するか、[実行時に新規作成]オプションを使用して新しいターゲットを作成することにより、データを書き込むことができます。
実行時に新規作成
実行時にMicrosoft Azure Cosmos DB SQL APIターゲットを作成します。
実行時にターゲットテーブルを作成するには、次のパラメータを指定します。
  • - オブジェクト名。Microsoft Azure Cosmos DB SQL APIで作成されるコレクションの名前。
  • 名前の先頭または末尾にスペースを使用することや、名前に次の文字を含めることはできません: \ / # ?
  • - パーティションキー。コレクションのパーティションキー。
  • キーは次の形式で指定します: /ID。パーティションキーフィールドが、ソーストランスフォーメーションまたは以前のトランスフォーメーションからの既存のフィールドであることを確認します。
    パーティションキーを、数字、スペース、Unicode文字、および特殊文字(アンダースコア以外)のみで構成することはできません。
  • - コレクションスループット。1秒あたりに処理される要求の単位。
  • 自動スケーリングのスループットの値を1000の倍数で指定します。自動スケーリングのスループットの最小値は1000で、最大値は1000000です。
    手動の場合のスループットの値は100の倍数で指定します。手動の場合のスループットの最小値は400で、最大値は1000000です。
  • - コレクションスループットスケール。スループットのタイプ。[自動スケーリング]または[手動]を選択します。
  • - 形式オプション。該当なし。
  • - 特殊文字の処理。該当なし。
パラメータ
実行時に定義するオブジェクトの値を保持するパラメータ。
ターゲットオブジェクトに既存のパラメータを選択するか、[新しいパラメータ]をクリックしてターゲットオブジェクトに新しいパラメータを定義します。
ターゲットタイプとして[パラメータ]を選択する場合にのみ[パラメータ]プロパティが表示されます。
実行時にターゲットオブジェクトを上書きする場合は、[実行時にパラメータのオーバーライドを許可する]オプションを選択します。タスクを実行すると、エージェントは詳細セッションプロパティで指定したファイルからパラメータを使用します。
形式
必須。Microsoft Azure Cosmos DB形式オプション。
次のいずれかの形式を選択します。
  • - なし。1 マルチレベル階層データを文字列形式で書き込む場合。
  • - JSON。1階層のJSONドキュメントの読み書きを行う場合。
デフォルトは[なし]です。
実行時にMicrosoft Azure Cosmos DB SQL APIターゲットを作成する場合、[なし]オプションは使用できません。
操作
該当なし。ターゲットの詳細プロパティでターゲット操作を設定する必要があります。
1詳細モードのマッピングには適用されません。
以下の表に、ターゲットトランスフォーメーションで設定できる詳細プロパティを示します。
詳細プロパティ
説明
スループット1
1秒あたりに処理される要求の単位。実行時にMicrosoft Azure Cosmos DB SQL APIでコレクションに指定したスループットをオーバーライドします。
データベースのスループットはオーバーライドできません。コレクションのスループットをオーバーライドする前に、Microsoft Azure Cosmos DB SQL APIでコレクションのスループットが設定されていることを確認してください。
スループットタイプに基づいてスループット値を指定します。
  • - スループットの自動スケーリング。値を1000の倍数で指定します。最小値は1000、最大値は1000000です。
  • - 手動スループット。値を100の倍数で指定します。手動の場合のスループットの最小値は400で、最大値は1000000です。
デフォルトは-1です。
自動ID生成1
ターゲットに書き込まれるドキュメントのIDを生成します。次のいずれかの値を指定します。
  • - 有効。Cosmos DBがドキュメントのIDを生成します。
  • - 無効。ソースオブジェクトがドキュメントのIDを提供します。データ統合は、ターゲットのIDポートにNULL値が提供されている場合、またはターゲットのIDポートにポートを接続していない場合に、行を拒否します。
ソース行の扱い
実行する操作。
次のいずれかのオプションを選択します。
  • - Insert
  • - Update1
  • - Upsert
  • - Delete
Update、Upsert、Delete操作を実行するには、IDポートとパーティションキーポートに接続する必要があります。IDポートまたはUpsertおよびUpdate操作用のパーティションキーに接続していない場合、データ統合は例外を表示します。そのため、Delete操作は失敗します。
UpsertおよびUpdate操作では、更新するポートに加えて、ドキュメントに含まれる他のすべてのポートにも接続する必要があります。接続されていないポートの値は、UpsertおよびUpdate操作中に削除されます。
実行優先度1
Microsoft Azure Cosmos DB SQL APIでの一括書き込み要求に優先度を付けます。
優先度を低く設定すると、優先度の低い要求のスループットが調整され、優先度の高い要求のみの実行が許可されます。優先度の低い要求は、他に優先度の高い要求がない場合にのみ調整されます。
デフォルトは[高]です。
一括書き込み1
データを一括で書き込むかどうかを指定します。デフォルトでは、Secure Agentはデータを一括で書き込みません。
拒否された行の転送1
トランスフォーメーションが、拒否された行を次のトランスフォーメーションに渡すか、拒否された行を削除するかを決定します。
デフォルトでは、マッピングタスクは拒否された行を次のトランスフォーメーションに転送します。
1詳細モードのマッピングには適用されません。

ターゲットの指定

既存のターゲットを使用するか、新しいターゲットを作成して、Microsoft Azure Cosmos DB SQL APIにデータを書き込むことができます。新しいターゲットを作成することを選択した場合は、タスクの実行時にエージェントによりターゲットが作成されます。
既存のターゲットを使用する場合は、選択したターゲットオブジェクトからスキーマを推測するか、受信フィールドからスキーマを生成します。
既存のターゲットについては、次のルールとガイドラインを考慮してください。
新しいターゲットを作成するときは、オブジェクト名、パーティションキー、コレクションスループット、およびコレクションスループットスケールを指定します。
新しいターゲットを作成するときは、次のルールとガイドラインを考慮してください。