User Guide > Using Data Profiler Engine > Command Line Syntax and Usage
Was this helpful?
Command Line Syntax and Usage
The Data Profiler Engine is invoked from the command line using the dataprofiler command. The command line options for the Data Profiler Engine are listed in the following table and can be specified in any order.
Example syntax for running a Profile from the Engine:
C:\Users\currentuser>dataprofiler C:\mypath\myprofile.dp
Example syntax for running a Profile from the Engine and specifying a macrodef file:
C:\Users\currentuser>dataprofiler -mf C:\mypath\mymacrodef.json C:\mypath\myprofile.dp
 
Option
Short Name
Argument
Description
-debug
-d
N/A
Captures debug level messages in the log file.
-trace
-t
N/A
Captures trace information in the log file.
-ini-file
-i
Path
Allows users to set the path to the cosmos.ini file
-consoleLog
-cl
N/A
Send log messages to the console. By default, only error messages are logged to the console.
-statistics-only
-so
N/A
When used, this option causes the Profile to generate the STATS_TARGET only. The other target files from the Profile (PASS_TARGET, FAIL_TARGET, DRILLDOWN_TARGET) will not be generated.
-help
-h
N/A
Prints the contents of the help file and exits.
-version
-v
N/A
Prints version information, Java version, and license information of the Data Profiler Engine and exits.
-logfile
-l
File name
Sets/overwrites the log file used in the Profile.
-macro-file
-mf
File name
Set the macrodef file used by the Profile.
-macro
-m
Name = value
Defines a new macro. This option will override macros that are used within the Profile.
Example: -m myMacro = C:\temp
-stats-file
-sf
File name
Sets the STATS_TARGET file in the Profile. This option will override the STATS_TARGET file specified in the Profile.
-source-dataset
-sd
File name
Sets the source dataset used in the Profile. When used, an existing .dataset file (found in UDConnections folder) must be referenced with this option. This option will override the source dataset used in the Profile.
-pass-dataset
-pd
File name
Sets the PASS_TARGET dataset used in the Profile. When used, an existing .dataset file (found in UDConnections folder) must be referenced with this option. This option will override the PASS_TARGET dataset used in the Profile.
-fail-dataset
-fd
File name
Sets the FAIL_TARGET dataset used in the Profile. When used, an existing .dataset file (found in UDConnections folder) must be referenced with this option. This option will override the FAIL_TARGET dataset used in the Profile.
-drilldown-file
-dd
File name
Sets the DRILLDOWN_TARGET file in the Profile. This option will override the DRILLDOWN_TARGET file specified in the Profile.
 
Last modified date: 02/01/2024