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

SQL Inserterオペレータの必須属性値を宣言するには、Teradata PTのDEFINE OPERATOR文で属性定義リスト構文を使用します。





構文規則:

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

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

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

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

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

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

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をログに出力しません。
  • 値なし、または属性指定の除外時は、事前定義の制限を使用します。最大32KのSQLを表示します(SQL全体が32K未満の場合)。 ログ対象のSQLが32Kを超える場合は、表示が最初の32KBに切り捨てられます。
MaxSessions = ‘maxSessions ログオンするセッションの最大数を指定する任意の属性。 MaxSessionsには、1以上の値を指定する必要があります。 1未満の値を指定すると、ジョブが終了されます。

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

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

  • 複数のセッションが使用されていて、プライマリ インデックス値が重複したデータがある場合は、データベース デッドロック2631エラーが発生する可能性があります。このエラーを回避するには、TPT SQL挿入オペレータで複数のセッションを使用しないようにします。
  • 複数のセッションが使用されていて、データがデータベース上の同じ行レベル ロックにアクセスすると、ジョブがハングする可能性があります。ハングを回避するには、TPT SQL挿入オペレータで複数のセッションを使用せずに、1つのセッションのみを使用するようにします。
MinSessions = ‘minSessions Stream オペレータ ジョブを継続するために最低限必要なセッション数を指定する任意の属性。

MinSessionsは、0よりも大きく、属性MaxSessionsで定義されている最大セッション数以下にする必要があります。

1未満の値を指定すると、ジョブが終了されます。

PrivateLogName = 'logName' Teradata PT Loggerによってパブリック ログ内部に保持されるログの名前を指定する任意の属性。 プライベート ログには、オペレータによる出力がすべて記録されます。

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

tlogview -j jobid -f privatelogname

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

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属性の値は、SQL Inserterオペレータのプライベート ログに表示されます。

QueryBandSessInfo属性の使用には、以下のルールが適用されます。
  • デフォルトでは、QueryBandSessInfo属性に有効な値が指定されるまで、クエリー バンドはオフになります。
  • QueryBandSessInfo属性に値が含まれている場合、SQL Inserterオペレータは、必要なSET QUERY BAND SQLを構成して、データベースにリクエストを伝達します。
  • SQL Inserterオペレータはクエリー バンド式をチェックせず、データベースに式をそのまま渡します。
  • ジョブを実行するデータベースのバージョンでクエリー バンド機能がサポートされていない場合、クエリー バンドは実行されません。 ただし、オペレータはエラーを無視してジョブの残りの部分を実行します。
  • クエリー バンド式に構文エラーがあると、データベースはエラーを返します。 すると、SQL Inserterオペレータはジョブを終了し、エラーをユーザーに報告します。
ReplicationOverride = ' option ' アクティブなセッションに対する通常のレプリケーション サービス制御を上書きする任意選択の属性。
有効な値は次のいずれかです。
  • ‘On’ = アクティブなセッションに対する通常のレプリケーション サービス制御を上書きします。
  • ‘Off’ = アクティブなセッションに関して、通常のレプリケーション サービスの上書きがオフになります(変更データの取得がアクティブな場合)。
  • ’None’ = (デフォルト)オーバーライドの要求はデータベースに送られません。

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

この属性に値を設定する際には、オペレータがログインで使用するユーザーIDにREPLCONTROL権限が付与されていなければなりません。
RemoveBOMFromFile = 'option' XML、JSON、またはCLOBのデータ ファイルの先頭でUTFバイト オーダー マーク(BOM)を探して削除するかどうかを指定する任意選択の属性。
有効な値は次のとおりです。
  • ’Y’または'Yes' = Inserterオペレータは、XML、JSON、またはCLOBのデータ ファイルの先頭にあるUTF BOMを検索して、BOMが存在する場合は処理前に削除します(デフォルト)。

    見つかったBOMがクライアントのUnicode文字セットでは無効な場合、このオペレータはエラー メッセージを表示して、ジョブを終了します。

    BOMが見つからない場合、Inserterオペレータは、エラー メッセージや警告メッセージをプライベート ログに記録したり、コンソールに表示したりすることなくファイルを処理します。

  • ’N’または'No' = Inserterオペレータは、UTF BOMを検索しません。

    Unicode文字セットにエンコーディングされているXML、JSONまたはCLOBのデータを、テーブル間で遅延モードで移動するときには、RemoveBOMFromFileを'No'に設定することを推奨します。 このようにすると、遅延モードで大量のデータ(例えば、100万行)を表に挿入するときのロード処理のパフォーマンスが向上します。

RemoveBOMFromFileは、次の2つの条件を満たしている場合にのみ使用できます。
  • ジョブ スキーマに、AS DEFERRED BY NAMEが定義されているXML、JSON、CLOBの列が1つ以上ある。
  • ロード ジョブのクライアント文字セットが、Unicode文字セットである。

この2つの条件が満たされていないと、この属性で指定した値は無視されます。

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' 挿入操作のデータベース マシン(非メインフレーム プラットフォーム)またはTDP(メインフレーム プラットフォーム)の名前を指定する任意の属性。

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

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

メインフレームでは、1文字のTdpIdがサポートされます。 1文字だけを指定すると、TDPで始まる4文字のTdpIdの略語とみなされます。
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' = オペレータ固有のアクティビティについてのトレース機能を有効にします。
  • '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パスを使用して文字を読み込むことができます。
UserPassword = 'password' ユーザー名に関連するパスワードを指定する属性。
一部の外部認証ログオン方式は、この属性の使用に対応していません。UserPasswordの指定要件の詳細については、<Teradata® Parallel Transporterユーザー ガイド, B035-2445>の「ログオン セキュリティ」を参照してください。
VARCHAR 定義済み属性のデータ型としてVARCHARを指定するキーワード。
WorkingDatabase = 'databaseName' ログオン データベース以外のデータベースをデフォルト データベースとして指定する任意の属性。

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

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