Skip to content
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

Generate db documentation from migrations instead of connection to an actual db #629

Open
fira42073 opened this issue Nov 3, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@fira42073
Copy link

From a user perspective, it would be great if I didn't have to spin up a database instance and apply migration to it in order to generate docs.

I think sqlc is doing a similar thing, perhaps it might be a good idea to somehow reuse this approach, or perhaps even the codebase.
https://github.com/sqlc-dev/sqlc/blob/main/internal/sql/catalog/schema.go

I see that this code is under internal/ , and reusing it is not really viable, but perhaps there is another possibility to evaluate the state of the database by looking just at migrations.

@fira42073 fira42073 added the enhancement New feature or request label Nov 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant