17.10 - 構文 - Parallel Transporter

Teradata® Parallel Transporter リファレンス

Product
Parallel Transporter
Release Number
17.10
Published
2022年2月
Content Type
プログラミング リファレンス
Publication ID
B035-2436-061K-JPN
Language
日本語
Last Update
2022-02-11

tbuildコマンドには、Teradata PTジョブ スクリプトを含むファイルを主要引数として指定します。tbuildオプションは、どの順序でも指定できます。



構文規則:

構文要素 説明
-C 各Consumerオペレータにデータをさらに均等に配置します。指示により、Producerオペレータとそのベースのデータ ストリームから、ラウンド ロビン(サイクリック)方式で、ターゲットのConsumerオペレータにデータ ブロックを送信します。

デフォルトでは、Teradata PTデータ ストリームは、プロデューサのチャネル設定アレイにある、最初に準備完了(利用可能)した Consumerオペレータに、データのブロックを送信します。プロセスが切り替わるのは、最初の Consumerオペレータがビジーのため、新たに入力を受信できないときだけです。 -Cオプションを使用すると、データが確実に各 Consumerオペレータに、均等に配置されます。

-d すべてのタスクでデバッグ トレース機能を有効にします。

このオプションを使用すると、tbuildのために呼び出されたすべての内部機能のトレース メッセージと戻りコードが出力されます。 内部エラー条件コードとトレース メッセージは、通常はインフラストラクチャ レベルで発生している問題のデバッグに役立ちます。 ただし、オペレータで提供されるトレース オプションとともにこのオプションを使用すると、ジョブの完全なトレースを取得できます。

このオプションを指定しない場合、デバッグ トレース機能は無効になります。

-e characterSet スクリプトの文字セット エンコーディングを指定します。このオプションでは、プラットフォーム固有のエンコーディングに関係なく、ビッグ エンディアンやリトル エンディアン形式のファイルも正しく処理されます。

指定しない場合は、デフォルトの文字セットとして7ビットASCII互換(UNIX OSとWindowsの場合)またはEBCDIC (z/OSの場合)が使用されます。

-e characterSetは、ジョブ スクリプトがUTF-16でエンコードされている場合に必須です。

すべての値は、大文字と小文字が区別されず、ハイフン付きまたはハイフン無しで指定できます。つまり、UTF-16、UTF16、utf16-beなどという表記はどれも有効になります。次の値がcharacterSetで有効です。

  • UTF-16

    (推奨表記)デフォルトのエンディアンは、クライアント プラットフォームに従います。

  • UTF-8

    (推奨表記)UTF-8の指定は任意選択です。 UTF-8以外のスクリプトでUTF-8を指定すると、エラーが発生します。 UTF-8エンコーディングでは、エンディアンは関係ありません。

  • UTF-16LE

    (推奨表記)リトル エンディアン エンコーディングのジョブ スクリプトを指定します。 ビッグ エンディアンのプラットフォームで実行した場合は、スクリプト エンコーディングは、実行前に、ビッグ エンディアンに変換されます。 クライアント セッション文字セット名としては、許可されません。

  • UTF-16BE

    (推奨表記)ビッグ エンディアン エンコーディングのジョブ スクリプトを指定します。 リトル エンディアンのプラットフォームで実行した場合は、スクリプト エンコーディングは、実行前に、リトル エンディアンに変換されます。 クライアント文字セット名としては、許可されません。

-f fileName Teradata PTジョブ スクリプト ファイルを指定します。
-h value

-h valueK

-h valueM

Teradata PTジョブのプロセス間で使用される共有メモリのサイズを指定します。

オプションには以下のものが含まれます。

  • -h valuevalueには共有メモリのサイズをバイト単位で指定します。1,048,576バイト~4,294,967,295バイトの範囲の値を指定できます。
  • -h valueKvalueKには共有メモリのサイズをキロバイト単位で指定します。1024K(1,048,576バイト)~4,194,304K(4,294,967,295バイト)の範囲の値を指定できます。
  • -h valueMvalueMには共有メモリのサイズをメガバイト単位で指定します。1M(1,048,576バイト)~4096M(4,294,967,295バイト)の範囲の値を指定できます。

例えば、次のように指定します。

tbuild -h 24M

-hオプションが指定されていない場合、Teradata PTは、<Teradata® Parallel Transporterユーザー ガイド, B035-2445>で概説されている計算に従って共有メモリを割り当てます。

-hオプションが無効である場合は、警告メッセージが出力され、<Teradata® Parallel Transporterユーザー ガイド, B035-2445>で概説されている計算に従って共有メモリが割り当てられます。

