> ## Documentation Index
> Fetch the complete documentation index at: https://docs.textql.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Azure Synapse Analytics Connector

> Connect TextQL to your Azure Synapse Analytics workspace

## Overview

This guide walks you through connecting TextQL to your Azure Synapse Analytics workspace. You can connect to either dedicated SQL pools or serverless SQL endpoints.

## Prerequisites

To connect TextQL with your Azure Synapse Analytics workspace, you will need:

* **Host URL** (SQL endpoint) and **Port** (default: 1433)
* **Database** name and **Schema**
* **SQL admin username** and **Password**
* **Authentication type** (SQL Authentication or Microsoft Entra ID)

## Gathering Connection Details from Azure

### Step 1: Navigate to Your Synapse Workspace

1. Log into the **Azure Portal**
2. Navigate to **Azure Synapse Analytics** from the services menu, or search for your workspace name
3. Select your Synapse workspace from the list

### Step 2: Locate SQL Endpoints

On your workspace's **Overview** page, find the SQL endpoints in the **Essentials** section:

* **Dedicated SQL endpoint**: Used for dedicated SQL pools (e.g., `yourworkspace.sql.azuresynapse.net`)
* **Serverless SQL endpoint**: Used for on-demand serverless queries (e.g., `yourworkspace-ondemand.sql.azuresynapse.net`)

**Choose the endpoint that matches your use case:**

* Use the **serverless endpoint** for ad-hoc queries and exploration without managing compute resources
* Use the **dedicated endpoint** for consistent performance with reserved compute (requires a dedicated SQL pool)

### Step 3: Get SQL Admin Credentials

Your SQL admin username is displayed in the workspace **Overview** under **SQL administrator login**.

### Step 4: Identify Database and Schema

* **Database**: Use `master` for the built-in serverless SQL pool, or the name of your dedicated SQL pool if you've created one
* **Schemas**: Typically `dbo` (default schema). To include more than one, separate them with commas, for example `dbo, sales`
* **Port**: Always `1433` for SQL connections

### Example Connection Details

```
Host: yourworkspace-ondemand.sql.azuresynapse.net
Port: 1433
Username: sqladminuser
Password: (from Azure Portal)
Database: master
Schemas: dbo
Authentication Type: SQL
```

## Creating the Connector in TextQL

### Step 1: Navigate to Connectors Page

1. Go to the [TextQL Connectors Page](https://app.textql.com/connectors)
2. Click **New Connector**

### Step 2: Select Azure Synapse Analytics

Select **Azure Synapse Analytics** from the available connectors to open the configuration form.

### Step 3: Enter Connection Details

The form requires the following information:

| Field | Description | Example |
| - | - | - |
| **Connector Name** | A descriptive name to identify this connection | `My Synapse Workspace` |
| **Host** | The SQL endpoint from your workspace (without https\://) | `yourworkspace-ondemand.sql.azuresynapse.net` |
| **Port** | The port number for Synapse connection | `1433` |
| **Username** | Your SQL admin username | `sqladminuser` |
| **Password** | The corresponding password for your SQL admin user | `••••••••` |
| **Database** | The name of your target database | `master` |
| **Schema** | The schema name within your database | `dbo` |
| **Authentication Type** | Select SQL for SQL Authentication | `SQL` |

### Step 4: Test and Create

1. Click **Test Connection** to verify your credentials and network access
2. Once the test succeeds, click **Create Connector** to save the connection

## Troubleshooting

### Connection Fails

**Verify the following:**

* Credentials are correct and match what's configured in Azure
* SQL pool is running (for dedicated SQL pools - check in the SQL pools section)
* Using the correct endpoint (dedicated vs. serverless)

<Note>
  Having trouble connecting? See the [Network Configuration Guide](/core/datasources/databases/network-configuration) for firewall and IP whitelisting setup.
</Note>

### Authentication Errors

**Check:**

* SQL admin username and password are correct
* Password hasn't expired or been changed
* User has appropriate permissions

### Timeout Errors

**Possible causes:**

* Firewall rules not configured correctly
* SQL pool is paused (for dedicated pools)
* Network connectivity issues
* Incorrect endpoint URL

## What's Next

Once your Azure Synapse connector is set up, you can:

* Ask Ana natural language questions about your data
* Generate SQL queries and visualizations
* Create reports and dashboards
* Share insights with your team


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.