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 below
  • server - name or IP address of the database server
  • port - server port
  • database - database name, or the database file or folder for file-based databases
  • username and password - database credentials
  • charset - character set, for databases that need one
  • include_views - true to copy views as tables, false by default

Engines

engineDatabase
accessAccess
advantageSybase Advantage (source only)
cockroachdbCockroachDB
csvCSV
db2luwDB2 LUW
dbfDBF (dBase, FoxPro)
excelExcel
filemakerFileMaker (source only)
firebirdFirebird
greenplumGreenplum
ingresIngres
interbaseInterbase
jsonJSON
localdbLocalDB
mariadbMariaDB
mysqlMySQL
nexusdbNexusDB
nuodbNuoDB
odbcODBC
oracleOracle
paradoxParadox (source only)
pervasivePervasive PSQL
postgresPostgreSQL
progressProgress OpenEdge
quickbooksQuickBooks (source only)
siardSIARD
sqlazureAzure SQL Database
sqlbaseGupta SQLBase
sqlceSQL Server Compact
sqliteSQLite
sqlserverSQL Server
sybaseasaSybase SQL Anywhere
sybaseaseSybase Adaptive Server Enterprise
sybaseiqSybase IQ
verticaVertica
verticaodbcVertica ODBC
vistadbVistaDB

SSL and SSH

For databases that support them in the connection screen:

  • ssl_cert - client certificate file, ssl_cert_password - its password
  • use_ssh - true to connect through an SSH tunnel
  • ssh_server, ssh_port, ssh_username - the SSH host and user
  • ssh_authentication - password or key
  • ssh_password - for password authentication
  • ssh_keyfile, ssh_keyfile_password - for key file authentication

Database-specific parameters

Databases not listed here use the common parameters only.

Access

  • database - the .accdb or .mdb file
  • password - database password
  • access_sysdb, access_syslogin, access_syspassword - system database file and its credentials, for secured databases

Azure SQL Database, SQL Server, LocalDB

  • server - server name, SERVER\INSTANCE for a named instance, or the .database.windows.net address for Azure
  • database - database name, or the .mdf file for LocalDB
  • iswinauth - true for Windows authentication, false for username and password
  • sqlauthentication - full choice of authentication: Windows, SqlServer, AadPassword, AadIntegrated, AadMfa, AadManagedIdentity, AadServicePrincipal
  • netlib - network library for SQL Server: <default>, Named pipes, TCP/IP or Shared memory
  • encrypted - true to encrypt the connection
  • trust_server_certificate - true to accept the server certificate without validation

CSV

  • database - folder containing the files
  • first_row_columns - true when the first row holds the column names
  • csv_separator - the delimiter character, or [TAB]
  • csv_row_delimiter - the row delimiter, [NEW_LINE] by default

DBF

  • database - folder containing the files
  • dbf_target_version - Visual FoxPro or dBase 3, for a target connection

Excel

  • database - folder containing the files
  • first_row_columns - true when the first row holds the column names
  • excel_version - XLSX or XLS, for a target connection

Firebird, Interbase

  • database - the database file
  • sqldialect - 1 or 3
  • client_library - full path to the client DLL, when not the default
  • role - user role

JSON, NexusDB, Paradox

  • database - folder containing the files

ODBC, FileMaker, QuickBooks

  • odbcconnectmode - DSN or Connection string
  • dsn - the saved ODBC data source
  • odbcconnstring - the connection string, when not using a DSN

Oracle

  • oracledirect - true to connect directly, false to go through the Oracle Client
  • sid_mode - ServiceName or Sid
  • sid - the service name or SID
  • oracleconnectmode - Standard, SysDba or SysOper
  • encrypted and oracle_wallet_location - for wallet-based connections

SQL Server Compact

  • database - the .sdf file
  • max_db_size - maximum database size in MB

SQLite, VistaDB

  • database - the database file
  • password - database password, the encryption key for VistaDB

Sybase Advantage

  • database - folder with the data files in direct mode, or the .add file in client mode
  • advantagedirect - true for direct mode, false for the Advantage client
  • advantage_exclusive_lock - true to lock the tables exclusively

Sybase SQL Anywhere, Sybase IQ

  • sybaseservername - name of the database server
  • database - database name

SIARD

  • database - the .siard file
  • siard_description, siard_archiver, siard_archiver_contact, siard_data_owner, siard_data_origin_timespan - archive metadata
  • siard_lob_folder - folder for the large object files
  • siard_compression_level - Optimal, Fastest or No compression

If this was useful,
our newsletter will be too.

Get monthly insights on data engineering, AI, and building critical infrastructure - direct from the Spectral Core team and CEO Damir Bulic.