Skip to content

Commit

Permalink
docs: update demo screen casts
Browse files Browse the repository at this point in the history
  • Loading branch information
@brianheineman
brianheineman committed Dec 17, 2024
1 parent 8c9e2a9 commit 1e184d6
Show file tree
Hide file tree
Showing 50 changed files with 866 additions and 831 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": 1731776588, "env": {"SHELL": "/bin/zsh", "TERM": "xterm-256color"}}
[0.027573, "o", "\u001b]11;?\u001b\\"]
[0.057021, "o", "⠁ connect [00:00:00] [ ] 0 B/0 B (0 B/s, 0s)"]
[0.057119, "o", "\r\u001b[2K"]
[0.06687, "o", "rsql> \u001b[38;2;131;148;150m.bail\u001b[0m\r\n"]
[0.067088, "o", "Bail on error: off\r\n"]
[1.096333, "o", "rsql> \u001b[38;2;131;148;150m.bail off\u001b[0m\r\n"]
[2.135804, "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.136437, "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": 147, "height": 40, "timestamp": 1734416075, "env": {"SHELL": "/bin/zsh", "TERM": "xterm-256color"}}
[0.023984, "o", "\u001b]11;?\u001b\\"]
[0.048435, "o", "⠁ connect [00:00:00] [ ] 0 B/0 B (0 B/s, 0s)"]
[0.048543, "o", "\r\u001b[2K"]
[0.058338, "o", "rsql> \u001b[38;2;131;148;150m.bail\u001b[0m\r\n"]
[0.05853, "o", "Bail on error: off\r\n"]
[1.087863, "o", "rsql> \u001b[38;2;131;148;150m.bail off\u001b[0m\r\n"]
[2.121733, "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.122227, "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.
46 changes: 23 additions & 23 deletions rsql_cli/docs/src/chapter2/changes/demo.cast
View file
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
{"version": 2, "width": 120, "height": 30, "timestamp": 1731776652, "env": {"SHELL": "/bin/zsh", "TERM": "xterm-256color"}}
[0.028305, "o", "\u001b]11;?\u001b\\"]
[0.071489, "o", "⠁ connect [00:00:00] [ ] 0 B/0 B (0 B/s, 0s)"]
[0.071603, "o", "\r\u001b[2K"]
[0.080999, "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.08109, "o", "⠁ "]
[0.081251, "o", "\r\u001b[2K"]
[0.081341, "o", "0 rows \u001b[2m(297.667µs)\u001b[0m\r\n"]
[1.119498, "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;152malice@example.com\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;152mbob@example.com\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m);\u001b[0m\r\n"]
[1.12007, "o", "⠁ \r\u001b[2K"]
[1.120549, "o", "2 rows \u001b[2m(1.009416ms)\u001b[0m\r\n"]
[2.16167, "o", "rsql> \u001b[38;2;131;148;150m.changes\u001b[0m\r\n"]
[2.162101, "o", "Changes: on\r\n"]
[3.207922, "o", "rsql> \u001b[38;2;131;148;150m.changes off\u001b[0m\r\n"]
[4.250022, "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;152mcharlie@example.com\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m);\u001b[0m\r\n"]
[4.25028, "o", "⠁ "]
[4.250882, "o", "\r\u001b[2K"]
[4.251034, "o", "\u001b[2m(1.001875ms)\u001b[0m\r\n"]
[5.295947, "o", "rsql> \u001b[38;2;131;148;150m.changes \u001b[38;2;133;153;0mon\u001b[0m\r\n"]
[6.346078, "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;152mdavid@example.com\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m);\u001b[0m\r\n"]
[6.346522, "o", "⠁ "]
[6.346593, "o", "\r\u001b[2K"]
[6.348468, "o", "1 row \u001b[2m(1.171209ms)\u001b[0m\r\n"]
{"version": 2, "width": 147, "height": 40, "timestamp": 1734416141, "env": {"SHELL": "/bin/zsh", "TERM": "xterm-256color"}}
[0.02353, "o", "\u001b]11;?\u001b\\"]
[0.061799, "o", "⠁ connect [00:00:00] [ ] 0 B/0 B (0 B/s, 0s)"]
[0.061919, "o", "\r\u001b[2K"]
[0.072162, "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.072233, "o", "⠁ "]
[0.072369, "o", "\r\u001b[2K"]
[0.072446, "o", "0 rows \u001b[2m(242µs)\u001b[0m\r\n"]
[1.105718, "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;152malice@example.com\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;152mbob@example.com\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m);\u001b[0m\r\n"]
[1.105927, "o", "⠁ "]
[1.106092, "o", "\r\u001b[2K"]
[1.10625, "o", "2 rows \u001b[2m(567.125µs)\u001b[0m\r\n"]
[2.147267, "o", "rsql> \u001b[38;2;131;148;150m.changes\u001b[0m\r\n"]
[2.147693, "o", "Changes: on\r\n"]
[3.185476, "o", "rsql> \u001b[38;2;131;148;150m.changes off\u001b[0m\r\n"]
[4.22914, "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;152mcharlie@example.com\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m);\u001b[0m\r\n"]
[4.229393, "o", "⠁ \r\u001b[2K"]
[4.229554, "o", "\u001b[2m(468.542µs)\u001b[0m\r\n"]
[5.268833, "o", "rsql> \u001b[38;2;131;148;150m.changes \u001b[38;2;133;153;0mon\u001b[0m\r\n"]
[6.309874, "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;152mdavid@example.com\u001b[38;2;131;148;150m'\u001b[38;2;131;148;150m);\u001b[0m\r\n"]
[6.310045, "o", "⠁ "]
[6.310232, "o", "\r\u001b[2K"]
[6.31042, "o", "1 row \u001b[2m(546.041µs)\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: 11 additions & 13 deletions rsql_cli/docs/src/chapter2/clear/demo.cast
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
{"version": 2, "width": 120, "height": 30, "timestamp": 1731776684, "env": {"SHELL": "/bin/zsh", "TERM": "xterm-256color"}}
[0.027644, "o", "\u001b]11;?\u001b\\"]
[0.055739, "o", "⠁ connect [00:00:00] [ ] 0 B/0 B (0 B/s, 0s)"]
[0.055863, "o", "\r\u001b[2K"]
[0.065643, "o", "rsql> \u001b[38;2;131;148;150m.help\u001b[0m\r\n"]
[0.065801, "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"]
[0.065848, "o", "\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\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"]
[0.065907, "o", "\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 Print the specified string\r\n\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 "]
[0.065924, "o", "in a system shell\r\n"]
[0.065952, "o", "\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"]
[0.065984, "o", "\u001b[1m.timer\u001b[0m\u001b[2m on|off \u001b[0m Enable or disable query execution timer\r\n"]
[1.101605, "o", "rsql> \u001b[38;2;131;148;150m.clear\u001b[0m\r\n"]
[1.103114, "o", "\u001b[H\u001b[2J\u001b[3J"]
{"version": 2, "width": 147, "height": 40, "timestamp": 1734416173, "env": {"SHELL": "/bin/zsh", "TERM": "xterm-256color"}}
[0.024353, "o", "\u001b]11;?\u001b\\"]
[0.055245, "o", "⠁ connect [00:00:00] [ ] 0 B/0 B (0 B/s, 0s)"]
[0.05532, "o", "\r\u001b[2K"]
[0.065432, "o", "rsql> \u001b[38;2;131;148;150m.help\u001b[0m\r\n"]
[0.065658, "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\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\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"]
[0.065694, "o", "\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"]
[0.065704, "o", "\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 Print the specified string\r\n\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"]
[0.06571, "o", "\u001b[1m.timer\u001b[0m\u001b[2m on|off \u001b[0m Enable or disable query execution timer\r\n"]
[1.108155, "o", "rsql> \u001b[38;2;131;148;150m.clear\u001b[0m\r\n"]
[1.110207, "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 1e184d6

Please sign in to comment.