Skip to Content

Database connector


The Database connector provides an interface for entering user-provided input such as server credentials to create a Database connection. That connection provides the foundation to configure associated Database connector activities that interact with the connection. Together, a specific Database connection and its activities are referred to as a Database endpoint.

Connector overview

This connector is used to first configure a database connection, establishing access to a database, and then used to configure one or more Database activities associated with that connection as a source or target within an operation or script:

  • Query: Queries data from a Database endpoint and is intended to be used as a source in an operation or called in a script.
  • Insert: Inserts new data in a Database endpoint and is intended to be used as a target in an operation or called in a script.
  • Update: Updates existing data in a Database endpoint and is intended to be used as a target in an operation or called in a script.
  • Upsert: Both updates existing data and inserts new data in a Database endpoint and is intended to be used as a target in an operation or called in a script. (Harmony supports Upsert activities for databases by using a combination of Query, Insert, and Update.)


As there is no database Delete activity, to delete data from a Database connection, use the DBExecute function in a Jitterbit Script by specifying the SQL command to be executed against the database.


This connector is a native Cloud Studio connector, which may be referred to by Jitterbit when communicating changes made to connectors. The release schedule for native Cloud Studio connectors is based on the cadence of Harmony cloud applications.

Accessing the connector

The Database connector is accessed from the design component palette's Project endpoints and connectors tab (see Design component palette).

database activities

Supported databases and data

Most JDBC- and ODBC-compliant databases are supported.

In databases, Jitterbit does not support data with these encoding types or object names:

  • Binary data
  • Unicode/UTF data
  • Tables or views with spaces in the names

Supported TLS versions

Transport Layer Security (TLS) 1.2 is supported and recommended for JDBC database endpoints. TLS 1.0 and 1.1 are no longer supported on cloud agents and are disabled by default on private agents version 10.47 and later.

If a database endpoint no longer works after an upgrade to a 10.47 or later agent, add enabledTLSProtocols=TLSv1.2 to the database connection string during configuration of the Database connection to force TLS 1.2 to be used (provided the protocol version is supported by the database endpoint).

On private agents, if TLS 1.2 is not supported by the database endpoint, TLS 1.0 or 1.1 can be re-enabled (though not recommended) by removing TLSv1 or TLSv1.1 from the jdk.tls.disabledAlgorithms security property in the private agent configuration file.

The private agent configuration file is located in these default directories:

  • Windows: C:\Program Files\Jitterbit Agent\jre\lib\security
  • Linux: /opt/jitterbit/jre/lib/security

Installing additional JDBC or ODBC drivers

Database drivers are automatically detected from the Harmony agent. For cloud agents, managed by Jitterbit, a set of commonly used JDBC drivers is supported and is already provided. For private agents, installed drivers are detected from the operating system where each private agent is installed. In addition, you can install other database drivers on private agents as needed. If you require the use of an ODBC driver, you can use a Windows private agent.

For general information and instructions on installing additional drivers on private agents, refer to Installing additional ODBC or JDBC drivers.

Special characters in database table/column names

If using a private agent, you can specify characters used to define delimiters within database table/column names within the private agent configuration file under the [DbDrivers] section.

If using an ODBC database driver, note that some special characters in database table/column names are unable to be handled by the driver. For example, database fields that have an at sign (@) are not compliant with SQL-based specifications and may not be supported. If the database uses such special characters in table/column names, as a workaround we recommend creating a view on the physical table that does not use the special character in column names and using that instead.

Database-specific information

See Database-specific information for reference information on configuring these databases:

Database functions

A number of database functions can be used within scripts to provide access to basic database interactions, including these:

  • CacheLookup
  • CallStoredProcedure
  • DBCloseConnection
  • DBExecute
  • DBLoad
  • DBLookup
  • DBLookupAll
  • DBRollbackTransaction
  • DBWrite
  • SetDBInsert
  • SetDBUpdate
  • SQLEscape
  • Unmap
  • <UDF>

For details on using these functions, see Database functions.


If you experience issues with the Database connector, these troubleshooting steps are recommended:

  1. Ensure the Database connection is successful by using the Test button in the configuration screen. If the connection is not successful, the error returned may provide an indication as to the problem.

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for cloud agents or for private agents) to generate additional log files and data.

  4. If using private agents, you can check the agent logs for more information.