-hのメモリ サイズが無効です。この指定は無視されます。

-hオプションの値が許容範囲外である場合は、警告が出力され、該当する最小値または最大値にサイズが調整されてから割り当てられます。-hオプションの値が許容範囲外である場合は、次のいずれかのメッセージが出力されます。
  • -hのメモリ サイズが最大許容値を上回っているので、4294967295に下方修正されます。
  • -hのメモリ サイズが最小許容値を下回っているので、1048576に上方修正されます
-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 jobName 任意選択で指定するジョブ名。ただし、各ジョブのチェックポイント ファイルの名前が一意になるようにするためには、指定することが強く推奨されています。jobNameを入力しない場合のデフォルトは、ユーザー名の後ろにハイフン("-")、および生成されたTeradata PTジョブの連番を付けた、次のような形式のものになります。
<user name>-<job sequence number>
同じログオン セッションで複数のジョブを同時に実行する場合は、ジョブごとに一意の名前を指定します。これは、各ジョブが独自のチェックポイント ファイルに書き込む必要があるためです。 一意の名前を指定しないと、複数の同時実行ジョブが同じチェックポイント ファイルに書き込みを試みます。 この場合ジョブは失敗します。
-l latencyInterval 任意選択で指定する古いバッファを消去する秒単位の更新時間間隔。 更新時間間隔は、Streamオペレータでのみ使用します。

値を指定しない場合、バッファがいっぱいになるまでデータ ストリームからデータが読み取られます。 バッファがいっぱいになると、すべてのバッファ レコードがデータベースに書き込まれます。

-L jobLogDirectory ジョブの実行中に作成されたTeradata PTファイルの格納場所を指定します。

jobLogDirectoryは、Teradata PTファイルが格納されているディレクトリのフルパス名です。

このオプションは、z/OSではサポートされません。

-m statisticsInterval オペレータに関する統計情報を収集する、秒単位の時間間隔を指定します。

このオプションを指定しない場合、統計情報は収集されません。

-n ジョブ ステップでエラーが返った場合でもジョブが継続して実行できることを指定します。
  • ジョブ ステップがゼロ以外の終了コードを受信した場合、ジョブは続行します。
  • ステップがステータス“failure"(4よりも大きい終了コード)で終了した場合、後続のステップは、前に失敗したステップで残されたチェックポイント ファイルを回避します。

必須の構文は次のとおりです。

tbuild -f <scriptFile> -n

このオプションを指定しません場合、ステップが失敗するとジョブは終了します。

-o ジョブの完了後、コンシューマ プライベート ログを標準出力に書き込みます。

-oオプションを指定しない場合、出力は標準出力に書き込まれません。

-r checkpointDirectory チェックポイント ファイルが“CheckpointDirectory"というディレクトリに格納されることを指定します。

-r オプションを指定しないと、チェックポイント ファイルは、デフォルトのチェックポイント ディレクトリに格納されます。このディレクトリは、Teradata PTの構成ファイルで定義されています。

-R restartLimit 自動(ジョブ)再始動時のデフォルトの試行回数である5回を上書きするオプション。-Rを指定している場合は、値を入力します。そうしないと、コマンドが拒否されて、エラーが返されます。restartLimitの値は0~512の範囲である必要があります。0を指定すると、自動(ジョブ)再始動は行なわれなくなります。
-s jobstepIdentifier 指定されたジョブ ステップからジョブの実行を開始するように指示します。

ジョブ ステップは、スクリプト内のジョブ ステップ名、またはスクリプト内でのジョブ ステップの物理的な順序に対応する暗黙のジョブ ステップ番号(1、2、3など)によって識別されます。

ジョブは、指定したジョブ ステップから開始されます。ジョブ スクリプト内で開始指定よりも前にあるジョブ ステップは、すべてスキップされます。

このオプションは、以下のようにチェックポイント ファイルも削除します。
  • スキップされたステップで使用されていたチェックポイント ファイル
  • 同じジョブの前の実行で使用されていたチェックポイント ファイル
  • 先行する1つ以上のステップが失敗するか、または終了が早過ぎるなどの原因で繰り越されたチェックポイント ファイル

上記の条件に一致するチェックポイント ファイルは後続のステップで無効となるため、-sオプションに指定されたステップを開始する前に自動的に削除されます。

以前は-sオプションでサイレント モードがサポートされていました。 現在ではサイレント モードは使用できなくなりました。
-S DD:ddname

-S dsName

-S sysoutClass

