必須属性および任意属性 - Parallel Transporter

Teradata® Parallel Transporterリファレンス - 17.20

Product
Parallel Transporter
Release Number
17.20
Published
2022年10月10日
Language
日本語
Last Update
2022-11-21
dita:mapPath
ja-JP/rwr1645128188440.ditamap
dita:ditavalPath
ja-JP/obe1474387269547.ditaval
dita:id
B035-2436
Product Category
Teradata Tools and Utilities

Streamオペレータの必須および任意の属性値を宣言するためには、Teradata PTのDEFINE OPERATOR文で属性定義リスト構文を使用します。







ストリーム オペレータ4


構文規則:

構文要素 説明
AccountId = 'acctId' ユーザー名に関連するアカウントを指定する任意の属性。

この属性を省略すると、デフォルトでデータベースの直接所有者のアカウントIDが設定されます。

AppendErrorTable = ’option ストリーム オペレータが既存のエラー テーブルを使用するかどうかを指定する任意の属性。
有効な値は次のとおりです。
  • ’No’ = Streamオペレータは既存のエラー テーブルを使用しません(デフォルト)。
  • ’Yes’ = Stream オペレータは既存のエラー テーブルを使用するか、またはエラー テーブルが存在しない場合にエラー テーブルを作成します。

    エラー テーブルが存在する場合、Streamオペレータはそのテーブルの行数を表示します。

    既存のエラー テーブルの構造がStreamオペレータの必要とするエラー テーブルと適合しない場合は、Streamオペレータがエラー メッセージを表示してジョブを終了します。

デフォルトでは、エラー テーブルがすでに存在する場合はStreamオペレータがエラー メッセージを表示してジョブを終了します。

ジョブの再始動時は、エラー テーブルが存在していても、Streamオペレータがエラー メッセージを表示してジョブを終了することはありません。

ArraySupport = ’option ストリーム オペレータがジョブに対してArraySupport機能を使用するかどうかを指定する任意の属性。
有効な値は次のとおりです。
  • ’On’ = Streamオペレータはジョブ全体でArraySupportを使用します。
  • ’Off’ = StreamオペレータはArraySupportを使用しません。
ArraySupportの値が指定されていない場合でも、以下の基準が満たされていれば、配列サポートは有効であり、ストリーム オペレータはジョブ全体に対してこの機能を使用します。
  • データベースとCLIv2の両方で配列サポート機能がサポートされている。
  • DML文が単一のDML文またはAtomic UPSERT文である。
  • SerializeがOnの場合にはジョブ ステップに単一のDMLグループが含まれている必要がある。

これらの基準のいずれかが満たされていないと、デフォルト値は'Off'になり、StreamオペレータはArraySupportを使用しません。

ArraySupportの値が’On’に設定されており、データベースまたはTeradata CLIv2のいずれかで配列サポート機能がサポートされていない場合、Stream オペレータは致命的なエラーで終了します。

ARRAYSUPPORT DMLオプションがジョブのAPPLY文の一部として使用されていると、StreamオペレータのArraySupport属性に指定された値は、DMLの値によって上書きされます。

Buffers = buffers リクエスト バッファの数を増やすかどうかを指定する任意の属性。

値の範囲は、下限値が2で、上限値はありません。デフォルト値は3です。割振り可能なリクエスト バッファの最大数は、接続されたセッション数の倍数(Buffers * connected_sessions)になります。

リクエスト バッファはグローバル リソースであるため、バッファは必要に応じてあらゆるセッションに割り当てられ、その後解放プールに戻されます。セッションに割り当てられるリクエスト バッファの数は、どの時点でも、ゼロからBuffers * connected_sessionsの間で変化します。

CheckpointRowCount = ' option ' チェックポイントで送信された行の出力を有効または無効にするようStream オペレータに指示する任意の属性。
有効な値は次のとおりです。
  • ’No’(’N’) = Stream オペレータは、チェックポイントで送信された行を出力しません(デフォルト)。
  • ’Yes’(’Y’) = Stream オペレータは、チェックポイントで送信された行を出力します。

    この属性は、TPTスクリプトモードでのみ使用できます。

ConnectString = 'connectionString' 接続文字列を指定する任意選択の属性。この接続文字列はCLIに渡され、CLIが接続文字列を検証します。

接続文字列の詳細については、<Teradata® Call-Level Interface Version 2リファレンス - ワークステーション接続システム, B035-2418>を参照してください。

TPTの接続文字列機能は、z/OSの場合のTPTのTDPバリアントを除くすべてのプラットフォームで利用できます。
DataEncryption = 'option' SQLリクエスト、応答、およびデータを暗号化して完全なセキュリティを可能にする任意選択の属性。
有効な値は次のとおりです。
  • ’On’ = すべてのSQLリクエスト、応答、およびデータが暗号化されます。
  • ’Off’ = 暗号化されません(デフォルト)。
