# tCosmosDBSQLAPIOutputの標準プロパティ

Availability-note[subscription](https://help.talend.com/r/en-US/Cloud/labels-on-talend-help-center/availability-subscription)

これらのプロパティは、標準ジョブのフレームワークで実行されているtCosmosDBSQLAPIOutputを設定するために使われます。

標準のtCosmosDBSQLAPIOutputコンポーネントは、データベースNoSQLファミリーに属しています。

このフレームワークのコンポーネントは、すべてのサブスクリプションベースのTalend製品で使用できます。

情報メモ注: このコンポーネントは、TalendのR2020-06以降のStudioマンスリーアップデートをインストール済みである場合のみ利用できます。詳細は管理者にお問い合わせください。

## 基本設定

| [Property type] (プロパティタイプ) | [Built-in] (組み込み)と[Repository] (リポジトリー)のいずれかです。<br><br><ul> <li> <span>[Built-In] (組み込み)</span>: 一元的に保存されるプロパティデータはありません。</li> <li> <span>[Repository] (リポジトリー)</span>: プロパティが保管されるリポジトリーファイルを選択します。後続フィールドは、取得されたデータを使用して自動的に入力されます。</li> </ul> |
| --- | --- |
| [Schema] (スキーマ)と[Edit schema] (スキーマを編集) | スキーマとは行の説明のことです。処理して次のコンポーネントに渡すフィールド(カラム)数を定義します。Sparkジョブを作成する場合、フィールドの命名時は予約語のlineを避けます。<br><br><ul> <li> <p> <span>[Built-in] (組み込み)</span>: そのコンポーネントに対してのみスキーマを作成し、ローカルに保管します。</p> </li> <li> <p> <span>[Repository] (リポジトリー)</span>: スキーマは作成済みで、リポジトリーに保管されています。さまざまなプロジェクトやジョブデザインで再利用できます。</p> </li> </ul><br><br>スキーマを変更するには[Edit schema] (スキーマを編集)をクリックします。<br><br>情報メモ注: 変更を加えると、スキーマは自動的に組み込みになります。<br><br><ul> <li> <p> <span>[View schema] (スキーマを表示)</span>: スキーマのみを表示する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Change to built-in property] (組み込みのプロパティに変更)</span>: ローカルで変更を行うためにスキーマを<span>組み込み</span>に変更する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Update repository connection] (リポジトリー接続をアップデート)</span>: リポジトリーに保存されているスキーマに変更を加え、変更後にそのコンテンツをすべてのジョブにプロパゲートするかどうかを決める場合は、このオプションを選択します。変更を現在のジョブにのみ反映する場合は、変更後、<span>[No] (いいえ)</span>を選択し、<span>[Repository Content] (リポジトリーコンテンツ)</span>ウィンドウで再びこのスキーマのメタデータを選択します。</p> </li> </ul> |
| URI | CosmosユーザーアカウントのURIを入力します。フィールドでプロンプトが表示されると、CosmosデータベースユーザーアカウントのURIはhttps://{アカウント名}.document.azure.com:443という形式になります。URIは、[Azure Portal]の[Keys] (キー)ペインで取得できます。関連情報は、[Create an Azure Cosmos DB account](https://docs.microsoft.com/en-US/azure/cosmos-db/create-cosmosdb-resources-portal) (英語のみ)をクリックしてください。 |
| [Primary key] (プライマリキー) | CosmosユーザーアカウントのURIを入力します。[Azure Portal]の[Keys] (キー)ペインで取得できます。関連情報は、[Create an Azure Cosmos DB account](https://docs.microsoft.com/en-US/azure/cosmos-db/create-cosmosdb-resources-portal) (英語のみ)をクリックしてください。 |
| [Database ID] (データベースID) | データベースの名前を入力します |
| [Collection ID] (コレクション ID) | コレクション名を入力します。 |
| 存在しない場合はコレクションを作成します | このオプションを選択すると、コレクションが存在しない場合にコレクションIDフィールドで指定されたコレクションを作成できます。このオプションは、[Data action] (データアクション)ドロップダウンリストから[Update] (アップデート)または[Delete] (削除)が選択されている場合に利用できます。 |
| データのアクション | 次のいずれかのオプションを選択します。<br><br><ul> <li> <p> <span>[Insert] (挿入)</span>: ドキュメントを挿入します。</p> </li> <li> <p> <span>[Update] (アップデート)</span>: 既存のドキュメントを受信データに置換しますが、これらのドキュメントのテクニカルIDは保持されます。</p> </li> <li> <p> <span>[Upsert]</span>: 存在しない場合はドキュメントを挿入しますが、存在する場合は<span>[Update] (アップデート)</span>と同じルールを適用します。</p> </li> <li> <p> <span>[Delete] (削除)</span>: ドキュメントを削除します。</p> </li> </ul> |
| [Auto ID generation] (自動ID生成) | このオプションを選択すると、処理されるドキュメントのIDを生成できます。 |

## 詳細設定

| [tStatCatcher Statistics] (tStatCatcher統計) | このチェックボックスを選択すると、コンポーネントレベルでログデータを収集できます。 |
| --- | --- |
| [Connection mode] (接続モード) | 使用する接続モードを指定します。GatewayとDirectHttpsの2つのオプションを利用できます。関連情報を参照するには、[ConnectionMode](https://docs.microsoft.com/en-US/java/api/com.microsoft.azure.cosmosdb.connectionmode?view=azure-java-legacy) (英語のみ)をクリックしてください。 |
| [Max connection pool size] (最大接続プールサイズ) | 最大接続プールサイズを設定するために使われます。デフォルトは1000です。 |
| [Consistency level] (一貫性レベル) | 一貫性レベルを設定するために使われます。関連情報は、 [\[Consistency levels\] (一貫性レベル)](https://docs.microsoft.com/en-US/azure/cosmos-db/consistency-levels) (英語のみ) をクリックしてください。 |
| [Partition key] (パーティションキー) | ドキュメントを削除するパーティションのキーを入力します。このオプションは、[Data action] (データ アクション)ドロップダウン リストで[Delete] (削除)が選択されている場合に利用できます。 |

## Global Variables

| ERROR\_MESSAGE | エラー発生時にコンポーネントによって生成されるエラーメッセージ。これはAfter変数で、文字列を返します。 |
| --- | --- |
| NB\_LINE | 処理された行数。これはAfter変数で、整数を返します。 |

## 使用方法

| **使用ルール** | tCosmosDBSQLAPIOutput、ジョブ内の先行するコンポーネントからのフローをベースに、データベースのコレクションで定義されているアクションを実行します。 |
| --- | --- |