Copy アクティビティで Azure Cosmos DB for NoSQL を構成する
この記事では、データ パイプラインのコピー アクティビティを使用して、Azure Cosmos DB for NoSQL との間でデータをコピーする方法について説明します。
サポートされている構成
コピー アクティビティの下の各タブの構成については、それぞれ次のセクションを参照してください。
全般
[全般設定] タブを構成するには、全般設定のガイダンスを参照してください。
ソース
コピー アクティビティの [ソース] タブの Azure Cosmos DB for NoSQL では、次のプロパティがサポートされています。
次の 3 つのプロパティが必要です。
- [データ ストアの種類]: [外部] を選択します。
- [接続]: 接続リストから Azure Cosmos DB for NoSQL 接続を選択します。 接続が存在しない場合は、[新規] を選択して新しい Azure Cosmos DB for NoSQL 接続を作成します。
- [コンテナー]: 使用するコンテナーを選択します。 [編集] を選択して、コンテナー名を手動で入力します。
[詳細設定] では、次のフィールドを指定できます。
[クエリの使用]: 使用クエリとして [テーブル] または [クエリ] を選択できます。 次の一覧で、各設定の構成について説明します。
[テーブル]: [テーブル] で指定したテーブルからデータを読み取ります。
[クエリ]: データを読み取る Azure Cosmos DB クエリを指定します。
[ページ サイズ:] クエリ結果のページあたりのドキュメント数。 既定値は "-1" で、これはサービス側の動的ページ サイズが最大 1000 まで使用されることを意味します。
[Detect datetime](datetime の検出): ドキュメント内の文字列値から datetime を検出するかどうか。 使用可能な値: true (既定値)、false。
[Preferred regions](優先リージョン): Azure Cosmos DB からデータを取得するときに接続するリージョンの優先リスト。 [新規] を選択した後、ドロップダウン リストから優先リージョンを 1 つ選択します。
[追加の列]: ソース ファイルの相対パスまたは静的値を格納するための追加のデータ列を追加します。 後者では式がサポートされています。 詳細については、「コピー中に列を追加する」を参照してください。
宛先
コピー アクティビティの [コピー先] タブの Azure Cosmos DB for NoSQL では、次のプロパティがサポートされています。
次の 3 つのプロパティが必要です。
- [データ ストアの種類]: [外部] を選択します。
- [接続]: 接続リストから Azure Cosmos DB for NoSQL 接続を選択します。
- [コンテナー]: [参照] を選択して、コピーするファイルを選択するか、パスを手動で入力します。
[詳細設定] では、次のフィールドを指定できます。
[Write behavior](書き込み動作): コピー先がファイルベースのデータ ストアからのファイルである場合に書き込み動作を定義します。 ドロップダウン リストから [動的なコンテンツの追加]、[挿入]、または [Upsert](アップサート) を選択できます。
[動的なコンテンツの追加]: [動的なコンテンツの追加] ウィンドウを開きます。 これにより、式ビルダーが開き、サポートされているシステム変数、アクティビティの出力、関数、およびユーザー指定の変数またはパラメーターから式を作成できます。 式言語について詳しくは、式と関数に関するページを参照してください。
[挿入]: ソース データに挿入がある場合は、このオプションを選択します。
[Upsert](アップサート): アップサートの動作は、同じ ID を持つドキュメントが既に存在する場合に、そのドキュメントを置き換えることです。それ以外の場合はドキュメントを挿入します。
[書き込みバッチ タイムアウト]: タイムアウトする前に一括挿入操作の完了を待つ時間です。指定できる値は
Timespanです。 たとえば "00:30:00" (30 分) を指定できます。[Write batch size](書き込みバッチ サイズ): SQL テーブルに挿入するバッチあたりの行数を指定します。 使用可能な値は整数 (行数) です。 既定では行のサイズに基づいて、サービスにより適切なバッチ サイズが動的に決定されます。
[最大コンカレント接続数]: アクティビティの実行中にデータ ストアに対して確立されるコンカレント接続数の上限。 コンカレント接続を制限する場合にのみ、値を指定します。
[パフォーマンス メトリック分析を無効にする]: この設定では、コピーのパフォーマンスの最適化と推奨事項のために、DTU、DWU、RU などのメトリックのコレクションを制御します。 この動作に不安がある場合は、この機能をオフにします。
マッピング
[マッピング] タブの構成については、「[マッピング] タブでマッピングを構成する」を参照してください。
設定
[設定] タブの構成については、「[設定] タブで他の設定を構成する」を参照してください。
テーブルの概要
次の表に、Azure Cosmos DB for NoSQL のコピー アクティビティの詳細を示します。
ソース テーブル
| 名前 | Description | Value | 必須 | JSON スクリプト プロパティ |
|---|---|---|---|---|
| データ ストアの種類 | データ ストアの種類。 | 外部品目番号 | はい | / |
| 接続 | ソース データ ストアへの実際の接続。 | <接続> | はい | つながり |
| コンテナー | ソース データのコンテナー。 | <ソースのコンテナー> | はい | container fileName |
| [クエリの使用] | 使用クエリとして [テーブル] または [クエリ] を選択できます。 | • [テーブル] • [クエリ] |
いいえ | type |
| ページ サイズ | クエリ結果のページあたりのドキュメント数。 既定値は "-1" で、これはサービス側の動的ページ サイズが最大 1000 まで使用されることを意味します。 | <ページ サイズ> | いいえ | PageSize |
| [Delete datetime](datetime の削除): | ソース データ ストア上のファイルは、コピー先ストアに移動された直後に削除されます。 ファイルの削除はファイルごとに行われるので、コピー操作が失敗した場合、一部のファイルが既にコピー先にコピーされソースからは削除されているが、他のファイルはまだソース ストアにあることがわかります。 | 選択または選択解除 | いいえ | detectDatetime |
| [Preferred regions](優先リージョン) | Azure Cosmos DB からデータを取得するときに接続するリージョンの優先リスト。 [新規] を選択した後、ドロップダウン リストから優先リージョンを 1 つ選択します。 | <優先リージョン> | いいえ | preferredRegions |
| 追加の列 | ソース ファイルの相対パスまたは静的値を格納するための追加のデータ列を追加します。 後者では式がサポートされています。 詳細については、「コピー中に列を追加する」を参照してください。 | <最大コンカレント接続数> | いいえ | additionalColumns |
[ターゲット テーブル]
| 名前 | Description | Value | 必須 | JSON スクリプト プロパティ |
|---|---|---|---|---|
| データ ストアの種類 | データ ストアの種類。 | 外部品目番号 | はい | / |
| 接続 | コピー先データ ストアへの接続。 | <接続> | はい | つながり |
| コンテナー | コピー先データのコンテナー。 | <ソースのコンテナー> | はい | container fileName |
| [Write behavior](書き込み動作) | Azure Cosmos DB にデータを書き込む方法を示します。 使用可能な値は、Insert、Upsert です。 upsert の動作は、同じ ID を持つドキュメントが既に存在する場合に、そのドキュメントを置き換えることです。それ以外の場合はドキュメントを挿入します。 | • [動的なコンテンツの追加] • [挿入] • [Upsert](アップサート) |
いいえ | writeBehavior |
| [書き込みバッチ タイムアウト] | タイムアウトする前に一括挿入操作の完了を待つ時間です。指定できる値は期間です。 たとえば "00:30:00" (30 分) を指定できます。 | TimeSpan | いいえ | writeBatchTimeout |
| [Write batch size](書き込みバッチ サイズ) | SQL テーブルに挿入するバッチあたりの行数。 使用可能な値は integer (行数) です。 既定では行のサイズに基づいて、サービスにより適切なバッチ サイズが動的に決定されます。 | <行数> (整数) |
いいえ | writeBatchSize |
| 最大コンカレント接続数 | アクティビティの実行中にデータ ストアに対して確立されたコンカレント接続数の上限。 コンカレント接続を制限する場合にのみ、値を指定します。 | <最大コンカレント接続数> | いいえ | maxConcurrentConnections |
| [パフォーマンス メトリック分析を無効にする] | この設定では、コピーのパフォーマンスの最適化と推奨事項のために、DTU、DWU、RU などのメトリックのコレクションを制御します。 この動作に不安がある場合は、この機能をオフにします。 | 選択または選択解除 | いいえ | disableMetricsCollection |