17.00 - 開始 - Teradata Data Mover

Teradata® Data Mover ユーザー ガイド

Product
Teradata Data Mover
Release Number
17.00
Published
2021年11月
Content Type
ユーザー ガイド
Publication ID
B035-4101-030K-JPN
Language
日本語 (日本)

目的

startコマンドは、createコマンドで作成されたジョブを開始します。実行時にコマンドラインに入力することにより、本来使用されていたものとは異なるジョブ変数値を指定できます。 また、更新されたparameters.xmlファイルを提供することにより、コピーするオブジェクトのリストだけでなくジョブ変数値も変更できます。 デーモンのリソースが不足していてジョブを直ちに実行できない場合、ジョブは実行待ちになります。

パラメータ

パラメータの順序を参照してください。

data_streams
(オプション)ソース データベースとターゲット データベース間で使用するデータ ストリームの数を指定します。Teradata DSAおよびTPT API(Teradata間)を使用するジョブに適用されます。他のすべてのプロトコルでは、単一のデータ ストリームを使用します。
例: 4
デフォルト値は、Data Moverによって動的に計算されます。
db_client_encryption
(オプション)データ転送中にジョブを暗号化する必要がある場合は、trueに設定します。
dm.rest.endpoint
(オプション)実行時に別のRESTサーバーに接続する(その結果別のデーモンに接続する)ために、Data Mover RESTサーバー URLを入力して、commandline.propertiesファイルに指定されているデフォルト値を上書きします。
https://dm-server1:1443/datamover
force_utility
(オプション) Data Moverデーモンはすべてのコピー操作で特定のユーティリティを使用します。

有効な値

  • dsa
  • jdbc
  • tptapi
  • tptapi_load
  • tptapi_stream
  • tptapi_update
  • T2T
この値を指定しない場合、Data Moverデーモンは、ジョブでの使用に最適なTeradataユーティリティを決定します。
Teradata DSAを使用して古いバージョンのTeradata Databaseにデータをコピーすることはできません。ソースTDPIDとターゲットTDPIDが同じ場合は、Teradata DSAを使用できません。
例: dsa
job_name
開始するジョブの名前。
例: 12315DFHJKS
job_priority
(オプション)ジョブの実行優先順位を指定します。サポートされる値は、HIGH、MEDIUM、LOW、およびUNSPECIFIEDです。値を指定しないと、デフォルト値MEDIUMが実行時に使用されます。
例: MEDIUM
log_level
(オプション) ログ ファイル出力のログ レベル。

有効な値

  • 0
  • 1
  • 2
  • 99
