Automated Continuous REST Replication to SingleStore

Always-on applications rely on automatic failover capabilities and real-time data access. CData Sync integrates live REST data into your SingleStore instance, allowing you to consolidate all of your data into a single location for archiving, reporting, analytics, machine learning, artificial intelligence and more.

Configure SingleStore as a Replication Destination

Using CData Sync, you can replicate REST data to SingleStore. To add a replication destination, navigate to the Connections tab.

1. Click Add Connection.
2. Select the Destinations tab and locate the SingleStore connector.
3. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the SingleStore connector. For more information about installing new connectors, see Connections in the Help documentation.
4. To connect to SingleStore, enter the required connection properties and select an authentication scheme (see below):
   • Server: Enter the host name or IP of the server hosting the SingleStore database.
   • Port: Enter the port of the server hosting the SingleStore database.
   • Database (Optional): Enter the default database to connect to when connecting to the SingleStore Server. If this is not set, tables from all databases will be available.

   Connect Using Standard Authentication

   To authenticate using standard authentication, set the following:

   • User: Enter the user which will be used to authenticate with the SingleStore server.
   • Password: Enter the password which will be used to authenticate with the SingleStore server.

   Connect Using Integrated Security

   As an alternative to providing the standard username and password, you can set IntegratedSecurity to True to authenticate trusted users to the server via Windows Authentication.

   Connect Using SSL Authentication

   You can leverage SSL authentication to connect to SingleStore data via a secure session. Configure the following connection properties to connect to data:

   • SSLClientCert: Set this to the name of the certificate store for the client certificate. Used in the case of 2-way SSL, where truststore and keystore are kept on both the client and server machines.
   • SSLClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
   • SSLClientCertSubject: Enter the subject of the TLS/SSL client certificate. It is used to locate the certificate in the store.
   • SSLClientCertType: Enter the certificate type of the client store.
   • SSLServerCert: Enter the certificate to be accepted from the server.

   Connect Using SSH Authentication

   Using SSH, you can securely login to a remote machine. To access SingleStore data via SSH, configure the following connection properties:

   • SSHClientCert: Set this to the name of the certificate store for the client certificate.
   • SSHClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
   • SSHClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
   • SSHClientCertType: The certificate type of the client store.
   • SSHPassword: The password that you use to authenticate with the SSH server.
   • SSHPort: The port used for SSH operations.
   • SSHServer: The SSH authentication server you are trying to authenticate against.
   • SSHServerFingerPrint: The SSH Server fingerprint used for verification of the host you are connecting to.
   • SSHUser: Set this to the username that you use to authenticate with the SSH server.

5. Once connected, click Create & Test to create, test and save the connection.

You are now connected to SingleStore and can use it as both a source and a destination.

NOTE: You can use the Label feature to add a label for a source or a destination.

In this article, we will demonstrate how to load REST data into SingleStore and utilize it as a destination.

Configure the REST Connection

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

1. Click Add Connection.
2. Select a source (REST).
3. Configure the connection properties.
   
   

   See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models REST APIs as bidirectional database tables and XML/JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

   After setting the URI and providing any authentication values, set Format to "XML" or "JSON" and set DataModel to more closely match the data representation to the structure of your data.

   The DataModel property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

   • Document (default): Model a top-level, document view of your REST data. The data provider returns nested elements as aggregates of data.
   • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
   • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

   See the Modeling REST Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

   
4. Click Connect to REST to ensure that the connection is configured properly.
5. Click Save & Test to save the 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, navigate to the Task tab in the Job, click Add Tasks, choose the table(s) from the list of REST tables you wish to replicate into SingleStore, and click Add Tasks again.

Customize Your Replication

Schedule Your Replication

Select the Overview tab in the Job, and click Configure under Schedule. You can schedule a job to run automatically by configuring it to run at 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 REST data to SingleStore.

Run the Replication Job

Once all the required configurations are made for the job, select the REST table you wish to replicate and click Run. After the replication completes successfully, a notification appears, showing the time taken to run the job and the number of rows replicated.

Free Trial & More Information

Now that you have seen how to replicate REST data into SingleStore, visit our CData Sync page to explore more about CData Sync and download a free 30-day trial. Start consolidating your enterprise data today!

As always, our world-class Support Team is ready to answer any questions you may have.