edit (Teradata Database) | Commands | Teradata Data Mover - 17.11 - edit - Teradata Data Mover

Teradata® Data Mover User Guide

Product
Teradata Data Mover
Release Number
17.11
Release Date
October 2021
Content Type
User Guide
Publication ID
B035-4101-091K
Language
English (United States)

Purpose

The edit command modifies an existing job definition. All previous job executions will be linked with the new job definition.

Parameters

See Parameter Order.

data_streams
[Optional] Number of data streams to use between the source and target databases. Applies to jobs that use Teradata DSA and TPT API (to and from Teradata). All other protocols use a single data stream.
Example: 4
The default value is dynamically calculated by Data Mover.
db_client_encryption
[Optional] Set to true if job needs to be encrypted during data transfer.
force_utility
[Optional] Forces the Data Mover daemon to use a specific utility for all copy operations.

Valid Values

  • dsa
  • jdbc
  • tptapi
  • tptapi_load
  • tptapi_stream
  • tptapi_update
  • T2T
If this value is not specified, the Data Mover daemon determines which Teradata utility is the best to use for the job.
Copying data to an older version of the Teradata Database using Teradata DSA is not valid. You cannot use Teradata DSA if the source and target TDPIDs are the same.
Example: dsa
job_name
Name of the job to be edited
Example: 12315DFHJKS
job_priority
[Optional] Specifies the execution priority for the job. Supported values are: HIGH, MEDIUM, and LOW, and UNSPECIFIED. If no value is specified, the default of MEDIUM is used at runtime.
Example: MEDIUM
log_level
[Optional] Log level for log file output.

Valid Values

  • 0
  • 1
  • 2
  • 99
Example: 2
The default value is 0.
max_agents_per_task
[Optional] Maximum number of Data Mover agents to use in parallel when moving tables or databases.
Example: 4
The default value is dynamically calculated by Data Mover.
netrace
[Optional] CLI netrace parameter. Any value greater than or equal to 0 generates a CLI trace log. Valid CLI value must be provided.
netrace_buf_len
[Optional] CLI netrace_buf_len parameter. Any value greater than or equal to 0 generates a CLI trace log. Valid CLI value must be provided.
online_archive
[Optional] Allows read and write access to the source table(s) while the tables are being copied with Teradata DSA. Updates occur to the source table during the copy, but are not transferred to the target table. After a successful copy, the data contained in the target table matches the data that was in the source table at the beginning of the copy.
Valid Values
Value Description
True Enables online archive
False Disables online archive
Unspecified Default – the value is set to the value in the Data Mover daemon configuration file
Example: true
overwrite_existing_objects
[Optional] Job overwrites objects that already exist on the target.
Valid Values
Value Description
True Enables overwriting
False Disables overwriting
Unspecified Default – the value is set to the value in the Data Mover daemon configuration file
If the parameter is not specified, the value is set to the overwrite_existing_objects parameter value in the Data Mover daemon configuration file. If the parameter is specified as true or false, that value takes precedence over the parameter value in the Data Mover daemon configuration file.
Example: true
query_band
[Optional] A semicolon-separated set of name-value pairs that uniquely identifies Teradata sessions or transactions for the source and target. To use a query band to identify the job payroll , the user ID aa100000 , and job session number 1122, define the query band as follows:
Example: Job=payroll;Userid=aa1000000;Jobsession=1122;
This parameter must be added as the last parameter in the XML job definition. See About Query Band for detailed syntax rules when defining a query band.
response_timeout
[Optional] Amount of time, in seconds, to wait for response from the Data Mover daemon.
Example: 60
security_password
[Optional] Password for the super user or authorized Viewpoint user.
Example: 53cUr17y
Required if security management is enabled on the Data Mover daemon. Not a valid parameter if -security_password_encrypted is also specified.
security_password_encrypted
[Optional] Encrypted password for the super user.
Example: 052c7aabd14c7770141ac3c0137ab98ae0d3f0f7cddf588981206b010c0c1b2f
Required if security management is enabled on the Data Mover daemon. Not a valid parameter if -security_password is also specified.
security_username
[Optional] User ID of the super user or authorized Viewpoint user. The user ID of the super user is dmcl_admin and cannot be changed.
Required if security management is enabled on the Data Mover daemon.
source_account_id
[Optional] Logon account ID for source database.
Spaces in the account name for the source or target account id causes the job to fail.
source_logon_mechanism
[Optional] Logon mechanism for source system. To log on to a source Teradata Database system, the user must provide at least one of the following:
  • source_user and source_password
  • source_logon_mechanism

Logon mechanisms are not supported for Teradata DSA jobs. Use logon mechanisms only for Teradata PT API and Teradata JDBC jobs. If -source_logon_mechanism is specified and -force_utility is not used, Teradata PT API is used by default. Specifying -source_logon_mechanism with Teradata DSA specified for -force_utility results in an error.

