Amazon RDS SQL Server

Prerequisites

• The MS SQL Server version is 2008 or higher.

• If the Pipeline Mode is Change Tracking or Table, and the Query mode is Change Tracking:

  • Change Tracking is enabled.

  • CHANGE TRACKING and ALTER DATABASE privileges are granted to the database user.

• Hevo’s IP addresses are whitelisted.

• SELECT and VIEW CHANGE TRACKING privileges are granted to the database user.

• You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.

---

Perform the following steps to configure your Amazon RDS SQL Server Source:

Enable Change Tracking

Note: This step is valid only for Pipelines with Change Tracking as their Pipeline Mode.

The Change Tracking mechanism captures changes made to a database. In order to enable, or disable change tracking, the database user must have the ALTER DATABASE privilege.

To enable change tracking, connect your Amazon RDS SQL Server database in your SQL Client tool, and enter these commands:

1. Enable change tracking at the database level:

    ALTER DATABASE <database_name> SET CHANGE_TRACKING = ON
    (CHANGE_RETENTION = 3 DAYS, AUTO_CLEANUP = ON)
   

   The CHANGE_RETENTION value specifies the time period for which change tracking information is retained. You can use AUTO_CLEANUP to enable or disable the cleanup task that removes old change tracking information. Read Enable Change Tracking for a Database.

2. Enable change tracking at the table and schema level:

    ALTER TABLE <schema_name>.<table> ENABLE CHANGE_TRACKING
   

   Repeat this step for each table you want to replicate using log-based incremental replication. Read Enable Change Tracking for a Table.

Note: Hevo does not support Change Data Capture (CDC) for Amazon RDS SQL Server.

---

Whitelist Hevo’s IP Addresses

You need to whitelist the Hevo IP addresses for your region to enable Hevo to connect to your Amazon RDS SQL Server database. To do this:

1. Open the Amazon RDS console.

2. In the left navigation pane, click Databases (or Instances if you are using an older version).

3. In the Databases section on the right, click the DB identifier of the Amazon RDS SQL Server instance.

   

   Note: The instance does not necessarily have to be a replica as long as it whitelists Hevo’s IP address for the region.

4. In the Connectivity & security tab, ensure Public Accessibility is set to Yes.

5. Click the link text under Security, VPC security groups to open the Security Groups panel.

   

6. In the Security Groups panel, click Inbound rules tab, and then, Edit inbound rules.

   

7. In the Edit inbound rules page:

   1. Click Add rule.

   2. In the Port range column, enter the port of your Amazon RDS SQL Server instance. The default value is 1433.

   3. In the Source column, select Custom from the drop-down and enter Hevo’s IP addresses for your region.

   4. Click Save rules.

      

---

Create a User and Grant Privileges

1. Create a user (optional)

2. Grant privileges to the user

The database user specified in the Hevo Pipeline must have the following global privileges:

• SELECT

• VIEW CHANGE TRACKING (If Pipeline Mode is Change Tracking or Table, and Query mode is Change Tracking)

To assign these privileges, log in to your Amazon RDS SQL Server instance as a masteruser in your SQL Client tool and enter the following commands:

1. Grant SELECT privilege at the database level:

   GRANT SELECT ON DATABASE::<database> TO <db_username>;
   

2. Grant SELECT privilege at the table and schema level:

   GRANT SELECT ON <schema_name>.<table_name> TO <db_username>;
   

3. Grant VIEW CHANGE TRACKING privilege, if Pipeline Mode is Change Tracking or Table, and Query mode is Change Tracking:

   GRANT VIEW CHANGE TRACKING ON <schema_name>.<table_name> TO <username>;
   

---