Automated Continuous Lakebase Replication to Local Delimited Files

Always-on applications rely on automatic failover capabilities and real-time data access. CData Sync integrates live Lakebase data into local delimited files (CSV/TSV), allowing you to consolidate all of your data into a single location for archiving, reporting, analytics, machine learning, artificial intelligence and more.

Configure CSV/TSV as a Replication Destination

Using CData Sync, you can replicate Lakebase data to delimited files, like CSV or TSV. To add a replication destination, navigate to the Connections tab.

1. Click Add Connection.
2. Select CSV as a destination.
3. Enter the necessary connection properties. To connect to a directory for storing delimited files, set the following:
   • Destination Folder: Set this location on the disk for the delimited files.
   • Include Column Headers: Set this to True for the first row in each file to represent the column names.
4. Click Test Connection to ensure that the connection is configured properly.
5. Click Save Changes.

Configure the Lakebase Connection

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

1. Click Add Connection.
2. Select a source (Lakebase).
3. Configure the connection properties.
   
   To connect to Databricks Lakebase, start by setting the following properties:
   • DatabricksInstance: The Databricks instance or server hostname, provided in the format instance-abcdef12-3456-7890-abcd-abcdef123456.database.cloud.databricks.com.
   • Server: The host name or IP address of the server hosting the Lakebase database.
   • Port (optional): The port of the server hosting the Lakebase database, set to 5432 by default.
   • Database (optional): The database to connect to after authenticating to the Lakebase Server, set to the authenticating user's default database by default.

   OAuth Client Authentication

   To authenicate using OAuth client credentials, you need to configure an OAuth client in your service principal. In short, you need to do the following:

   1. Create and configure a new service principal
   2. Assign permissions to the service principal
   3. Create an OAuth secret for the service principal

   For more information, refer to the Setting Up OAuthClient Authentication section in the Help documentation.

   OAuth PKCE Authentication

   To authenticate using the OAuth code type with PKCE (Proof Key for Code Exchange), set the following properties:

   • AuthScheme: OAuthPKCE.
   • User: The authenticating user's user ID.

   For more information, refer to the Help documentation.

   
4. Click Connect to ensure that the connection is configured properly.
5. Click Save 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.

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 Lakebase data to delimited files.