Amazon DocumentDB

Amazon DocumentDB is a fast, secure, scalable, and fully managed database service that is compatible with MongoDB. It allows you to store and query JSON data, as well as set up, operate, and scale MongoDB-compatible databases in the cloud. Amazon DocumentDB also supports the same application code, drivers, and tools as MongoDB.

Hevo uses DocumentDB Change Streams to ingest data from your Amazon DocumentDB database and replicate it into the Destination of your choice.


Perform the following steps to configure your Amazon DocumentDB Source:

Whitelist Hevo’s IP Address

You must whitelist Hevo’s IP address in your existing Amazon EC2 instance in order to connect to Hevo. Read Creating an Amazon EC2 instance if you have not created one already. Hevo needs this EC2 instance to create an SSH tunnel to connect to your DocumentDB cluster and replicate data from it.

Perform the following steps to whitelist Hevo’s IP address in your existing EC2 instance:

  1. Log in to your Amazon EC2 console.

  2. In the left navigation pane, under Network & Security, click Security Groups.

    Navigation Pane

  3. Click on the security group linked to your EC2 instance.

    Select Security Group

  4. In the Inbound rules tab, click Edit inbound rules.

    Edit Inbound Rules

  5. In the Edit inbound rules page, in the Source column, select Custom from the drop-down, and enter Hevo’s IP address for your region.

    Save Rules

  6. Click Save rules.

Enable Streams

You need to enable Streams on the DocumentDB collections and databases whose data you want to replicate to the Destination through Hevo.

To do this:

  1. Open your mongo shell.

  2. Depending on the collections and databases you want to sync, run one of the following commands:

    • To enable change streams for a specific collection in a specific database:

      db.adminCommand({modifyChangeStreams: 1,
        database: "<database_name>",
        collection: "<collection_name>",
        enable: true});
      Replace <database_name> and <collection_name> with a database and collection name of your choice.
    • To enable change streams for all collections in a specific database:

      db.adminCommand({modifyChangeStreams: 1,
        database: "<database_name>",
        collection: "",
        enable: true});
      Replace <database_name> with a database name of your choice.
    • To enable change streams for all collections in all databases:

      db.adminCommand({modifyChangeStreams: 1,
        database: "",
        collection: "",
        enable: true});

Modify the Change Stream Log Retention Duration

The change stream retention duration is the period for which Events are held in the change stream logs. If an Event is not read within that period, then it is lost.

This may happen if:

  • The change stream log is full, and the database has started discarding the older Event entries to write the newer ones.

  • The timestamp of the Event is older than the change stream retention duration.

The change stream log retention duration directly impacts the change stream log size that you must maintain to hold the entries.

By default, Amazon DocumentDB retains the Events for three hours after recording them. You must maintain an adequate size or retention duration of the change stream log for Hevo to read the Events without losing them. Hevo recommends that you modify the retention duration to 72 hours (259200 seconds).

To extend the change stream log retention duration:

  1. Log in to your Amazon DocumentDB console.

  2. In the left navigation pane, click Parameter Groups.

    Parameter Groups

  3. Select the cluster parameter group associated with your cluster. Read Determining an Amazon DocumentDB Cluster’s Parameter Group for more information.

    Cluster Parameter Groups

  4. In the Cluster parameters section, search and select change_stream_log_retention_duration, and then click Edit.

    Log duration

  5. Modify the Value to 259200 seconds.

    Note: The Value should be in seconds only.

    Change value

  6. Click Modify cluster parameter.

Create User and Set up Permissions to Read DocumentDB Databases

Perform the following steps to create a database user, and grant READ privileges to that user:

  1. Open your mongo shell.

  2. Run the following command to create a user and grant READ permissions to that user.

    use admin
      user: "<username>",
      pwd: "<password>",
      roles: [ "readAnyDatabase" ]
    Replace <username> and <password> with a username and password of your choice.

Configure Amazon DocumentDB Connection Settings

Perform the following steps to configure Amazon DocumentDB as the Source in your Pipeline:

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE in the Pipelines List View.

  3. In the Select Source Type page, select Amazon DocumentDB.

  4. In the Configure your Amazon DocumentDB Source page, specify the following:

    DocumentDB settings

    • Pipeline Name: A unique name for your Pipeline, not exceeding 255 characters.

    • Database Host: The IP address or DNS of your primary instance in the AWS console. You can find the primary instance for your cluster under the Role column of your AWS console.

    • Database Port: The port on which your DocumentDB server listens for connections. Default value: 27017.

    • Database User: The database user that you created. This authenticated user has the permissions to read collections in your database.

    • Database Password: The password of the database user.

    • Authentication Database Name: The database that stores the user’s information. The user name and password entered in the preceding steps are validated against this database. Default value: admin.

    • Connect through SSH: Hevo connects to your DocumentDB cluster using an SSH tunnel, instead of directly connecting your Amazon DocumentDB database host to Hevo. This provides an additional level of security to your database by not exposing your Amazon DocumentDB setup to the public. Read Connecting Through SSH.

    • Use SSL: Enable this option if you have enabled SSL at the DocumentDB server end.

    • Advanced Settings:

      • Load All Databases: If enabled, Hevo fetches data from all the databases you have access to on the specified host. If disabled, provide the comma-separated list of the database names from which you want to fetch the data.

      • Merge Collections: If enabled, collections with the same name across different databases are merged into a single Destination table. If disabled, separate tables are created and prefixed with the respective database name.

    • Load Historical Data: If enabled, the entire table data is fetched during the first run of the Pipeline. If disabled, Hevo loads only the data that was written in your database after the time of the creation of the Pipeline.

    • Include New Tables in the Pipeline: If enabled, Hevo automatically ingests data from tables created after the Pipeline is built. If disabled, the new tables are listed in the Pipeline Detailed View in Skipped state, and you can manually include the ones you want and load their historical data.

      You can change this setting later.

  5. Click TEST & CONTINUE.

  6. Proceed to configuring the data ingestion and setting up the Destination.

Source Considerations

  • DocumentDB does not support reading change streams from replica instances, so Hevo cannot connect to DocumentDB replica instances.

  • DocumentDB does not support null values for the _id field.

    The _id field in a DocumentDB collection serves as its primary key. Therefore, commands that use _id as a parameter, such as commands to fetch, sort, or update data, do not run successfully if you provide a null value in the _id field.

    For example, when you run the following command in DocumentDB to select and sort data according to their _id values, you get a null pointer exception while fetching the document if the _id field does not hold a value:

    db.collection.aggregate({ $group : { _id : {$type:"$_id"}, type: {$min:"$_id"} } }
  • DocumentDB does not support BSON documents larger than 16 MB in change streams.

    The change streams response documents must adhere to the 16 MB limit for BSON documents. In case the size of the document exceeds 16 MB, the Pipeline is paused and an error is displayed stating, Failed to read documents from the Change Stream. Documents larger than 16 MB are not supported. This applies to scenarios such as when the update operation in Change Streams is configured to return the full updated document, or an insert or replace operation is performed within a document that is at or just below the specified size limit.



See Also

Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Jul-15-2022 1.92 New document.
Last updated on 15 Jul 2022