Example: KRB5
source_logon_mechanism_data
[Optional] Additional parameters needed for the logon mechanism of the source system.
Example: joe@domain1@@mypassword
source_password
[Optional] Source Teradata logon password.
Example: 123456789
Not a valid parameter if source_password_encrypted is also specified.
source_password_encrypted
[Optional] Source Teradata encrypted logon password.
Example: 17894cc84b5637a88e36fa37a010e3662d18f64b8ce204bef8d63868ad417810
Not a valid parameter if -source_password is also specified.
source_sessions
[Optional] Number of sessions per data stream on the source database.
Example: 4
The default value is dynamically calculated by Data Mover.
source_tdpid
[Optional] Source Teradata Database.
Example: Checks
source_user
[Optional] Source Teradata logon id.
Example: TD_API_user
source_userid_pool
[Optional] Job pulls the user from the specified credential pool. Available for any job type. Must use the same credential pool as target_userid_pool if specifying both parameters in the same job definition.
Example: POOL-1
target_account_id
[Optional] Logon account ID for target database.
Spaces in the account name for the source or target account id causes the job to fail.
target_logon_mechanism
[Optional] Logon mechanism for target system. To log on to a target Teradata Database system, the user must provide at least one of the following:
  • target_user and target_password
  • target_logon_mechanism

Teradata DSA does not support logon mechanisms. Use logon mechanisms only with Teradata PT API and Teradata JDBC jobs. If -target_logon_mechanism is specified and -force_utility is not used, Teradata PT API is used by default. Specifying -target_logon_mechanism with Teradata DSA specified for -force_utility results in an error.

Example: KRB5
target_logon_mechanism_data
[Optional] Additional parameters that are needed for the target system's logon mechanism.
Example: my@domain2@@mypassword
target_password
[Optional] Target Teradata logon password.
Example: 212133344
Not a valid parameter if -target_password_encrypted is also specified.
target_password_encrypted
[Optional] Target Teradata encrypted logon password.
Example: 30e458fce484cefef07724653f5046095208f69fcfbf76bf7290b8576192c2fe
Not a valid parameter if -target_password is also specified.
target_sessions
[Optional] Number of sessions per data stream on the target database.
Example: 4
The default value is dynamically calculated by Data Mover.
target_tdpid
[Optional] Target Teradata Database.
Example: Leo
target_user
[Optional] Target Teradata logon id.
Example: TD_tar_user
target_userid_pool
[Optional] Job pulls the user from the specified credential pool. Available for any job type. Must use the same credential pool as source_userid_pool if specifying both parameters in the same job definition.
Example: POOL-1
tpt_debug
[Optional] TPT API trace debug log parameter. Any value greater than or equal to 0 generates a TPT API trace log. Valid TPT API value must be provided.
uowid
[Optional] Alternate ID or name for the batch of work associated with the job. If you provide a value for this parameter, Data Mover reports this value as the unit of work ID when sending events to Teradata Ecosystem Manager or to its internal TMSMEVENT table. If you do not specify this parameter, Data Mover uses a default value as the unit of work ID when sending events to Teradata Ecosystem Manager or to its internal TMSMEVENT table. The default value for the unit of work ID is composed of the job execution name and the current timestamp. For example, if you want to define the origins of a query source the job execution name is sales_table, the default value of the unit of work ID is sales_table-20110115155656EST
Example: sales_tables_start

Usage Notes

If security is enabled and job_security is specified in the modified XML to change job owner, the user must be dcml_admin; if security is enabled and job_security is specified in the modified XML to change job permission, the user must be dcml_admin or the job owner, and the user must provide all the permissions, not just the modified permissions

Make sure the list of objects in the XML file contains all objects to be moved, not just the objects with name modifications. If an object specified in the original job is not included in the updated list, it is not removed from the new job definition. If no objects are listed, Data Mover assumes there are no updates to original object list.

XML File Example

For the edit command, type datamove edit -f parameters.xml.

The following example shows a parameters file for the edit command.
<?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"> 
<!-- source and target ip not provided, they will be retrieved from original job def --> 
    <job_name>job_name<job_name>    
    <source_user>dm12066</source_user> 
    <source_password>dbc</source_password> 
    <target_user>dm12066</target_user> 
    <target_password>dbc</target_password> 
<!-- The following are the object which are different from original job def --> 
<database selection="unselected"> 
    <name>dm12066</name> 
    <table selection="included"> 
        <name>fmt_inf</name> 
        <validate_row_count>ALL</validate_row_count> 
        <compare_ddl>true</compare_ddl> 
    </table> 
    <table selection="included"> 
        <name>NOPITab</name> 
        <validate_row_count>ALL</validate_row_count> 
        <compare_ddl>true</compare_ddl> 
    </table> 
    </database> 
        <views> 
            <view selection="included" copyData="true"> 
                <name>arrayTabView</name> 
                <database>dm12066</database> 
                <validate_row_count>partial</validate_row_count> 
                <compare_ddl>true</compare_ddl> 
                <sql_where_clause><![CDATA[ where c1 = 2]]></sql_where_clause> 
                <key_columns> 
                    <key_column>c1</key_column> 
                </key_columns> 
            </view> 
        </views> 
</dmEdit>