Automated Continuous REST Data Replication to OneLake in Microsoft Fabric



Use CData Sync for automated, continuous, customizable REST data replication to OneLake in Microsoft Fabric.

Always-on applications rely on automatic failover capabilities and real-time data access. CData Sync integrates live REST data into your OneLake instance in Microsoft Fabric, allowing you to consolidate all your data into a single location for archiving, reporting, analytics, machine learning, artificial intelligence and more.

Configure OneLake as a Replication Destination

Using CData Sync, you can replicate REST data to OneLake. To add a replication destination, navigate to the Connections tab.

  1. Click Add Connection.
  2. Click the Sources tab and locate Azure OneLake connector.
  3. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the OneLake connector. For more information about installing new connectors, see Connections in the Help documentation.
  4. After the connected is added, enter the following Basic connection properties under Settings to connect to OneLake:
    • Connection Name: Enter a connection name of your choice.
    • File Format: Select the file format that you want to use. Sync supports the CSV, PARQUET, and AVRO file formats.
    • URI: Enter the path of the file system and folder that contains your files (for example, onelake://Workspace/Test.LakeHouse/Files/CustomFolder).
    • Auth Scheme: To connect with an Azure Active Directory (AD) user account, select Azure AD for Auth Scheme. CData Sync provides an embedded OAuth application with which to connect so no additional properties are required.
    • Data Model: Specify the data format to use while parsing the selected file format documents and generating the database metadata.
    • If you are hosting CData Sync (locally or in your own cloud):
      • Use CData CallbackURL: Disable the toggle.
      • Callback URL: Enter the Callback URL.
    • If you are using CData Sync Cloud, leave the Use CData CallbackURL toggle enabled.
  5. Navigate to the Advanced tab and scroll down to the Miscellaneous section.
  6. In Include Files, enter the file format initially selected.
  7. Select Create from Insert Mode dropdown. The other Insert Mode options are Overwrite and Batch.
  8. Now, navigate back to Basic settings and click Connect to Azure OneLake.
  9. Once connected, click Create & Test to save the connection.

You are now connected to OneLake and can use it as both a source and a destination.

NOTE: You can use the Label feature to add a label for a source or a destination.

In this article, we will demonstrate how to load REST data into OneLake and utilize it as a destination.

Configure the REST Connection

You can configure a connection to REST from the Connections tab. To add a connection to your REST account, navigate to the Connections tab.

  1. Click Add Connection.
  2. Select a source (REST).
  3. Configure the connection properties.

    See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models REST APIs as bidirectional database tables and XML/JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

    After setting the URI and providing any authentication values, set Format to "XML" or "JSON" and set DataModel to more closely match the data representation to the structure of your data.

    The DataModel property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

    • Document (default): Model a top-level, document view of your REST data. The data provider returns nested elements as aggregates of data.
    • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
    • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

    See the Modeling REST Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

  4. Click Connect to REST to ensure that the connection is configured properly.
  5. Click Save & Test to save the changes.

Configure Replication Queries

CData Sync enables you to control replication with a point-and-click interface and with SQL queries. For each replication you wish to configure, navigate to the Jobs tab and click Add Job. Select the Source and Destination for your replication.

Edit the Job

  1. In the Advanced tab of the Job, click Edit Replicate Options and select the Insert Mode as Single File from the dropdown (If the Insert Mode is selected as "Create" in the OneLake connector.)
  2. In "Batch" mode, you need to set the Insert Mode in Jobs to File Per Batch.
  3. In "Overwrite" mode, both Single File and File Per Batch work.

Replicate Entire Tables

To replicate an entire table, click Add Tables in the Tables section, choose the table(s) you wish to replicate, and click Add Selected Tables.

Customize Your Replication

You can use the Columns and Query tabs of a task to customize your replication. The Columns tab allows you to specify which columns to replicate, rename the columns at the destination, and even perform operations on the source data before replicating. The Query tab allows you to add filters, grouping, and sorting to the replication.

Schedule Your Replication

In the Schedule section, you can schedule a job to run automatically, configuring the job to run after specified intervals ranging from once every 10 minutes to once every month.

Once you have configured the replication job, click Save Changes. You can configure any number of jobs to manage the replication of your REST data to OneLake.

Free Trial & More Information

Now that you have seen how to replicate REST data into OneLake, visit our CData Sync page to explore more about CData Sync and download a free 30-day trial. Start consolidating your enterprise data today!

As always, our world-class Support Team is ready to answer any questions you may have.

Ready to get started?

Learn more or sign up for a free trial:

CData Sync