17.10 - 実行時パラメータ - FastExport

Teradata® FastExportリファレンス

Product
FastExport
Release Number
17.10
Release Date
2021年6月
Content Type
プログラミング リファレンス
Publication ID
B035-2410-061K-JPN
Language
日本語 (日本)

メインフレーム接続システムに対応した実行時パラメータ

次の表 に、メインフレーム接続構成に対応したFastExport実行時パラメータをリストします。

実行時パラメータの説明(メインフレーム接続システム)
パラメータ 説明
BRIEF 縮小印刷出力の実行時パラメータです。FastExportの印刷出力を、ジョブの成否を判別するのに必要な最小限の情報だけに制限します。
CHARSET=character-set-name FastExportジョブの文字セットの指定。

文字セット名を指定できます。文字セットの指定はFastExportのジョブ全体にわたって有効です。このことは、データベースをリセットすることによってそのFastExportジョブが再始動された場合にもあてはまります。

  • クライアント システムに障害が発生した場合、またはFastExportジョブを取り消した場合、文字セットの指定はそれ以上有効ではなくなります。これらの場合、そのジョブの再実行依頼時には最初のジョブのときに使用したものと同じ文字セットを指定しなければなりません。そのようなジョブを再実行依頼する場合に別の文字セットを指定すると、再始動したジョブがロードするデータは最初のジョブでロードしたデータと同じようには表示されません。

    文字セットの指定を入力しないと、FastExportは以下のCall-Level Interface Version 2 (CLIv2)デフォルト ファイルに指定されているものを使用します。HSHSPB(メインフレーム接続のクライアント システムの場合)。

    上記以外の場合、FastExportを呼び出す場合には必ずデータベースに指定した文字セットがデフォルトとなります。

  • UTF8クライアント文字セットをメインフレームで使用する場合は、クライアント文字セット名を実行時パラメータ(CHARSET=UTF8)で指定する必要があります。UTF8も有効な値になります。

    文字セットを指定するその他の方法については、文字セットの指定を参照してください。

ERRLOG=filename FastExportエラー メッセージの代替ファイル指定です。

メインフレーム接続のクライアント システムでは、代替ファイルの指定は8文字までです。さらに次のような条件もあります。

  • z/OSの場合、JCL内で定義されているDDNAMEでなければなりません。

エラー ログfilenameにはデフォルトの指定はありません。

fastexport command FastExportジョブの開始を示す実施オプションです。

指定できるコマンドは1つだけなので、通常はFastExportジョブ スクリプトが格納されているファイルを指定するRUN FILEコマンドを指定します。

DD制御文を使って入出力ファイルを指定してからでないとユーティリティを呼び出すことはできません。

MAXSESS = max-sessions データベースにログオンできる最大FastExportセッション数です。

最大数の指定は0より大きく、システム上のAMPの合計数よりは小さくする必要があります。

デフォルトでは、AMPごとに1セッションです。

MINSESS = min-sessions

ジョブの実行に必要な最小FastExportセッション数です。

最小数の指定は0より大きくなっている必要があります。

デフォルト値は1です。

RVERSION バージョン番号を表示して停止します。
STATUS ON|OFF 5分間隔のステータス レポートです。

有効時はON(デフォルト)を、無効時はOFFを使用します。

ワークステーション接続システムの実行時パラメータ

次の表に、ワークステーション接続構成に対応したFastExport実行時パラメータをリストします。

実行時パラメータの説明(ワークステーション接続システム)
パラメータ 説明
< infilename ワークステーション接続クライアント システムでFastExportコマンドとTeradata SQL文が格納されている標準入力ファイルの名前です。

infilenameを指定すると、そこに標準入力(stdin)がリダイレクトされます。infilename指定を入力しないと、デフォルトはstdinになります。

> outfilename ワークステーション接続システムでFastExportメッセージに対応する標準出力ファイルの名前です。

outfilenameを指定すると、そこに標準出力(stdout)がリダイレクトされます。

