構文 - Parallel Transporter

tdloadでは、次の構文を使用します。

ここで、jobOptionsは次のいずれかです。

構文要素	説明
AutoPickSessInstance ON/OFF	TPT Easy Loaderに、セッションおよびインスタンス数を自動的に選択するように指示します。このオプションのデフォルト値はOFFです。詳細については、<Teradata® Parallel Transporterユーザーガイド, B035-2445>の「Teradata PT Easy Loaderでのセッションとインスタンスの自動選択」を参照してください。
-c characterSet	フラットファイルの文字セットエンコーディング。このオプションでクライアントセッション文字セットを設定します。フラットファイルがASCIIファイルではない場合は、このオプションを指定します。
-d "delimiterCharacter"	区切り形式のフラットファイルでデータレコードのフィールドを分離するために使用する区切り文字。デフォルトの区切り文字はカンマ(,)です。この点がTeradata PTスクリプトを使用する場合(パイプ文字(\|)がデフォルトの区切り文字)と異なります。フラットファイルの区切り文字がカンマではない場合は、このオプションを指定する必要があります。
-f fileName	必須。ロード対象データを含むフラットファイル名。 tdloadコマンドを実行しているのが、フラットファイルが保存されているディレクトリではない場合は、fileNameには、フラットファイルの完全修飾名が必要です。 -f (または、--SourceFileName)オプションと--SourceTableオプションは、相互に排他的です。これらのオプションの両方がtdloadコマンドラインで指定された場合、エラーが返されます。 -f (または、--SourceFileName)オプションと--SelectStmtオプションは、相互に排他的です。これらのオプションの両方がtdloadコマンドラインで指定された場合、エラーが返されます。
-h tdpId	ネットワークで認識されているTeradata Data Warehouse Appliance 2xxxの名前。このオプションを指定しない場合、デフォルトのホスト名が使用されます。推奨事項:このオプションを指定すれば、正しいシステムに確実に接続できます。
-I ConfigurationFileName	次のファイルにアクセスできない場合に、目的の構成ファイルを指定します。 TPTインストールディレクトリにあるグローバル構成ファイルtwbcfg.ini ユーザーのホームディレクトリにあるローカル構成ファイル.twbcfg.ini 次のグローバルパラメータは、ユーザー指定の構成ファイルで定義できます。 GlobalAttributeFile CheckpointDirectory LogDirectory これらのパラメータの定義は、次の構文を使って指定する必要があります。 <parameter> = <single-quoted string> 例えば、UNIXシステムでは: CheckpointDirectory='/opt/teradata/client/16.20/tbuild/checkpoint' LogDirectory='/opt/teradata/client/16.20/tbuild/logs' -Iオプションは、WindowsおよびUNIXプラットフォームでのみサポートされます。
-j jobVariablesFile	ジョブ変数ファイルの名前。 tdloadコマンドを実行しているのが、ジョブ変数ファイルが保存されているディレクトリではない場合は、jobVariablesFileに、完全修飾ファイル名が必要です。ジョブ変数ファイルは、UTFバイトオーダーマークの有無にかかわらず、ASCII、UTF-8、またはUTF-16で保存できます。
-L jobLogDirectory	ジョブの実行中に作成されたTeradata PTファイルの位置を指定するオプション。 jobLogDirectoryは、Teradata PTファイルが格納されているディレクトリのフルパス名です。このオプションは、z/OSではサポートされません。
-p password	指定Teradataユーザーのパスワード。このオプションを指定しない場合、tdloadからパスワードの入力要求が表示されます。
- R restartLimit	自動(ジョブ)再始動時のデフォルトの試行回数である5回を上書きするオプション。 -Rを指定する場合、値を入力しないと、システムでコマンドが拒否され、エラーが返されます。 restartLimitの値は、ゼロ以上の任意の整数にすることができます。値ゼロを指定すると、ジョブが自動的に再始動されなくなります。
-r checkpointDirectory	チェックポイントファイルが“CheckpointDirectory"というディレクトリに格納されることを指定するオプション。 -r オプションを指定しないと、チェックポイントファイルは、デフォルトのチェックポイントディレクトリに格納されます。このディレクトリは、Teradata PTの構成ファイルで定義されています。
-S	このコマンドで生成されたTeradata PTスクリプトを保存します。
-t tableName	必須。ターゲットテーブルの名前。指定Teradataユーザーのデフォルトデータベースではないデータベースにターゲットテーブルがある場合は、--TargetWorkingDatabaseオプションも使用する必要があります。
-u userName	必須。ターゲットテーブルへのアクセス権があるTeradataユーザーのログオンID。
-v	ジョブを実行せずにtdloadのバージョン番号を表示するオプション。他のオプションとともに使用しないでください。このオプションは、UNIXおよびWindowsプラットフォームでのみ機能します。
-w restartWaitPeriod	再起動と再起動の間隔を秒単位で指定します。このオプションを指定しないと、自動再起動と自動再起動の間に待機が行なわれません。有効な再起動待機期間の値は、1から86400(秒)までの正の整数でなければなりません。
-x	デバッグ処理を有効にします。
- z checkpointInterval	チェックポイント間の時間間隔を秒単位で指定するオプション。このオプションを指定しないと、間隔チェックポイント操作は実行されません。チェックポイント間隔の有効な値は0～86400(秒)です。
--help	ヘルプを表示します。
--DefaultStagingTable	--DefaultStagingTableオプションは、NOPIステージングテーブルを作成し、ターゲットテーブルではなくこのステージングテーブルにデータをロードするように、TPT Easy Loaderに指示します。ステージングテーブルはターゲットのTeradata Database上に作成されます。ステージングテーブルの名前は次のとおりです。 <target table>_STG データがファイルからのものである場合、TPT Easy Loaderはターゲットテーブルからテーブル定義を取得し、VARCHAR以外の列を同等のVARCHAR列に変換して、すべてVARCHAR列で構成されたステージングテーブルを作成します。これにより、データ変換エラーなどの問題やエラーを引き起こす可能性があるデータを、ステージングテーブルのVARCHAR列に読み込むことができます。データがステージングテーブルに読み込まれると、必要なINSERT-SELECT文を作成して、ステージングテーブルからターゲットテーブルにデータを移動することができます。データがソーステーブルからのものである場合、TPT Easy Loaderはソーステーブルからテーブル定義を取得し、VARCHAR以外の列を同等のVARCHAR列に変換して、すべてVARCHAR列で構成されたステージングテーブルを作成します。データがソーステーブルのSELECTリクエストからのものである場合、TPT Easy LoaderはSELECTリクエストのスキーマを取得し、VARCHAR以外の列を同等のVARCHAR列に変換して、すべてVARCHAR列で構成されたステージングテーブルを作成します。 TPT Easy LoaderはステージングテーブルへのロードにLoadオペレータを使用します。その理由は、Loadオペレータは最速のプロトコル(FastLoad)を使用して、空のテーブルにデータをロードするためです。ターゲットテーブルと"_STG"接尾辞の合計長がTeradata Databaseのテーブル名の最大サイズを超える場合、TPT Easy Loaderはターゲットテーブル名を切り捨ててから"_STG"接尾辞を追加します。これにより、ステージングテーブルの最終的な長さはTeradata Databaseのテーブル名の最大サイズ内に収まります。ステージングテーブルは存在していてはなりません。ステージングテーブルがすでに存在する場合、TPT Easy Loaderはエラーメッセージを表示してジョブを終了します。 --DefaultStagingTableオプションを指定しないことで、ステージングテーブルにロードせずに直接ターゲットテーブルにロードすることができます。 --StagingTableオプションと--DefaultStagingTableオプションは、相互に排他的です。両方のオプションを指定した場合、TPT Easy Loaderはエラーメッセージを表示してジョブを終了します。 --DefaultStagingTableオプションをジョブ変数ファイルで指定することはできません。このオプションはコマンドラインでのみ指定できます。ジョブ変数ファイルには値が必要ですが、--DefaultStagingTableオプションには値がありません。
--NoLoadSlot	このオプションは、ロードスロットを使用しないようにTPT Easy Loaderに指示します。ソースマシンとターゲットマシンの2つが存在する場合は、その両方にこれを暗黙的に示します。それ以外の場合は、ソースのみ、またはターゲットのみに示します。このオプションは、任意のジョブ変数に"Load/Update/Export/Stream"プレフィックスを指定することで上書きできます。 --NoLoadSlot、--StagingTable、および--DefaultStagingTableオプションは、相互に排他的です。これらのオプションを指定した場合、TPT Easy Loaderは次のエラーメッセージを表示してジョブを終了します。 TPT_INFRA: TPT05565: エラー: --NoLoadSlotオプションは、--StagingTableおよび--DefaultStagingTableと相互に排他的です。 --NoLoadSlotオプションをジョブ変数ファイルで指定することはできません。このオプションはコマンドラインでのみ指定できます。ジョブ変数ファイルには値が必要ですが、--NoLoadSlotオプションには値がありません。
<long_option>value	Easy Loaderは、オペレータテンプレート内で定義されているすべての標準ジョブ変数と、汎用ジョブ変数をサポートします。これらの汎用ジョブ変数は、オペレータテンプレートから派生し、Easy Loaderが自動的にオペレータの意思決定を行なえるようにします。汎用ジョブ変数を作成するには、単にテンプレートジョブ変数から演算子名を削除し、オペレータがプロデューサまたはコンシューマであるかどうかに応じて‘Source’または‘Target’を追加します。例えば、Load演算子のトレースレベルジョブ変数は“LoadTraceLevel"であり、これを汎用にするため“TargetTraceLevel"として指定します。LoadがEasy Loaderによって選択されたConsumerオペレータである場合、“TargetTraceLevel"はロード演算子に自動的にマップされます。その他の例と手順については、<Teradata® Parallel Transporterユーザーガイド, B035-2445>の「Teradata PT Easy Loader」を参照してください。

