Replicate Multiple CockroachDB Accounts

Ready to get started?

Learn more or sign up for a free trial:

CData Sync



Replicate multiple CockroachDB accounts to one or many databases.

CData Sync for CockroachDB 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 CockroachDB connections. In this article we show how to use the CLI to replicate multiple CockroachDB accounts.

Configure CockroachDB Connections

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

Windows

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

Set the following to connect to CockroachDB.

  • Server: The host name or IP address of the server.
  • Port: The port number of the CockroachDB server. If not specified, the default port is 26257.
  • Database: The name of the Cockroach database. If not specified, you connect to the user's default database.
  • User: The Cockroach DB user account used to authenticate.
  • Password: The password used to authenticate the user.

Configure Queries for Each CockroachDB 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 CockroachDB API. The statement below caches and incrementally updates a table of CockroachDB 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 CockroachDB 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

CockroachDBSync.exe -g MyProductionCockroachDBConfig.xml -f MyProductionCockroachDBSync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar CockroachDBSync.jar -g MyProductionCockroachDBConfig.xml -f MyProductionCockroachDBSync.sql