Microsoft SQL Server

SQL Server is a relational database management system, or RDBMS, developed and marketed by Microsoft.

Overview

Hightouch lets you pull data stored in Microsoft SQL Server and push it to downstream destinations. Connecting Hightouch to Microsoft SQL Server requires some setup in both platforms. In Microsoft SQL Server, you need to configure your firewall settings.

Azure firewall setup

By default, Azure protects your SQL Server from any external IP address from connecting to your SQL Server. Follow these steps to add Hightouch's IP addresses to the firewall:

Log into your Azure Console Dashboard.
Click on SQL databases under Services.
Select the SQL database you want to update.
Select Set server firewall .
Under Public network access, select Selected networks.
Scroll to Firewall rules and click Add a firewall rule.
Allowlist the Hightouch IP addresses for your region.
Click the Save button on the bottom left.

Connection configuration

In Hightouch, go to the Sources overview page and click the Add source button. Select Microsoft SQL Server and follow the steps below.

Choose authentication method

When creating a SQL Server source, you can either enter the Host, Port, Database, User, and Password by selecting Password or you can provide the full URI Connection string.

Connection string

Enter your connection string in this format: Server=server;Database=database;User Id=username;Password=password;Encrypt=boolean.

Once you've entered your connection string and clicked Continue, you can skip to the Test your Connection section of this doc.

Choose connection type

Hightouch can connect directly to SQL Server over the public internet or via an SSH tunnel. Since data is encrypted in transit via TLS, a direct connection is suitable for most use cases. You may need to set up a tunnel if your SQL Server instance is on a private network or virtual private cloud (VPC).

Hightouch supports both standard and reverse SSH tunnels. To learn more about SSH tunneling, refer to Hightouch's tunneling documentation.

Configure your source

Enter the following required fields into Hightouch:

Host: The hostname or IP address of your Microsoft SQL Server.
Port: The port number of your Microsoft SQL Server. The default is 1433, but yours may be different.
Database: The name of the database in your Microsoft SQL Server.
User: This can be your personal Microsoft SQL Server login or a dedicated user for Hightouch.
(Optional) Password: The password for the user specified above.

Optionally you can enter a Request timeout duration and whether to Trust server certification.

Test your connection

When setting up Microsoft SQL Server as a source for the first time, Hightouch validates your credentials and access to your database. Once the test passes, click Continue to finish setup.

If you see the following error message, you need to update your firewall settings in your Azure Console.

Cannot open server 'hightouch-test' request by login. Client with IP address '54.196.30.169' is not allowed to access the server. To enable access, use the Windows Azure Management Portal or run sp_set_firewall_rule on the master database to create a firewall rule for this IP address or address range. It may up take up to five minutes for this change to take effect.

Next steps

Once your source configuration has passed the necessary validation, you've completed setting up Microsoft SQL Server as a source. Next, you can set up models to define which data you want to pull from Microsoft SQL Server.

The Microsoft SQL Server source supports these modeling methods:

writing a query in the SQL editor
using the visual table selector
leveraging existing dbt models

Tips and troubleshooting

Most issues with the Microsoft SQL Server source can be resolved by verifying the firewall settings according to the setup instructions above.

If you see an error message similar to the following

Login failed for user '<username>'

login failed for user '<domain>\<username>'

verify that the username and password work locally. You may also need to adjust your Microsoft SQL Service authentication mode. See Microsoft's documentation for more information about login errors and authentication modes.