Advanced Parameters

This section covers advanced configuration options for FastTransfer, including tracing, logging, and display settings.

Run ID

The Run ID parameter allows you to specify a custom identifier for tracing the transfer process. This is useful for correlating logs and tracking operations across systems.

Example:

./FastTransfer \
...
 --runid "transfer-2024-01-15-001" \
...

Syntax:

• Short form: -R "RunSpanID"
• Long form: --runid "RunSpanID"

Default Value: A random GUID is generated if not specified.

Tracing

Use a meaningful Run ID to make it easier to search logs and trace specific transfer operations, especially in production environments or when running multiple transfers.

Settings File

Specify a custom settings file for logging and other configuration options. This allows you to use different configuration profiles for different environments or scenarios.

Example:

./FastTransfer \
...
 --settingsfile "config/production-settings.json" \
...

Syntax:

• Short form: -O "file_path"
• Long form: --settingsfile "file_path"

Default Value: FastTransfer__settings.json in the same folder as the executable.

Configuration File

The settings file contains logging configuration, connection settings, and other advanced options. You can maintain separate configuration files for development, staging, and production environments.

Log Level

Override the log level defined in the settings file. This is useful for temporary debugging or troubleshooting without modifying the settings file.

Example:

./FastTransfer \
...
 --loglevel debug \
...

Syntax:

• Long form: --loglevel "level"

Allowed Values:

Log Level	Description
debug	Detailed debugging information
information	General informational messages (default)
warning	Warning messages for potentially harmful situations
error	Error messages for failures
fatal	Fatal error messages for critical failures

Default Value: information

Debugging

Use --loglevel debug when troubleshooting issues to get the most detailed logging output. Remember to switch back to information or warning for production use to avoid excessive log volume.

No Banner

Disable the FastTransfer banner display in the command line output. This is useful for scripting or when you want cleaner output in automated processes.

Example:

./FastTransfer \
...
 --nobanner \
...

Syntax:

• Long form: --nobanner

Clean Output

Using --nobanner is recommended when running FastTransfer from scripts or CI/CD pipelines where you want to minimize console output or parse the results programmatically.

Complete Example

Here's a complete example using advanced parameters:

Windows

.\FastTransfer.exe `
 --sourceconnectiontype "mssql" `
 --sourceserver "localhost" `
 --sourcedatabase "production" `
 --sourcetrusted `
 --targetconnectiontype "msbulk" `
 --targetserver "localhost" `
 --targetdatabase "warehouse" `
 --targettrusted `
 --targetschema "dbo" `
 --targettable "sales" `
 --query "select * from sales where order_date >= '2024-01-01'" `
 --runid "daily-sales-sync-2024-01-15" `
 --settingsfile "config/production-settings.json" `
 --loglevel information `
 --nobanner

Linux

./FastTransfer \
 --sourceconnectiontype "mssql" \
 --sourceserver "localhost" \
 --sourcedatabase "production" \
 --sourcetrusted \
 --targetconnectiontype "msbulk" \
 --targetserver "localhost" \
 --targetdatabase "warehouse" \
 --targettrusted \
 --targetschema "dbo" \
 --targettable "sales" \
 --query "select * from sales where order_date >= '2024-01-01'" \
 --runid "daily-sales-sync-2024-01-15" \
 --settingsfile "config/production-settings.json" \
 --loglevel information \
 --nobanner

This example:

• Uses a custom Run ID for tracing
• Loads configuration from a custom settings file
• Sets the log level to information
• Disables the banner for cleaner output