Update the documentation for preferences dialog and keyboard shortcuts. #7349, #7458

This commit is contained in:
Pravesh Sharma 2024-05-15 15:21:23 +05:30 committed by GitHub
parent f833cea0dd
commit 1c44cfb714
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
17 changed files with 145 additions and 155 deletions

View File

@ -100,25 +100,29 @@ The toolbar options are:
:alt: Debugger navigation toolbar :alt: Debugger navigation toolbar
:align: center :align: center
+-------------------------+-----------------------------------------------------------------------------------------------------------+ .. table::
| Option | Action | :class: longtable
+=========================+===========================================================================================================+ :widths: 1 4 1
| *Step into* | Click the *Step into* icon to execute the currently highlighted line of code. |
+-------------------------+-----------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------------------------------------------------------------------------------------------------+------------------------+
| *Step over* | Click the *Step over* icon to execute a line of code, stepping over any sub-functions invoked by the code.| | Option | Action | Shortcut |
| | The sub-function executes, but is not debugged unless it contains a breakpoint. | +=========================+===========================================================================================================+========================+
+-------------------------+-----------------------------------------------------------------------------------------------------------+ | *Step into* | Click the *Step into* icon to execute the currently highlighted line of code. | Option/Alt + Shift + I |
| *Continue/Start* | Click the *Continue/Start* icon to execute the highlighted code, and continue until the program | +-------------------------+-----------------------------------------------------------------------------------------------------------+------------------------+
| | encounters a breakpoint or completes. | | *Step over* | Click the *Step over* icon to execute a line of code, stepping over any sub-functions invoked by the code.| Option/Alt + Shift + O |
+-------------------------+-----------------------------------------------------------------------------------------------------------+ | | The sub-function executes, but is not debugged unless it contains a breakpoint. | |
| *Toggle breakpoint* | Use the *Toggle breakpoint* icon to enable or disable a breakpoint (without removing the breakpoint). | +-------------------------+-----------------------------------------------------------------------------------------------------------+------------------------+
+-------------------------+-----------------------------------------------------------------------------------------------------------+ | *Continue/Start* | Click the *Continue/Start* icon to execute the highlighted code, and continue until the program | Option/Alt + Shift + C |
| *Clear all breakpoints* | Click the *Clear all breakpoints* icon to remove all breakpoints from the program. | | | encounters a breakpoint or completes. | |
+-------------------------+-----------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------------------------------------------------------------------------------------------------+------------------------+
| *Stop* | Click the *Stop* icon to halt the execution of a program. | | *Toggle breakpoint* | Use the *Toggle breakpoint* icon to enable or disable a breakpoint (without removing the breakpoint). | Option/Alt + Shift + T |
+-------------------------+-----------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------------------------------------------------------------------------------------------------+------------------------+
| *Help* | Click the *Help* icon to open debugger documentation. | | *Clear all breakpoints* | Click the *Clear all breakpoints* icon to remove all breakpoints from the program. | Option/Alt + Shift + X |
+-------------------------+-----------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------------------------------------------------------------------------------------------------+------------------------+
| *Stop* | Click the *Stop* icon to halt the execution of a program. | Option/Alt + Shift + S |
+-------------------------+-----------------------------------------------------------------------------------------------------------+------------------------+
| *Help* | Click the *Help* icon to open debugger documentation. | |
+-------------------------+-----------------------------------------------------------------------------------------------------------+------------------------+
The top panel of the debugger window displays the program body; click in the The top panel of the debugger window displays the program body; click in the
grey margin next to a line number to add a breakpoint. The highlighted line in grey margin next to a line number to add a breakpoint. The highlighted line in

View File

@ -48,9 +48,9 @@ File Options
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| Icon | Behavior | Shortcut | | Icon | Behavior | Shortcut |
+======================+===================================================================================================+================+ +======================+===================================================================================================+================+
| *Open File* | Click the *Open File* icon to load a previously saved diagram. | Ctrl + O | | *Open File* | Click the *Open File* icon to load a previously saved diagram. | Cmd/Ctrl + O |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Save* | Click the *Save* icon to perform a quick-save of a previously saved diagram, or to save the | Ctrl + S | | *Save* | Click the *Save* icon to perform a quick-save of a previously saved diagram, or to save the | Cmd/Ctrl + S |
| | diagram to a file. | | | | diagram to a file. | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Save as* | Click the *Save As* to open a new browser dialog and specify a new location to save the diagram. | Ctrl + Shift + | | *Save as* | Click the *Save As* to open a new browser dialog and specify a new location to save the diagram. | Ctrl + Shift + |
@ -67,13 +67,13 @@ Export Options
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| Icon | Behavior | Shortcut | | Icon | Behavior | Shortcut |
+======================+===================================================================================================+================+ +======================+===================================================================================================+================+
| *Generate SQL* | Click the *Generate SQL* icon to generate the DDL SQL for the diagram and open a query tool | Option + Ctrl +| | *Generate SQL* | Click the *Generate SQL* icon to generate the DDL SQL for the diagram and open a query tool | Option/Alt + |
| | with the generated SQL ready for execution. | S | | | with the generated SQL ready for execution. | Ctrl + S |
| | You can select the option *With DROP Table* if you wish to have DROP Table DDL statements before | | | | You can select the option *With DROP Table* if you wish to have DROP Table DDL statements before | |
| | each CREATE Table DDL. You can see the option by clicking the down arrow beside the SQL button. | | | | each CREATE Table DDL. You can see the option by clicking the down arrow beside the SQL button. | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Download image* | Click the *Download image* icon to save the ERD diagram in a image formate | Option + Ctrl +| | *Download image* | Click the *Download image* icon to save the ERD diagram in a image formate | Option/Alt + |
| | | I | | | | Ctrl + I |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
Editing Options Editing Options

