How to configure Microsoft SQL Server (MSSQL) as a destination in Mage to write pipeline data into a SQL Server database using SQL authentication or Azure AD.
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 | ✅ |
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 |
INSERT
and CREATE TABLE
permissions if writing to new tables.