create - Teradata Data Mover

Teradata® Data Mover ユーザー ガイド

Product
Teradata Data Mover
Release Number
17.10
Published
2021年6月
Language
日本語
Last Update
2021-07-16
dita:mapPath
ja-JP/fcu1619423186706.ditamap
dita:ditavalPath
ja-JP/fcu1619423186706.ditaval
dita:id
B035-4101
Product Category
Analytical Ecosystem

目的

createコマンドは、構文パラメータとオブジェクト リストを使用して、デーモンに対してジョブを作成します。ジョブ定義は、パラメータとオブジェクト リストから構成されます。

構文

Data Mover 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
execute_permission
(オプション)作成したジョブの実行権限を持つユーザー名とロールを定義します。
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
freeze_job_steps
(オプション)ジョブ ステップを停止して、ジョブが開始されるたびに再作成されないようにします。ジョブが作成された後でソース環境とターゲット環境を変更しない場合にのみtrueに設定してください。
有効な値
  • true - ジョブが開始されるたびにジョブ ステップが再作成されることはありません
  • false - ジョブが開始されるたびにジョブ ステップが再作成されます
  • unspecified(デフォルト) - 値はfalseに設定されます
例: true
job_name
(オプション)このジョブの名前。最大32文字の一意の名前にする必要があります。
名前を指定しない場合、<source tdpid >_<target tdpid >_<date time year>のフォーマットで自動生成されます。
job_priority
(オプション)ジョブの実行優先順位を指定します。サポートされる値は、HIGH、MEDIUM、LOW、およびUNSPECIFIEDです。値を指定しないと、デフォルト値MEDIUMが実行時に使用されます。
例: MEDIUM
job_security
(オプション)作成したジョブのアクセス パラメータを定義します。
log_level
(オプション) ログ ファイル出力のログ レベル。

有効な値

  • 0
  • 1
  • 2
  • 99
例: 2
デフォルト値は0です。
log_to_event_table
(オプション) このジョブに使用するイベント テーブルを指定します。 詳細については、イベント テーブルの使用を参照してください。
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
owner_name
(オプション)ジョブを作成したユーザー。
例: owner
デーモン セキュリティがオフ、またはユーザーがスーパー ユーザー(dmcl_admin)の場合に設定します。設定しない場合、ログオンした実際のユーザーが値を上書きします。
read_permission
(オプション)作成したジョブの読み取り権限を持つユーザー名とロールを定義します。
response_timeout
(オプション) Data Moverデーモンからの応答を待機する時間(秒単位)。
例: 60
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_password_encrypted
(オプション) ソース データベースの暗号化されたログオン パスワード。
例: 17894cc84b5637a88e36fa37a010e3662d18f64b8ce204bef8d63868ad417810
-source_passwordも指定されている場合は、このパラメータは無効です。
source_sessions
(オプション) ソース データベースのデータ ストリームごとのセッション数。
例: 4
デフォルト値は、Data Moverによって動的に計算されます。
source_tdpid
ソース Teradata Database。
例: Checks
source_user
(オプション) ソース データベースのログオンID。
例: TD_API_user
このパラメータに対しログオンIDを指定しない場合、コマンドによって対話的に入力が要求されます。
ソースまたはターゲットIDのユーザー名にスペースがあると、ジョブに失敗します。
source_userid_pool
(オプション) ジョブによって、指定の資格情報プールからユーザーが取得されます。両方のパラメータを同じジョブ定義で指定する場合は、target_userid_poolと同じ資格情報プールを使用する必要があります。
例: POOL-1
table
(オプション) コピーするテーブル。
例: DB1.TABLE
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_logon_mechanism_data
(オプション) ターゲット システムのログオン メカニズムに必要な追加パラメータ。
例: my@domain2@@mypassword
target_password
(オプション) ターゲット データベースのログオン パスワード。
例: 212133344
-target_password_encryptedも指定されている場合は、このパラメータは無効です。このパラメータでパスワードを指定しないと、コマンドはログオンIDを対話的に入力するように要求します。入力内容は、パスワードの長さにかかわらず一連のアスタリスクで隠されます。
target_password_encrypted
(オプション) ターゲット データベースの暗号化されたログオン パスワード。
例: 30e458fce484cefef07724653f5046095208f69fcfbf76bf7290b8576192c2fe
-target_passwordも指定されている場合は、このパラメータは無効です。
target_sessions
(オプション) ターゲット データベースのデータ ストリームごとのセッション数。
例: 4
デフォルト値は、Data Moverによって動的に計算されます。
target_tdpid
(オプション)ターゲットTeradataデータベース。
例: Leo
target_user
(オプション) ターゲット データベースのログオンID。
例: TD_tar_User
このパラメータに対しログオンIDを指定しない場合、コマンドによって対話的に入力が要求されます。
ソースまたはターゲットIDのユーザー名にスペースがあると、ジョブに失敗します。
target_userid_pool
(オプション) ジョブによって、指定の資格情報プールからユーザーが取得されます。両方のパラメータを同じジョブ定義で指定する場合は、source_userid_poolと同じ資格情報プールを使用する必要があります。
例: POOL-1
tpt_debug
(オプション) TPT APIトレース デバッグ ログ パラメータ。0以上の値を指定すると、TPT APIトレース ログが生成されます。有効なTPT APIの値を指定する必要があります。
write_permission
(オプション)作成したジョブの書き込み権限を持つユーザー名とロールを定義します。

使用上の注意

datamove create -f parameters.xmlと入力してジョブを作成します。createコマンドが完了すると、ジョブ名が画面上に表示されます。このジョブ名は、stopコマンドやstartコマンドなどのその他のコマンドで使用するために覚えておいてください。

createコマンドでは、ジョブは開始されません。ジョブを開始するにはstartコマンドを、またジョブ スクリプトを確認するにはeditコマンドを使用してください。

XMLファイルの例

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

次の例は、createコマンドのパラメータ ファイルを示しています。
<?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>floyd_dmdev_create</job_name>
    <source_tdpid>floyd</source_tdpid>
    <source_user>dmguest</source_user>
    <source_password>please</source_password>
    <target_tdpid>dmdev</target_tdpid>
    <target_user>dmguest</target_user>
    <target_password>please</target_password>
    <data_streams>5</data_streams>
    <source_sessions>1</source_sessions>
    <target_sessions>1</target_sessions>
    <force_utility>dsa</force_utility>
    <log_level>0</log_level>
    <db_client_encryption>false</db_client_encryption>
    <database selection="unselected">
        <name>dmguest</name>
        <table selection="included">
            <name>test1</name>
            <db_client_encryption>true</db_client_encryption>
        </table>
        <table selection="included">
            <name>test2</name> 
        </table> 
        <table selection="included">
            <name>test3</name>
        </table>
    </database>
    <query_band>Job=payroll;Userid=aa1000000;Jobsession=1122;</query_band> 
    <job_security>
         <owner_name>owner</owner_name>
    <read_permission>
        <username>read_user1</username>
        <username>read_user2</username>
        <role>read_role1</role>
        <role>read_role2</role>
    </read_permission> 
    <write_permission>
        <username>write_user1</username>
        <username>write_user2</username>
        <role>write_role1</role>
        <role>write_role2</role>
    </write_permission>
    <execute_permission>
        <username>execute_user1</username>
        <username>execute_user2</username>
        <role>execute_role1</role>
        <role>execute_role2</role>
    </execute_permission> 
    </job_security>
</dmCreate>