一般的に使用されるlongオプションは次のとおりです。

Longオプション	説明
--InsertStmt "INSERT statement;"	ローダーのオペレータに使用するInsert文。 tdload --InsertStmt "INSERT <table> (:COL1, :COL2);" このオプションを使用すると、プロデューサからのデータを、送信元スキーマでの定義方法とは異なる順序で選択的に送信できます。これを使用しない場合は、$INSERTマクロが使用され、ソーステーブルのスキーマにターゲットテーブルのスキーマとの互換性がなければなりません。
--SelectStmt “SELECT statement(s);”	SELECT文は、Teradata Databaseテーブルからデータ選択を実行します。 SELECT文にはスペースや空白文字が入力できるため、次のようにコマンドラインに指定する場合、ステートメント全体を二重引用符(")で囲む必要があります。 tdload --SelectStmt "sel * from src_tbl;" SELECT文要求では、次のような指定はできません。 USING修飾子の指定 SELECT DATEまたはSELECT USERなどのデータのないテーブルへのアクセステーブルのプライマリインデックスまたは固有セカンダリインデックスに基づいて行にアクセスするSELECT文など、1つまたは2つのAMPで満たされる BLOB(バイナリラージオブジェクト)またはCLOB(キャラクタラージオブジェクト)のデータ型を含む JSON(JavaScript Object Notation)のデータ型を含める XMLデータ型を含める --SelectStmtオプションと-f (または、--SourceFileName)オプションは、相互に排他的です。これらの両方がtdloadコマンドラインで定義された場合、エラーが返されます。 --SelectStmtオプションと-- SourceTableオプションの両方が定義されている場合、--SourceTableオプションは無視され、警告メッセージがコンソールに返されます。
--SourceAccountId accountId	指定Teradataユーザーに関連付けられたアカウント。
--SourceFileName fileName	必須。ロード対象データを含むフラットファイル名。 --SourceFileName (または、-f)オプションと--SourceTableオプションは、相互に排他的です。これらのオプションの両方がtdloadコマンドラインで指定された場合、エラーが返されます。 --SourceFileName (または、-f)オプションと--SelectStmtオプションは、相互に排他的です。これらのオプションの両方がtdloadコマンドラインで指定された場合、エラーが返されます。
--SourceInstances number	Teradataからデータの抽出に使用されるインスタンス数。デフォルト値は1です。
--SourceMaxSessions number	テーブルからのデータの抽出に使用されるセッションの最大数。デフォルト値は32です。
--SourceMinSessions number	テーブルからのデータの抽出に使用されるセッションの最小数。デフォルト値は1です。
--SourceTable tableName	ソーステーブルの名前。注: 指定Teradataユーザーのデフォルトデータベースではないデータベースにソーステーブルがある場合は、--SourceWorkingDatabaseオプションも使用する必要があります。 --SelectStmtオプションと-f (または、--SourceFileName)オプションは、相互に排他的です。これらの両方がtdloadコマンドラインで指定された場合、エラーが返されます。 --SourceTableオプションと-- SelectStmtオプションの両方が定義されている場合、--SourceTableオプションは無視され、警告メッセージがコンソールに返されます。
--SourceTextDelimiter "delimiterCharacter"	区切り形式のフラットファイルでデータレコードのフィールドを分離するために使用する区切り文字。
--SourceTdpId tdpId	ネットワークで認識されているTeradata Databaseの名前。
--SourceTraceLevel value	フラットファイルからデータを読み込むオペレータでトレースメッセージを有効にします。有効な値は次のとおりです。 'Yes' = tdloadは、'all'値を適切なオペレータの'TraceLevel'属性に設定します。 'No' = トレース機能を無効にします(デフォルト)。
--SourceUserName userName	ソーステーブルへのアクセス権があるTeradataユーザーのログオンID。
--SourceUserPassword password	指定Teradataユーザーのパスワード。このオプションを指定しない場合、tdloadからパスワードの入力要求が表示されます。
--SourceWorkingDatabase databaseName	ソーステーブルが位置するデータベース。
--StagingTable stagingTableName	--StagingTableオプションは、指定した<staging table name>のNOPIステージングテーブルを作成し、ターゲットテーブルではなくこのステージングテーブルにデータをロードするように、TPT Easy Loaderに指示します。ステージングテーブルはターゲットのTeradata Database上に作成されます。データがファイルからのものである場合、TPT Easy Loaderはターゲットテーブルからテーブル定義を取得し、VARCHAR以外の列を同等のVARCHAR列に変換して、すべてVARCHAR列で構成されたステージングテーブルを作成します。これにより、データ変換エラーなどの問題やエラーを引き起こす可能性があるデータを、ステージングテーブルのVARCHAR列に読み込むことができます。データがステージングテーブルに読み込まれると、必要なINSERT-SELECT文を作成して、ステージングテーブルからターゲットテーブルにデータを移動することができます。データがソーステーブルからのものである場合、TPT Easy Loaderはソーステーブルからテーブル定義を取得し、VARCHAR以外の列を同等のVARCHAR列に変換して、すべてVARCHAR列で構成されたステージングテーブルを作成します。データがソーステーブルのSELECTリクエストからのものである場合、TPT Easy LoaderはSELECTリクエストのスキーマを取得し、VARCHAR以外の列を同等のVARCHAR列に変換して、すべてVARCHAR列で構成されたステージングテーブルを作成します。 TPT Easy LoaderはステージングテーブルへのロードにLoadオペレータを使用します。その理由は、Loadオペレータは最速のプロトコル(FastLoad)を使用して、空のテーブルにデータをロードするためです。ステージングテーブルは存在していてはなりません。ステージングテーブルがすでに存在する場合、TPT Easy Loaderはエラーメッセージを表示してジョブを終了します。ステージングテーブルは、データベース名で修飾することができます。 --StagingTableオプションを指定しないことで、ステージングテーブルにロードせずに直接ターゲットテーブルにロードすることができます。 --StagingTableオプションと--DefaultStagingTableオプションは、相互に排他的です。両方のオプションを指定した場合、TPT Easy Loaderはエラーメッセージを表示してジョブを終了します。 --StagingTableオプションは、ジョブ変数ファイルで次のように指定できます。 StagingTable = 'tablename' コマンドラインで指定した--StagingTableオプションの値とジョブ変数ファイルで指定した--StagingTableオプションの値とでは、コマンドラインで指定したオプションの値が優先されます。
--SharedMemorySize	--SharedMemorySizeオプションを使用すると、実行中のジョブに割り当てる共有メモリの量を指定できます。指定された値は、tbuildコマンドのオプション(-h)で使用されます。 Teradata PT Easy Loaderは、SharedMemorySizeの値のエラーチェックを実行しません。tdloadコマンドに指定された値は、tbuildコマンドにそのまま直接渡されます。
--TargetAccountId accountId	指定Teradataユーザーに関連付けられたアカウント。
--TargetErrorLimit number	データレコードで許可されるエラーの最大数。発生したエラー数がこの数値を超えると、ロードジョブは終了します。デフォルト値は1です。
--TargetMaxSessions number	ロードジョブの中で使用されるセッションの最大数。デフォルト値は32です。
--TargetMinSessions number	ロードジョブの中で使用されるセッションの最小数。デフォルト値は1です。
--TargetTable tableName	必須。ターゲットテーブルの名前。
--TargetTdpId tdpId	ネットワークで認識されているTeradata Databaseの名前。
--TargetTraceLevel value	ターゲットテーブルにデータをロードするオペレータでトレースメッセージを有効にします。有効な値は次のとおりです。 'Yes' = tdloadは、'all'値を適切なオペレータのTraceLevel属性に設定します。 'No' = トレース機能を無効にします(デフォルト)。
--TargetUserName userName	必須。ターゲットテーブルへのアクセス権があるTeradataユーザーのログオンID。
--TargetUserPassword password	指定Teradataユーザーのパスワード。
--TargetWorkingDatabase databaseName	ターゲットテーブルを含むデータベース。指定Teradataユーザーのデフォルトデータベースではないデータベースにターゲットテーブルがある場合は、このオプションが必要です。

“--< long_option> value"は、汎用または演算子テンプレートのジョブ変数のいずれかです。使用法の詳細については、Teradata® Parallel Transporterユーザーガイド, B035-2445の「Teradata PTイージーローダー」を参照してください。

構文規則:

オプション	指定内容
jobName	ロードジョブを識別する固有名。推奨事項:複数のロードジョブが同時に動作しているときは、自分のジョブに名前を付けることを強く推奨します。