DateForm = 'option' Stream オペレータ ジョブのDATEデータ型を指定する任意の属性。値:
  • 'integerDate' = 整数のDATEデータ型(デフォルト)
  • 'ansiDate' = ANSI固定長のCHAR(10) DATEデータ型
DeleteLobDataFiles = 'option' 行がデータベースにコミットされたときに、Data Connector Producerから遅延LOBデータ ファイルを削除するかどうかを指定するオプションの属性。
'option'の有効な値は次のとおりです。
  • 'Yes'(または'Y') = 行がデータベースにコミットされたら、遅延モードLOBデータ ファイルを削除します。
  • 'No'(または'N') = 遅延モードLOBデータ ファイルを削除しません(デフォルト)。

これ以外の値を指定するとエラーになります。

DropErrorTable = 'option' ストリーム オペレータがジョブ終了時にエラー テーブルを削除するかどうかを指定する任意選択の属性。
有効な値は次のとおりです。
  • ’Yes’ = Stream オペレータはジョブ終了時にエラー テーブルが空の場合に削除します(デフォルト)。Teradata PTはDROP TABLE文を自動的に実行します。
  • ’No’ = Stream オペレータはジョブ終了時にエラー テーブルが空の場合でも削除しません。

    多数の小さな(短時間で終了する)ロード ジョブを定期的に実行する場合は、このようなジョブに対してDropErrorTableを’No’に設定することで、Vantageデータ ディクショナリに対する更新の回数が減少します。

    エラー テーブルが削除されない場合は、次のジョブの開始時にAppendErrorTableを’Yes’に設定することで、そのエラー テーブルを使用できます。

DropMacro = 'option' Stream オペレータにマクロを削除するか、将来使用するために維持するかどうかを指示する任意の属性。
VARCHAR DropMacro = '<Y[es]|N[o]>'

デフォルトでは、Streamオペレータは、成功したジョブの終了時にマクロを削除します。DropMacroの値がNまたはNoである場合、マクロに対してDROP MACRO文が発行されるまで、そのマクロはデータベースに残ったままです。保持されているマクロは、明示的に削除されるまでデータベースによって維持されるため、使用しなくなったマクロがないか定期的に確認して削除する必要があります。

ErrorLimit = limit Stream オペレータ ジョブを終了するまでにエラー テーブルに格納できるレコードの概数をデータベースで指定する任意の属性。

この数値が概数であるのは、Stream オペレータからデータベースに一度に複数のデータ行が送信されるからです。 エラー制限値を超えたことを示すメッセージをTeradata PTが処理するまでに、エラー制限値に指定された実際の数を上回るレコードがエラー テーブルにロードされている可能性があります。

ErrorLimitには、1以上の値を指定する必要があります。 無効な値を指定すると、Stream オペレータ ジョブは終了します。 デフォルトでは、ErrorLimit値は無制限です。

ErrorLimitの指定は、Streamオペレータの各インスタンスに適用されます。
ErrorTable = 'errorTableName' エラー テーブルの名前を指定する任意の属性。このテーブルには、データ変換エラー、制約違反、およびその他のエラー条件に関する情報が含まれています。

エラー テーブル名の先頭に修飾子としてデータベース名を付けます。 つまり、大きなサイズのPERM 領域が含まれるデータベースを指定した場合、この方法を使用すると、ロードに関係するテーブルを格納するすべてのデータベースのPERM領域を増やす必要がなくなります。

エラー テーブルのデータベースを指定しない場合、テーブルはユーザー ログオンに関連するデータベースに置かれます。

デフォルトでは、エラー テーブルは新規のテーブルでなければなりません。 このデフォルトは変更可能です。 AppendErrorTable属性を'Yes'または'Y'に設定すると、新規のエラー テーブルも既存のエラー テーブルも使用できるようになります。

Streamオペレータ ジョブを再始動する場合、またはAppendErrorTable属性を'Yes'または'Y'に設定してエラー テーブルを再使用する場合を除き、既存のテーブル名と重複する名前は使用しないでください。

テーブル名を指定しない場合、Spreamオペレータによってテーブル名が作成されます。

ユーザー提供のエラー テーブルの名前は、データベースでテーブル名に許容されている最大長を超えてはいけません。

LDILoadGroup = 'value' Stream オペレータにLDILoadGroup値を通知する任意の属性。

この値は、LDILoadJobが’Yes’(’Y’)に設定されている場合に必要です。

例えば、LDILoadGroup = ’Grp1’

