Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sqlbuild.com/llms.txt

Use this file to discover all available pages before exploring further.

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"
FieldDescription
hostSQL Server hostname (default: localhost). Also accepts server as an alias.
portSQL Server port (default: 1433)
userDatabase user (default: sa). Also accepts username as an alias.
passwordDatabase password
databaseDatabase 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.

​
Per-environment connections

adapter = "sqlserver"

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

[environments.prod]
schema = "prod"

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

[environments.dev]
schema = "dev"

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