例: 2
デフォルト値は0です。
max_agents_per_task
(オプション)テーブルまたはデータベースの移動時に同時に使用するData Moverエージェントの最大数。
例: 4
デフォルト値は、Data Moverによって動的に計算されます。
netrace
(オプション) CLI netraceパラメータ。0以上の値を指定すると、CLIトレース ログが生成されます。有効なCLIの値を指定する必要があります。
netrace_buf_len
(オプション) CLI netrace_buf_lenパラメータ。0以上の値を指定すると、CLIトレース ログが生成されます。有効なCLIの値を指定する必要があります。
online_archive
(オプション)Teradata DSAを使用してテーブルをコピーしている間の、ソース テーブルへの読み取りアクセスおよび書き込みアクセスを許可します。コピー中にソース テーブルが更新されても、その更新はターゲット テーブルには転送されません。コピーが成功した後、ターゲット テーブルに含まれるデータは、コピーの開始時のソース テーブル内のデータに一致します。
有効な値
説明
True オンライン アーカイブを有効にします
False オンライン アーカイブを無効にします
Unspecified デフォルト - この値はData Moverデーモン構成ファイルの値に設定されます
例: true
overwrite_existing_objects
(オプション) ジョブは、ターゲットに既に存在するオブジェクトを上書きします。
有効な値
説明
True 上書きを有効にします
False 上書きを無効にします
Unspecified デフォルト - この値はData Moverデーモン構成ファイルの値に設定されます
このパラメータを指定しないと、値はData Moverデーモン構成ファイルのoverwrite_existing_objectsパラメータ値に設定されます。trueまたはfalseに指定すると、値はData Moverデーモン構成ファイルのパラメータ値より優先されます。
例: true
query_band
(オプション) ソースおよびターゲットのTeradataセッションまたはトランザクションを一意に識別する、名前と値の組み合わせをセミコロンで区切ったセット。ジョブpayroll、ユーザーID aa100000、およびジョブ セッション番号1122を識別するクエリーバンドを使用するには、次のクエリーバンドを定義します。
例: Job=payroll;Userid=aa1000000;Jobsession=1122;
このパラメータは、最後のパラメータとして、XMLジョブ定義に追加する必要があります。クエリーバンドを定義するときの構文ルールの詳細については、クエリー バンドについてを参照してください。
response_timeout
(オプション) Data Moverデーモンからの応答を待機する時間(秒単位)。
例: 60
save_changes
(オプション)変更したジョブ変数値を保存し、それらを使用して、ジョブの作成時に定義された元の値を置き換えます。
security_password
(オプション)スーパー ユーザーまたは許可されたViewpointユーザーのパスワード。
例: 53cUr17y
Data Moverデーモンでセキュリティの管理が有効になっている場合に必須。 -security_password_encryptedも指定されている場合は、無効なパラメータになります。
security_password_encrypted
(オプション) スーパーユーザーの暗号化されたパスワード。
例: 052c7aabd14c7770141ac3c0137ab98ae0d3f0f7cddf588981206b010c0c1b2f
Data Moverデーモンでセキュリティの管理が有効になっている場合に必須。 -security_passwordも指定されている場合は、無効なパラメータになります。
security_username
(オプション)スーパー ユーザーまたは許可されたViewpointユーザーのユーザーID。スーパーユーザーのユーザーIDはdmcl_adminで、変更できません。
Data Moverデーモンでセキュリティの管理が有効になっている場合に必須。
source_account_id
(オプション) ソース データベースのログオン アカウントID。
ソースまたはターゲットIDのアカウント名にスペースがあると、ジョブに失敗します。
source_logon_mechanism
(オプション) ソース システムのログオン メカニズム。ソースTeradata Database システムにログオンする場合、ユーザーは少なくとも次のいずれかを入力する必要があります。
  • source_user および source_password
  • source_logon_mechanism

ログオン メカニズムは、Teradata DSAジョブではサポートされていません。ログオン メカニズムはTeradata PT APIジョブとTeradata JDBCジョブにのみ使用してください。-source_logon_mechanismを指定し、-force_utilityを使用しないと、デフォルトではTeradata PT APIが使用されます。-source_logon_mechanismを指定し、-force_utilityにTeradata DSAを指定すると、エラーが発生します。

例: KRB5
source_logon_mechanism_data
(オプション)ソース システムのログオン メカニズムに必要な追加のパラメータ。
例: joe@domain1@@mypassword
source_password
(オプション) ソース データベースのログオン パスワード。
例: 123456789
-source_password_encryptedも指定されている場合は、このパラメータは無効です。このパラメータでパスワードを指定しないと、コマンドはログオンIDを対話的に入力するように要求します。入力内容は、パスワードの長さにかかわらず一連のアスタリスクで隠されます。
source_sessions
(オプション) ソース データベースのデータ ストリームごとのセッション数。
例: 4
デフォルト値は、Data Moverによって動的に計算されます。
source_tdpid
(オプション)ソースTeradataデータベース。
例: Checks
source_user
(オプション) ソース データベースのログオンID。
例: TD_API_user
このパラメータに対しログオンIDを指定しない場合、コマンドによって対話的に入力が要求されます。
ソースまたはターゲットIDのユーザー名にスペースがあると、ジョブに失敗します。
sync
(オプション) ジョブの完了を待機してから、ジョブが正常に完了したことを示す終了コードを返します。終了コード0は、ジョブの正常な完了を示します。0以外の終了コードは、ジョブまたはコマンドのエラーを示します。
target_account_id
(オプション) ターゲット データベースのログオン アカウントID。
ソースまたはターゲットIDのアカウント名にスペースがあると、ジョブに失敗します。
target_logon_mechanism
(オプション) ターゲット システムのログオン メカニズム。ターゲットTeradataデータベース システムにログオンする場合、ユーザーは少なくとも次のいずれかを入力する必要があります。
  • target_user および target_password
  • target_logon_mechanism

