Skip to main content

Connection Parameters

FastTransfer requires connection information to access your database. This page covers all connection-related parameters.

Connection Type

Specify the type of database connection driver to use. This parameter determines how FastTransfer connects to your database.

./FastTransfer \
...
--connectiontype mssql \
...

Syntax:

  • Short form: -C "connection_type"
  • Long form: --connectiontype "connection_type"

Available Connection Types:

Connection TypeDescription
clickhouseClickHouse database
hanaSAP HANA database
mssqlMicrosoft SQL Server (default)
mysqlMySQL/MariaDB database
nzsqlIBM Netezza
odbcGeneric ODBC connection
oledbGeneric OLE DB connection
oraodpOracle Data Provider
pgcopyPostgreSQL with COPY protocol
pgsqlPostgreSQL standard connection
teradataTeradata database

DSN (Data Source Name)

If you have chosen an ODBC connection type, you must define the DSN with the -N or --dsn parameter, or alternatively define a connection string using -G or --connectionstring.

./FastTransfer \
...
--connectiontype odbc \
--dsn "MyODBCDataSource" \
...

Syntax:

  • Short form: -N "DSN_name"
  • Long form: --dsn "DSN_name"

Provider

If you have chosen an OLEDB connection type, you must define the OLEDB provider with the -P or --provider parameter.

./FastTransfer \
...
--connectiontype oledb \
--provider MSOLEDBSQL \
...
./FastTransfer \
...
--connectiontype oledb \
--provider NZOLEDB \
...

Syntax:

  • Short form: -P "provider_name"
  • Long form: --provider "provider_name"

Server

Except if you have defined a connection string (-G or --connectionstring), you must define a server (or could also be a TNS entry for Oracle).

Syntax:

  • Short form: -S "server"
  • Long form: --server "server"

Server Format Examples

The server parameter accepts different formats depending on your database:

IP address or DNS name:

./FastTransfer \
...
--server "myserver.mydomain.com" \
...

IP address or DNS name with port number:

./FastTransfer \
...
--server "myserver.mydomain.com:2433" \
...

or

./FastTransfer \
...
--server "myserver.mydomain.com,2433" \
...

IP address or DNS name with named instance:

./FastTransfer \
...
--server "myserver.mydomain.com\myinstance" \
...

For Oracle - Easy Connect string:

./FastTransfer \
...
--server "myserver.mydomain.com:1521/myinstance" \
...

Trusted or User & Password

Trusted

You can used a trusted (Windows or Kerberos Authentication) using the --trusted switch parameter.

./FastTransfer \
...
--server "myserver.mydomain.com\myinstance \
--trusted \
--database MySourceDB" \
...

User and Password

You can also provide a user and password the --user and --password can be used like this

./FastTransfer \
...
--server "myserver.mydomain.com\myinstance \
--user "FastUser" \
--password "FastPassword" \
--database MySourceDB" \
...

Connection String

Tips

You can use a connection string to define the connection to the database. This connection string will override any other connection parameters and can be used if the other authentication mode are not enougth for your case

You can use the connection string for any connection type. The connection string must be enclosed in double quotes.

Example:

./FastTransfer \
...
--connectionstring "Server=myserver;Database=mydb;User ID=FastUser;Password=FastPassword;Encrypt=True;TrustServerCertificate=True"
...

Syntax:

  • Short form: -G "connection_string"
  • Long form: --connectionstring "connection_string"

Database

Optionally define a source database.

Example:

./FastTransfer \
...
--database "AdventureWorks" \
...

Syntax:

  • Short form: -I "database_name"
  • Long form: --database "database_name"
Copyright © 2026 Architecture & Performance. Built with Docusaurus.