This integration is certified by Stitch. For support, contact Stitch support.
|Release Status||Released||Supported By||Stitch|
|SSL Connections||Supported||VPN Connections||Unsupported|
|Whitelisting||Tables and columns||View Replication||Supported|
Connecting SQL Server RDS
SQL Server RDS Setup Requirements
To set up SQL Server RDS in Stitch, you need:
Permissions in Amazon Web Services (AWS) that allow you to:
- Create/manage Security Groups, which is required to whitelist Stitch’s IP addresses.
- View database details, which is required for retrieving the database’s connection details.
Permissions in SQL Server RDS that allow you to create/manage users. This is required to create the Stitch database user.
A database that uses case-insensitive collation. More info about collation can be found here in Microsoft’s documentation.
Step 1: Whitelist Stitch's IP addresses
For Stitch to successfully connect with your RDS instance, you’ll need to add our IP addresses to the appropriate database security group via the AWS management console. To do this, an inbound security rule must be created for each of our IP addresses.
The IP addresses can be added to an existing group or you can create a new one. The important thing is that the group is authorized to access the instance you want to connect to Stitch.
- Log into your AWS account.
- Navigate to the Security Group Management page, typically Services > Compute > EC2.
- Click the Security Groups option, under Network & Security in the menu on the left side of the page.
- Click Create Security Group.
- In the window that displays, fill in the fields as follows:
- Security group name: Enter a unique name for the security group. For example:
- Description: Enter a description for the security group.
- VPC: Verify that the selected VPC is the same VPC your database is in.
- Security group name: Enter a unique name for the security group. For example:
- In the Inbound tab, click Add Rule.
- Fill in the fields as follows:
- Type: Select
Custom TCP Rule
- Port Range: Enter the port your database uses. (
CIDR, IP or Security Group, enter one of the IP addresses listed below:
- Type: Select
- Add another rule by clicking the Add Rule button.
Repeat steps 6-8 until all the IP addresses above have been added:
- When finished, click Create.
Step 2: Create a Stitch database user
Next, you’ll create a dedicated database user for Stitch. This will ensure Stitch is visible in any logs or audits, and allow you to maintain your privilege hierarchy.
us_english. Issues with replication may arise if a different setting is used.
- Log into your database.
Create a SQL login for the Stitch database user:
CREATE LOGIN [stitch_username] WITH PASSWORD=’[password]’ go
Grant the Stitch user access to the database:
USE [database] go
Create the Stitch database user and map them to the database:
CREATE USER [stitch_username] FOR LOGIN go
Grant the Stitch user
SELECTprivileges to all tables in the database, run this command:
GRANT SELECT to [stitch_username] go
If you wish to limit the Stitch user to specific tables, run this command instead:
GRANT SELECT ON [schema_name].[table_name] TO [stitch_username] go
See the Privileges list tab for an explanation of why these permissions are required by Stitch.
In the table below are the database user privileges Stitch requires to connect to and replicate data from a SQL Server RDS database.
|Privilege name||Reason for requirement|
Required to select rows from tables in a database.
Step 3: Locate RDS connection details in AWS
Next, you’ll retrieve the connection details required to complete the setup in Stitch. This info can be found on the Instance Details page in AWS.
If you don’t still have this page open, click Instances and then the instance you’re connecting to Stitch.
- On the Instance Details page, scroll down to the Connect section.
Locate the Endpoint and Port fields, which are highlighted in the image below:
Leave this page open for now - you’ll need it to complete the setup in the next step.
Step 4: Connect Stitch
- Sign into your Stitch account, if you haven’t already.
- On the Stitch Dashboard page, click the Add Integration button.
- Click the Microsoft SQL Server icon.
Fill in the fields as follows:
Integration Name: Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your data warehouse.
For example, the name “Stitch SQL Server RDS” would create a schema called
stitch_sql_server_rdsin the data warehouse. Note: The schema name cannot be changed after the integration is saved.
Host (Endpoint): Paste the Endpoint address from the SQL Server RDS Details page in AWS into this field.
Don’t include the port number, which is appended to the end of the endpoint string - this will cause errors.
Port: Enter the port used by the SQL Server RDS instance. The default is
Username: Enter the Stitch SQL Server RDS database user’s username.
Password: Enter the password for the Stitch database user.
Database: Enter the name of the SQL Server RDS database. Stitch will ‘find’ all databases you give the Stitch user access to - a default database is only used to complete the connection.
In addition, click the Connect using SSL checkbox if you’re using an SSL connection. Note: The database must support and allow SSL connections for this setting to work correctly.
Step 5: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Stitch offers two methods of creating a replication schedule:
- Replication Frequency: This method requires selecting the interval you want replication to run for the integration. Start times of replication jobs are based on the start time and duration of the previous job. Refer to the Replication Frequency documentation for more information and examples.
Anchor scheduling: Based on the Replication Frequency, or interval, you select, this method “anchors” the start times of this integration’s replication jobs to a time you select to create a predictable schedule. Anchor scheduling is a combination of the Anchor Time and Replication Frequency settings, which must both be defined to use this method. Additionally, note that:
- A Replication Frequency of at least one hour is required to use anchor scheduling.
An initial replication job may not begin immediately after saving the integration, depending on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
- You’ll need to contact support to request using an Anchor Time with this integration.
To help prevent overages, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 6: Select data to replicate
The last step is to select the tables and columns you want to replicate. When you track a table, you’ll also need to define its Replication Method and, if using Key-based Incremental Replication, its Replication Key.
You can track tables and columns by:
- In the Integration Details page, click the Tables to Replicate tab.
- Locate a table you want to replicate.
- Click the checkbox next to the object’s name. A green checkmark means the object is set to replicate.
- If there are child objects, they’ll automatically display and you’ll be prompted to select some.
- After you set a table to replicate, the Table Settings page will display. Note: When you track a table, by default all columns will also be tracked.
In the Table Settings page, define the table’s Replication Method and, if using Key-based Incremental Replication, its Replication Key.
- Repeat this process for every table you want to replicate.
Initial and historical replication jobs
After you finish setting up SQL Server RDS, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Extracting data from SQL Server RDS
When you connect a database as an input, Stitch only needs read-only access to the databases, tables, and columns you want to replicate. There are two processes Stitch runs during the Extraction phase of the replication process: a structure sync and a data sync.
Structure sync queries
The first part of the replication process is called a structure sync. This process will detect any changes to the structure of your database. For example: a new column is added to one of the tables you’re syncing in Stitch.
To perform a structure sync, Stitch runs queries on the
partitions tables in the
Data sync queries
The second step in the Extraction phase is called a data sync. This is where Stitch extracts data and replicates it. The method Stitch uses is the same for all databases, but differs depending on the Replication Method that each table uses.
Key-based Incremental Replication
For tables using Key-based Incremental Replication, Stitch runs a single query and reads out of the associated cursor in batches:
SELECT column_a, column_b <,...> FROM table_a WHERE replication_key_column >= 'last_maximum_replication_key_value' ORDER BY replication_key_column
Full Table Replication
For tables using Full Table Replication, Stitch runs a single query and reads out of the resulting cursor in batches:
SELECT column_a, column_b <,...> FROM table_a
While we make every effort to ensure the queries that Stitch executes don’t impart significant load on your databases, we still have some recommendations for guaranteeing database performance:
- Use a replica database instead of connecting directly. We recommend using read replicas in lieu of directly connecting production databases with high availability and performance requirements.
- Apply indexes to Replication Key columns. We restrict and order our replication queries by this column, so applying an index to the columns you’re using as Replication Keys can improve performance.