XRMigrationTool Syntax | VantageCloud Lake - XRMigrationTool Syntax - Teradata VantageCloud Lake

Lake - Using Queries, UDFs, and External Stored Procedures

Deployment
VantageCloud
Edition
Lake
Product
Teradata VantageCloud Lake
Release Number
Published
February 2025
ft:locale
en-US
ft:lastEdition
2025-08-12
dita:mapPath
vgj1683671089901.ditamap
dita:ditavalPath
pny1626732985837.ditaval
dita:id
vgj1683671089901

XRMigrationTool Syntax

XRMigrationTool {-d input_dir -o output_dir -s source_dir -t pat_token -p key_path | -h}

XRMigrationTool Syntax Elements

-d input_dir
--Input_Dir
Required
The directory where the SQL script (for example, a BTEQ file) and the Migration Tool config file are stored.
XRMigrationTool updates the SQL script to replace CREATE FUNCTION, REPLACE FUNCTION, CREATE PROCEDURE, and REPLACE PROCEDURE syntax with calls to tdextroutine.
XRMigrationTool looks for the config.yml file in this directory. See Migration Tool Config File.
-o output_dir
--Output_Dir
Required
XRMigrationTool creates a subdirectory named SQLToPayload in the output directory to store the generated manifest files.
-s source_dir
--Source_Dir
Required
The single directory where the source files are stored for all the SQL scripts. There should not be any subfolders under the directory containing source files.
-t pat_token
--Pat_Token
Optional
Personal Access Token (PAT) for authentication. The tdextroutine calls require PAT for user authentication.
-p key_path
--Key_Path
Optional
Path to the private key file used to generate PAT.
-h
--help
Displays information on how to use XRMigrationTool.