COPY INTO テーブル実行処理

オペレーション名

COPY INTO テーブル実行

機能概要

COPY INTO <テーブル>コマンド(以下、COPYコマンド)を実行し、ステージ上のファイルからテーブルへデータをロードします。

本コンポーネントが使用するCOPYコマンド仕様については、以下のリンク先ページより参照してください。

「COPY INTO <テーブル>」- (https://docs.snowflake.com/ja/sql-reference/sql/copy-into-table)

データモデル

本コンポーネントのデータモデルはテーブルモデル型です。

プロパティ

変数の使用については、「変数」を参照してください。

基本設定

項目名	必須/省略可	変数の使用	説明	備考
名前	必須	使用不可	スクリプトキャンバス上での名前を入力します。

必須設定

項目名	必須/省略可	変数の使用	説明	備考
接続先	必須	使用不可	グローバルリソースを選択します。 [追加]: 新規にグローバルリソースを追加します。 [一覧の編集]: 「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
ステージ名	必須	使用可	ステージ名を選択または入力します。	[COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。本プロパティで入力した値は、COPYコマンドに設定されます。スキーマ名やステージ名に「.」が含まれる場合、スキーマ名とステージ名を引用符で囲むと正しく扱うことができます。スキーマ名が「A.B」で、ステージ名が「C.D」とすると、正しい引用符の囲み方は「"A.B"."C.D"」となります。
ステージ名を引用符で囲う	省略可	使用不可	ステージ名を引用符で囲うかどうかを選択します。 [チェックあり]: [ステージ名]に表示されているステージ名を引用符で囲います。 [チェックなし]:(デフォルト) [ステージ名]に表示されているステージ名を引用符で囲いません。スペースなどの文字がステージ名に含まれていた場合には、ステージ名を引用符で囲う必要があります。引用符で囲う必要がある文字については、接続先のベンダーに問い合わせてください。	[COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。実行時には[ステージ名]に入力されたステージ名をそのまま使用します。 [ステージ名]に入力されたステージ名が引用符で囲われていた場合には、実行時にも引用符で囲まれたステージ名でクエリーを発行します。 [ステージ名]に入力されたステージ名が引用符で囲まれていない場合には、実行時に本プロパティの有効/無効を確認のうえ、本プロパティが有効であれば引用符で囲まれたステージ名でクエリーを発行します。 [ステージ名]に環境変数を設定した場合、本プロパティの有効/無効を切り替えた際に値が展開されます。
ステージ上のファイル/フォルダパス	省略可	使用可	ステージ上のファイル/フォルダパスを入力します。	パスは「/」から始まる文字列を指定します。ステージのルートフォルダを「/」で表します。 [COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。本プロパティで入力した値は、COPYコマンドに設定されます。
テーブル名	必須	使用可	テーブル名を選択または入力します。	[COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。本プロパティで入力した値は、COPYコマンドに設定されます。スキーマ名やテーブル名に「.」が含まれる場合、スキーマ名とテーブル名を引用符で囲むと正しく扱うことができます。スキーマ名が「A.B」で、テーブル名が「C.D」とすると、正しい引用符の囲み方は「"A.B"."C.D"」となります。
テーブル名を引用符で囲う	省略可	使用不可	テーブル名を引用符で囲うかどうかを選択します。 [チェックあり]: [テーブル名]に表示されているテーブル名を引用符で囲います。 [チェックなし]:(デフォルト) [テーブル名]に表示されているテーブル名を引用符で囲いません。スペースなどの文字がテーブル名に含まれていた場合には、テーブル名を引用符で囲う必要があります。引用符で囲う必要がある文字については、接続先のベンダーに問い合わせてください。	[COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。実行時には[テーブル名]に入力されたテーブル名をそのまま使用します。 [テーブル名]に入力されたテーブル名が引用符で囲われていた場合には、実行時にも引用符で囲まれたテーブル名でクエリーを発行します。 [テーブル名]に入力されたテーブル名が引用符で囲まれていない場合には、実行時に本プロパティの有効/無効を確認のうえ、本プロパティが有効であれば引用符で囲まれたテーブル名でクエリーを発行します。 [テーブル名]に環境変数を設定した場合、本プロパティの有効/無効を切り替えた際に値が展開されます。
COPYコマンドを直接入力する	省略可	使用不可	COPYコマンドを直接入力するかどうかを選択します。 [チェックあり]: COPYコマンドを直接入力します。 [チェックなし]:(デフォルト) 各プロパティに設定された値をもとにCOPYコマンドが生成されます。
COPYコマンド	必須	使用可	Snowflakeへ発行するCOPYコマンドを入力します。	[COPYコマンドを直接入力する]にチェックを入れた場合、有効になります。 COPYコマンドは「COPY INTO」から始まる必要があります。

プロパティアクション

項目名	説明	備考
ステージ一覧の取得	スキーマ上のステージ名を取得して、[ステージ名]に設定します。	[接続先]が選択されている場合、有効になります。 [COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。
テーブル一覧の取得	スキーマ上のテーブル名を取得して、[テーブル名]に設定します。	[接続先]が選択されている場合、有効になります。 [COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。
テーブルブラウザの起動	テーブルブラウザを起動します。操作方法については、「テーブルブラウザ」を参照してください。	[テーブル一覧の取得]が成功した場合、有効になります。 [COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。 [テーブル名]で指定したテーブルが初期表示されます。

ファイル指定設定

項目名	必須/省略可	変数の使用	説明	備考
ファイルの指定方法	省略可	使用不可	ロードするファイルを指定する方法を選択します。 [すべてのファイルをロード]:(デフォルト) [ステージ上のファイル/フォルダパス]配下のファイルすべてをロードします。 [正規表現にマッチしたファイルをロード]: [正規表現パターン]にマッチするファイルをロードします。 [ファイル名を指定してロード]: [ファイル名一覧/ファイル名]に一致するファイルをロードします。	[COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。
正規表現パターン	省略可	使用可	正規表現パターンを入力します。	[ファイルの指定方法]で[正規表現にマッチしたファイルをロード]を選択した場合、表示されます。 [COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。本プロパティで入力した値は、COPYコマンドのPATTERNパラメータに設定されます。
ファイル名一覧	省略可	-	ファイル名一覧を設定します。各ファイル名は以下のボタンで操作することができます。 [追加]: ファイル名を追加します。 [上へ]: 選択しているファイル名の順序を一つ上に上げます。 [下へ]: 選択しているファイル名の順序を一つ下に下げます。 [削除]: ファイル名を削除します。	[ファイルの指定方法]で[ファイル名を指定してロード]を選択した場合、表示されます。 [COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。本プロパティで入力した値は、COPYコマンドのFILESパラメータに設定されます。
ファイル名一覧/ファイル名	省略可	使用可	ファイル名を入力します。

ファイル形式設定

項目名	必須/省略可	変数の使用	説明	備考
名前付きファイル形式	省略可	使用可	ロードに使用する名前付きファイル形式を入力します。	[COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。本プロパティで入力した値は、COPYコマンドのFORMAT_NAMEパラメータに設定されます。スキーマ名や名前付きファイル形式に「.」が含まれる場合、スキーマ名と名前付きファイル形式を引用符で囲むと正しく扱うことができます。スキーマ名が「A.B」で、名前付きファイル形式が「C.D」とすると、正しい引用符の囲み方は「"A.B"."C.D"」となります。
名前付きファイル形式を引用符で囲う	省略可	使用不可	名前付きファイル形式を引用符で囲うかどうかを選択します。 [チェックあり]: [名前付きファイル形式]に表示されている名前付きファイル形式を引用符で囲います。 [チェックなし]:(デフォルト) [名前付きファイル形式]に表示されている名前付きファイル形式を引用符で囲いません。スペースなどの文字が名前付きファイル形式に含まれていた場合には、名前付きファイル形式を引用符で囲う必要があります。引用符で囲う必要がある文字については、接続先のベンダーに問い合わせてください。	[COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。実行時には[名前付きファイル形式]に入力された名前付きファイル形式をそのまま使用します。 [名前付きファイル形式]に入力された名前付きファイル形式が引用符で囲われていた場合には、実行時にも引用符で囲まれた名前付きファイル形式でクエリーを発行します。 [名前付きファイル形式]に入力された名前付きファイル形式が引用符で囲まれていない場合には、実行時に本プロパティの有効/無効を確認のうえ、本プロパティが有効であれば引用符で囲まれた名前付きファイル形式でクエリーを発行します。 [名前付きファイル形式]に環境変数を設定した場合、本プロパティの有効/無効を切り替えた際に値が展開されます。

列対応設定

項目名	必須/省略可	変数の使用	説明	備考
列対応方法	省略可	使用不可	ファイル上の列とテーブル上の列を対応させる方法を選択します。 [順番一致]:(デフォルト) 列の順番通りに対応させます。 [列名一致]: 列名が一致する列を対応させます。	[COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。本プロパティで入力した値は、COPYコマンドのMATCH_BY_COLUMN_NAMEパラメータに設定されます。
大文字小文字を区別する	省略可	使用不可	列名の大文字小文字を区別するかどうかを選択します。 [チェックなし]:(デフォルト) 列名の大文字小文字を区別しません。 [チェックあり]: 列名の大文字小文字を区別します。	[列対応方法]で[列名一致]を選択した場合、表示されます。 [COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。本プロパティで入力した値は、COPYコマンドのMATCH_BY_COLUMN_NAMEパラメータに設定されます。

エラー設定

項目名	必須/省略可	変数の使用	説明	備考
エラー時の動作	省略可	使用不可	エラーが発生した際の動作を選択します。 [中止]:(デフォルト) 1件でもエラーが発生した場合、ロード処理を中止します。 [ファイルをスキップ]: エラーが発生したファイルをスキップし、次のファイルをロードします。 [続行]: エラーが発生した行をスキップし、次の行をロードします。	[COPYコマンドを直接入力する]にチェックを入れた場合、無効になります。本プロパティで入力した値は、COPYコマンドのON_ERRORパラメータに設定されます。

データ処理方式

項目名	必須/省略可	変数の使用	説明	備考
データ処理方式	必須	使用不可	データ処理方式を選択します。 [スクリプトの設定を使用する]:(デフォルト) スクリプトプロパティの大容量データ処理の設定をアダプタに使用します。 [大容量データ処理を行わない]: 大容量データ処理を行いません。 [大容量データ処理を行う]: 大容量データ処理を行います。

項目名	必須/省略可	変数の使用	説明	備考
コメント	省略可	使用不可	このアダプタの簡単な説明を記述することができます。説明を記述すると、仕様書に反映させることができます。

スキーマ

入力スキーマ

ありません。

出力スキーマ

<?xml version="1.0"?>
<table>
  <row>
    <column>file</column>
    <column>status</column>
    <column>rows_parsed</column>
    <column>rows_loaded</column>
    <column>error_limit</column>
    <column>errors_seen</column>
    <column>first_error</column>
    <column>first_error_line</column>
    <column>first_error_character</column>
    <column>first_error_column_name</column>
  </row>
  <row>
    :
  </row>
</table>

要素名	ラベル	説明	備考
row	-	ロードしたファイルの件数分だけ繰り返します。
column	file	ロードしたファイルのステージ上のファイルパスを出力します。
	status	ファイルをロードした結果を出力します。	すべての行のロードに成功した場合は「LOADED」、ファイルがすでにロードされていた場合は「LOAD_SKIPPED」、すべての行のロードに失敗した場合は「LOAD_FAILED」、ロードに成功した行とロードに失敗した行がある場合は「PARTIALLY_LOADED」が出力されます。
	rows_parsed	ロード対象の行数を出力します。
	rows_loaded	ロードに成功した行数を出力します。
	error_limit	ロードが中止されるエラーの数を出力します。	statusが「LOAD_SKIPPED」の場合は「0」が出力されます。
	errors_seen	ロードに失敗した行数を出力します。
	first_error	最初にロードに失敗した原因を出力します。	statusが「LOADED」の場合は値が空白になります。
	first_error_line	最初にロードに失敗した行の位置を出力します。	statusが「LOADED」または「LOAD_SKIPPED」の場合は「0」が出力されます。
	first_error_character	最初にロードに失敗した行の、エラーが発生した文字の位置を出力します。	statusが「LOADED」または「LOAD_SKIPPED」の場合は「0」が出力されます。
	first_error_column_name	最初にロードに失敗した列名を出力します。	statusが「LOADED」または「LOAD_SKIPPED」の場合は値が空白になります。

大容量データ処理

大容量データ処理に対応しています。

トランザクション

トランザクションをサポートしています。

PSPでの使用について

PSPで使用できます。

PSPについては、「パラレルストリーミング処理」を参照してください。

使用できるコンポーネント変数

コンポーネント変数名	説明	備考
loaded_file_count	ロードに成功したファイル数が格納されます。	デフォルト値はnullです。 PSPでは値が格納されません。
load_skipped_file_count	すでにロードされていたファイル数が格納されます。	デフォルト値はnullです。 PSPでは値が格納されません。
load_failed_file_count	ロードに失敗したファイル数が格納されます。	デフォルト値はnullです。 PSPでは値が格納されません。
partially_loaded_file_count	ロードが一部成功、一部失敗したファイル数が格納されます。	デフォルト値はnullです。 PSPでは値が格納されません。
error_code	エラー(SnowflakeSQLException)発生時、発生したエラーに対応するエラーコードが格納されます。	デフォルト値はnullです。正常終了時は「0」が格納されます。エラーコードはドライバの仕様に基づいています。
message_category	エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。	デフォルト値はnullです。
message_code	エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。	デフォルト値はnullです。
message_level	エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。	デフォルト値はnullです。
error_type	エラー発生時、発生したエラーの種類が格納されます。	デフォルト値はnullです。エラーの種類は、以下のような形式となります。例:「java.io.FileNotFoundException」 DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_message	エラー発生時、発生したエラーのメッセージが格納されます。	デフォルト値はnullです。 DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_trace	エラー発生時、発生したエラーのトレース情報が格納されます。	デフォルト値はnullです。 DataSpider Servistaのバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限