MySQL

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

Using tbls with MySQL

1. First, install tbls by following the installation instructions

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

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

Replace the following with your database details:

• dbuser: Your MySQL username
• dbpass: Your MySQL password
• hostname: Your database host (e.g., localhost)
• 3306: Port number (default is 3306)
• 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/mysql-with-tbls.yml
• tbls project: samples/mysql-with-tbls

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

Direct MySQL Support

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