MSSQL (Microsoft SQL Server)

Overview

Use Microsoft SQL Server (MSSQL) as a destination in Mage to export data from your pipelines into relational tables for analytics, reporting, or operational workloads. Mage supports both on-premise SQL Server deployments and cloud-hosted options like Azure SQL Database.

Configuration Parameters

You must provide the following credentials to configure the MSSQL destination:

Key	Description	Example Value	Required
`database`	Name of the target database where data will be written.	`msdb`	✅
`host`	Hostname or IP address of your MSSQL server.	`172.20.0.2`	✅
`port`	Port used by the MSSQL service. Typically `1433`.	`1433`	✅
`username`	Username with permission to read and write to the specified schema and table.	`guest`	✅
`password`	Password for the MSSQL user.	`abc123...`	✅
`schema`	Target schema inside the database.	`public`	✅
`table`	Name of the destination table Mage will create or write to.	`users`	✅

Optional Parameters

Key	Description	Example Value
`authentication`	Authentication method. Set to `ActiveDirectoryServicePrincipal` to use Azure AD authentication.	`ActiveDirectoryServicePrincipal`
`driver`	Name of the ODBC driver for SQL Server.	`ODBC Driver 18 for SQL Server`
`skip_schema_creation`	If `true`, Mage will skip the `CREATE SCHEMA` command during initialization. See GitHub issue	`true`
`lower_case`	If `true`, all column names will be converted to lowercase. Default is `true`.	`true`
`connection_method`	Connection method. Set to `ssh_tunnel` to connect via SSH tunnel. Default: `direct`	`ssh_tunnel`
`ssh_host`	(SSH tunnel only) The host of the intermediate bastion server.	`123.45.67.89`
`ssh_port`	(SSH tunnel only) The port of the intermediate bastion server. Default: `22`	`22`
`ssh_username`	(SSH tunnel only) The username used to connect to the bastion server.	`username`
`ssh_password`	(SSH tunnel only, optional) The password used to connect to the bastion server. Required if not using `ssh_pkey`.	`password`
`ssh_pkey`	(SSH tunnel only, optional) The path to the private key used to connect to the bastion server. Required if not using `ssh_password`.	`/path/to/private/key`

SSH tunneling is a Mage Pro only feature.

Notes

Mage uses the SQLAlchemy MSSQL dialect to connect and write data into Microsoft SQL Server.
Ensure the user has INSERT and CREATE TABLE permissions if writing to new tables.
Azure-hosted SQL Servers may require SSL or Azure AD authentication depending on your network configuration.
Make sure any required firewall rules or virtual network settings are properly configured for external access.

Adventure starts here

Concepts

Project

Contributing

About

MSSQL (Microsoft SQL Server)

Overview

Configuration Parameters

Optional Parameters

Notes

​Overview

​Configuration Parameters

​Optional Parameters

​Notes

​Related Resources

Overview

Configuration Parameters

Optional Parameters

Notes

Related Resources