Skip to content

📝 Add MySQL documentation with tbls integration guide #594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 28, 2025

Conversation

MH4GF
Copy link
Member

@MH4GF MH4GF commented Jan 28, 2025

I wrote an example of mysql support using tbls.

Copy link

changeset-bot bot commented Jan 28, 2025

⚠️ No Changeset found

Latest commit: e352210

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@MH4GF MH4GF marked this pull request as ready for review January 28, 2025 04:12
@MH4GF MH4GF requested a review from a team as a code owner January 28, 2025 04:12
@MH4GF MH4GF requested review from hoshinotsuyoshi, FunamaYukina, junkisai and sasamuku and removed request for a team January 28, 2025 04:12
2. Use tbls to generate a schema.json file from your MySQL database:

```bash
tbls out -t json -o schema.json "mysql://dbuser:dbpass@hostname:3306/dbname"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works fine in my local environment👍

3. Use the generated schema.json with Liam:

```bash
npx @liam-hq/cli erd build --format=tbls --input schema.json
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works fine in my local environment👍

this is also fine.

Co-authored-by: Ryota Sasazawa <65695538+sasamuku@users.noreply.github.com>
Copy link
Member

@sasamuku sasamuku left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM⭐

@sasamuku sasamuku added this pull request to the merge queue Jan 28, 2025
Merged via the queue into main with commit b87bf6a Jan 28, 2025
11 checks passed
@sasamuku sasamuku deleted the docs-for-mysql branch January 28, 2025 07:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants