rudb-cli 0.2.9

The command line shell.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

//! The text the shell prints about itself.
//!
//! Kept together so that adding an option and forgetting to document it is one file to notice
//! rather than two.

/// The list of modes, which both `.help` and the error from a bad `.mode` want.
pub const MODES: &str = "ascii, box, column, csv, duckbox, html, insert, json, jsonlines, line, list, markdown, quote, table, tabs, trash";

/// What `-help` prints.
pub const USAGE: &str = "\
Usage: rudb [OPTIONS] [FILENAME [SQL...]]

An embedded analytical database, compatible with DuckDB.

FILENAME is the database to open. Only :memory: works today, because there is no storage format
yet. A second argument is SQL to run, after which the shell exits.

Options:
  -bail                  stop after the first error
  -batch                 read input as a script even when it is a terminal
  -c, -s SQL             run SQL and exit
  -cmd SQL               run SQL before reading input, and keep reading
  -echo                  print each statement before running it
  -f, -file FILENAME     run a file of SQL and exit
  -header, -noheader     turn column names on or off
  -init FILENAME         run a file of SQL before reading input
  -interactive           show a prompt even when input is not a terminal
  -newline SEP           what goes between rows in the separated modes
  -nullvalue TEXT        what a null prints as
  -readonly              open without allowing writes
  -separator SEP         what goes between values in the separated modes
  -version               print the version and exit
  --print-config         print the build configuration and exit
  -h, -help              print this and exit

Any mode can also be given as an option, so -csv is the same as -cmd '.mode csv'.
";

/// What `.help` prints.
pub const DOT_COMMANDS: &str = "\
.bail on|off             stop after the first error
.databases               list the attached databases
.echo on|off             print each statement before running it
.exit                    exit the shell
.headers on|off          turn column names on or off
.help                    print this
.mode MODE ?TABLE?       set the output mode
.nullvalue TEXT          set what a null prints as
.open FILENAME           close the current database and open another
.output ?FILENAME?       send output to a file, or back to stdout
.print TEXT...           print the text
.quit                    exit the shell
.read FILENAME           run a file of SQL
.schema ?PATTERN?        show the CREATE TABLE for the tables
.separator COL ?ROW?     set the separators used in the separated modes
.show                    show the current settings
.tables ?PATTERN?        list the tables
.timer on|off            print how long each statement took
";