chore(docs): sqlite instructions #827
Conversation
npetzall
commented
Feb 13, 2022
•
npetzall
commented
|
It's old and moldy, so a quick review so that it's understandable. Should we include a link to an example db? |
| Recommended driver is the xerial driver: |xerial| |br| | ||
| Driver can be downloaded from releases |br| | ||
| To use the driver specify ``-t sqlite-xerial`` |
There was a problem hiding this comment.
This can be made more concise.
And less "choppy".
It doesn't flow well.
| Driver can be downloaded from releases |br| | ||
| To use the driver specify ``-t sqlite-xerial`` | ||
|
|
||
| If connecting without user/pass the ``-sso`` argument can be used. |
There was a problem hiding this comment.
Not SQLite-specific. Remove.
There was a problem hiding this comment.
The reasoning would be that SQLite is more common without user/pass than others since it's not an exposed service.
There was a problem hiding this comment.
Are we gonna make that evaluation for each database that we support? I think it would be better to create a credentials page a refer to that one.
| Arguments: |br| | ||
| ``-s`` same as database name | ||
| ``-cat`` same as database name | ||
| ``-db`` full path to database file |
There was a problem hiding this comment.
Misformatted: Each should appear on their own line.
| ``-cat`` same as database name | ||
| ``-db`` full path to database file | ||
|
|
||
| Example layout on windows: |br| |
There was a problem hiding this comment.
No reason to be Windows-specific
There was a problem hiding this comment.
Reasoning is to be as clear as possible and I have more faith in Linux user being able to convert Windows information than Windows users converting Linux information.
This is a bias from my side, i sort of assume Linux users are more comfortable in a terminal than Windows users.
There was a problem hiding this comment.
There's a point where trying to be clear just causes confusion. I'm confident that our users can understand an abstract file system (you could even draw it like a tree if you want)
| To avoid possible issues with space and strange characters. |br| | ||
| Base directory ``C:\Tmp\sqlite`` |br| | ||
| place ``schemaspy-[version].jar`` in the root of that folder. |br| |
There was a problem hiding this comment.
Yes, it's a maintainability problem. We don't want to repeat this for each database
| place ``sqlite-jdbc-[version].jar`` in a subdir ``driver`` |br| | ||
| place ``[databasefile].db`` in a subdir ``db`` |br| | ||
|
|
||
| If we use chinook.db as an example we will have the following layout:: |
There was a problem hiding this comment.
Should we include a link to an example db?
Sure!
| Place the command prompt in ``C:\Tmp\sqlite`` |br| | ||
| Now you can run:: |
There was a problem hiding this comment.
Replace with terminal command
| Place the command prompt in ``C:\Tmp\sqlite`` |br| | ||
| Now you can run:: | ||
|
|
||
| java -jar schemaspy-6.1.1-SNAPSHOT.jar -t sqlite-xerial -sso -o out -dp driver -db C:/Tmp/sqlite/db/chinook.db -s chinook -cat chinook |
|
|
||
| java -jar schemaspy-6.1.1-SNAPSHOT.jar -t sqlite-xerial -sso -o out -dp driver -db C:/Tmp/sqlite/db/chinook.db -s chinook -cat chinook | ||
|
|
||
| Output will be written to ``C:\Tmp\sqlite\out`` |br| |
There was a problem hiding this comment.
This is clear from the command
There was a problem hiding this comment.
Depending on the level of the reader i would say.
There was a problem hiding this comment.
In that case, do like we do in the README at tell them to browse C:\Tmp\sqlite\out\index.html. But, again, that's general instructions
| Place the command prompt in ``C:\Tmp\sqlite`` |br| | ||
| Now you can run:: | ||
|
|
||
| java -jar schemaspy-6.1.1-SNAPSHOT.jar -t sqlite-xerial -sso -o out -dp driver -db C:/Tmp/sqlite/db/chinook.db -s chinook -cat chinook |
There was a problem hiding this comment.
Split up up the command over several lines from readability.