Binary file not shown.

Before

Width:  |  Height:  |  Size: 193 KiB

After

Width:  |  Height:  |  Size: 184 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 191 KiB

After

Width:  |  Height:  |  Size: 185 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 160 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 117 KiB

After

Width:  |  Height:  |  Size: 132 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 154 KiB

After

Width:  |  Height:  |  Size: 236 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 90 KiB

After

Width:  |  Height:  |  Size: 123 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 119 KiB

After

Width:  |  Height:  |  Size: 256 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 190 KiB

After

Width:  |  Height:  |  Size: 181 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 184 KiB

After

Width:  |  Height:  |  Size: 190 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 35 KiB

View File

@ -13,47 +13,45 @@ When using main browser window, the following keyboard shortcuts are available:
.. table:: .. table::
:class: longtable :class: longtable
:widths: 2 3 :widths: 2 2 3
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shortcut for all platforms | Function | | Shortcut (Windows/Linux) | Shortcut (Mac) | Function |
+============================+=======================================================+ +============================+====================+====================================+
| Shift+Ctrl+a | Add grid row | | Shift + Ctrl + a | Shift + Ctrl + a | Add grid row |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Alt+b | Object explorer | | Shift + Alt + b | Shift + Option + b | Object explorer |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Alt+n | Create object | | Shift + Alt + n | Shift + Option + n | Create object |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Alt+d | Delete object | | Shift + Alt + d | Shift + Option + d | Delete object |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Alt+g | Direct debugging | | Shift + Alt + g | Shift + Option + g | Direct debugging |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Alt+e | Edit object properties | | Shift + Alt + e | Shift + Option + e | Edit object properties |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Alt+f | File main menu | | Shift + Alt + f | Shift + Option + f | File main menu |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Alt+h | Help main menu | | Shift + Alt + h | Shift + Option + h | Help main menu |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Alt+o | Object main menu | | Shift + Alt + o | Shift + Option + o | Object main menu |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Alt+c | Open context menu | | Shift + Alt + q | Shift + Option + q | Open query tool |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Alt+q | Open query tool | | Shift + Ctrl + f | Shift + Ctrl + f | Quick Search |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Ctrl+f | Quick Search | | F5 | F5 | Refresh object explorer |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| F5 | Refresh object explorer | | Shift + Alt + s | Shift + Option + s | Search objects |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Alt+s | Search objects | | Shift + Alt + [ | Shift + Option + [ | Tabbed panel backward |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Alt+[ | Tabbed panel backward | | Shift + Alt + ] | Shift + Option + ] | Tabbed panel forward |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Alt+] | Tabbed panel forward | | Shift + Alt + l | Shift + Option + l | Tools main menu |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Alt+l | Tools main menu | | Shift + Alt + v | Shift + Option + v | View data |
+----------------------------+-------------------------------------------------------+ +----------------------------+--------------------+------------------------------------+
| Shift+Alt+v | View data |
+----------------------------+-------------------------------------------------------+
Property Grid Controls Property Grid Controls
********************** **********************
@ -67,16 +65,14 @@ Use the shortcuts below when working with property grid controls:
+----------------------------+-------------------------------------------------------+ +----------------------------+-------------------------------------------------------+
| Shortcut for all platforms | Function | | Shortcut for all platforms | Function |
+============================+=======================================================+ +============================+=======================================================+
| Control+Shift+A | Add row in Grid | | Ctrl + Shift + A | Add row in Grid |
+----------------------------+-------------------------------------------------------+ +----------------------------+-------------------------------------------------------+
| Tab | Move focus to the next control | | Tab | Move focus to the next control |
+----------------------------+-------------------------------------------------------+ +----------------------------+-------------------------------------------------------+
| Shift+Tab | Move focus to the previous control | | Shift + Tab | Move focus to the previous control |
+----------------------------+-------------------------------------------------------+ +----------------------------+-------------------------------------------------------+
| Return | Pick the selected an item in a combo box | | Return | Pick the selected an item in a combo box |
+----------------------------+-------------------------------------------------------+ +----------------------------+-------------------------------------------------------+
| Control+Shift+A | Add row in Grid |
+----------------------------+-------------------------------------------------------+
SQL Editors SQL Editors
*********** ***********
@ -98,11 +94,7 @@ When using the syntax-highlighting SQL editors, the following shortcuts are avai
+--------------------------+----------------------+-------------------------------------+ +--------------------------+----------------------+-------------------------------------+
| Ctrl + Alt + Right | Cmd + Option + Right | Move right one word | | Ctrl + Alt + Right | Cmd + Option + Right | Move right one word |
+--------------------------+----------------------+-------------------------------------+ +--------------------------+----------------------+-------------------------------------+
| Ctrl + / | Cmd + / | Comment selected code (Inline) | | Ctrl + / | Cmd + / | Comment/Uncomment code (Block) |
+--------------------------+----------------------+-------------------------------------+
| Ctrl + . | Cmd + . | Uncomment selected code (Inline) |
+--------------------------+----------------------+-------------------------------------+
| Ctrl + Shift + / | Cmd + Shift + / | Comment/Uncomment code (Block) |
+--------------------------+----------------------+-------------------------------------+ +--------------------------+----------------------+-------------------------------------+
| Ctrl + a | Cmd + a | Select all | | Ctrl + a | Cmd + a | Select all |
+--------------------------+----------------------+-------------------------------------+ +--------------------------+----------------------+-------------------------------------+
@ -124,11 +116,7 @@ When using the syntax-highlighting SQL editors, the following shortcuts are avai
+--------------------------+----------------------+-------------------------------------+ +--------------------------+----------------------+-------------------------------------+
| Ctrl + f | Cmd + f | Find | | Ctrl + f | Cmd + f | Find |
+--------------------------+----------------------+-------------------------------------+ +--------------------------+----------------------+-------------------------------------+
| Ctrl + g | Cmd + g | Find next | | Ctrl + Shift + f | Option + Cmd + f | Replace |
+--------------------------+----------------------+-------------------------------------+
| Ctrl + Shift + g | Cmd + Shift + g | Find previous |
+--------------------------+----------------------+-------------------------------------+
| Ctrl + Shift + f | Cmd + Shift + f | Replace |
+--------------------------+----------------------+-------------------------------------+ +--------------------------+----------------------+-------------------------------------+
Query Tool Query Tool
@ -143,9 +131,9 @@ When using the Query Tool, the following shortcuts are available:
+--------------------------+-----------------------+-----------------------------------+ +--------------------------+-----------------------+-----------------------------------+
| Shortcut (Windows/Linux) | Shortcut (Mac) | Function | | Shortcut (Windows/Linux) | Shortcut (Mac) | Function |
+==========================+=======================+===================================+ +==========================+=======================+===================================+
| Alt + Shift + o | Option + Shift + o | Open file | | Ctrl + o | Cmd + o | Open file |
+--------------------------+-----------------------+-----------------------------------+ +--------------------------+-----------------------+-----------------------------------+
| Alt + Shift + s | Option + Shift + s | Save file | | Ctrl + s | Cmd + s | Save file |
+--------------------------+-----------------------+-----------------------------------+ +--------------------------+-----------------------+-----------------------------------+
| Alt + Shift + n | Option + Shift + n | Edit options | | Alt + Shift + n | Option + Shift + n | Edit options |
+--------------------------+-----------------------+-----------------------------------+ +--------------------------+-----------------------+-----------------------------------+
@ -185,7 +173,7 @@ When using the Query Tool, the following shortcuts are available:
+--------------------------+-----------------------+-----------------------------------+ +--------------------------+-----------------------+-----------------------------------+
| Shift + Alt + [ | Shift + option + [ | Previous tab | | Shift + Alt + [ | Shift + option + [ | Previous tab |
+--------------------------+-----------------------+-----------------------------------+ +--------------------------+-----------------------+-----------------------------------+
| Shift + Alt + Tab | Shift + option +Tab | Switch Panel | | Shift + Alt + Tab | Shift + option + Tab | Switch Panel |
+--------------------------+-----------------------+-----------------------------------+ +--------------------------+-----------------------+-----------------------------------+
| Shift + Ctrl + u | Shift + Ctrl + u | Toggle case of selected text | | Shift + Ctrl + u | Shift + Ctrl + u | Toggle case of selected text |
+--------------------------+-----------------------+-----------------------------------+ +--------------------------+-----------------------+-----------------------------------+
@ -276,38 +264,17 @@ Inner Tab and Panel Navigation
When using the Query Tool and Debugger, the following shortcuts are available When using the Query Tool and Debugger, the following shortcuts are available
for inner panel navigation: for inner panel navigation:
.. table::I .. table::
:class: longtable :class: longtable
:widths: 2 2 3 :widths: 2 2 3
+--------------------------+---------------------------+------------------------------------+ +--------------------------+---------------------------+------------------------------------+
| Shortcut (Windows/Linux) | Shortcut (Mac) | Function | | Shortcut (Windows/Linux) | Shortcut (Mac) | Function |
+==========================+===========================+====================================+ +==========================+===========================+====================================+
| Alt + Shift + ] | Alt + Shift + ] | Move to next tab within a panel | | Alt + Shift + ] | Option + Shift + ] | Move to next tab within a panel |
+--------------------------+---------------------------+------------------------------------+ +--------------------------+---------------------------+------------------------------------+
| Alt + Shift + [ | Alt + Shift + [ | Move to previous tab within a panel| | Alt + Shift + [ | Option + Shift + [ | Move to previous tab within a panel|
+--------------------------+---------------------------+------------------------------------+ +--------------------------+---------------------------+------------------------------------+
| Alt + Shift + Tab | Alt + Shift + Tab | Move between inner panels | | Alt + Shift + Tab | Option + Shift + Tab | Move between inner panels |
+--------------------------+---------------------------+------------------------------------+ +--------------------------+---------------------------+------------------------------------+
Access Key
**********
<accesskey> is browser and platform dependant. The following table lists the
default access keys for supported browsers.
.. table::
:class: longtable
:widths: 2 1 1 1
+-------------------+-------------+-------------+---------------+
| | Windows | Linux | Mac |
+===================+=============+=============+===============+
| Edge | Alt | | |
+-------------------+-------------+-------------+---------------+
| Chrome | Alt | Alt | Ctrl + Option |
+-------------------+-------------+-------------+---------------+
| Firefox | Alt + Shift | Alt + Shift | Ctrl + Option |
+-------------------+-------------+-------------+---------------+
| Safari | Alt | | Ctrl + Option |
+-------------------+-------------+-------------+---------------+

View File

@ -44,7 +44,8 @@ Use the fields on the *Display* panel to specify general display preferences:
them to continue. them to continue.
* When the *Hide shared servers?* switch is set to *True*, the client will hide * When the *Hide shared servers?* switch is set to *True*, the client will hide
all the shared servers from the object explorer. all the shared servers from the object explorer. **Note:** This option is visible only when
pgAdmin is running in server mode.
* When the *Show empty object collections?* switch is turned off, then all object * When the *Show empty object collections?* switch is turned off, then all object
collections which are empty will be hidden from browser tree. collections which are empty will be hidden from browser tree.
@ -157,12 +158,37 @@ Expand the *Dashboards* node to specify your dashboard display preferences.
Use the fields on the *Refresh rates* panel to specify your refersh rates Use the fields on the *Refresh rates* panel to specify your refersh rates
preferences for the graphs on the *Dashboard* tab: preferences for the graphs on the *Dashboard* tab:
* Use the *Average load statistics refresh rate* field to specify the number of
seconds between average load statistics samples displayed in graphs.
* Use the *Block I/O statistics refresh rate* field to specify the number of * Use the *Block I/O statistics refresh rate* field to specify the number of
seconds between block I/O statistic samples displayed in graphs. seconds between block I/O statistic samples displayed in graphs.
* Use the *CPU usage per process statistics refresh rate* field to specify the number of
seconds between CPU usage per process statistics samples displayed in graphs.
* Use the *Handle & Process count statistics refresh rate* field to specify the number
of seconds between handle & process count statistics samples displayed in graphs.
* Use the *I/O analysis statistics refresh rate* field to specify the number
of seconds between I/O analysis statistics samples displayed in graphs.
* Use the *Memory usage per process statistics refresh rate* field to specify the number
of seconds between memory usage per process statistics samples displayed in graphs.
* Use the *Memory usage statistics refresh rate* field to specify the number
of seconds between memory usage statistics samples displayed in graphs.
* Use the *Percentage of CPU time used by different process modes statistics refresh rate*
field to specify the number of seconds between Percentage of CPU time used by different
process modes samples displayed in graphs.
* Use the *Session statistics refresh rate* field to specify the number of * Use the *Session statistics refresh rate* field to specify the number of
seconds between session statistic samples displayed in graphs. seconds between session statistic samples displayed in graphs.
* Use the *Swap memory usage statistics refresh rate* field to specify the number of
seconds between swap memory usage statistics samples displayed in graphs.
* Use the *Transaction throughput refresh rate* field to specify the number of * Use the *Transaction throughput refresh rate* field to specify the number of
seconds between transaction throughput samples displayed in graphs. seconds between transaction throughput samples displayed in graphs.
@ -205,6 +231,9 @@ Use the fields on the *Options* panel to manage ERD preferences.
:align: center :align: center
* Use *Cardinality Notation* to change the cardinality notation format
used to present relationship links.
* When the *SQL With DROP Table* switch is set to *True*, the SQL * When the *SQL With DROP Table* switch is set to *True*, the SQL
generated by the ERD Tool will add DROP table DDL before each CREATE generated by the ERD Tool will add DROP table DDL before each CREATE
table DDL. table DDL.
@ -251,8 +280,8 @@ Expand the *Miscellaneous* node to specify miscellaneous display preferences.
:align: center :align: center
* Use the *Themes* drop-down listbox to select the theme for pgAdmin. You'll also get a preview just below the * Use the *Themes* drop-down listbox to select the theme for pgAdmin. You'll also get a preview just below the
drop down. Note that, to apply the theme you need to refresh the pgAdmin page. You can also submit your drop down. You can also submit your own themes,
own themes, check `here <https://github.com/pgadmin-org/pgadmin4/blob/master/README.md>`_ how. check `here <https://github.com/pgadmin-org/pgadmin4/blob/master/README.md>`_ how.
Currently we support Standard, Dark and High Contrast theme. Currently we support Standard, Dark and High Contrast theme.
The Paths Node The Paths Node
@ -290,9 +319,6 @@ programs (pg_dump, pg_dumpall, pg_restore and psql) and there respective version
Use the fields on the *Help* panel to specify the location of help files. Use the fields on the *Help* panel to specify the location of help files.
* Use the *EDB Advanced Server Help Path* to specify the path to EDB Postgres
Advanced Server documentation.
* Use the *PostgreSQL Help Path* to specify the path to PostgreSQL * Use the *PostgreSQL Help Path* to specify the path to PostgreSQL
documentation. documentation.
@ -345,11 +371,8 @@ Tool display.
* Use the *Connection status refresh rate* field to specify the number of * Use the *Connection status refresh rate* field to specify the number of
seconds between connection/transaction status updates. seconds between connection/transaction status updates.
* Use the *Query info notifier timeout* field to control the behaviour of the * When the *Show query success notification?* switch is set to *True*, the Query Tool
notifier that is displayed when query execution completes. A value of *-1* will show notifications on successful query execution.
will disable the notifier, and a value of 0 will display it until clicked. If
a positive value above zero is specified, the notifier will be displayed for
the specified number of seconds. The default is *5*.
.. image:: images/preferences_sql_editor.png .. image:: images/preferences_sql_editor.png
:alt: Preferences dialog sqleditor editor settings :alt: Preferences dialog sqleditor editor settings
@ -376,6 +399,9 @@ Use the fields on the *Editor* panel to change settings of the query editor.
changed to text/plain. Keyword highlighting and code folding will be disabled. changed to text/plain. Keyword highlighting and code folding will be disabled.
This will improve editor performance with large files. This will improve editor performance with large files.
* When the *Show View/Edit Data Promotion Warning?* switch is set to *True*
View/Edit Data tool will show promote to Query tool confirm dialog on query edit.
.. image:: images/preferences_sql_explain.png .. image:: images/preferences_sql_explain.png
:alt: Preferences dialog sqleditor explain options :alt: Preferences dialog sqleditor explain options
:align: center :align: center

View File

@ -29,9 +29,9 @@ File Options
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| Icon | Behavior | Shortcut | | Icon | Behavior | Shortcut |
+======================+===================================================================================================+================+ +======================+===================================================================================================+================+
| *Open File* | Click the *Open File* icon to display a previously saved query in the SQL Editor. | Accesskey + O | | *Open File* | Click the *Open File* icon to display a previously saved query in the SQL Editor. | Cmd/Ctrl + O |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Save File* | Click the *Save* icon to perform a quick-save of a previously saved query, or to access the | Accesskey + S | | *Save File* | Click the *Save* icon to perform a quick-save of a previously saved query, or to access the | Cmd/Ctrl + S |
| | *Save* menu: | | | | *Save* menu: | |
| | | | | | | |
| | * Select *Save* to save the selected content of the SQL Editor panel in a file. | | | | * Select *Save* to save the selected content of the SQL Editor panel in a file. | |
@ -50,7 +50,7 @@ Filter/Limit Options
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| Icon | Behavior | Shortcut | | Icon | Behavior | Shortcut |
+======================+===================================================================================================+================+ +======================+===================================================================================================+================+
| *Filter* | Click the *Filter* icon to set filtering and sorting criteria for the data when in *View/Edit data| Accesskey + F | | *Filter* | Click the *Filter* icon to set filtering and sorting criteria for the data when in *View/Edit data| Option/Alt + F |
| | mode*. Click the down arrow to access other filtering and sorting options: | | | | mode*. Click the down arrow to access other filtering and sorting options: | |
| | | | | | | |
| | * In the *SQL Filter*, you can enter a SQL query as filtering criteria. | | | | * In the *SQL Filter*, you can enter a SQL query as filtering criteria. | |
@ -63,7 +63,7 @@ Filter/Limit Options
| | | | | | | |
| | * Click *Remove Sort/Filter* to remove any previously selected sort or filtering options. | | | | * Click *Remove Sort/Filter* to remove any previously selected sort or filtering options. | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| Limit Selector | Select a value in the *Limit Selector* to limit the size of the dataset to a number of rows. | Accesskey + R | | Limit Selector | Select a value in the *Limit Selector* to limit the size of the dataset to a number of rows. | Option/Alt + R |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
Query Editing Options Query Editing Options
@ -80,24 +80,25 @@ Query Editing Options
+----------------------+---------------------------------------------------------------------------------------------------+-----------------------+ +----------------------+---------------------------------------------------------------------------------------------------+-----------------------+
| Icon | Behavior | Shortcut | | Icon | Behavior | Shortcut |
+======================+===================================================================================================+=======================+ +======================+===================================================================================================+=======================+
| *Edit* | Use the *Edit* menu to search, replace, or navigate the code displayed in the SQL Editor: | | | *Edit* | Use the *Edit* menu to search, replace, or navigate the code displayed in the SQL Editor: | Option/Alt + Shift + N|
| +---------------------------------------------------------------------------------------------------+-----------------------+ | +---------------------------------------------------------------------------------------------------+-----------------------+
| | Select *Find* to provide a search target, and search the SQL Editor contents. | Cmd+F | | | Select *Find* to provide a search target, and search the SQL Editor contents. | Cmd/Ctrl + F |
| +---------------------------------------------------------------------------------------------------+-----------------------+ | +---------------------------------------------------------------------------------------------------+-----------------------+
| | Select *Replace* to locate and replace (with prompting) individual occurrences of the target. | Option+Cmd+F (MAC) | | | Select *Replace* to locate and replace (with prompting) individual occurrences of the target. | Option + Cmd + F (MAC)|
| | | Ctrl+Shift+F (Others) | | | | Ctrl + Shift + F |
| | | (Others) |
| +---------------------------------------------------------------------------------------------------+-----------------------+ | +---------------------------------------------------------------------------------------------------+-----------------------+
| | Select *Go to Line/Column* to go to specified line number and column position | Cmd+L or Ctrl+L | | | Select *Go to Line/Column* to go to specified line number and column position | Cmd/Ctrl + L |
| +---------------------------------------------------------------------------------------------------+-----------------------+ | +---------------------------------------------------------------------------------------------------+-----------------------+
| | Select *Indent Selection* to indent the currently selected text. | Tab | | | Select *Indent Selection* to indent the currently selected text. | Tab |
| +---------------------------------------------------------------------------------------------------+-----------------------+ | +---------------------------------------------------------------------------------------------------+-----------------------+
| | Select *Unindent Selection* to remove indentation from the currently selected text. | Shift+Tab | | | Select *Unindent Selection* to remove indentation from the currently selected text. | Shift + Tab |
| +---------------------------------------------------------------------------------------------------+-----------------------+ | +---------------------------------------------------------------------------------------------------+-----------------------+
| | Select *Toggle Comment* to comment/uncomment any lines that contain the selection in SQL style. | Cmd+/ | | | Select *Toggle Comment* to comment/uncomment any lines that contain the selection in SQL style. | Cmd/Ctrl + / |
| +---------------------------------------------------------------------------------------------------+-----------------------+ | +---------------------------------------------------------------------------------------------------+-----------------------+
| | Select *Clear Query* to clear the query editor window. | Cmd+. | | | Select *Clear Query* to clear the query editor window. | Option/Alt + Ctrl + L |
| +---------------------------------------------------------------------------------------------------+-----------------------+ | +---------------------------------------------------------------------------------------------------+-----------------------+
| | Select *Format SQL* to format the selected SQL or all the SQL if none is selected | Shift+Cmd+K | | | Select *Format SQL* to format the selected SQL or all the SQL if none is selected | Cmd/Ctrl + K |
+----------------------+---------------------------------------------------------------------------------------------------+-----------------------+ +----------------------+---------------------------------------------------------------------------------------------------+-----------------------+
Query Execution Query Execution
@ -114,7 +115,8 @@ Query Execution
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| Icon | Behavior | Shortcut | | Icon | Behavior | Shortcut |
+======================+===================================================================================================+================+ +======================+===================================================================================================+================+
| *Stop* | Click the *Stop* icon to cancel the execution of the currently running query. | Accesskey + Q | | *Stop* | Click the *Stop* icon to cancel the execution of the currently running query. |Option + Shift +|
| | |Q |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Execute script* | Click the *Execute script* icon to either execute or refresh the query highlighted in the SQL | F5 | | *Execute script* | Click the *Execute script* icon to either execute or refresh the query highlighted in the SQL | F5 |
| | editor panel. Click the down arrow to access other execution options: | | | | editor panel. Click the down arrow to access other execution options: | |
@ -130,7 +132,7 @@ Query Execution
| | EXPLAIN is displayed graphically on the *Explain* tab of the output panel, and in text | | | | EXPLAIN is displayed graphically on the *Explain* tab of the output panel, and in text | |
| | form on the *Data Output* tab. | | | | form on the *Data Output* tab. | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Explain analyze* | Click the *Explain analyze* icon to invoke an EXPLAIN ANALYZE command on the current query. | Shift+F7 | | *Explain analyze* | Click the *Explain analyze* icon to invoke an EXPLAIN ANALYZE command on the current query. | Shift + F7 |
| | | | | | | |
| | Navigate through the *Explain Options* menu to select options for the EXPLAIN command: | | | | Navigate through the *Explain Options* menu to select options for the EXPLAIN command: | |
| | | | | | | |
@ -151,9 +153,9 @@ Query Execution
| | | | | | | |
| | * Select *Wal* to include the information on WAL record generation. | | | | * Select *Wal* to include the information on WAL record generation. | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Commit* | Click the *Commit* icon to commit the transaction. | Shift+CTRL+M | | *Commit* | Click the *Commit* icon to commit the transaction. |Shift + Ctrl + M|
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Rollback* | Click the *Rollback* icon to rollback the transaction. | Shift+CTRL+R | | *Rollback* | Click the *Rollback* icon to rollback the transaction. |Shift + Ctrl + R|
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Macros* | Click the *Macros* icon to manage the macros. You can create, edit or clear the macros through | | | *Macros* | Click the *Macros* icon to manage the macros. You can create, edit or clear the macros through | |
| | the *Manage Macros* option. | | | | the *Manage Macros* option. | |
@ -175,21 +177,23 @@ Data Editing Options
+======================+===================================================================================================+================+ +======================+===================================================================================================+================+
| *Add row* | Click the *Add row* icon to add a new row | | | *Add row* | Click the *Add row* icon to add a new row | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Copy* | Click the *Copy* icon to copy the content with or without header: | Accesskey + C | | *Copy* | Click the *Copy* icon to copy the content with or without header: | Cmd/Ctrl + C |
| | | | | | | |
| | * Click the *Copy* icon to copy the content that is currently highlighted in the Data Output | | | | * Click the *Copy* icon to copy the content that is currently highlighted in the Data Output | |
| | panel. | | | | panel. | |
| | | | | | | |
| | * Click *Copy with headers* to copy the highlighted content along with the header. | | | | * Click *Copy with headers* to copy the highlighted content along with the header. | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Paste* | Click the *Paste* icon to paste a previously copied row with or without serial/identity values: | Accesskey + P | | *Paste* | Click the *Paste* icon to paste a previously copied row with or without serial/identity values: | Option/Alt + |
| | | Shift + P |
| | | | | | | |
| | * Click the *Paste* icon to paste a previously copied row into a new row. | | | | * Click the *Paste* icon to paste a previously copied row into a new row. | |
| | | | | | | |
| | * Click the *Paste with SERIAL/IDENTITY values?* if you want to paste the copied column values | | | | * Click the *Paste with SERIAL/IDENTITY values?* if you want to paste the copied column values | |
| | in the serial/identity columns. | | | | in the serial/identity columns. | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Delete* | Click the *Delete* icon to mark the selected rows for deletion. These marked rows get deleted | Accesskey + D | | *Delete* | Click the *Delete* icon to mark the selected rows for deletion. These marked rows get deleted | Option/Alt + |
| | | Shift + D |
| | when you click the *Save Data Changes* icon. | | | | when you click the *Save Data Changes* icon. | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+ +----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Save Data Changes* | Click the *Save Data Changes* icon to save data changes (insert, update, or delete) in the Data | F6 | | *Save Data Changes* | Click the *Save Data Changes* icon to save data changes (insert, update, or delete) in the Data | F6 |

View File

@ -322,21 +322,6 @@ def register_browser_preferences(self):
fields=fields fields=fields
) )
self.preference.register(
'keyboard_shortcuts',
'context_menu',
gettext('Open context menu'),
'keyboardshortcut',
{
'alt': True,
'shift': True,
'control': False,
'key': {'key_code': 67, 'char': 'c'}
},
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=fields
)
self.preference.register( self.preference.register(
'keyboard_shortcuts', 'keyboard_shortcuts',
'direct_debugging', 'direct_debugging',

View File

@ -48,7 +48,6 @@ _.extend(pgBrowser.keyboardNavigation, {
'sub_menu_create': commonUtils.parseShortcutValue(prefStore.getPreferences('browser', 'sub_menu_create')?.value), 'sub_menu_create': commonUtils.parseShortcutValue(prefStore.getPreferences('browser', 'sub_menu_create')?.value),
'sub_menu_delete': commonUtils.parseShortcutValue(prefStore.getPreferences('browser', 'sub_menu_delete')?.value), 'sub_menu_delete': commonUtils.parseShortcutValue(prefStore.getPreferences('browser', 'sub_menu_delete')?.value),
'sub_menu_refresh': commonUtils.parseShortcutValue(prefStore.getPreferences('browser', 'sub_menu_refresh')?.value), 'sub_menu_refresh': commonUtils.parseShortcutValue(prefStore.getPreferences('browser', 'sub_menu_refresh')?.value),
'context_menu': commonUtils.parseShortcutValue(prefStore.getPreferences('browser', 'context_menu')?.value),
'direct_debugging': commonUtils.parseShortcutValue(prefStore.getPreferences('browser', 'direct_debugging')?.value), 'direct_debugging': commonUtils.parseShortcutValue(prefStore.getPreferences('browser', 'direct_debugging')?.value),
'add_grid_row': commonUtils.parseShortcutValue(prefStore.getPreferences('browser', 'add_grid_row')?.value), 'add_grid_row': commonUtils.parseShortcutValue(prefStore.getPreferences('browser', 'add_grid_row')?.value),
'open_quick_search': commonUtils.parseShortcutValue(prefStore.getPreferences('browser', 'open_quick_search')?.value), 'open_quick_search': commonUtils.parseShortcutValue(prefStore.getPreferences('browser', 'open_quick_search')?.value),
@ -69,7 +68,6 @@ _.extend(pgBrowser.keyboardNavigation, {
'bindSubMenuCreate': {'shortcuts': this.keyboardShortcut.sub_menu_create}, // Sub menu - Create Object, 'bindSubMenuCreate': {'shortcuts': this.keyboardShortcut.sub_menu_create}, // Sub menu - Create Object,
'bindSubMenuDelete': {'shortcuts': this.keyboardShortcut.sub_menu_delete}, // Sub menu - Delete object, 'bindSubMenuDelete': {'shortcuts': this.keyboardShortcut.sub_menu_delete}, // Sub menu - Delete object,
'bindSubMenuRefresh': {'shortcuts': this.keyboardShortcut.sub_menu_refresh, 'bindElem': '#tree'}, // Sub menu - Refresh object, 'bindSubMenuRefresh': {'shortcuts': this.keyboardShortcut.sub_menu_refresh, 'bindElem': '#tree'}, // Sub menu - Refresh object,
'bindContextMenu': {'shortcuts': this.keyboardShortcut.context_menu}, // Sub menu - Open context menu,
'bindDirectDebugging': {'shortcuts': this.keyboardShortcut.direct_debugging}, // Sub menu - Direct Debugging 'bindDirectDebugging': {'shortcuts': this.keyboardShortcut.direct_debugging}, // Sub menu - Direct Debugging
'bindAddGridRow': {'shortcuts': this.keyboardShortcut.add_grid_row}, // Subnode Grid Add Row 'bindAddGridRow': {'shortcuts': this.keyboardShortcut.add_grid_row}, // Subnode Grid Add Row
'bindOpenQuickSearch': {'shortcuts': this.keyboardShortcut.open_quick_search}, // Subnode Grid Refresh Row 'bindOpenQuickSearch': {'shortcuts': this.keyboardShortcut.open_quick_search}, // Subnode Grid Refresh Row
@ -306,6 +304,12 @@ _.extend(pgBrowser.keyboardNavigation, {
bindOpenQuickSearch: function() { bindOpenQuickSearch: function() {
pgWindow.pgAdmin.Browser.all_menus_cache.help.mnu_quick_search_help.callback(); pgWindow.pgAdmin.Browser.all_menus_cache.help.mnu_quick_search_help.callback();
}, },
bindAddGridRow: function() {
let gridElem = document.activeElement.closest('.pgrt')?.parentElement;
if (gridElem) {
gridElem.querySelector('button[data-test="add-row"]')?.click();
}
}
}); });
module.exports = pgAdmin.Browser.keyboardNavigation; module.exports = pgAdmin.Browser.keyboardNavigation;