MSSQL snapshot

A high-level look at Stitch's MSSQL integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release Status

Released

Supported By

Stitch

Stitch Plan

Free

Supported Versions

2000 through 2016

CONNECTION METHODS
SSH Connections

Supported

SSL Connections

Supported

REPLICATION SETTINGS
Anchor Scheduling

Unsupported

Table-level Reset

Supported

Configurable Replication Methods

Supported

REPLICATION METHODS
Log-based Replication

Unsupported

Key-based Replication

Supported

Full Table Replication

Supported

DATA SELECTION
Table Selection

Supported

Column Selection

Supported

View Replication

Supported

TRANSPARENCY
Extraction Logs

Unsupported

Loading Reports

Supported

Connecting MSSQL

MSSQL setup requirements

To set up MSSQL in Stitch, you need:

Make sure your server is set up properly before continuing. If you need some help figuring out your hosting details, we recommend looping in a member of your engineering team.


Step 1: Whitelist Stitch's IP addresses

For the connection to be successful, you’ll need to configure your firewall to allow access from our IP addresses. Whitelist the following IPs before continuing onto the next step:

  • 52.23.137.21/32

  • 52.204.223.208/32

  • 52.204.228.32/32

  • 52.204.230.227/32


Step 2: Create a Stitch database user

Creating a user with SELECT privileges can either be done via a query or the MSSQL UI. In this section, we’ll walk you through using the query method.

  1. Log into your database.
  2. Create a SQL login for the Stitch database user:

    CREATE LOGIN [stitch_username] WITH PASSWORD=[password]
    go
    
  3. Grant the Stitch user access to the database:

    USE [database]
    go
    
  4. Create the Stitch database user and map them to the database:

    CREATE USER [stitch_username] FOR LOGIN 
    go
    
  5. Grant the Stitch user SELECT privileges.

    To grant SELECT privileges 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
    

Step 3: Connect Stitch

In this step, you’ll complete the setup by entering the database’s connection details and defining replication settings in Stitch.

Step 3.1: Define the database connection details

  1. Sign into your Stitch account, if you haven’t already.
  2. On the Stitch Dashboard page, click the Add Integration button.
  3. Click the MSSQL icon.
  4. 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 MSSQL” would create a schema called stitch_mssql in the data warehouse. Note: The schema name cannot be changed after the integration is saved.

    • Host (Endpoint): Enter the host address (endpoint) used by the MSSQL instance.

      In general, this will be 127.0.0.1 (localhost), but could also be some other network address (ex: 192.68.0.1) or your server’s public IP address. Note: This must be the actual address - entering localhost into this field will cause connection issues.

    • Port: Enter the port used by the MSSQL instance. The default is 1433.

    • Username: Enter the Stitch MSSQL database user’s username.

    • Password: Enter the password for the Stitch database user.

    • Database: Optional: Enter the name of the default database Stitch will connect to. Stitch will ‘find’ all databases you give the Stitch user access to - a default database is only used to test and complete the connection.

Step 3.2: Define the SSL connection details

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 4: 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 keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.


Step 5: Select data to replicate

The last step is to select 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 select tables and columns by:

  1. In the Integration Details page, click the Tables to Replicate tab.
  2. Locate a table you want to replicate.
  3. Click the checkbox next to the object’s name. A green checkmark means the object is set to replicate.
  4. If there are child objects, they’ll automatically display and you’ll be prompted to select some.
  5. After you set a table to replicate, the Settings page will display. Note: When you track a table, by default all columns will also be tracked.

  6. In the Settings page, define the table’s Replication Method and, if using Key-based Incremental Replication, its Replication Key.

  7. Repeat this process for every table you want to replicate.

Initial and historical replication jobs

After you finish setting up MSSQL, 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.



Troubleshooting

Connection issues and collation

If you’re experiencing connection issues and have verified that the database user has the correct permissions, check your server’s collation setting.

Connecting MSSQL to Stitch successfully requires that your server use case-insensitive collation.

Data discrepancies and database user language settings

If you’re missing data, check that the database user’s language setting is set to us_english. Using a different setting can cause problems with replication, including issues with properly identifying new and updated data.


Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.