Skip to content

Commit 6763a6e

Browse files
danvergaradanvergara
committed
docs(mkdocs): update docs to catch up with the latest changes
1 parent c55a7b3 commit 6763a6e

File tree

2 files changed

+36
-7
lines changed

2 files changed

+36
-7
lines changed

‎docs/tutorials/navigation.md‎

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ One of the main features of dblab is to be a simple but very useful UI to intera
22
![dblab](https://raw.githubusercontent.com/danvergara/dblab/main/assets/tutorials/images/full-ui.png){ width="700" : .center }
33

44
- <kbd>Ctrl+I</kbd> to move from Rows to Indexes and backwards.
5-
- <kbd>Ctrl+F</kbd> to move from Rows to Constraints and backwards.
5+
- <kbd>Ctrl+T</kbd> to move from Rows to Constraints and backwards.
66
- <kbd>Ctrl+S</kbd> to move from Rows to Structure and backwards.
77

88
When selected each panel will show different information in the bottom box:
@@ -27,4 +27,31 @@ To navigate there you can use:
2727

2828
Once you are placed above the correct name in the menu press <kbd>Enter</kbd> to select the table.
2929
Now you can navigate to the different panels to see the information related to it.
30-
![dblab](https://raw.githubusercontent.com/danvergara/dblab/main/assets/tutorials/images/left-menu.png){ width="400" : .center }
30+
![dblab](https://raw.githubusercontent.com/danvergara/dblab/main/assets/tutorials/images/left-menu.png){ width="400" : .center }
31+
32+
### Key Bindings
33+
Key | Description
34+
----------------------------------------|---------------------------------------
35+
<kbd>Ctrl+Space</kbd> | If the query panel is active, execute the query
36+
<kbd>Ctrl+D</kbd> | Cleans the whole text from the query editor, when the editor is selected
37+
<kbd>Enter</kbd> | If the tables panel is active, list all the rows as a result set on the rows panel and display the structure of the table on the structure panel
38+
<kbd>Ctrl+S</kbd> | If the rows panel is active, switch to the schema panel. The opposite is true
39+
<kbd>Ctrl+T</kbd> | If the rows panel is active, switch to the constraints view. The opposite is true
40+
<kbd>Ctrl+I</kbd> | If the rows panel is active, switch to the indexes view. The opposite is true
41+
<kbd>Ctrl+H</kbd> | Toggle to the panel on the left
42+
<kbd>Ctrl+J</kbd> | Toggle to the panel below
43+
<kbd>Ctrl+K</kbd> | Toggle to the panel above
44+
<kbd>Ctrl+L</kbd> | Toggle to the panel on the right
45+
<kbd>Arrow Up</kbd> | Next row of the result set on the panel. Views: rows, table, constraints, structure and indexes
46+
<kbd>k</kbd> | Next row of the result set on the panel. Views: rows, table, constraints, structure and indexes
47+
<kbd>Arrow Down</kbd> | Previous row of the result set on the panel. Views: rows, table, constraints, structure and indexes
48+
<kbd>j</kbd> | Previous row of the result set on the panel. Views: rows, table, constraints, structure and indexes
49+
<kbd>Arrow Right</kbd> | Horizontal scrolling on the panel. Views: rows, constraints, structure and indexes
50+
<kbd>l</kbd> | Horizontal scrolling on the panel. Views: rows, constraints, structure and indexes
51+
<kbd>Arrow Left</kbd> | Horizontal scrolling on the panel. Views: rows, constraints, structure and indexes
52+
<kbd>h</kbd> | Horizontal scrolling on the panel. Views: rows, constraints, structure and indexes
53+
<kbd>g</kbd> | Move cursor to the top of the panel's dataset. Views: rows, constraints, structure and indexes
54+
<kbd>G</kbd> | Move cursor to the bottom of the panel's dataset. Views: rows, constraints, structure and indexes
55+
<kbd>Ctrl-F</kbd> | Move down by one page. Views: rows, constraints, structure and indexes
56+
<kbd>Ctrl-B</kbd> | Move up by one page. Views: rows, constraints, structure and indexes
57+
<kbd>Ctrl+c</kbd> | Quit

‎docs/usage.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,11 @@ If you want to see the rows of a table, press <kbd>Enter</kbd>.
7878

7979
To see the schema of a table, locate yourself on the `rows` panel and press <kbd>Ctrl+S</kbd> to switch to the `structure` panel, then switch <kbd>Ctrl+S</kbd> to switch back.
8080

81-
The same can be achieved for the `constraints` view by pressing <kbd>Ctrl+F</kbd> to go back and forth between the `rows` and the `constraints` panels.
81+
The same can be achieved for the `constraints` view by pressing <kbd>Ctrl+T</kbd> to go back and forth between the `rows` and the `constraints` panels.
82+
83+
The `--db` flag is now optional (except for Oracle), meaning that the user will be able to see the list of databases they have access to. The regular list of tables will be replaced with a tree structure showing a list of databases and their respective list of tables, branching off each database. Due to the nature of the vast majority of DBMSs that don't allow cross-database queries, dblab has to open an independent connection for each database. The side effect of this decision, is that the user has to press `Enter` on the specific database of interest. An indicator showing the current active database will appear at the bottom-right of the screen. To change the focus, just hit enter on another database. Once a database is selected, the usual behavior of inspecting tables remains the same.
84+
85+
<img src="https://raw.githubusercontent.com/danvergara/dblab/main/screenshots/tree-view.png" />
8286

8387
Now, there's a menu to navigate between hidden views by just clicking on the desired options:
8488

@@ -87,8 +91,7 @@ Now, there's a menu to navigate between hidden views by just clicking on the des
8791
![Alt Text](https://raw.githubusercontent.com/danvergara/dblab/main/screenshots/constraints-view.png){ width="700" : .center }
8892
![Alt Text](https://raw.githubusercontent.com/danvergara/dblab/main/screenshots/indexes-view.png){ width="700" : .center }
8993

90-
As you may have noticed, navigation has already been added, so every time you query the content of a listed table, the result set is going to be paginated. This allows to the user dealing with large tables, optimizing resources.
91-
Just hit the `BACK` and `NEXT` buttons to go back and forth.
94+
9295

9396
### Key Bindings
9497
Key | Description
@@ -97,7 +100,7 @@ Key | Description
97100
<kbd>Ctrl+D</kbd> | Cleans the whole text from the query editor, when the editor is selected
98101
<kbd>Enter</kbd> | If the tables panel is active, list all the rows as a result set on the rows panel and display the structure of the table on the structure panel
99102
<kbd>Ctrl+S</kbd> | If the rows panel is active, switch to the schema panel. The opposite is true
100-
<kbd>Ctrl+F</kbd> | If the rows panel is active, switch to the constraints view. The opposite is true
103+
<kbd>Ctrl+T</kbd> | If the rows panel is active, switch to the constraints view. The opposite is true
101104
<kbd>Ctrl+I</kbd> | If the rows panel is active, switch to the indexes view. The opposite is true
102105
<kbd>Ctrl+H</kbd> | Toggle to the panel on the left
103106
<kbd>Ctrl+J</kbd> | Toggle to the panel below
@@ -111,7 +114,6 @@ Key | Description
111114
<kbd>l</kbd> | Horizontal scrolling on the panel. Views: rows, constraints, structure and indexes
112115
<kbd>Arrow Left</kbd> | Horizontal scrolling on the panel. Views: rows, constraints, structure and indexes
113116
<kbd>h</kbd> | Horizontal scrolling on the panel. Views: rows, constraints, structure and indexes
114-
<kbd>h</kbd> | Horizontal scrolling on the panel. Views: rows, constraints, structure and indexes
115117
<kbd>g</kbd> | Move cursor to the top of the panel's dataset. Views: rows, constraints, structure and indexes
116118
<kbd>G</kbd> | Move cursor to the bottom of the panel's dataset. Views: rows, constraints, structure and indexes
117119
<kbd>Ctrl-F</kbd> | Move down by one page. Views: rows, constraints, structure and indexes

0 commit comments

Comments
 (0)