Connection Parameters
| Parameter | Description | Required | Example |
|---|---|---|---|
| Host | Server address | Yes | sqlserver.example.com |
| Port | Server port | Optional | 1433 (default) |
| Database | Database name | Yes | ProductionDB |
| Username | SQL Server user | Yes | readonly_user |
| Password | User password | Yes | ******** |
| Authentication | Auth mode | Yes | SQL Server or Windows |
Required Permissions
Create a login and user with read-only access:
sqlserver_permissions.sql
-- Minimum required permissions USE [your_database]; GRANT CONNECT TO readonly_user; GRANT VIEW DEFINITION TO readonly_user; GRANT SELECT ON SCHEMA::dbo TO readonly_user; -- For metadata extraction (System Catalog) GRANT VIEW ANY DEFINITION TO readonly_user;
Special Features
Azure SQL Support
Native support for Azure SQL Database and Managed Instance.
Named Instance Support
Connect seamlessly to named instances (e.g., SERVER\\INSTANCE).
Schema Support
Full support for multiple schemas, including dbo and custom schemas.
Temporal Table Detection
Identifies system-versioned temporal tables for historical data tracking.
Common Issues
Named pipes/TCP not enabled
Enable TCP/IP protocol in SQL Server Configuration Manager.
Login failed for user
Ensure 'Mixed Mode Authentication' is enabled if using SQL Server Authentication. Verify the user exists and account is unlocked.
Cannot connect to Azure SQL
Whitelst your client IP in the Azure SQL firewall settings.
Named instance connection
Use the format `server\instance` or `server\instance,port`. Ensure the SQL Server Browser service is running.