Add flag to sort tables alphabetically #17
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ntindall
reviewed
Jul 10, 2024
|
|
||
| $ ./bin/sql-gen-doc -dsn 'user:password@tcp(localhost:3306)/database_to_generate' -out outfile.md |
ntindall
reviewed
Jul 10, 2024
| @@ -22,8 +22,10 @@ Usage of ./bin/sql-gen-doc: | |||
| a data source name for the database, e.g. user:password@tcp(mysql:3306)/database_name | |||
| -o string | |||
| the outfile to write the documentation to, if no outfile is specified, the output is written to stdout | |||
| --sort-tables | |||
| outputs tables in alphabetical order | |||
There was a problem hiding this comment.
we should make this the default once we hit 1.0
otherwise I think the behavior is somewhat nondeterministic? (or based upon the order that the dbs are created)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the option to sort tables alphabetically in the output schema file. If the flag is not set, tables will be output in whatever order returned by the query.
I tested by running on a DB with and without the flag and observed the correct output when the flag was set.