CONSOLE
Connection overrides
The -OSC and -OTC switches override the source and target connection with parameter=value pairs separated by semicolons:
-OTC "server=db2.example.com;database=adventureworks_test;password=secret"Parameter names are case-insensitive. Only the parameters you list change, the rest stays as saved in the project. When running without a project file, engine is required on both sides.
Common parameters
engine- the database type, from the table belowserver- name or IP address of the database serverport- server portdatabase- database name, or the database file or folder for file-based databasesusernameandpassword- database credentialscharset- character set, for databases that need oneinclude_views-trueto copy views as tables,falseby default
Engines
engine | Database |
|---|---|
access | Access |
advantage | Sybase Advantage (source only) |
cockroachdb | CockroachDB |
csv | CSV |
db2luw | DB2 LUW |
dbf | DBF (dBase, FoxPro) |
excel | Excel |
filemaker | FileMaker (source only) |
firebird | Firebird |
greenplum | Greenplum |
ingres | Ingres |
interbase | Interbase |
json | JSON |
localdb | LocalDB |
mariadb | MariaDB |
mysql | MySQL |
nexusdb | NexusDB |
nuodb | NuoDB |
odbc | ODBC |
oracle | Oracle |
paradox | Paradox (source only) |
pervasive | Pervasive PSQL |
postgres | PostgreSQL |
progress | Progress OpenEdge |
quickbooks | QuickBooks (source only) |
siard | SIARD |
sqlazure | Azure SQL Database |
sqlbase | Gupta SQLBase |
sqlce | SQL Server Compact |
sqlite | SQLite |
sqlserver | SQL Server |
sybaseasa | Sybase SQL Anywhere |
sybasease | Sybase Adaptive Server Enterprise |
sybaseiq | Sybase IQ |
vertica | Vertica |
verticaodbc | Vertica ODBC |
vistadb | VistaDB |
SSL and SSH
For databases that support them in the connection screen:
ssl_cert- client certificate file,ssl_cert_password- its passworduse_ssh-trueto connect through an SSH tunnelssh_server,ssh_port,ssh_username- the SSH host and userssh_authentication-passwordorkeyssh_password- for password authenticationssh_keyfile,ssh_keyfile_password- for key file authentication
Database-specific parameters
Databases not listed here use the common parameters only.
Access
database- the.accdbor.mdbfilepassword- database passwordaccess_sysdb,access_syslogin,access_syspassword- system database file and its credentials, for secured databases
Azure SQL Database, SQL Server, LocalDB
server- server name,SERVER\INSTANCEfor a named instance, or the.database.windows.netaddress for Azuredatabase- database name, or the.mdffile for LocalDBiswinauth-truefor Windows authentication,falsefor username and passwordsqlauthentication- full choice of authentication:Windows,SqlServer,AadPassword,AadIntegrated,AadMfa,AadManagedIdentity,AadServicePrincipalnetlib- network library for SQL Server:<default>,Named pipes,TCP/IPorShared memoryencrypted-trueto encrypt the connectiontrust_server_certificate-trueto accept the server certificate without validation
CSV
database- folder containing the filesfirst_row_columns-truewhen the first row holds the column namescsv_separator- the delimiter character, or[TAB]csv_row_delimiter- the row delimiter,[NEW_LINE]by default
DBF
database- folder containing the filesdbf_target_version-Visual FoxProordBase 3, for a target connection
Excel
database- folder containing the filesfirst_row_columns-truewhen the first row holds the column namesexcel_version-XLSXorXLS, for a target connection
Firebird, Interbase
database- the database filesqldialect-1or3client_library- full path to the client DLL, when not the defaultrole- user role
JSON, NexusDB, Paradox
database- folder containing the files
ODBC, FileMaker, QuickBooks
odbcconnectmode-DSNorConnection stringdsn- the saved ODBC data sourceodbcconnstring- the connection string, when not using a DSN
Oracle
oracledirect-trueto connect directly,falseto go through the Oracle Clientsid_mode-ServiceNameorSidsid- the service name or SIDoracleconnectmode-Standard,SysDbaorSysOperencryptedandoracle_wallet_location- for wallet-based connections
SQL Server Compact
database- the.sdffilemax_db_size- maximum database size in MB
SQLite, VistaDB
database- the database filepassword- database password, the encryption key for VistaDB
Sybase Advantage
database- folder with the data files in direct mode, or the.addfile in client modeadvantagedirect-truefor direct mode,falsefor the Advantage clientadvantage_exclusive_lock-trueto lock the tables exclusively
Sybase SQL Anywhere, Sybase IQ
sybaseservername- name of the database serverdatabase- database name
SIARD
database- the.siardfilesiard_description,siard_archiver,siard_archiver_contact,siard_data_owner,siard_data_origin_timespan- archive metadatasiard_lob_folder- folder for the large object filessiard_compression_level-Optimal,FastestorNo compression
