Stitch Documentation
has moved!

Please update your bookmarks to https://www.stitchdata.com/docs

If you're not automatically redirected after 5 seconds, click here.

Selecting & Changing Mongo Replication Keys

At this time, Stitch only supports Incremental Replication for Mongo integrations. This means that only new and updated data will be replicated to your data warehouse.

While Incremental Replication works for Mongo the way it does for every other integration, the requirements, gotchas, and process for setting Replication Keys is a little different.

In this article, we’ll cover:

  1. Requirements for Mongo Replication Keys
  2. Our recommendations for Replication Keys
  3. Replication Key Gotchas
  4. Changing a Mongo Replication Key

Mongo Replication Key Requirements

Stitch uses a field you define - called a Replication Key - to identify new and updated data for replication. For Mongo connections, Stitch requires that the Replication Key field:

  1. is indexed and
  2. exists in the root of the document.

If you want to sync Mongo data and are going to add query parameters - which is what Incremental Replication does - undue stress could be put on your Mongo database. By indexing the fields you want to sync, that stress can be relieved.

Replication Key Recommendations

While the only requirement for a Mongo Replication Key is that the field is indexed, we do have some recommendations.

  1. Replication Key fields should contain only one data type.
    While Mongo allows you to have multiple data types in a single field, we strongly recommend keeping Replication Key fields to just one. This is because of the way Mongo compares and sorts data types and how this can impact replication.

  2. Date and timestamp fields are great Replication Key candidates.
    We’re big fans of using updatedAt or modifiedAt. This is the best way to ensure that both new records and updates to existing records are captured.

    In some cases - for example, if a table is append-only - createdAt may also be suitable.

  3. If date or timestamp fields can't be used, Replication Keys should update incrementally.
    Fields with Integer and ObjectId data types can be used as Replication Keys if they update incrementally, which allows Stitch to identify a MAX value and detect new records for replication. 

    This is suitable for append-only tables only, meaning that the table is only updated with new data. If existing records are ever modified, a field like updatedAt or modifiedAt should be used instead.

Replication Key Gotchas

Before selecting a Replication Key for a table, there are a few things you should keep in mind.

  1. Changing a collection's Replication Key requires a full resync of the collection.
    To change the Replication Key for a Mongo collection, Stitch must perform a full re-sync of the collection.

  2. NULL is a defined BSON data type in Mongo.
    Unlike SQL, NULLs can actually compare to other data types and replicate without issue.

  3. While the _id field can typically be used as a Replication Key...
    ... You should verify the field's data type - and that it contains only one data type (see below for details) - before using it. Some data types may not auto-increment, which will lead to issues with detecting new data.

  4. Stitch doesn’t require single data types for Replication Keys.
    But we do strongly recommend it. Here’s an example that demonstrates why:

    1. We sync a table, using a field called _id as the Replication Key. This field contains both ObjectId and String data types.
    2. A historical sync of the table completes.
    3. Because Mongo considers ObjectId data types to be greater than Strings, Stitch will record the MAX value as the last replicated record containing an ObjectId data type in the Replication Key field.
    4. New records are added to the table.
    5. During the next sync, Stitch uses the last recorded MAX value - in this case, an ObjectId - to identify new/updated data. Remember: only records with Replication Key values greater than or equal to this value will be selected for replication.
    6. Because ObjectIds > Strings, all records with Strings are considered to be less than the last recorded MAX value. This means Stitch won’t be able to detect these records and replicate them to your data warehouse.

    Because Stitch may be unable to correctly identify new and updated data due to how data types are sorted, it’s best to keep Replication Key fields to a single data type. For guidance on how to determine if a field has multiple data types, check out this troubleshooting doc.

Changing a Mongo Replication Key

Important!
Changing a Replication Key will queue a full replication of the data in the collection. This will result in a higher number of rows synced, which will count towards your monthly quota. A full re-sync is required to ensure there aren't any gaps in your data.

    1. From the Stitch Dashboard page, click into the Mongo integration.
    2. In the Integration Details page, click the database that contains the collection.
    3. When the list of collections displays, click the name of the collection.
    4. Click the Collection Settings button.
    5. Select the desired column from the Replication Key drop-down.
    6. Click Update Settings.
    7. A full-sync warning will display. To continue with changing the Replication Key, click the Change Replication Key button.

Related

Was this article helpful?
0 out of 0 found this helpful

Comments

Questions or suggestions? If something in our documentation is unclear, let us know in the comments!