Microsoft SQL Server

Currently, Microsoft SQL Server (MSSQL) is supported through the tbls integration. While direct MSSQL support is not yet implemented, you can use tbls as a workaround to generate schema documentation for your MSSQL database.

Using tbls with Microsoft SQL Server

1. First, install tbls by following the installation instructions

2. Use tbls to generate a schema.json file from your MSSQL database:

tbls out -t json -o schema.json "mssql://dbuser:dbpass@hostname:1433/dbname"

Replace the following with your database details:

• dbuser: Your MSSQL username
• dbpass: Your MSSQL password
• hostname: Your database host (e.g., localhost)
• 1433: Port number (default is 1433)
• dbname: Your database name

3. Use the generated schema.json with Liam:

npx @liam-hq/cli erd build --format=tbls --input schema.json

You can find sample implementations for this case on GitHub:

• GitHub Actions: .github/workflows/mssql-with-tbls.yml
• tbls project: samples/mssql-with-tbls

For more details about using tbls format, see the tbls documentation.

Direct MSSQL Support

Direct MSSQL support is planned but not yet implemented. If you're interested in this feature, please follow or contribute to the discussion on GitHub.