License
Configure how FastTransfer retrieves and uses its license file.
License Parameter
Use the --license parameter to specify the location or content of your FastTransfer license.
--licenseLong form only--license "<path_or_content>": a file path, an HTTP(S) URL or the license content itself.
By default, FastTransfer will try to use the license file named FastTransfer.lic in the same directory as the FastTransfer executable. You can specify a custom license file using the --license parameter.
License Sources
FastTransfer supports multiple ways to provide a license:
- 1. File path
- 2. HTTP(S) endpoint
- 3. License content (inline)
Specify a custom license file path:
.\FastTransfer.exe `
...
--license "C:\licenses\FastTransfer.lic" `
...
./FastTransfer \
...
--license "/path/to/licenses/FastTransfer.lic" \
...
Retrieve the license from a remote URL where you put the license content and distribute it using HTTPS:
.\FastTransfer.exe `
...
--license "https://licenseserve.yourdomain.lan/FastTransfer.lic" `
...
./FastTransfer \
...
--license "https://licenseserve.yourdomain.lan/FastTransfer.lic" \
...
Provide the license content directly. Using a variable or environment variable is recommended. Useful for Docker or Lambda deployment:
# Using environment variable
$env:FastTransfer_LICENSE = "LICENSE_CONTENT_HERE"
.\FastTransfer.exe `
...
--license $env:FastTransfer_LICENSE `
...
# Using variable
$license = Get-Content "C:\licenses\FastTransfer.lic" -Raw
.\FastTransfer.exe `
...
--license $license `
...
# Using environment variable
export FastTransfer_LICENSE="LICENSE_CONTENT_HERE"
./FastTransfer \
...
--license "$FastTransfer_LICENSE" \
...
# Using variable
license=$(cat /path/to/licenses/FastTransfer.lic)
./FastTransfer \
...
--license "$license" \
...
ADBC Driver License
The ADBC connection types (adbc_*) need an ADBC driver block in addition to the FastTransfer block. Keep both blocks in the same file and pass it with --license: FastTransfer hands the ADBC block to the drivers.
| Exit code | When |
|---|---|
| 99 | An adbc_* transfer without an ADBC driver block |
Complete Example
Here's a complete example using a license from a remote server with a database transfer:
| This example | |
|---|---|
| License | Retrieved from a remote UNC path |
| Source | A PostgreSQL database, orders from 2024 onwards |
| Target | A SQL Server database, loaded with bulk insert |
| Method | DataDriven parallel method with 4 threads, one chunk per month of order_date |
- Windows
- Linux
.\FastTransfer.exe `
--sourceconnectiontype "pgsql" `
--sourceserver "localhost" `
--sourcedatabase "production" `
--sourceuser "FastUser" `
--sourcepassword "FastPassword" `
--targetconnectiontype "msbulk" `
--targetserver "localhost" `
--targetdatabase "warehouse" `
--targettrusted `
--targetschema "dbo" `
--targettable "orders" `
--query "SELECT * FROM orders WHERE order_date >= '2024-01-01'" `
--parallelmethod DataDriven `
--distributekeycolumn "EXTRACT(MONTH FROM order_date)" `
--degree 4 `
--license "//SharedUnc/licenses/FastTransfer/FastTransfer.lic"
./FastTransfer \
--sourceconnectiontype "pgsql" \
--sourceserver "localhost" \
--sourcedatabase "production" \
--sourceuser "FastUser" \
--sourcepassword "FastPassword" \
--targetconnectiontype "msbulk" \
--targetserver "localhost" \
--targetdatabase "warehouse" \
--targettrusted \
--targetschema "dbo" \
--targettable "orders" \
--query "SELECT * FROM orders WHERE order_date >= '2024-01-01'" \
--parallelmethod DataDriven \
--distributekeycolumn "EXTRACT(MONTH FROM order_date)" \
--degree 4 \
--license "//SharedUnc/licenses/FastTransfer/FastTransfer.lic"
- ADBC Connectionsthe
adbc_*connection types and their license block - Installationwhere FastTransfer looks for
FastTransfer.lic