outfilename指定を入力しないと、デフォルトはstdoutになります。

outfilename指定でstdoutをリダイレクトする場合は、その同じoutfilenameをROUTE MESSAGESコマンドで出力先またはエコー先として使用しないでください。そのようにすると、同一のファイルに対する書き込み操作で競合が生じるため、生成される結果は不完全なものとなります。
-b 縮小印刷出力の実行時パラメータです。FastExportの印刷出力を、ジョブの成否を判別するのに必要な最小限の情報だけに制限します。
-c character-set-name FastExportジョブの文字セットの指定。

文字セット名を指定できます。文字セットの指定はFastExportのジョブ全体にわたって有効です。このことは、データベースをリセットすることによってそのFastExportジョブが再始動された場合にもあてはまります。

  • クライアント システムに障害が発生した場合、またはFastExportジョブを取り消した場合、文字セットの指定はそれ以上有効ではなくなります。これらの場合、そのジョブの再実行依頼時には最初のジョブのときに使用したものと同じ文字セットを指定する必要があります。そのようなジョブを再実行依頼する場合に別の文字セットを指定すると、再始動したジョブがロードするデータは最初のジョブでロードしたデータと同じようには表示されません。

    文字セットの指定を入力しないと、FastExportは以下のCLIv2デフォルト ファイルに指定されているものを使用します。clispb.dat(ワークステーション接続のクライアント システムの場合)

    上記以外の場合、FastExportを呼び出す場合には必ずデータベースに指定した文字セットがデフォルトとなります。

  • ネットワークでUTF16クライアント文字セットを使用する場合、このクライアント文字セット名は実行時パラメータで指定する必要があります(つまり、c UTF16)。UTF16も有効な値になります。

    文字セットを指定するその他の方法については、文字セットの指定を参照してください。

-e filename FastExportエラー メッセージの代替ファイル指定です。

代替ファイル名を指定すると、FastExportのすべてのエラー メッセージの記録が二重に生成されます。この場合、ジョブが失敗した理由を知るために出力ストリーム全体を見る必要はありません。

エラー ログfilenameにはデフォルトの指定はありません。

-i scriptencoding ジョブ スクリプトのエンコーディング形式を指定します。

このパラメータは、UTF-16クライアント文字セットで使用するために導入されています。したがって、UTF-16クライアント文字セットが使用されている場合にのみ有効です。使用されているクライアント文字セットがUTF-16ではなく、パラメータが指定されている場合、FaxtExportはエラーを報告して終了します。

有効なエンコーディング オプションは次のとおりです。
  • UTF-8またはUTF8
  • UTF-16BE、UTF16-BE、UTF16BEのいずれか
  • UTF-16LE、UTF16-LE、UTF16LEのいずれか
  • UTF-16またはUTF16
  • UTF-8は、ジョブ スクリプトがUTF-8文字セットであることを示しています。
  • UTF-16は、ジョブ スクリプトがUTF-16文字セットで、エンディアンが指定されていないことを示しています。
  • UTF-16BEは、ジョブ スクリプトがビッグ エンディアンのUTF-16文字セットであることを示しています。
  • UTF-16LEは、ジョブ スクリプトがリトル エンディアンのUTF-16文字セットであることを示しています。または、UTF-16LEが指定されているが、スクリプト ファイルのUTF-16バイト オーダー マーク(Byte Order Mark: BOM)で、スクリプトがビック エンディアン形式であることが示されている場合、FaxtExportはエラーを報告して終了します。

UTF-16またはUTF-8 BOMは、スクリプト ファイル内にあっても無くてもかまいません。i実行時パラメータ(必須)を使用して入力スクリプト フォーマットを指定し、-c 実行時パラメータ(必須)を使用してセッション文字セットを指定して、確実にスクリプト ファイル内のBOMを適切に処理します。

