Connection overrides

Common parameters

  • - engine - access/mysql/sqlserver/postgres...

 

List of supported engines (database types)

engine parameter name of the database type
access Access
cockroachdb CockroachDB
csv CSV
dbf DBF (dBase,FoxPro)
excel Excel
firebird Firebird
greenplum Greenplum
interbase Interbase
localdb LocalDB
mariadb MariaDB
mysql MySQL
nexusdb NexusDB
nuodb NuoDB
odbc ODBC
pervasive Pervasive PSQL
postgres PostgreSQL
redshift Amazon RedShift
siard SIARD
sqlazure Azure SQL Database
sqlce SQL Server Compact (SQLCE)
sqlite SQLite
sqlserver SQL Server
verticaodbc Vertica ODBC
vistadb VistaDB
advantage Sybase Advantage
filemaker FileMaker
paradox Paradox
quickbooks QuickBooks

 

Relational database connection parameters

  • - database - folder containing data files
  • - server - name or IP address of the database server
  • - port - server port used to connect
  • - username - database user
  • - password - user's password
  • - include_views - include views in data copy or replication projects; "true" or "false" (default)

ODBC connection parameters

  • - odbcConnectMode - should we use saved ODBC connection or specify a connection string directly? (DSN/Connection string)
  • - dsn - saved ODBC connection
  • - odbcConnString - connection string
  • - username - database user
  • - password - user's password

Access

  • - database - ACCDB or MDB database file
  • - password - database password
  • - access_sysdb - system database file
  • - access_syslogin - system database username
  • - access_syspassword - system database password

Azure SQL Database

  • - server - full path to the database in the cloud (database-identifier.database.windows.net)
  • - username - database user
  • - password - user's password
  • - database - name of Azure database
  • - encrypted - true if connection should be encrypted
  • - trust_server_certificate - true if we should trust server certificate

CSV

  • - database - folder containing data files
  • - charset - character set used to encode data
  • - csv_separator - separator character

List of available charsets: "(autodetect)", "UTF8", "UTF32", "1250", "1251", "1252", "1253", "1254", "1255", "1256", "1257", "1258", "437", "737", "720", "775", "850", "852", "855", "857", "858", "861", "862", "866", "932"

DB2

  • - standard relational connection parameters, listed on top of this page

DBF (Clipper, dBase, FoxBase, Visual FoxPro)

  • - database - folder containing data files
  • - charset - character set

Derby

  • - database - folder containing data files

Excel

  • - database - folder containing data files
  • - first_row_columns - first row contains column names (true/false)
  • - excel_version - XLSX or XLS (only for the target connection)

FileMaker

  • - standard ODBC connection parameters, listed on top of this page

Firebird

  • - standard relational connection parameters, listed on top of this page
  • - sqlDialect - database dialect (1 or 3)
  • - charset - character set used to encode data
  • - client_library - full path to FBCLIENT.DLL
  • - role - user role

Gupta

  • - standard relational connection parameters, listed on top of this page

H2

  • - database - full path to database file, without .mv.db extension
  • - username - database user
  • - password - user's password

HSQLDB

  • - database - full path to database file, without extension
  • - username - database user
  • - password - user's password

Informix

  • - standard ODBC connection parameters, listed on top of this page 

Ingres

  • - standard relational connection parameters, listed on top of this page

Interbase

  • - standard relational connection parameters, listed on top of this page
  • - sqlDialect - database dialect (1 or 3)
  • - charset - character set used to encode data
  • - client_library - full path to GDS32.DLL or IBCLIENT64.DLL, depending on application architecture
  • - role - user role

SQLExpress LocalDB

  • - database - full path to .MDF database file
  • - isWinAuth - true if Windows authentication is to be used, false if username/password combination
  • - username - database user
  • - password - user's password

MySQL & MariaDB

  • - standard relational connection parameters, listed on top of this page

NexusDB

  • - database - folder containing data files
  • - username - database user
  • - password - user's password

ODBC

  • - standard ODBC connection parameters, listed on top of this page

Oracle

  • - oracleDirect - true if connecting directly, false if connecting via Oracle Client (OCI)
  • - sid_mode - service_name/sid
  • - oracleConnectMode - authentication mode (Default/SysDba/SysOper)
  • - database - folder containing data files
  • - server - name or IP address of the database server
  • - port - server port used to connect
  • - username - database user
  • - password - user's password

Oracle RDB

  • - standard relational connection parameters, listed on top of this page

Paradox

  • - database - folder containing data files
  • - charset - character set

Pervasive

  • - standard relational connection parameters, listed on top of this page

PostgreSQL

  • - standard relational connection parameters, listed on top of this page

Progress

  • - standard ODBC connection parameters, listed on top of this page

QuickBooks

  • - standard ODBC connection parameters, listed on top of this page

SQL Compact (SQLCE)

  • - database - full path to .SDF database file
  • - password - user's password
  • - max_db_size - maximum database file size in MB

SQL Server

  • - server - name or IP address of the database server (if non-default instance is used, specify SERVERNAME\INSTANCENAME here)
  • - isWinAuth - true if Windows authentication is to be used, false if username/password combination
  • - username - database user
  • - password - user's password
  • - database - database name
  • - netlib - network library to use (<default>, Named pipes, TCP/IP, Shared memory)
  • - encrypted - true if connection should be encrypted
  • - trust_server_certificate - true if we should trust server certificate

SQLite

  • - database - full path to database file
  • - password - user's password

Sybase Adaptive Server (ASE)

  • - standard relational connection parameters, listed on top of this page 

Sybase Advantage

  • - database - folder containing data files in direct mode, or full path to the ADD file in client mode
  • - advantage_exclusive_lock - set to true if tables should be exclusively locked by our application
  • - charset - character set used to encode data

Sybase SQL Anywhere (ASA)

  • - server - name or IP address of the server computer
  • - sybaseServerName - name of ASA database server
  • - database - name of ASA database
  • - username - database user
  • - password - user's password
  • - charset - character set used to encode data

Vertica

  • - standard relational connection parameters, listed on top of this page 

VistaDB

  • - database - full path to .vdb5 database file
  • - password - encryption key

SIARD

  • - siard_description - description for the target SIARD archive
  • - siard_archiver - archiver name
  • - siard_archiver_contact - contact name of the archiver
  • - siard_data_owner - owner or the original data
  • - siard_data_origin_timespan - description of the time span
  • - siard_lob_folder - directory for the binary large object files
  • - siard_compression_level - compression level for the target SIARD database; available options are "Optimal", "Fastest" and "No Compression"