Ready to get started?

Learn more or sign up for a free trial:

CData Sync

Replicate Multiple Square Accounts



Replicate multiple Square accounts to one or many databases.

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

Configure Square Connections

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

Windows

<?xml version="1.0" encoding="UTF-8" ?> <CDataSync> <DatabaseType>SQLite</DatabaseType> <DatabaseProvider>System.Data.SQLite</DatabaseProvider> <ConnectionString>OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;</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>OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;</ConnectionString> <ReplicateAll>False</ReplicateAll> <NotificationUserName></NotificationUserName> <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString> </CDataSync>

Square uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app with Square to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Additionally, you must specify the LocationId. You can retrieve the Ids for your Locations by querying the Locations table. Alternatively, you can set the LocationId in the search criteria of your query.

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

REPLICATE Refunds;

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 Square accounts into the same database:

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

REPLICATE PROD_Refunds SELECT * FROM Refunds

Alternatively, you can use a different schema:

REPLICATE PROD.Refunds SELECT * FROM Refunds

Run Sync

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

Windows

SquareSync.exe -g MyProductionSquareConfig.xml -f MyProductionSquareSync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar SquareSync.jar -g MyProductionSquareConfig.xml -f MyProductionSquareSync.sql