Replicate Multiple SQL Server Accounts via the CData Sync CLI

CData Sync for SQL Server is a stand-alone application that provides solutions for a variety of replication scenarios such as replicating sandbox and production instances into your database. Both Sync for Windows and Sync for Java include a command-line interface (CLI) that makes it easy to manage multiple SQL Server connections. In this article we show how to use the CLI to replicate multiple SQL Server accounts.

Configure SQL Server Connections

You can save connection and email notification settings in an XML configuration file. To replicate multiple SQL Server accounts, use multiple configuration files. Below is an example configuration to replicate SQL Server to SQLite:

Windows

<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync>
 <DatabaseType>SQLite</DatabaseType>
 <DatabaseProvider>System.Data.SQLite</DatabaseProvider>
 <ConnectionString>User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=1433;</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>User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=1433;</ConnectionString>
 <ReplicateAll>False</ReplicateAll>
 <NotificationUserName></NotificationUserName>
 <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
</CDataSync>

Connecting to Microsoft SQL Server

Connect to Microsoft SQL Server using the following properties:

• Server: The name of the server running SQL Server.
• User: The username provided for authentication with SQL Server.
• Password: The password associated with the authenticating user.
• Database: The name of the SQL Server database.

Connecting to Azure SQL Server and Azure Data Warehouse

You can authenticate to Azure SQL Server or Azure Data Warehouse by setting the following connection properties:

• Server: The server running Azure. You can find this by logging into the Azure portal and navigating to "SQL databases" (or "SQL data warehouses") -> "Select your database" -> "Overview" -> "Server name."
• User: The name of the user authenticating to Azure.
• Password: The password associated with the authenticating user.
• Database: The name of the database, as seen in the Azure portal on the SQL databases (or SQL warehouses) page.

SSH Connectivity for SQL Server

You can use SSH (Secure Shell) to authenticate with SQL Server, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).

SSH Connections to SQL Server in Password Auth Mode

To connect to SQL Server via SSH in Password Auth mode, set the following connection properties:

• User: SQL Server User name
• Password: SQL Server Password
• Database: SQL Server database name
• Server: SQL Server Server name
• Port: SQL Server port number like 3306
• UserSSH: "true"
• SSHAuthMode: "Password"
• SSHPort: SSH Port number
• SSHServer: SSH Server name
• SSHUser: SSH User name
• SSHPassword: SSH Password

SSH Connections to SQL Server in Public Key Auth Mode

To connect to SQL Server via SSH in Password Auth mode, set the following connection properties:

• User: SQL Server User name
• Password: SQL Server Password
• Database: SQL Server database name
• Server: SQL Server Server name
• Port: SQL Server port number like 3306
• UserSSH: "true"
• SSHAuthMode: "Public_Key"
• SSHPort: SSH Port number
• SSHServer: SSH Server name
• SSHUser: SSH User name
• SSHClientCret: the path for the public key certificate file

Configure Queries for Each SQL Server Instance

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 SQL Server API. The statement below caches and incrementally updates a table of SQL Server data:

REPLICATE Orders;

You can specify a file containing the replication queries you want to use to update a particular database. Separate replication statements with semicolons. The following options are useful if you are replicating multiple SQL Server accounts into the same database:

You can use a different table prefix in the REPLICATE SELECT statement:

REPLICATE PROD_Orders SELECT * FROM Orders 

Alternatively, you can use a different schema:

REPLICATE PROD.Orders SELECT * FROM Orders

Run Sync

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

Windows

SQLSync.exe -g MyProductionSQLConfig.xml -f MyProductionSQLSync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar SQLSync.jar -g MyProductionSQLConfig.xml -f MyProductionSQLSync.sql