Amazon DocumentDB

Overview

Syniti Replicate allows you to replicate data from relational database tables to Amazon DocumentDB, a cloud-based document database, using the following methods:

• Refresh or Snapshot Replication: A one-time complete replication from any major relational database source to Amazon DocumentDB as a target, according to replication settings and scripts.

• Mirroring or Change Data Capture Replication: A continuous update of a replicated table to Amazon DocumentDB based on changes in the source database that have been recorded in the database server log. Any changes found in the log are applied to Amazon DocumentDB as a target, according to replication settings and scripts.

DocumentDB stores data in flexible, consistently formatted documents. All records in DocumentDB are associated with a specific collection inside a database. When replicating data using Syniti Replicate to DocumentDB, the DocumentDB file system is visualized as relational tables (with columns and data types). You can create a target table and define a replication to a DocumentDB target, applying mappings and expression logic as you would normally do with relational database targets. The DocumentDB message is built internally using a JSON serialization of the entire record. Every replication must be associated with a DocumentDB collection, so that Syniti Replicate can determine where to publish the message.

You can schedule the replication, identify the columns to be replicated, and add scripts to transform data during replication. Source databases include Oracle, Microsoft SQL Server, IBM Db2 for i, IBM Db2 LUW, Sybase, Informix, MySQL, and so on.

Use Syniti Replicate Management Center to:

• Create source connections to RDBMS tables

• Create AWS DocumentDB targets Map

• RDBMS sources to DocumentDB targets

• Enable replication

Replication Architecture for Amazon DocumentDB

Versions Supported

Amazon DocumentDB is supported as a TARGET system in Refresh and Mirroring mode, starting from version 3.6 or higher.

Prerequisites

• Ensure that you have downloaded the .NET Driver MongoDB Driver Version 2.19.0 for Amazon DocumentDB. Click here to download.

• Download and run the NuGet command line tool from NuGet Gallery.

• Ensure that you have downloaded and installed Syniti Replicate.

  Note

  To download or register Syniti Replicate, log in to the support site, then click the required link in the Replicate section of the article. The Knowledge Platform Product Suites article acts as a hub to point to various resources. You can also submit a request for additional support.

Limitations

• As Amazon DocumentDB is not a standard relational database and only handles messages, it is not possible to open the content of a target table in the Management Center to verify if the replication has been successful. To do that, use another application that is able to act as a consumer to receive the messages sent to Amazon DocumentDB.

• Syniti Verifier is not supported for Amazon DocumentDB.

• Data Masking is not supported for this database in Syniti Replicate.

• Databases, schemas, and tables names containing special characters like slash or backslash are not supported in this database.

User Permissions

Syniti Replicate require a grant READ user permission, for example:

use admin
db.createUser(
    {
          user: "<username>",
          pwd: "<password>",
          roles: [ "readAnyDatabase" ]
    }
)

Setup Summary

This section lists a summary of all the steps required for setting up and using Syniti Replicate with Amazon DocumentDB as a target.

• Install .NET Provider for Source Database

• Prepare your Amazon Environment

• Syniti Replicate Setup

• Start Replicating

Install .NET Provider for Source Database

Prepare your Amazon Environment

1. Create your Amazon DocumentDB Cluster.

2. Add your Cluster to your VPC Security Group.

3. Add the Syniti Replicate IP Address to the Inbound Rules to whitelist Syniti Replicate Server.

4. Create a user/pwd using a proper role.

Syniti Replicate Setup

Complete the following steps in the Syniti Replicate Management Center:

1. In the Metadata Explorer, create a source connection to your RDBMS.

2. Create a target connection using the DocumentDB option in the Database field.

3. Create a replication.

Start Replicating

Start the Replication Agent in the Syniti Replicate Service Monitor.

Set Up Target Connection to Amazon DocumentDB

This section assumes you have selected the Enable Transactional Replication Wizard option to launch the Add Target Connection wizard. If not, open the wizard from the Management Center and complete the following steps:

1. In the Metadata Explorer, click Targets.

2. Right-click the menu and click Add New Connection.

3. Enter the information in the Connection Properties dialog box as per your requirement based on the following tables:

Connection Properties - Required Information

Connection Properties - Optional Information

Editing Collection Name

Data Type Mapping

When Amazon DocumentDB is used as a target system, the mapping of Syniti Replicate data types to the corresponding data type in Amazon DocumentDB is listed in the following table:

Further Resources

For a complete up-to-date list of supported sources and targets, and information on where to obtain a .NET provider, check the Supported .NET Providers article in the Help Center.