UTF-16が指定され、スクリプト ファイルにUTF-16 BOMが含まれる場合、FaxtExportはUTF-16 BOMで示されたエンディアンに従ってスクリプトを解釈します。UTF-16 BOMが含まれない場合、FastExportはオプション値で示されたエンディアンに従ってスクリプトを解釈します。エンディアンがオプション値で提示されていない場合(すなわち、UTF-16BEまたはUTF-16LEの代わりにUTF-16が指定されている場合)、FastExportは、FastExportジョブが呼び出したクライアント システムのエンディアンに従ってUTF-16でジョブ スクリプトを解釈します。指定されたエンコーディング文字は、.RUN FILEコマンドに含まれるすべてのスクリプト ファイルに適用されます。

この実行時パラメータが指定されず、UTF-16クライアント文字が使用されている場合、FastExportはUTF-16でジョブ スクリプトを解釈します。UTF-8が指定されている場合、FastExportは、UTF-8でジョブ スクリプトを解釈し、さらにスクリプト内のSQL文とData Manipulation Language (DML: データ操作言語)文をUTF-8からUTF-16に変換してからデータベースに送信します。

-M max-sessions データベースにログオンできる最大FastExportセッション数です。

最大数の指定は0より大きく、システム上のAMPの合計数よりは小さくする必要があります。

デフォルトでは、AMPごとに1セッションです。

-N min-sessions ジョブの実行に必要な最小FastExportセッション数です。

最小数の指定は0より大きくなっている必要があります。

デフォルト値は1です。

-r 'fastexport command' FastExportジョブの開始を示す実施オプションです。

指定できるコマンドは1つだけなので、通常はFastExportジョブ スクリプトが格納されているファイルを指定するRUN FILEコマンドを指定します。

-s value 5分間隔のステータス レポートです。

valueには、レポートを有効にする場合はONを、無効にする場合はOFFを、それぞれ使用します。

-u outputencoding ジョブ出力のエンコーディング形式を指定します。

同パラメータは、UTF16クライアント文字セットで用いられます。したがって、UTF16クライアント文字セットが使用されている場合のみ有効です。使用されているクライアント文字セットがUTF-16ではなく、パラメータが指定されている場合、FaxtExportはエラーを報告して終了します。

有効なエンコーディング オプションは次のとおりです。
  • UTF-8またはUTF8
  • UTF-16BE、UTF16-BE、UTF16BEのいずれか
  • UTF-16LE、UTF16-LE、UTF16LEのいずれか
  • UTF-16またはUTF16

UTF-16BEは、FaxtExportに対して、ジョブ出力をビッグ エンディアンのUTF-16文字セットで行なうよう指示します。

UTF16-LEは、FaxtExportに対して、ジョブ出力をリトル エンディアンのUTF-16文字セットで行なうよう指示します。

ビッグ エンディアンのクライアント システムの場合、UTF-16は、FastExportに対して、ジョブ出力をビッグ エンディアンのUTF-16文字セットで行なうよう指示します。

リトル エンディアンのクライアント システムの場合、UTF-16は、FastExportに対して、ジョブ出力をリトル エンディアンのUTF-16文字セットで行なうよう指示します。

UTF-16 BOMは、以下のジョブ出力の一部として印刷されます。
  • UTF-16BE、UTF16-BE、UTF16BEのいずれか
  • UTF-16LE、UTF16-LE、UTF16LEのいずれか
  • UTF-16またはUTF16エンコーディング

パラメータを指定せず、使用されているクライアント文字セットがUTF-16の場合、ジョブ出力はUTF-16として行なわれます。

-y データ暗号化オプションの指定です。

実行時に指定すると、すべてのセッションが暗号化されます。

-V バージョン番号を表示して停止します。
オ各種オペレーティング システム プラットフォーム上でFastExportを呼び出すサンプルのJCLおよびコマンドについては、呼出しの例を参照してください。

実行時パラメータが重複して指定されている場合、最初に指定されているものが有効になります。残りのパラメータは省略され、警告メッセージ「UTY2430 Warning: Run time parameters detected and omitted (警告: 実行時パラメータが検出され、省略されました。)」が発行されます。