Skip to main content
Skip table of contents

MSSQL

The MSSQL connector allows you to connect directly to Microsoft SQL Server or Azure Synapse Analytics databases. Once connected, you can create tabular assets that pull data from your source database into the platform.

Unlike storage connectors (e.g., Amazon S3 or Google Cloud Storage), which connect to data in files or object stores, the Microsoft SQL connector is a database connector that enables access to structured data stored in relational databases.

Currently, the Microsoft SQL connector supports creating tabular assets and cannot be used as an export location.

Prerequisites

Before setting up a Microsoft SQL or Azure Synapse connector, you must have the following information:

  • Host – Your database host’s IP (e.g., 1.1.1.2) or domain (e.g., my.server.com)

  • Port – Typically 1433 for SQL Server and Azure Synapse connections (this is the standard default; update if your environment uses a different port)

  • Database (optional for SQL Server, required for Synapse Dedicated Pools) – Specify this to limit the connector’s scope or target a specific database

  • Username and Password – Credentials for the user account with read access to the required data

  • Firewall Rules – Ensure the platform’s IP ranges are permitted in your database or Synapse workspace firewall

Azure Synapse and Microsoft SQL Server both support encrypted connections using TLS.
By default, the JDBC driver enforces encryption when connecting to Synapse.

Supported Versions:

  • Microsoft SQL Server 2019, 2022

  • Azure Synapse Analytics (Dedicated and On-Demand Pools)

Microsoft SQL vs Azure Synapse

While both systems use the same JDBC driver, there are a few configuration differences to note when connecting to Synapse.

Setting

Microsoft SQL

Azure Synapse

Username Format

username

username@synapseworkspace

Database

Optional

Must be specified when setting up the connector

Default Connection (no database specified)

Connects to the default or master database

Connects to the MASTER instance, which may be on a different pool

Firewall Configuration

Allow inbound connections from platform IPs

Allow inbound connections from platform IPs and Synapse workspace permissions

When connecting to an Azure Synapse Dedicated Pool, the database must be explicitly specified when configuring your connector. For On-Demand (Serverless) Pools, the database may be selected dynamically during asset creation.

Before testing your connector, confirm that network access is correctly configured:

  • Add the Harbr platform’s outbound IP ranges to your database (SQL Server) or workspace (Synapse) firewall.

  • For Synapse, ensure Allow Azure services and resources to access this workspace is enabled in workspace networking settings.

Creating the Connector

  1. Navigate to Manage from the navigation bar.

  2. Select Connectors to open the Manage Connectors screen.

  3. Click Create Connector in the top right corner.

  4. Enter a Name for your connector and an optional Description.

  5. Select Type → Microsoft SQL or Azure Synapse

  6. Enter the required connection details:

    • Host

    • Port

    • Database (if applicable)

    • Username

    • Password

  7. Add any Integration Metadata if needed for programmatic integration.

  8. Click Create to save the connector.

  9. Click Close to return to the Connectors screen.

Creating an Asset

To create a tabular asset using your Microsoft SQL or Synapse connector:

  1. Select Create Asset from the navigation bar.

  2. Choose Tabular as the asset type.

  3. Select your Microsoft SQL connector from the list.

  4. If your connector does not have a database specified, choose a database from the dropdown.

  5. Select a Schema and Table/View.

  6. Complete the remaining configuration steps and Release the asset.

Once released, the asset can be:

  • Shared directly with other users

  • Added to a data product

  • Consumed via data sharing or integrations

The database user configured in the connector must have read access to all schemas and tables intended for asset creation. For best practice, use a service account created specifically for the platform integration, rather than a personal or admin account.

Other Considerations

  • Azure Synapse connections must include the database name for Dedicated Pools.

  • If connecting to an On-Demand Pool, ensure the workspace name is appended to the username (e.g., user@synapseworkspace).

  • Ensure network and workspace permissions allow inbound connections from the Harbr platform.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.