Getting Started

Version 24.1.8910


Getting Started


Welcome to CData Sync, a robust, easy-to-use data integration platform. With the power of Sync, you can move data from 200+ supported sources to relational databases (SQL Server, Oracle, PostgreSQL, and so on), cloud data warehouses (Amazon Redshift, Snowflake, Google BigQuery, and so on), and other big data systems (Amazon S3, Azure Data Lake, Kafka, and so on) in near real time! Available to install on-premises or in the cloud, the easy-to-use interface means that your integration can be flowing in a matter of minutes.

Key Features

  • Change Data Capture: Sync offers change data capture (CDC) across multiple data warehouses, which enables you to move data where you need it without overextending resources to do so.

  • Events: Sync uses events to incorporate external information into your data pipeline flow. Events provide flexibility around performing stored procedures before and after your jobs.

  • High Availability/Clustering: Scalability is important so you can meet demand without sacrificing performance or availability. Sync offers high availability (HA) and clustering deployment options for all types of data needs. The combination of HA and clustering provides better scalability by providing redundancy and by ensuring system uptime even in the event of a failure.

  • Host On-Premises or in the Cloud: You can deploy Sync where you need your data pipelines executed, whether your systems are on-premises or in the cloud.

  • Incremental Replication: Sync retrieves only changesets to minimize bandwidth use and latency of synchronization.

  • Logging and Transaction Monitoring: Sync enables you to monitor changes that are made to the database and the data source.

  • Point-and-Click Configuration: Sync administration is simple, with straightforward job scheduling and data transformations.

  • Replication to Major Data Warehouses: Sync supports popular databases like SQL Server, PostgreSQL, Snowflake, Amazon, and so on.

  • Single Sign-On: Sync supports single sign-on through OAuth in order to prevent password fatigue and to ensure enterprise security.

  • Standard Enterprise-Class Security Features: Sync offers encrypted client-server communications by using either the Transport Layer Security (TLS) protocol or the Secure Sockets Layer (SSL) protocol, depending on which protocol is supported.

  • Transformations: Sync offers multiple ways to perform advanced transformations across your data in preparation for use in analytics, machine-learning algorithms, and more.

Core Concepts

  • Connection: A connection is a link either to a source or to a destination. For more information, see Connections.

  • Connector: A connector is a specific connection type. For example, you can make multiple connections to different Salesforce accounts by using the Salesforce connector. For more information, see Connections and Jobs.

  • Destination: A destination connection is the location to which your data flows. For more information, see Destinations.

  • Event: An event provides the ability to integrate external information into data-flow tasks. Sync offers pre-job and post-job events. These events enable you to inject query parameters or to trigger other external processes by using APIScript, an XML-based language that is included with Sync. For more information, see Events.

  • Job: A Sync job is a unit of execution that includes the source connection, the destination connection, and a set of one or more tasks that represent data flows for different tables. For more information, see Jobs.

  • Source: A source connection is the origin from which your data flows. For more information, see Sources.

  • Tasks: A task is an assigned unit of work that accomplishes an activity. In Sync, tasks control the data flow from a source into a destination table. For more information, see Tasks.

  • Transformation: A transformation is the ability to manipulate the format of the data so that it is in the state that you want in order to use it. Sync offers in-flight and post-job transformation capabilities with advanced SQL queries and dbt core or dbt cloud integrations. For more information, see Transformations.

Quick-Start Guide

This section provides steps for initial setup of Sync, and it provides links to specific sections of Sync documentation that explain how to use the application. In addition, you can find support resources in the Getting Support section.

Initial Setup

Follow these steps to install and start CData Sync:

  1. Download the installation file from the CData Sync website.

  2. Follow the instructions in Installation and Configuration to install Sync.

  3. Follow the instructions in Starting the Server to start Sync and to log in.

  4. After you log in, navigate to the Settings page and click the Licensing tab. Then, click the Install New License button and fill out the form to activate Sync.

Using CData Sync

After you install and run Sync, see the following pages for information about using Sync:

  • See Creating Connections for instructions about how to create connections to sources and destinations.

  • See Adding a New Job for information about how to create a job.

  • See Transformations for information about configuring ELT and ETL transformations.

  • See REST API for a full list of actions and parameters that the Admin API supports.

Getting Support

For assistance with using Sync, use either of these resources:

  • This documentation, which provides detailed information about each feature of the platform as well as how to use and configure them.

  • CData Technical Support