LDILoadJob = 'option' 分離負荷機能を有効または無効にするようにストリーム オペレータに指示する任意選択の属性。
LDILoadJobの値は次のいずれかです。
  • ’No’(’N’) = 分離負荷なし(デフォルト)
  • ’Yes’(’Y’) = 分離負荷を要求します。Stream オペレータは、"BEGIN ISOLATED LOADING ON <target table(s)> USING QUERY_BAND 'LDILoadGroup=<...>;' IN MULTIPLE SESSION;"を送信します。複数のセッションでは、ターゲット テーブルが修飾されている場合、データベースへのリクエスト。ターゲット テーブルは、「すべての孤立したロード」として作成する必要があります。

    例:

    CREATE TABLE   testtable,
    	          FALLBACK,
    	          WITH ISOLATED LOADING FOR ALL
       (COL1       VARCHAR(5),
        COL2       VARCHAR(5));');
LDIMacroTableName = ['table1', 'table2' ... 定義済みマクロのLDIテーブル名を指定する任意の属性。事前定義されたマクロを使用する場合は、LDILoadJobが’Y[es]’に設定されており、LDILoadGroupが値で指定されている必要があります。
LogonMech = ' string ' 使用するログオン メカニズムを指定する任意選択の属性。
一部の認証方式では、この属性を指定することが必須であることがあります。この属性が8バイトを超えると、ジョブが終了します。

LogonMechの指定要件については、<Teradata® Parallel Transporterユーザー ガイド, B035-2445>の「ログオン セキュリティ」を参照してください。

LogonMechData = 'data' 追加のログオン メカニズム データを転送する任意の属性。
一部の外部認証方式では、この属性を指定することが必須です。LogonMechDataの指定要件については、<Teradata® Parallel Transporterユーザー ガイド, B035-2445>の「ログオン セキュリティ」を参照してください。
LogSQL = 'option' 対象ジョブのSQLの中でログに記録する数を制御する任意選択の属性。
有効な値は次のいずれかです。
  • 'Yes' = すべてのSQLをログに出力します。 最大長は1Mです。
  • 'No' = SQLをログに出力しません。
  • 値または属性が省略されていない = SQLのすべてが32 K未満の場合、最大32 KのSQLを表示する定義済みの制限を受け入れます。ログに記録されるSQLが32Kを超える場合は、最初の32 Kバイトに表示を切り捨てます。
LogTable = 'logTableName' チェックポイント情報の再起動ログ テーブルの名前を指定する任意選択の属性。再起動ログ テーブルは固有のテーブル名である必要があり、一時停止したジョブから再起動する場合以外は、存在してはなりません。

再始動ログ テーブルが存在しない場合、Streamオペレータが再始動ログを作成します。 再始動ログ テーブルが存在する場合、Streamオペレータは最後のチェックポイントから再始動します。 再始動ログ テーブルの指定に失敗すると、ジョブが終了されます。

再起動ログ テーブルで必要とされる権限は次のとおりです。
  • SELECT
  • INSERT
  • DELETE
再起動ログ テーブルが含まれているデータベースで必要とされる権限は以下のとおりです。
  • DROP
  • CREATE

Streamオペレータは、再始動ログ テーブルを自動的に保守します。 再始動ログ テーブルに少しでも手が加えられると、再始動機能は無効になります。

再始動ログ テーブルの名前を完全修飾しない場合、再始動ログ テーブルはユーザーのデフォルト(ログオン)のデータベースに作成されます。 WorkingDatabase属性を使用する場合は、再始動ログ テーブルをデフォルト(ログオン時)のデータベース内に置く予定であっても、再始動ログ テーブルの名前を完全修飾する必要があります。

MacroDatabase = 'dbName' Streamオペレータが使用するマクロが格納されるデータベースを指定する任意の属性。

デフォルトのマクロ データベースは、再始動ログ テーブルのデータベースです。

MaxSessions = maxSessions ログオンするセッションの最大数を指定する任意の属性。

MaxSessionsには、1以上の値を指定する必要があります。1未満の値を指定すると、ジョブが終了されます。

デフォルトは、オペレータ インスタンスごとに1セッションです。

メイン インスタンスが、インスタンスの数からStreamオペレータ セッションの均等配分を割り出します。 例えば、4つのインスタンスと16個のStreamオペレータ セッションがある場合、各インスタンスは4つのStreamオペレータ セッションにログオンします。

MinSessions = minSessions Stream オペレータ ジョブを継続するために最低限必要なセッション数を指定する任意の属性。

MinSessionsには、1以上およびStreamオペレータの最大セッション数以下の値を指定する必要があります。 1未満の値を指定すると、ジョブが終了されます。

デフォルトは1です。

NotifyExit = 'inmodName' _dynamnという名前のエントリ ポイントを持つユーザー定義の通知出口ルーチンの名前を指定する属性。 値を指定しない場合、次のデフォルト名が使用されます。
  • libnotfyext.dll for Windows platforms
  • Apple macOSプラットフォームの場合、libnotfyext.dylib
  • libnotfyext.so for all other UNIX platforms
  • NOTFYEXT for z/OS platforms

独自の通知出口ルーチンを指定する方法については、非推奨の構文を参照してください。

NotifyLevel = ' notifyLevel ' 特定のイベントをレポートするレベルを指定する任意の属性。 有効値は次のいずれかです。
  • 'Off' = イベントの通知は実行されません(デフォルト)。
  • 'Low' = 通知レベル「低」の欄に「あり」と表示されているイベントが通知されます。
  • 'Med' = 通知レベル「中」の欄に「あり」と表示されているイベントが通知されます。
  • 'High' = 通知レベル「高」の欄に「あり」と表示されているイベントが通知されます。
  • "Ultra’ = 通知レベル「超」の欄に「あり」と表示されているイベントが通知されます。
NotifyMethod = 'notifyMethod' イベントをレポートするためのメソッドを指定する任意の属性。メソッド:
  • 'None' = イベントをログに記録しません(デフォルト)。
  • 'Msg' = イベントをログに送ります。

    Windowsの場合、イベントはイベント ビューアで閲覧できるイベント ログに送られます。 メッセージはアプリケーション ログに送られます。

    Solaris、AIX、およびLinuxの各プラットフォームの場合、イベントの送り先は/etc/syslog.confファイルで指定された設定値に依存します。

    SLES11の場合、イベントの送り先は/etc/syslog-ng.confファイルで指定された設定値に依存します。

    z/OSシステムの場合、イベントはジョブ ログに送られます。

  • 'Exit' = イベントをユーザー定義の通知出口ルーチンに送ります。 行カウント情報は、4バイトの符号無し整数値になります。
  • 'Exit64' = イベントをユーザー定義の通知出口ルーチンに送ります。 行カウント情報は、次のイベントについては、8バイトの符号無し整数値になります。

    NMEventCkptBeg64

    NMEventCkptEnd64

    NMEventErrorTable64

    NMEventRunStats64

    NMEventImportEnd64

  • 'ExitEON' = イベントをユーザー定義の通知出口ルーチンに送ります。

    完全なTeradataオブジェクト名が、NMEventInitializeEONイベントの通知出口ルーチンに渡されます。

    また、ExitEONから8バイトの符号なし整数値の形式で行カウント情報が送信されます。

NotifyString = 'notifyString' システム ログに送られるすべてのメッセージの先頭に付加するユーザー定義文字列を指定する任意の属性。 この文字列は、ユーザー定義の通知出口ルーチンにも送られます。 文字列の最大長は次のとおりです。
  • NotifyMethodが'Exit'の場合、80バイト
  • NotifyMethodが'Msg'の場合、16バイト
OperatorCommandID = 'commandId' Streamオペレータの属性を使用してレートとRate値を指定できても、ジョブの実行が開始されるまでは、特定のジョブ ステップに最適な値が分からない可能性があります。 OperatorCommandIdを使用すると、twbcmdを使用してジョブの開始後に新しいレートまたは周期値を割り当てることができるStream オペレータの特定の参照を識別することができますtwbcmd:

APPLY指定内のオペレータの各コピーに対して、Teradata PTは、<operator object name> + <process Id>によって構成されるOperatorCommandIdのデフォルト値を生成します。 別の識別子を割り当てる必要がある場合は、以下のことを実行します。

Streamオペレータに対するDEFINE OPERATOR文内でoperatorCommandID属性を宣言します。

任意選択で、Streamオペレータの参照されたコピー内(APPLY文内)でOperatorCommandID属性に値を割り当てることができます。 値が割り当てられていない場合、Teradata PTはシステム生成値を提供します。 以下のように、レート値の変更が必要なジョブ ステップの番号をOperatorCommandIDの値として指定することが有用になる場合があります。

APPLY <dml1> TO OPERATOR ( Stream_Oper[2] ATTRIBUTES ( OperatorCommandID = ‘ratestep#1’)),
APPLY <dml2> TO OPERATOR ( Stream_Oper[3] ATTRIBUTES ( OperatorCommandID = ‘ratestep#2’)),

twbcmdユーティリティを使用して、特定のStreamオペレータのコピーにレートの値を割り当てます。

twbcmdユーティリティを使用したレート値の変更については、twbcmdを参照してください。

Pack = number 複文リクエストにパックするステートメント数を指定する任意の属性。最大値は2400です。デフォルト値は20です。
ジョブが1つ以上の遅延LOB/JSON/XML列を読み込んでいるとき、データベースはリクエストあたり4096のスプール ファイルをサポートできるため、可能な最大パック係数は4096です。
PackMaximum = 'option' Stream オペレータに現在のストリーム ジョブの最大可能パック係数を動的に判断するように要求する任意の属性。PackMaximum値:
  • 'No' ('N') = パックなし(デフォルト)
  • 'Yes'('Y')= 最大可能パック係数を決定します。
PauseLDI =' option' 分離負荷機能を一時停止するようにストリーム オペレータに指示する任意選択の属性。
PauseLDIの値は次のいずれかです。
  • ’No’ (’N’) = ストリーム オペレータは、"BEGIN ISOLATED LOADING ON <ターゲット テーブル> USING QUERY_BAND 'LDILoadGroup=<値>;';"が送信済みであれば、"END ISOLATED LOADING FOR QUERY_BAND 'LDILoadGroup=<値>;';"をデータベースに送信します。
  • 'Yes' ('Y') = ストリーム オペレータは、"END ISOLATED LOADING FOR QUERY_BAND 'LDILoadGroup=<値>;';"をデータベースに送信しません。
Periodicity = periodicity ストリーム オペレータによってデータベースに送信されるDML文を、1分間隔で可能な限り均等に分散するように指定するオプション。periodicityの値によって、1分あたりの部分間隔の数が設定されます。Periodicityを指定すると、システム リソースを整然と効率的に利用できるようになります。

例えば、次のように指定します。 ステートメントのレートが1600でRate値が10の場合、処理されるステートメントの最大数は、6(60/10)秒ごとに160(1600/10)ステートメントとなります。

Periodicity属性の使用には、以下の条件およびルールが適用されます。
  • 有効な値は1~600の整数です。
  • デフォルト値は4です。すなわち、1分あたり15秒の期間4回になります。
  • ステートメントのレートが無制限の場合、Periodicityの値は無視されます。
  • ユーザーは、ジョブの実行中にTeradata PTの外部コマンド インターフェース ユーティリティtwbcmdを使用してPeriodicityの値を変更できます。
PrivateLogName = 'logName' Teradata PT Loggerによってパブリック ログ内部に保持されるログの名前を指定する任意の属性。 プライベート ログには、Stream オペレータによる出力がすべて含まれます。

プライベート ログは、tlogviewコマンドを次のように使用すると表示できます。ここで、jobIdはTeradata PTのジョブ名を、privateLogNameはStream オペレータのPrivateLogName属性の値を示します。

tlogview -j jobid -f privatelogname

プライベート ログを指定しない場合、出力はすべてパブリック ログに格納されます。

デフォルトでは、診断トレース メッセージは生成されません。 診断トレース メッセージは、ユーザーがTraceLevel属性に有効な値を設定している場合にのみ生成されます。

tlogviewコマンドの詳細については、Teradata PTユーティリティのコマンドを参照してください。

QueryBandSessInfo = ’queryBandExpression ジョブ セッションの期間のクエリー バンドを指定する任意選択の属性。

queryBandExpressionは、セミコロンで区切られ、セミコロンで終了する、名前=値ペアのセットです。 ユーザーは、下記の例のようなクエリー バンド式を定義します。

‘org=Finance;load=daily;location=west;’

QueryBandSessInfoは、ARRAY属性として指定することもできます。

クエリー バンド式の作成規則については、Teradata Vantage™ - SQLデータ定義言語-構文規則および例, B035-1144およびTeradata Vantage™ - SQLデータ定義言語 - 詳細トピック, B035-1184を参照してください。

QueryBandSessInfo属性の値は、Streamオペレータのプライベート ログに表示されます。

QueryBandSessInfo属性の使用には、以下のルールが適用されます。
  • デフォルトでは、QueryBandSessInfo属性に有効な値が指定されるまで、クエリー バンドはオフになります。
  • QueryBandSessInfo属性に値が含まれている場合、Stream オペレータは、必要なSET QUERY BAND SQLを構成し、Stream オペレータのSQLセッションの一部として発行して、データベースにリクエストを伝達します。
  • Stream オペレータはクエリー バンド式をチェックせず、データベースに式をそのまま渡します。
  • ジョブを実行するデータベースのバージョンでクエリー バンド機能がサポートされていない場合、クエリー バンドは実行されません。 ただし、オペレータはエラーを無視してジョブの残りの部分を実行します。
  • クエリー バンド式に構文エラーがあると、データベースはエラーを返します。 すると、Streamオペレータはジョブを終了し、エラーをユーザーに報告します。
QueueErrorTable = 'option' エラー テーブルがキュー テーブルであるかどうかを指定する任意選択の属性。
有効な値は次のとおりです。
  • ’Yes’(’Y’) = エラー テーブルをキュー テーブルとして作成します。
  • ’No’(’N’) = エラー テーブルを非キュー テーブルとして作成します(デフォルト)。

この属性は、Streamストリームと、Streamオペレータ内のエラー テーブルに固有なものです。 この属性は、SELECTおよびCONSUMEデータベース オペレーション(行を返してそれを削除する)を使用しているときに発生したエラーを取得する際に特に便利です。 エラー テーブルをキュー テーブルとして使用することで、エラー テーブル内の行を削除する手間を省くことができます。

Rate = statementRate ストリーム オペレータがデータベースに1分あたりに送信できるDML文の最大数を指定するオプション。
Rate属性の使用には、以下の条件およびルールが適用されます。
  • ステートメントのレートは正の整数でなければなりません。
  • ステートメントのレートが指定されていない場合、レートは無制限になります。
  • ステートメントのレートがステートメントのパック係数の値よりも小さい場合、Streamオペレータは、パック係数よりも少ない数のリクエストを送信します。
  • ステートメントのレートが無効な場合、Streamオペレータは、エラー メッセージを表示し、戻りコード8で終了します。
  • 逐次化が使用されない場合: Packの値に達するまで、ストリーム オペレータはセッション入力“バケット”に連続的な行を追加する。次に、そのデータを送信し、セッション リスト内の次のセッションに進んで、新しい入力バケットへの入力を始める。ただし、文のRate/Periodicity(R/P)がPack係数より小さい場合、R/P数の行がセッション バケットに追加されてから、バケットの内容がデータベースに送信される。
  • 逐次化が使用される場合: serialization列のデータはハッシュされていて、結果の値は、データ行に対するセッションを選択するためのセッション リストのインデックスとして使用されている。そのため、逐次化を使用していて、R/PがPack係数より小さい場合、データベースに送信されるR/P数の行が複数のセッション間で分散される可能性がある。
  • ユーザーは、ジョブの実行中にTeradata PTの外部コマンド インターフェース ユーティリティtwbcmdを使用してステートメントのRate値を変更できます。
ReplicationOverride = ' option ' アクティブなセッションに対する通常のレプリケーション サービス制御を上書きする任意選択の属性。
有効な値は次のいずれかです。
  • ‘On’ = アクティブなセッションに対する通常のレプリケーション サービス制御を上書きします。
  • ‘Off’ = アクティブなセッションに関して、通常のレプリケーション サービスの上書きがオフになります(変更データの取得がアクティブな場合)。
  • ’None’ = 上書きのリクエストはデータベースに送られません(デフォルト)。

詳細については、<Teradata Replication Services Using Oracle GoldenGate>を参照してください。

この属性に値を設定する際には、オペレータがログインで使用するユーザーIDにREPLCONTROL権限が付与されていなければなりません。
Robust = 'option' 回復/再始動操作に堅固動作再始動ロジックを使用するかどうかを指定する任意選択の属性。

「堅固動作モード」では、リクエストが発行されるたびに1つのデータベース行が再始動ログ テーブルに書き込まれます。 再始動ログ テーブルにおけるこの行の集まりは、リクエスト ログと呼ぶことができます。リクエストは完全に終了するか完全にロールバックするかのどちらかであることがデータベースによって保証されているため、リクエスト ログには常にインポートの完了ステータスが正確に反映されます。

Robustの値は次のいずれかです。
  • 'Yes' ('Y') = 堅固動作再始動ロジックを使用する(デフォルト)。堅固動作モードでは、パックされたリクエストごとで、チェックポイントとチェックポイントの間にいくつかの「部分チェックポイント」行がログに書き込まれる。それらの行は、チェックポイントが書き込まれるたびに削除される。堅固動作回復モード時、Streamオペレータは、最後に記録されたチェックポイント以降、どれくらいの処理が完了したかを突き止める必要がある。これは、一連の「部分チェックポイント」をデータベースから読み取り直して整列し、ジョブが中断されたときに不完全なまま残されたトランザクションすべてを再処理することで達成される。
  • 'No' ('N') = 単純再始動ロジックを使用します(デフォルト)。 この場合、再始動を実行すると、Streamオペレータはジョブ内の最後のチェックポイントから処理を開始します。 チェックポイント後に発生した処理はすべて再実行されます。 この方法を使用すると、堅固動作ロジックにある追加のデータベース書き込みに余分なオーバーヘッドがかからりません。そのため、操作の結果を変更せずに繰り返すことができる特定のDML文に適しています。

堅固動作再始動ロジックを使用するかどうかが確かでない場合は、Robustパラメータを'Yes'に設定すると常に安全を確保できます。

RoleName = 'role name'

データベースにセキュリティを実装する任意の属性。オペレータの先頭には、"SET ROLE"の値が付加されます。構文は、次のようにデータベースに送信されます。

SET ROLE <role name>;

例:

SET ROLE All;

"SET ROLE"コマンドの使用の詳細については、<Teradata Vantage™ - SQLデータ定義言語-構文規則および例, B035-1144>を参照してください。

VARCHAR ARRAYを使用すると、複数の値を指定できます。以下に例を示します。

VARCHAR ARRAY RoleName = ['role name1', 'role name2'],

セッションが接続されると、オペレータはメイン コントロール セッションとデータSQLセッションでデータベースにリクエストを送信します。

  • オペレータはこの属性の値を検証せずに、そのままデータベースに渡し、データベースが値を検証します。検証が失敗すると、オペレータはそのジョブをエラーで終了します。
  • 値ではC形式のコメントが使用可能であり、そのコメントはデータベースに渡されます。
  • 値ではANSI形式のコメントはサポートされていません。値にANSI形式のコメントが含まれている場合、オペレータは構文エラーでジョブを終了することがあります。
  • セミコロンは値に使用できません。これは、オペレータがリクエストごとに1つのステートメントのみを許可するためです。値にセミコロンが含まれている場合に、オペレータはオペレータ エラーでジョブを終了します。
TdpId = 'dbcName' Streamオペレータ ジョブのデータベース マシン(非メインフレーム プラットフォーム)またはTDP(メインフレーム プラットフォーム)の名前を指定する任意の属性。

dbcNameは、最大256文字まで指定でき、ドメイン サーバー名を1つ指定できます。

TdpId属性に対して値を指定しない場合、オペレータは、システム管理者がユーザー用に設定したデフォルトのTdpIDを使用します。

TenacityHours = hours データベース上で最大数のセッションがすでに実行されている場合、Stream オペレータが継続的にログオンを試行する時間数を指定する任意の属性。

デフォルト値は4時間です。 Tenacity機能を有効にするためには、hoursに0以上の値を指定する必要があります。 0を指定すると、Tenacity機能は無効になります。 0未満の値を指定すると、Streamオペレータ ジョブが終了されます。

TenacitySleep = minutes データベース上で最大数のセッションがすでに実行されている場合、Stream オペレータ ジョブがログオン操作を再試行するまでに一時停止する分数を指定する任意の属性。

分数には0以上の値を指定する必要があります。1未満の値を指定すると、Stream オペレータはエラー メッセージを返してジョブを終了します。デフォルトは6分間です。

TimeZoneSessInfo = 'timeZoneValue' オペレータのジョブ セッションの期間にデフォルトのタイムゾーンの変位を変更できるようにする任意選択の属性。

この属性の値を指定すると、オペレータはSET TIME ZONE <timeZoneValue>; SQLリクエストを作成します。

セッションが接続されると、オペレータはメイン コントロール セッションとデータSQLセッションでデータベースにリクエストを送信します。

以下に例を示します。
  • 例1: 次の例では、セッションのデフォルトのタイムゾーン変位をシステム デフォルトのタイムゾーンであるLOCALに設定します。

    VARCHAR TimeZoneSessInfo = 'LOCAL'

  • 例2: 次の例では、セッションのデフォルトのタイムゾーン変位を、ログオンしているユーザーのデフォルトのタイムゾーンであるUSERに設定します。

    VARCHAR TimeZoneSessInfo = 'USER'

  • 例3: 次の例では、セッションのデフォルトのタイムゾーン変位を単純な定数タイムゾーン文字列式に設定します。

    VARCHAR TimeZoneSessInfo = '''America Pacific'''

    値内のどの単一引用符文字(')も、TPTジョブ スクリプトで2つの連続した単一引用符文字として入力する必要があります。これにより、正しい値がデータベースに送信されます。
  • オペレータはこの属性の値を検証せずに、そのままデータベースに渡し、データベースが値を検証します。検証が失敗すると、オペレータはそのジョブをエラーで終了します。
  • 値ではC形式のコメントが使用可能であり、そのコメントはデータベースに渡されます。
  • 値ではANSI形式のコメントはサポートされていません。値にANSI形式のコメントが含まれている場合、オペレータは構文エラーでジョブを終了します。
  • セミコロンは値に使用できません。これは、オペレータが "SET TIME ZONE SQL"リクエスト内で1つのステートメントのみを許可するためです。値にセミコロンが含まれている場合に、オペレータはオペレータ エラーでジョブを終了します。

SET TIME ZONE SQLについて詳しくは、Teradata Vantage™ - SQLデータ定義言語-構文規則および例, B035-1144を参照してください。

TraceLevel = 'level' オペレータの各インスタンスによってパブリック ログ(または、PrivateLogName属性で指定されている場合はプライベート ログ)に書き込まれる診断メッセージの種類を指定する任意の属性。 診断トレース機能は、ログ ファイルで詳細な情報を提供するため、問題の追跡や診断に役立ちます。 トレース レベルは次の通りです。
  • 'None' = トレース機能を無効にします(デフォルト)。
  • ’CLI’ = CLIに関連するアクティビティ(データベースとの対話)についてのトレース機能を有効にします。
  • 'PX' = Teradata PTインフラストラクチャに関連するアクティビティについてのトレース機能を有効にします。
  • 'Oper' = オペレータ固有のアクティビティについてのトレース機能を有効にします。
  • 'Notify' = 通知機能に関連するアクティビティについてトレース機能を有効にします。
  • 'All' = 上記すべてのアクティビティについてのトレース機能を有効にします。

VARCHAR ARRAYを使用すると、複数の値を指定できます。以下に例を示します。

VARCHAR TraceLevel = 'CLI'
VARCHAR TraceLevel = 'OPER'
VARCHAR ARRAY TraceLevel = [ 'CLI' ]
VARCHAR ARRAY TraceLevel = [ 'CLI', 'OPER' ]
TraceLevel属性は、診断を支援するためにのみ指定します。 この属性によって得られる追加情報の量とタイプは、ニーズの変化に合わせてリリースごとに変わります。
TransformGroup = 'transformgroupname' Teradata複合データ型(CDT)のアクティブな変換の変更をサポートする任意選択の属性。この値は<udt name> <transform group name>であり、オペレータが、ハードコードされた文字列"SET TRANSFORM GROUP FOR TYPE "を先頭に付加します。RDBMSに送信される構文は次のとおりです。
SET TRANSFORM GROUP FOR TYPE <udt name> <transform group name>;
例えば、次のように指定します。
"SET TRANSFORM GROUP FOR TYPE JSON CHARACTER SET LATIN TD_JSON_VARCHAR;"
VARCHAR ARRAYを使用すると、複数の値を指定できます。以下に例を示します。
VARCHAR ARRAY TransformGroup = ['JSON CHARACTER SET LATIN TD_JSON_VARCHAR', 'ST_GEOMETRY TD_GEO_VARCHAR'],

セッションが接続されると、オペレータはメイン コントロール セッションとデータSQLセッションでデータベースにリクエストを送信します。

  • オペレータはこの属性の値を検証せずに、そのままデータベースに渡し、データベースが値を検証します。検証が失敗すると、オペレータはそのジョブをエラーで終了します。
  • 値ではC形式のコメントが使用可能であり、そのコメントはデータベースに渡されます。
  • 値ではANSI形式のコメントはサポートされていません。値にANSI形式のコメントが含まれている場合、オペレータは構文エラーでジョブを終了することがあります。
  • セミコロンは値に使用できません。これは、オペレータがリクエストごとに1つのステートメントのみを許可するためです。値にセミコロンが含まれている場合に、オペレータはオペレータ エラーでジョブを終了します。
TreatDBSRestartAsFatal= ‘option データベースの再起動時にジョブを終了するかどうかをオペレータに指示する任意選択の属性。
TreatDBSRestartAsFatalの値は次のいずれかです。
  • ’No’(’N’) = データベースの再起動が発生した場合、オペレータは終了しない(デフォルト)。データベースの再起動は、再試行可能な処理として扱われます。
  • ’Yes'(’Y’) = データベースの再起動が発生した場合、オペレータは終了する。
UnicodePassThrough = ' value ' Unicode Pass Through機能を有効または無効にするようにオペレータに指示する任意選択の属性。
有効な値は次のいずれかです。
  • ’On’ = オペレータ内のUnicode Pass Through機能を有効にする。
  • ’Off’ = (デフォルト)オペレータ内のUnicode Pass Through機能を無効にする。
TPTジョブがUTF8またはUTF16のセッション文字セットを使用している場合、UnicodePassThrough属性を’On’に設定すると、オペレータはUnicodeパスを使用して文字を読み込むことができます。
UserName = 'userId' ユーザー名を指定する属性。
外部認証ログオン方式によっては、この属性と互換性がない場合があります。
UserPassword = 'password' ユーザー名に関連するパスワードを指定する属性。
外部認証ログオン方式によっては、この属性と互換性がない場合があります。
WorkingDatabase = 'databaseName' ログオン データベース以外のデータベースをデフォルト データベースとして指定する任意の属性。

この属性で指定されたデータベース名は、2つのSQLセッションを接続した直後にオペレータによって送られるTeradata SQL DATABASE文で使用されます。

WorkingDatabaseが指定されない場合、修飾されていないすべてのテーブル名において、ログオンしたユーザーに関連付けられたデフォルト データベースがWorkingDatabaseとみなされます。