Azure Synapse Analytics Connector

​

Overview

​

Prerequisites

• 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

• 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)

• 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

​

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
• Schema: Typically dbo (default schema)
• 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
Schema: dbo
Authentication Type: SQL

​

Creating the Connector in TextQL

​

Step 1: Navigate to Connectors Page

1. Go to the TextQL Connectors Page
2. Click New Connector

​

Step 2: Select Azure Synapse Analytics

​

Step 3: Enter Connection Details

​

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

• 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)

​

Authentication Errors

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

​

Timeout Errors

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

​

What’s Next

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