ログオン メカニズムは、Teradata DSAではサポートされていません。ログオン メカニズムはTeradata PT APIジョブとTeradata JDBCジョブにのみ使用してください。-target_logon_mechanismを指定し、-force_utilityを使用しないと、デフォルトではTeradata PT APIが使用されます。-target_logon_mechanismを指定し、-force_utilityにTeradata DSAを指定すると、エラーが発生します。

例: KRB5
target_password
(オプション) ターゲット データベースのログオン パスワード。
例: 212133344
-target_password_encryptedも指定されている場合は、このパラメータは無効です。このパラメータでパスワードを指定しないと、コマンドはログオンIDを対話的に入力するように要求します。入力内容は、パスワードの長さにかかわらず一連のアスタリスクで隠されます。
target_sessions
(オプション) ターゲット データベースのデータ ストリームごとのセッション数。
例: 4
デフォルト値は、Data Moverによって動的に計算されます。
target_tdpid
(オプション)ターゲットTeradataデータベース。
例: Leo
target_user
(オプション) ターゲット データベースのログオンID。
例: TD_tar_User
このパラメータに対しログオンIDを指定しない場合、コマンドによって対話的に入力が要求されます。
ソースまたはターゲットIDのユーザー名にスペースがあると、ジョブに失敗します。
tpt_debug
(オプション) TPT APIトレース デバッグ ログ パラメータ。0以上の値を指定すると、TPT APIトレース ログが生成されます。有効なTPT APIの値を指定する必要があります。
uowid
(オプション) ジョブに関連付けられた作業バッチ用の代替IDまたは名前。このパラメータに値を設定すると、Data Moverによって、Teradata Ecosystem Managerまたはその内部TMSMEVENTテーブルにイベントが送信される際、この値は作業単位IDとして報告されます。このパラメータを指定しない場合、Teradata Ecosystem Managerまたはその内部TMSMEVENTテーブルにイベントが送信される際、デフォルト値が作業単位IDとして使用されます。作業単位IDのデフォルト値は、ジョブの実行名と現在のタイムスタンプで構成されます。例えば、ジョブの実行名がsales_tableであるクエリー ソースを定義した場合、作業単位IDのデフォルト値は、sales_table-20110115155656ESTになります。
例: sales_tables_start

使用上の注意

ジョブが開始されるたびに、新しいジョブ インスタンスがjob name-date time yearという名前で作成されます。この名前は、ジョブに固有の実行情報を識別するために、statusコマンドまたはログに表示されます。ジョブの開始後にジョブのステータスを監視するには、statusコマンドを使用します。

あるジョブのインスタンスが指定された全ステップを完了していない場合、そのジョブの新しいインスタンスは開始できません。デーモンのリソースが不足していてジョブを直ちに実行できない場合、ジョブは実行待ちになります。同じオブジェクトを、実行中または実行待ちの別のジョブとして同じターゲットにコピーすることはできません。

次に示す2つの方法のいずれかで、実行時にジョブ変数の新しい値を指定できます。
  • createコマンドを使用する場合と同様に、ジョブ変数の値をコマンドラインに直接指定する。例えば、job1のロギング レベルの値を99に設定するには、次のように入力します。 datamove start -job_name job1 -log_level 99
  • XMLファイルを変更し、startコマンドに送信することによって、createコマンドを使用する場合と同様に、ジョブ変数の新しい値を指定します。 datamove start -job_name job1 -f job1.xml

コピーするオブジェクトのリストを変更する場合は、XMLファイルを変更してサブミットすることでリストを変更する必要があります。この際、名前が変更されたオブジェクトだけでなく、コピーするすべてのオブジェクトがXMLファイルに含まれている必要があります。コピー対象として当初指定されていたオブジェクトがリストに含まれていない場合、そのオブジェクトはジョブの実行に含まれません。

デフォルトでは、実行時に指定するジョブ変数はいずれもジョブ定義に保存されません。このため、ジョブを再度実行すると、そのジョブはその元の設定に戻ります。今後も使用できるように、コマンドライン上またはファイルでsave changesパラメータを使用して新しいジョブ変数値を保存できます。例:
  • コマンドライン プロンプトでdatamove start -job_name job1 -log_level 99 -save_changesと入力します。
  • XMLファイルで次のものを指定します。<saveChanges>true</saveChanges>
    例に示すように、save changesパラメータの構文は、コマンド ラインで使用する場合とXMLファイルで使用する場合で異なります。
