Microsoft SQL Server

Hevo can load data from any of your pipelines into a Microsoft SQL Server database. In this document, we will walk through the steps to add Microsoft SQL Server as a Destination.


Prerequisites

  • The database user must have CREATE TABLE, ALTER, SELECT, INSERT, UPDATE and USAGE grants on the database.

Add Destination

Do one of the following:

  • After you configure the Source during Pipeline creation, click ADD DESTINATION.

  • Click DESTINATIONS in the Asset Palette, and then, in the Destinations List View, click + CREATE.


Select Destination Type

In the Add Destination page, select MS SQL Server.

Alternatively, use the Search Destination Type search box to search for the Destination.


Configure MS SQL Server Connection Settings

Specify the following settings in the Configure your MS SQL Server Destination page:

MS SQL Server Destination settings

  • Destination Name: A unique name for your Destination.

  • Database Host: The SQL Server host’s IP address or DNS. To connect to a local database, follow the steps given below.

  • Database Port: The port on which your SQL Server listens for connections. Default value: 1433

  • Database User: A user with a non-administrative role in the SQL Server database.

  • Database Password: The password for the user.

  • Database Name: The name of the Destination database to which the data is loaded.

  • Database Schema: The name of the Destination database schema (Default value: dbo)

  • Additional Settings:

    • Connect through SSH: Enable this option to connect to Hevo using an SSH tunnel, instead of directly connecting your MS SQL Server database host to Hevo. This provides an additional level of security to your database by not exposing your MS SQL Server setup to the public. Read Connecting Through SSH.

    If this option is disabled, you must whitelist Hevo’s IP addresses.

    • Sanitize Table/Column Names?: Enable this option to remove all non-alphanumeric characters and spaces in a table or column name, and replace them with an underscore (_). Read Name Sanitization.

Test Connection

After filling the details, click on TEST CONNECTION to test connectivity to the Destination Postgres server.


Save Connection

Once the test is successful, save the connection by clicking on SAVE DESTINATION.


Connect to a Local Database

Prerequisites

  • MY-SQL/MS-SQL service is running on your local machine.

  • You have an account on ngrok and an installed ngrok utility on your local machine. To run ngrok on your local machine, follow these one-time steps:

    1. Extract the ngrok utility:

      • On Linux or MacOS, unzip ngrok from a terminal:

        unzip /path/to/ngrok.zip
        
      • On Windows, double-click ngrok.zip to extract it.

    2. Authenticate ngrok in your local machine:

      ./ngrok authtoken <your_auth_token>
      

      You can get the auth token from your ngrok dashboard. For example, in the image below, the auth_token starts with 1t7uGaJshUvnh2Fg1MApl.

      Auth token


Connecting to the Local Database

Perform the following steps to connect to the local database:

  1. Log in to your database server.

  2. Start a TCP tunnel forwarding to your database port.

    ./ngrok tcp <your_database_port>
    

    For example, the port address for MySQL is 3306. Therefore, the command would be:

    ./ngrok tcp 3306
    
  3. Copy the public IP address (hostname and port number) for your local database and port. For example, in the image below, 8.tcp.ngrok.io is the database hostname and 19789 is the port number.

    Getting hostname and port

  4. Paste the hostname and port number into the Database Host and Database Port fields respectively.

    MySQL settings

  5. Specify all other settings and click TEST & CONTINUE.


Destination Considerations

  • You must disable any foreign keys defined in the target tables. Foreign keys do not allow data to be loaded until the reference table has a corresponding key defined.

  • You can replicate data for only 1018 columns in a given MS SQL Server table. Read Limits on the Number of Columns.


Limitations

None.



Revision History

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

Date Release Description of Change
Jul-26-2021 1.68 Added section, Connect to a Local Database.
Jul-12-2021 NA Updated the section, Destination Considerations.
Last updated on 27 May 2022