Skip to content

Commit

Permalink
docs: update demos
Browse files Browse the repository at this point in the history
  • Loading branch information
@brianheineman
brianheineman committed Jan 9, 2025
1 parent 9562000 commit ef92c2f
Show file tree
Hide file tree
Showing 48 changed files with 744 additions and 757 deletions.
18 changes: 9 additions & 9 deletions rsql_cli/docs/src/chapter2/bail/demo.cast
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{"version": 2, "width": 120, "height": 30, "timestamp": 1736209274, "env": {"SHELL": "/bin/zsh", "TERM": "xterm-256color"}}
[0.02408, "o", "\u001b]11;?\u001b\\"]
[0.049554, "o", "⠁ connect [00:00:00] [ ] 0 B/0 B (0 B/s, 0s)"]
[0.04964, "o", "\r\u001b[2K"]
[0.059226, "o", "rsql> \u001b[38;2;131;148;150m.bail\u001b[0m\r\n"]
[0.059403, "o", "Bail on error: off\r\n"]
[1.101722, "o", "rsql> \u001b[38;2;131;148;150m.bail off\u001b[0m\r\n"]
[2.151788, "o", "rsql> \u001b[38;2;131;148;150m.invalid\u001b[38;2;133;153;0m-\u001b[38;2;131;148;150mcommand\u001b[0m\r\n"]
[2.152571, "o", "\u001b[31m\u001b[31mError\u001b[0m\u001b[31m\u001b[0m: Invalid command '\u001b[1m.invalid-command\u001b[0m', for help type '\u001b[1m.help\u001b[0m'\r\n"]
{"version": 2, "width": 120, "height": 30, "timestamp": 1736383345, "env": {"SHELL": "/bin/zsh", "TERM": "xterm-256color"}}
[0.02404, "o", "\u001b]11;?\u001b\\"]
[0.062523, "o", "⠁ connect [00:00:00] [ ] 0 B/0 B (0 B/s, 0s)"]
[0.062601, "o", "\r\u001b[2K"]
[0.072372, "o", "rsql> \u001b[38;2;131;148;150m.bail\u001b[0m\r\n"]
[0.072573, "o", "Bail on error: off\r\n"]
[1.110631, "o", "rsql> \u001b[38;2;131;148;150m.bail off\u001b[0m\r\n"]
[2.162324, "o", "rsql> \u001b[38;2;131;148;150m.invalid\u001b[38;2;133;153;0m-\u001b[38;2;131;148;150mcommand\u001b[0m\r\n"]
[2.16356, "o", "\u001b[31m\u001b[31mError\u001b[0m\u001b[31m\u001b[0m: Invalid command '\u001b[1m.invalid-command\u001b[0m', for help type '\u001b[1m.help\u001b[0m'\r\n"]
Binary file modified rsql_cli/docs/src/chapter2/bail/demo.gif
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 23 additions & 24 deletions rsql_cli/docs/src/chapter2/changes/demo.cast
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
{"version": 2, "width": 120, "height": 30, "timestamp": 1736209341, "env": {"SHELL": "/bin/zsh", "TERM": "xterm-256color"}}
[0.024657, "o", "\u001b]11;?\u001b\\"]
[0.063544, "o", "⠁ connect [00:00:00] [ ] 0 B/0 B (0 B/s, 0s)"]
[0.063619, "o", "\r\u001b[2K"]
[0.073487, "o", "rsql> \u001b[38;2;133;153;0mCREATE\u001b[38;2;131;148;150m \u001b[38;2;133;153;0mTABLE\u001b[38;2;131;148;150m \u001b[38;2;181;137;0musers\u001b[38;2;131;148;150m\r\n(\r\n id \u001b[38;2;38;139;210mINTEGER\u001b[38;2;131;148;150m \u001b[38;2;147;161;161mPRIMARY KEY\u001b[38;2;131;148;150m,\r\n first_name \u001b[38;2;38;139;210mTEXT\u001b[38;2;131;148;150m \u001b[38;2;133;153;0mNOT NULL\u001b[38;2;131;148;150m,\r\n last_name \u001b[38;2;38;139;210mTEXT\u001b[38;2;131;148;150m \u001b[38;2;133;153;0mNOT NULL\u001b[38;2;131;148;150m,\r\n email \u001b[38;2;38;139;210mTEXT\u001b[38;2;131;148;150m \u001b[38;2;133;153;0mNOT NULL\u001b[38;2;131;148;150m UNIQUE\r\n);\u001b[0m\r\n"]
[0.073541, "o", "⠁ "]
[0.073684, "o", "\r\u001b[2K"]
[0.073758, "o", "0 rows \u001b[2m(219.042µs)\u001b[0m\r\n"]
[1.116916, "o", "rsql> \u001b[38;2;133;153;0mINSERT INTO\u001b[38;2;131;148;150m users (id, first_name, last_name, email)\r\n\u001b[38;2;133;153;0mVALUES\u001b[38;2;131;148;150m (\u001b[38;2;108;113;196m1\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mAlice\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mJohnson\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;[email protected]\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m),\r\n (\u001b[38;2;108;113;196m2\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mBob\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mSmith\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;[email protected]\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m);\u001b[0m\r\n"]
[1.117244, "o", "⠁ "]
[1.117752, "o", "\r\u001b[2K"]
[1.117781, "o", "2 rows \u001b[2m(950.25µs)\u001b[0m\r\n"]
[2.164902, "o", "rsql> \u001b[38;2;131;148;150m.changes\u001b[0m\r\n"]
[2.165444, "o", "Changes: on\r\n"]
[3.219125, "o", "rsql> \u001b[38;2;131;148;150m.changes off\u001b[0m\r\n"]
[4.269166, "o", "rsql> \u001b[38;2;133;153;0mINSERT INTO\u001b[38;2;131;148;150m users (id, first_name, last_name, email)\r\n\u001b[38;2;133;153;0mVALUES\u001b[38;2;131;148;150m (\u001b[38;2;108;113;196m3\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mCharlie\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mBrown\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;[email protected]\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m);\u001b[0m\r\n"]
[4.269841, "o", "⠁ "]
[4.26989, "o", "\r\u001b[2K"]
[4.270091, "o", "\u001b[2m(913.083µs)\u001b[0m\r\n"]
[5.325923, "o", "rsql> \u001b[38;2;131;148;150m.changes \u001b[38;2;133;153;0mon\u001b[0m\r\n"]
[6.377114, "o", "rsql> \u001b[38;2;133;153;0mINSERT INTO\u001b[38;2;131;148;150m users (id, first_name, last_name, email)\r\n\u001b[38;2;133;153;0mVALUES\u001b[38;2;131;148;150m (\u001b[38;2;108;113;196m4\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mDavid\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mLee\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;[email protected]\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m);\u001b[0m\r\n"]
[6.37737, "o", "⠁ "]
[6.377604, "o", "\r\u001b[2K"]
[6.377749, "o", "1 row \u001b[2m(688.709µs)\u001b[0m\r\n"]
{"version": 2, "width": 120, "height": 30, "timestamp": 1736383412, "env": {"SHELL": "/bin/zsh", "TERM": "xterm-256color"}}
[0.024177, "o", "\u001b]11;?\u001b\\"]
[0.055536, "o", "⠁ connect [00:00:00] [ ] 0 B/0 B (0 B/s, 0s)"]
[0.055614, "o", "\r\u001b[2K"]
[0.065245, "o", "rsql> \u001b[38;2;133;153;0mCREATE\u001b[38;2;131;148;150m \u001b[38;2;133;153;0mTABLE\u001b[38;2;131;148;150m \u001b[38;2;181;137;0musers\u001b[38;2;131;148;150m\r\n(\r\n id \u001b[38;2;38;139;210mINTEGER\u001b[38;2;131;148;150m \u001b[38;2;147;161;161mPRIMARY KEY\u001b[38;2;131;148;150m,\r\n first_name \u001b[38;2;38;139;210mTEXT\u001b[38;2;131;148;150m \u001b[38;2;133;153;0mNOT NULL\u001b[38;2;131;148;150m,\r\n last_name \u001b[38;2;38;139;210mTEXT\u001b[38;2;131;148;150m \u001b[38;2;133;153;0mNOT NULL\u001b[38;2;131;148;150m,\r\n email \u001b[38;2;38;139;210mTEXT\u001b[38;2;131;148;150m \u001b[38;2;133;153;0mNOT NULL\u001b[38;2;131;148;150m UNIQUE\r\n);\u001b[0m\r\n"]
[0.065288, "o", "⠁ "]
[0.06545, "o", "\r\u001b[2K"]
[0.065565, "o", "0 rows \u001b[2m(225.833µs)\u001b[0m\r\n"]
[1.105388, "o", "rsql> \u001b[38;2;133;153;0mINSERT INTO\u001b[38;2;131;148;150m users (id, first_name, last_name, email)\r\n\u001b[38;2;133;153;0mVALUES\u001b[38;2;131;148;150m (\u001b[38;2;108;113;196m1\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mAlice\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mJohnson\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;[email protected]\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m),\r\n (\u001b[38;2;108;113;196m2\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mBob\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mSmith\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;[email protected]\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m);\u001b[0m\r\n"]
[1.106283, "o", "⠁ "]
[1.106599, "o", "\r\u001b[2K2 rows \u001b[2m(1.162542ms)\u001b[0m\r\n"]
[2.154753, "o", "rsql> \u001b[38;2;131;148;150m.changes\u001b[0m\r\n"]
[2.155413, "o", "Changes: on\r\n"]
[3.197714, "o", "rsql> \u001b[38;2;131;148;150m.changes off\u001b[0m\r\n"]
[4.250627, "o", "rsql> \u001b[38;2;133;153;0mINSERT INTO\u001b[38;2;131;148;150m users (id, first_name, last_name, email)\r\n\u001b[38;2;133;153;0mVALUES\u001b[38;2;131;148;150m (\u001b[38;2;108;113;196m3\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mCharlie\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mBrown\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;[email protected]\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m);\u001b[0m\r\n"]
[4.251477, "o", "⠁ execute_sql [00:00:00] [ ] 0 B/0 B (0 B/s, 0s)"]
[4.252635, "o", "\r\u001b[2K"]
[4.253083, "o", "\u001b[2m(2.950625ms)\u001b[0m\r\n"]
[5.298067, "o", "rsql> \u001b[38;2;131;148;150m.changes \u001b[38;2;133;153;0mon\u001b[0m\r\n"]
[6.344917, "o", "rsql> \u001b[38;2;133;153;0mINSERT INTO\u001b[38;2;131;148;150m users (id, first_name, last_name, email)\r\n\u001b[38;2;133;153;0mVALUES\u001b[38;2;131;148;150m (\u001b[38;2;108;113;196m4\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mDavid\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;152mLee\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m, \u001b[38;2;131;148;150m'\u001b[38;2;42;161;[email protected]\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m);\u001b[0m\r\n"]
[6.345228, "o", "⠁ "]
[6.346238, "o", "\r\u001b[2K"]
[6.346289, "o", "1 row \u001b[2m(1.281959ms)\u001b[0m\r\n"]
Binary file modified rsql_cli/docs/src/chapter2/changes/demo.gif
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 12 additions & 12 deletions rsql_cli/docs/src/chapter2/clear/demo.cast
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{"version": 2, "width": 120, "height": 30, "timestamp": 1736209374, "env": {"SHELL": "/bin/zsh", "TERM": "xterm-256color"}}
[0.024373, "o", "\u001b]11;?\u001b\\"]
[0.049714, "o", "⠁ connect [00:00:00] [ ] 0 B/0 B (0 B/s, 0s)"]
[0.049815, "o", "\r\u001b[2K"]
[0.059584, "o", "rsql> \u001b[38;2;131;148;150m.help\u001b[0m\r\n"]
[0.059782, "o", "\u001b[1m.bail\u001b[0m\u001b[2m on|off \u001b[0m Stop after an error occurs\r\n"]
[0.059794, "o", "\u001b[1m.changes\u001b[0m\u001b[2m on|off \u001b[0m Show number of rows changed\r\n\u001b[1m.clear\u001b[0m\u001b[2m \u001b[0m Clear the screen\r\n\u001b[1m.color\u001b[0m\u001b[2m on|off \u001b[0m Enable or disable color output\r\n"]
[0.059843, "o", "\u001b[1m.completions\u001b[0m\u001b[2m on|off \u001b[0m Enable or disable smarter completions\r\n\u001b[1m.describe\u001b[0m\u001b[2m [table] \u001b[0m Describe a table in the schema\r\n\u001b[1m.drivers\u001b[0m\u001b[2m \u001b[0m Display available database drivers\r\n\u001b[1m.echo\u001b[0m\u001b[2m on|prompt|off \u001b[0m Enable or disable echoing commands\r\n\u001b[1m.exit\u001b[0m\u001b[2m [code] \u001b[0m Exit the application\r\n\u001b[1m.footer\u001b[0m\u001b[2m on|off \u001b[0m Enable or disable result footer\r\n\u001b[1m.format\u001b[0m\u001b[2m [format] \u001b[0m Set the output format for the results\r\n\u001b[1m.header\u001b[0m\u001b[2m on|off \u001b[0m Enable or disable result header\r\n\u001b[1m.help\u001b[0m\u001b[2m \u001b[0m Show this help message\r\n\u001b[1m.history\u001b[0m\u001b[2m on|off \u001b[0m Show the command history\r\n\u001b[1m.indexes\u001b[0m\u001b[2m [table] \u001b[0m Display the indexes\r\n\u001b[1m.limit\u001b[0m\u001b[2m [limit] \u001b[0m Set the maximum number of results to return\r\n\u001b[1m.locale\u001b[0m\u001b[2m [locale] \u001b[0m Set the display locale\r\n\u001b[1m.output\u001b[0m\u001b[2m clipboard|<file>\u001b[0m Output contents to the sys"]
[0.059888, "o", "tem clipboard, <file> or the console\r\n\u001b[1m.print\u001b[0m\u001b[2m [string] \u001b[0m Print the specified string\r\n"]
[0.059907, "o", "\u001b[1m.quit\u001b[0m\u001b[2m \u001b[0m Quit the application\r\n\u001b[1m.read\u001b[0m\u001b[2m [file] \u001b[0m Read a SQL file and execute it\r\n\u001b[1m.rows\u001b[0m\u001b[2m on|off \u001b[0m Show number of rows returned\r\n\u001b[1m.schemas\u001b[0m\u001b[2m \u001b[0m List the schemas in the database\r\n\u001b[1m.sleep\u001b[0m\u001b[2m [seconds] \u001b[0m Sleep for a specified number of seconds\r\n\u001b[1m.system\u001b[0m\u001b[2m command [args] \u001b[0m Run command in a system shell\r\n\u001b[1m.tables\u001b[0m\u001b[2m \u001b[0m List the tables in the schema\r\n\u001b[1m.tee\u001b[0m\u001b[2m clipboard|<file> \u001b[0m Output contents to the system clipboard or a <file>, and the console\r\n\u001b[1m.timer\u001b[0m\u001b[2m on|off \u001b[0m Enable or disable query execution timer\r\n"]
[1.1081, "o", "rsql> \u001b[38;2;131;148;150m.clear\u001b[0m\r\n"]
[1.11078, "o", "\u001b[H\u001b[2J\u001b[3J"]
{"version": 2, "width": 120, "height": 30, "timestamp": 1736383444, "env": {"SHELL": "/bin/zsh", "TERM": "xterm-256color"}}
[0.024401, "o", "\u001b]11;?\u001b\\"]
[0.063425, "o", "⠁ connect [00:00:00] [ ] 0 B/0 B (0 B/s, 0s)"]
[0.063519, "o", "\r\u001b[2K"]
[0.073393, "o", "rsql> \u001b[38;2;131;148;150m.help\u001b[0m\r\n"]
[0.073613, "o", "\u001b[1m.bail\u001b[0m\u001b[2m on|off \u001b[0m Stop after an error occurs\r\n\u001b[1m.changes\u001b[0m\u001b[2m on|off \u001b[0m Show number of rows changed\r\n\u001b[1m.clear\u001b[0m\u001b[2m \u001b[0m Clear the screen"]
[0.07362, "o", "\r\n\u001b[1m.color\u001b[0m\u001b[2m on|off \u001b[0m Enable or disable color output\r\n\u001b[1m.completions\u001b[0m\u001b[2m on|off \u001b[0m Enable or disable smarter completions\r\n"]
[0.073683, "o", "\u001b[1m.describe\u001b[0m\u001b[2m [table] \u001b[0m Describe a table in the schema\r\n\u001b[1m.drivers\u001b[0m\u001b[2m \u001b[0m Display available database drivers\r\n\u001b[1m.echo\u001b[0m\u001b[2m on|prompt|off \u001b[0m Enable or disable echoing commands\r\n\u001b[1m.exit\u001b[0m\u001b[2m [code] \u001b[0m Exit the application\r\n\u001b[1m.footer\u001b[0m\u001b[2m on|off \u001b[0m Enable or disable result footer\r\n\u001b[1m.format\u001b[0m\u001b[2m [format] \u001b[0m Set the output format for the results\r\n\u001b[1m.header\u001b[0m\u001b[2m on|off \u001b[0m Enable or disable result header\r\n\u001b[1m.help\u001b[0m\u001b[2m \u001b[0m Show this help message\r\n\u001b[1m.history\u001b[0m\u001b[2m on|off \u001b[0m Show the command history\r\n\u001b[1m.indexes\u001b[0m\u001b[2m [table] \u001b[0m Display the indexes\r\n\u001b[1m.limit\u001b[0m\u001b[2m [limit] \u001b[0m Set the maximum number of results to return\r\n\u001b[1m.locale\u001b[0m\u001b[2m [locale] \u001b[0m Set the display locale\r\n\u001b[1m.output\u001b[0m\u001b[2m clipboard|<file>\u001b[0m Output contents to the system clipboard, <file> or the console\r\n\u001b[1m.print\u001b[0m\u001b[2m [string] \u001b[0m P"]
[0.073706, "o", "rint the specified string\r\n"]
[0.073732, "o", "\u001b[1m.quit\u001b[0m\u001b[2m \u001b[0m Quit the application\r\n\u001b[1m.read\u001b[0m\u001b[2m [file] \u001b[0m Read a SQL file and execute it\r\n\u001b[1m.rows\u001b[0m\u001b[2m on|off \u001b[0m Show number of rows returned\r\n\u001b[1m.schemas\u001b[0m\u001b[2m \u001b[0m List the schemas in the database\r\n\u001b[1m.sleep\u001b[0m\u001b[2m [seconds] \u001b[0m Sleep for a specified number of seconds\r\n\u001b[1m.system\u001b[0m\u001b[2m command [args] \u001b[0m Run command in a system shell\r\n\u001b[1m.tables\u001b[0m\u001b[2m \u001b[0m List the tables in the schema\r\n\u001b[1m.tee\u001b[0m\u001b[2m clipboard|<file> \u001b[0m Output contents to the system clipboard or a <file>, and the console\r\n\u001b[1m.timer\u001b[0m\u001b[2m on|off \u001b[0m Enable or disable query execution timer\r\n"]
[1.114115, "o", "rsql> \u001b[38;2;131;148;150m.clear\u001b[0m\r\n"]
[1.115464, "o", "\u001b[H\u001b[2J\u001b[3J"]
Binary file modified rsql_cli/docs/src/chapter2/clear/demo.gif
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit ef92c2f

Please sign in to comment.