tbuildがプライベート ログとパブリック ログの両方を指定された格納場所に書き込めるようにします(z/OSプラットフォームの場合)。以下のlogDestinationオプションから選択します。
  • ddnameを指定する場合: tbuild -S logDestination

    ここで、logDestinationDD:<ddname> (ログ ファイルの宛先ddname)です。

  • dsnameを指定する場合: tbuild -S logDestination

    ここで、logDestinationは<dsname>はdsname (ログ ファイルの宛先データセット名)です。

    完全修飾のデータセット名は、名前を単一引用符で囲んで指定します。
  • SYSOUTクラスを指定する場合:tbuild -S logDestination

    ここで、logDestination<sysout class> (ログ ファイルのSYSOUTクラス)です。

-Sオプションを指定しない場合、tbuildはプライベート ログもパブリック ログも、指定された場所に書き込みません。 ただし、tbuildは、JOBLOG DD文によって参照されているデータセットにはログを書き込みます。

-t すべてのタスクでトレース オプションを有効にします。

このオプションを指定しない場合、トレースは無効になります。

-u jobVariables コマンド ラインでジョブ変数値を指定できるようにします。

このオプションは、ジョブ スクリプトの現在の実行に対してコマンド ラインでジョブ変数割り当てを指定するために使用します。

1つのジョブ スクリプト内には複数のソースのジョブ変数割り当てがあり、優先順位の階層に従って呼び出されます。詳細については、<Teradata® Parallel Transporterユーザー ガイド, B035-2445>の「ジョブ変数の使用」とそれに関連するトピックを参照してください。

次の例では、UsrIDとPwdがジョブ変数として定義されており、これらはUserName属性とUserPassword属性の実行時の値を指定するために使用されています。

ATTRIBUTES
(
   VARCHAR UserName = @UsrID,
   VARCHAR UserPassword = @Pwd
);

次のコマンドは、これらのジョブ変数の実行時値を指定しています。

tbuild -f scriptFileName -u "UsrID = 'John Doe', Pwd = 'ABC123' "
-v jobVariablesFile 外部ファイルにジョブ変数値を指定できるようにします。

このオプションは、スクリプトに指定されているジョブ変数に対して実行時に値を割り当てる-uオプションに似ていますが、次のようなコマンドによってtbuildが参照する外部ファイルに変数値が格納される点が異なります。

tbuild -f scriptFileName -v jobVariablesFile

ここで、jobVariableFileは、置き換えられる値を含んでいるファイルです。

UsrID = 'John Doe',
Pwd = 'ABC123'

ジョブ変数ファイルが格納されているディレクトリ以外でtbuildコマンドを実行している場合、jobVariablesFileは完全修飾ファイル名である必要があります。ジョブ変数ファイルは、ASCII、UTF-8、またはUTF-16で保存でき、UTFバイト オーダー マーク付きとマークなしのどちらでも構いません。

-V ジョブを実行せずにTeradata PTのバージョン番号を表示します。

他のオプションとともに使用しないでください。 このオプションは、UNIXおよびWindowsプラットフォームでのみ機能します。

-w restartWaitPeriod 再起動の時間間隔を秒単位で指定します。

このオプションを指定しないと、自動再起動と自動再起動の間に待機が行なわれません。

有効な再起動待機期間の値は、1から86400(秒)までの正の整数でなければなりません。

-W processTimeout

TPTがサブプロセスを生成するまで待機する秒数を指定します。値には1~900の整数を指定できます。ジョブが次のエラーとともに頻繁に失敗する場合に、このオプションの使用を検討してください。

エラー: タスク初期化の待機が時間切れになりしました。

-Wオプションが指定されない場合、TPTはデフォルトの120秒を使用します。

-Wオプションが無効(0または数値以外)の場合、TPTはデフォルト値の120秒を使用します。-Wオプションが無効な場合、次のメッセージが発行されます。

TPT_INFRA: TPT04215: 警告: -Wタイムアウト値は無効であり、無視されます。

-Wオプションが最大許容値900秒より大きい場合、TPTは最大値900秒を使用し、次のメッセージを表示します。

TPT_INFRA: TPT04214: 警告: -Wタイムアウトの値は許容最大値を超えるので900に下げられます

-z checkpointInterval チェックポイント間の時間間隔を秒単位で指定するオプション。

このオプションを指定しない場合、ジョブ スクリプトでチェックポイント間隔を指定しない限り、間隔チェックポイント操作は実行されません。

両方でチェックポイント間隔を指定した場合は、-zオプションの指定が優先されます。

チェックポイント間隔の有効な値は0~86400(秒)です。