save changesが有効な場合、変更されたジョブ定義は新しいベース ジョブ定義として保存されます。ジョブ変数値を変更すると、ジョブ プランの再構築がトリガーされ、ジョブ ステップの停止オプションが有効になっている場合には上書きされます。現在の実行には、この新しいジョブ プランが使用されます。save changesが有効でない場合、ベース ジョブ定義は変更されません。ジョブ プランは再構築され、変更された変数が現在の実行で使用されますが、ベース ジョブ定義は変更されないまま、後続のすべての実行でベース ジョブ定義が使用されます。
セキュリティ設定は、一部のstartコマンド オプションに次のような影響を与えます。
  • セキュリティが有効になっている場合、save changesパラメータをtrueに設定するには、書き込み権限を所有している必要があります。
  • ジョブの所有者でないユーザーは、XMLでオブジェクト リストを指定する場合とstartコマンドを使用してそのリストをサブミットする場合に、ソースおよびターゲットのTeradataシステムにユーザー名とパスワードを入力する必要があります。
  • セキュリティが有効で、ジョブの権限を変更するために変更済みのXMLでjob_security指定されている場合、ユーザーはdcml_adminまたはジョブ所有者である必要があり、ユーザーは変更された権限だけでなく、すべての権限を提供する必要があります。job_ownerjob_securityで指定され、ユーザーがジョブ所有者を変更する場合、ユーザーはdcml_adminである必要があります。

XMLファイルの例

startコマンドの場合は、datamove start -f parameters.xmlと入力します。

次の例に表示されたXMLファイルは、DSAを使用してテーブルfmt_infおよびtest 1をターゲットにコピーするジョブtestStartを定義します。
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<dmCreate xmlns="http://schemas.teradata.com/dataMover/v2009" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:schemaLocation="http://schemas.teradata.com/unity/datamover.xsd"> 
    <job_name>testStart</job_name> 
    <source_tdpid>dmdev</source_tdpid> 
    <source_user>dmuser</source_user> 
    <source_password>dbc</source_password> 
    <target_tdpid>dm-daemon2</target_tdpid> 
    <target_user>dmuser</target_user> 
    <target_password>dbc</target_password> 
    <data_streams>1</data_streams> 
    <source_sessions>1</source_sessions> 
    <target_sessions>1</target_sessions> 
    <overwrite_existing_objects>TRUE</overwrite_existing_objects> 
    <freeze_job_steps>true</freeze_job_steps> 
    <force_utility>DSA</force_utility> 
    <log_level>1</log_level> 
    <online_archive>false</online_archive> 
    <database selection="unselected"> 
        <name>testdb</name> 
        <table selection="included"> 
            <name>fmt_inf</name> 
            <validate_row_count>ALL</validate_row_count> 
        </table> 
            <table selection="included"> 
                <name>test1</name> 
                <compare_ddl>true</compare_ddl> 
            </table> 
    </database> 
</dmCreate> 
次の例では、XMLファイルが変更されていて、名前がchangedParameters.xmlになっています。start -job_name testStart -f changedParameters.xml - force_utility tptapi -syncを実行し、TPTAPIを使用してテーブルtest3、およびテーブルfmt_inf内のi = 2であるレコードのみをターゲットにコピーすることができます。
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<dmEdit xmlns="http://schemas.teradata.com/dataMover/v2009" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:schemaLocation="http://schemas.teradata.com/unity/datamover.xsd">     
    <job_name>testStart</job_name> 
    <source_user>dmuser</source_user> 
    <source_password>dbc</source_password> 
    <target_user>dmuser</target_user> 
    <target_password>dbc</target_password> 
    <database selection="unselected"> 
        <name>testdb</name> 
        <table selection="included"> 
            <name>fmt_inf</name> 
            <validate_row_count>ALL</validate_row_count> 
            <compare_ddl>true</compare_ddl> 
            <sql_where_clause>
                <![CDATA[ where i = 2]]>
            </sql_where_clause> 
            <key_columns> 
                <key_column>i</key_column> 
            </key_columns> 
        </table> 
        <table selection="included"> 
            <name>test3</name> 
            <validate_row_count>ALL</validate_row_count> 
            <compare_ddl>true</compare_ddl> 
        </table> 
    </database> 
</dmEdit>