Replicate GitLab Data to Multiple Databases via the CData Sync CLI

Always-on applications rely on automatic failover capabilities and real-time access to data. CData Sync for GitLab integrates live GitLab data into your mirrored databases, always-on cloud databases, and other databases such as your reporting server: Automatically synchronize with remote GitLab data from Windows or any machine running Java.

You can use Sync's command-line interface (CLI) to easily control almost all aspects of the replication. You can use the CLI to replicate GitLab data to one or many databases without any need to change your configuration.

Connect to GitLab Data

You can save connection strings and other settings like email notifications in XML configuration files.

The following example shows how to replicate to SQLite.

Windows

<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync><DatabaseType>SQLite</DatabaseType>
  <DatabaseProvider>System.Data.SQLite</DatabaseProvider>
  <ConnectionString>Profile=C:\profiles\GitLab.apip;ProfileSettings='APIKey=your_personal_access_token';</ConnectionString>
  <ReplicateAll>False</ReplicateAll>
  <NotificationUserName></NotificationUserName>
  <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
  <TaskSchedulerStartTime>09:51</TaskSchedulerStartTime>
  <TaskSchedulerInterval>Never</TaskSchedulerInterval>
</CDataSync>

Java

<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync><DatabaseType>SQLite</DatabaseType><DatabaseProvider>org.sqlite.JDBC</DatabaseProvider>
<ConnectionString>Profile=C:\profiles\GitLab.apip;ProfileSettings='APIKey=your_personal_access_token';</ConnectionString>
<ReplicateAll>False</ReplicateAll>
<NotificationUserName></NotificationUserName>
<DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
</CDataSync>

To connect to GitLab, use either OAuth or a personal access token:

Using OAuth

Register an OAuth application in GitLab under Edit Profile > Applications (or group Settings > Applications). Set the Redirect URI to https://oauth.cdata.com/oauth/. Note the Application ID (OAuth Client Id) and Secret (shown once). Then set:

• OAuth Client Id: The Application ID from your GitLab OAuth application.
• OAuth Client Secret: The Secret from your GitLab OAuth application.

Click Sign In to complete OAuth authentication.

Using a Personal Access Token

In GitLab, navigate to Edit Profile > Access Tokens > Add new token. Select the required scopes (such as api, read_api, read_user, read_repository) and set an expiration date. Copy the token immediately (shown only once). Then set:

• API Key: The personal access token from your GitLab account.

Configure Replication Queries

Sync enables you to control replication with standard SQL. The REPLICATE statement is a high-level command that caches and maintains a table in your database. You can define any SELECT query supported by the GitLab API. The statement below caches and incrementally updates a table of GitLab data:

REPLICATE AccessRequests;

You can specify a file containing the replication queries. This enables you to use the same replication queries to replicate to several databases.

Run Sync

After you have configured the connection strings and replication queries, you can run Sync with the following command-line options:

Windows

APISync.exe -g MySQLiteConfig.xml -f APISync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar APISync.jar -g MySQLiteConfig.xml -f APISync.sql