ODBC Query
Open Database Connectivity (ODBC) is a standard application programming interface (API) designed to unify access to SQL databases. An ODBC query allows the extraction of specific information sets from those databases.
The ODBC Query source support batch syncs.
You can review the parameters that can be found in the info tab below (Image 1).
Parameter | Description | Example |
---|---|---|
Title | Mandatory. Input a name for your data sync | ODBC Query Sync |
Version | Mandatory. This is a pre-populated field containing a version number for your data sync. You can override it if you wish. | 1.0.0 |
Parameters | |

Image 1: The Info Tab
The following table outlines the mandatory and optional parameters you will find on the Source tab (Image 2).
Source Details
Schema
Filter
The following parameters will help to define your data sync source and how it functions.
Parameter | Description | Example |
---|---|---|
Source | Mandatory. Select your source from the drop down menu. | ODBC |
Connection String | Mandatory. The Connection String to connect to your ODBC Driver. The Connections UI will encrypt this value. | |
Query | This should be a SELECT statement indicating the data you want to sync out of your ODBC. | Select * from dbo.employees |
The Schema section is where you define which source columns you want to sync in your connection. You can repeat the values for multiple columns.
Parameter | Description | Example |
---|---|---|
Name | Mandatory. The name of your column as it appears in the source. | Name |
Alias | Optional. You may choose to use an alias on your column so that it has a different name in the data sync. | |
Data Type | Mandatory. The data type of the column values. | Text |
Description | Optional. You may choose to add a description to your column. | |
There are other options available for the Schema section if you click on Show Advanced.
Parameter | Description | Example |
---|---|---|
Mandatory |
| |
Validate Data |
| |
Trim Whitespace | Optional if data type = text. If your data type was chosen as "text", you can choose whether to trim the whitespace (that is, spaces and other non-printing characters). | |
Max Length | Optional if data type = text. You can input a numerical value in this field that represents the maximum length of the data that can be synced in your column. If the value is exceeded, the row will be rejected (you can find this error in the Execution Log). | |
You can choose to add in a Transformation > String Replacement by inputting the following:
Parameter | Description | Example |
---|---|---|
Pattern | Mandatory if using a Transformation. The pattern for your string replacement, i.e. the string that will be searched and replaced. | |
Replacement | What you want to replace your pattern with. | |
Note that you can have more than one String Replacement
You have the option to add a source filter to your data sync. Please review the documentation here for more information on source filters.

Image 2: The Source Tab
- Click Jobs > Start a Job to begin your sync.
Last modified 3mo ago