Skip to main content

Output Info

Configure where and how FastTransfer saves exported data.

Directory

Use the -D or --directory parameter to specify where the output file(s) will be saved.

Local Paths

.\\FastTransfer.exe \
...
--directory "C:\exports\sales\orders" \
...

UNC Paths

For Windows network shares, you can use UNC paths:

.\\FastTransfer.exe \
...
--directory "\\server\share\exports\orders" \
...

Cloud Paths

FastTransfer supports direct export to cloud storage:

./FastTransfer \
...
--directory "s3://my-bucket/exports/orders" \
...
Information

See Cloud Options for authentication and configuration details.

Syntax:

  • Short form: -D "path"
  • Long form: --directory "path"

Output File

Use the -o or --fileoutput parameter to specify the name of the output file. The file extension determines the output format.

./FastTransfer \
...
--fileoutput "orders.parquet" \
...

Syntax:

  • Short form: -o "filename"
  • Long form: --fileoutput "filename"

Supported Formats

ExtensionFormatDescription
.parquetParquetColumnar, compressed (recommended)
.csvCSVDelimiter-separated values
.tsvTSVTab-separated values
.jsonJSONJavaScript Object Notation
.bsonBSONBinary JSON
.xlsxExcelMicrosoft Excel format
.binBinaryPostgreSQL COPY binary format

Tokens

Use tokens in --directory and --fileoutput parameters for dynamic paths and filenames.

./FastTransfer \
...
--directory "/exports/{sourcedatabase}/{sourceschema}" \
--fileoutput "{sourcetable}_{startdate}.parquet" \
...

Syntax: Tokens are enclosed in curly braces {token_name}

Available Tokens

TokenDescriptionExample Value
{sourcedatabase}Value from --databaseAdventureWorks
{sourceschema}Value from --sourceschemaSales
{sourcetable}Value from --sourcetableOrders
{starttimestamp}Job start (yyyyMMddHHmmss)20260107143022
{starttimestamp:FORMAT}Custom timestamp formatSee below
{startdate}Job start date (yyyyMMdd)20260107
{starttime}Job start time (HHmmss)143022
{starthour}Job start hour (HH)14
{user}Username (from --user or system)dbuser
{filetype}Output format extensionparquet
{datadrivencolumn}Data-driven split valueVaries

Timestamp Format Codes

Use {starttimestamp:FORMAT} with custom format:

FormatDescriptionExample
yyyy4-digit year2026
yy2-digit year26
MMMonth (01-12)01
ddDay (01-31)07
HHHour 24h (00-23)14
mmMinute (00-59)30
ssSecond (00-59)22

Examples:

# yyyyMMdd format
./FastTransfer \
...
--fileoutput "orders_{starttimestamp:yyyyMMdd}.parquet" \
...

# yyyy-MM-dd format
./FastTransfer \
...
--fileoutput "orders_{starttimestamp:yyyy-MM-dd}.parquet" \
...

# yyyyMMddHH format (hourly)
./FastTransfer \
...
--fileoutput "logs_{starttimestamp:yyyyMMddHH}.parquet" \
...

Timestamped Output

Use the -x or --timestamped parameter to automatically add a timestamp to the filename.

./FastTransfer \
...
--fileoutput "orders.parquet" \
--timestamped \
...

Syntax:

  • Short form: -x
  • Long form: --timestamped
tip

--timestamped automatically appends _yyyyMMddHHmmss to the filename. For more control over format and placement, use timestamp tokens instead.

Encoding

Use the -e or --encoding parameter to specify character encoding for text formats (CSV, JSON, TSV).

./FastTransfer \
...
--fileoutput "orders.csv" \
--encoding "UTF-8" \
...

Syntax:

  • Short form: -e "encoding"
  • Long form: --encoding "encoding"

Default: UTF-8

note

Encoding is not applicable to Parquet files (they use UTF-8 internally).

Copyright © 2026 Architecture & Performance. Built with Docusaurus.