SQLite Forum

Minor fault in CLI documentation
Login

Minor fault in CLI documentation

(1) By Simon Slavin (slavin) on 2022-01-22 12:24:22 [link] [source]

In this section

https://sqlite.org/cli.html#index_recommendations_sqlite_expert_

there's a table which lists the options for the .expert command. The listing for the second option --sample allows a linebreak between the '--' and the 'sample'. Experienced programmers won't have a problem but less experienced once won't understand what it means.

I also note that, when reading the section as a naïve user, it wasn't obvious to me if I should be using --sample 100 or just leaving out that option entirely. Without understanding how SQLite works, I couldn't tell which was a good option to start with. Perhaps part of that section might be rewritten to correct that problem, assuming a not-huge database and an average desktop computer.

(2) By Larry Brasfield (larrybr) on 2022-01-22 17:05:37 in reply to 1 [source]

Thanks. Fixed.

FWIW, I could not figure out what that option's default was until I read the code.