cleanup | Commands | Teradata Data Mover - 17.11 - cleanup - 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 cleanup command cleans up Teradata DSA, Teradata PT API, and Teradata JDBC tasks from a job that failed or was stopped before completing successfully. The command deletes staging, error, work, and log tables and releases HUT locks, depending on the underlying utility used for the job.

Parameters

See Parameter Order.

dm.rest.endpoint
[Optional] Enter a Data Mover REST server URL to overwrite the default value specified in the commandline.properties file in order to connect to a different REST server (and therefore a different daemon) at runtime.
https://dm-server1:1443/datamover
job_name
Name of the job to be cleaned up.
Example: 12315DFHJKS
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.

Usage Notes

The following information is specific to the type of job running cleanup:
  • Teradata DSA – a DSA stop command is issued for the running job and DSMAIN stops the job and releases any locks.
  • Teradata PT API – existing target log, work, error, and staging tables are dropped.
  • Teradata JDBC – existing target staging tables are dropped.

The cleanup command only cleans up job instances that are not currently running. To clean up a currently running job, stop the job and then run cleanup.

XML File Example

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

In the following example, the parameters file cleans up database artifacts that are left by the stopped or failed job 12315DFHJKS:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<dmCleanup
	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>12315DFHJKS</job_name>
</dmCleanup>