SQL Server - SQLBuild

SQL Server requires the optional pymssql dependency:

pip install 'sqlbuild[sqlserver]'
# or
uv pip install 'sqlbuild[sqlserver]'

Connection config

adapter = "sqlserver"

[connection]
host = "localhost"
port = 1433
user = "sa"
password = "my_password"
database = "my_database"

Field	Description
`host`	SQL Server hostname (default: `localhost`). Also accepts `server` as an alias.
`port`	SQL Server port (default: `1433`)
`user`	Database user (default: `sa`). Also accepts `username` as an alias.
`password`	Database password
`database`	Database name (default: `master`). Also accepts `dbname` as an alias.

All fields in connection are passed to pymssql.connect(). See the pymssql documentation for all available options. SQL Server supports schema-only, full-row, and bounded sqb diff comparisons.

Per-target connections

adapter = "sqlserver"

[connection]
host = "localhost"
user = "sa"
password = "${ENV:MSSQL_PASSWORD}"

[targets.prod]
schema = "prod"

[targets.prod.connection]
host = "prod-sql.example.com"
database = "analytics"

[targets.dev]
schema = "dev"

[targets.dev.connection]
database = "analytics_dev"