IntenseWebs/pgadmin4
3
0
Fork 0
mirror of https://github.com/pgadmin-org/pgadmin4.git synced 2024-11-25 18:20:20 -06:00
Code Issues Packages Projects Releases Wiki Activity
bf6ee28dae
pgadmin4/docs/en_US/menu_bar.rst

157 lines
17 KiB
ReStructuredText
Raw Normal View History

Some doc restructuring and cleanup.
2019-03-07 08:26:56 -06:00
.. _menu_bar:
More doc updates.
2016-06-07 03:04:58 -05:00
Some doc restructuring and cleanup.
2019-03-07 08:26:56 -06:00
*****************
`Menu Bar`:index:
*****************
More doc updates.
2016-06-07 03:04:58 -05:00
Major doc cleanup: - Reformat source so it's wrapped. - Standardise markup. - Center images. - Restructure in various places to improve the indexing. - Remove duplicated Query Tool toolbar descriptions. - Ensure the structure works in both HTML and LaTeX.
2019-03-08 09:29:05 -06:00
The pgAdmin menu bar provides drop-down menus for access to options, commands,
and utilities. The menu bar displays the following selections: *File*, *Object*,
Tools*, and *Help*. Selections may be grayed out which indicates they are
disabled for the object currently selected in the *pgAdmin* tree control.
More doc updates.
2016-06-07 03:04:58 -05:00
Major doc cleanup: - Reformat source so it's wrapped. - Standardise markup. - Center images. - Restructure in various places to improve the indexing. - Remove duplicated Query Tool toolbar descriptions. - Ensure the structure works in both HTML and LaTeX.
2019-03-08 09:29:05 -06:00
The File Menu
*************
More doc updates.
2016-06-07 03:04:58 -05:00
Doc restructuring
2016-06-21 03:06:44 -05:00
.. image:: /images/file_menu.png
Ensure images in the docs have alt tags for screen readers. Fixes #2903
2018-01-11 10:58:30 -06:00
:alt: pgAdmin file menu bar
Major doc cleanup: - Reformat source so it's wrapped. - Standardise markup. - Center images. - Restructure in various places to improve the indexing. - Remove duplicated Query Tool toolbar descriptions. - Ensure the structure works in both HTML and LaTeX.
2019-03-08 09:29:05 -06:00
:align: center
Doc restructuring
2016-06-21 03:06:44 -05:00
More doc updates.
2016-06-07 03:04:58 -05:00
Use the *File* menu to access the following options:
Add support for reset saved password. Fixes #3074
2018-07-27 04:06:42 -05:00
+-------------------------+---------------------------------------------------------------------------------------------------------+
| Option | Action |
+=========================+=========================================================================================================+
| *Preferences* | Click to open the :ref:`Preferences <preferences>` dialog to to customize your pgAdmin settings. |
+-------------------------+---------------------------------------------------------------------------------------------------------+
| *Reset Layout* | If you have modified the workspace, click to restore the default layout. |
+-------------------------+---------------------------------------------------------------------------------------------------------+
Allow the UI layout to be fully locked or to prevent docking changes. Fixes #2653
2019-05-31 10:51:30 -05:00
| *Lock Layout* | Click to open a submenu to select the level for locking the UI layout |
| | This can also be changed from browser display :ref:`preferences <preferences>` |
+-------------------------+---------------------------------------------------------------------------------------------------------+
More doc updates.
2016-06-07 03:04:58 -05:00
Major doc cleanup: - Reformat source so it's wrapped. - Standardise markup. - Center images. - Restructure in various places to improve the indexing. - Remove duplicated Query Tool toolbar descriptions. - Ensure the structure works in both HTML and LaTeX.
2019-03-08 09:29:05 -06:00
The Object Menu
***************
More doc updates.
2016-06-07 03:04:58 -05:00
Doc restructuring
2016-06-21 03:06:44 -05:00
.. image:: /images/object_menu.png
Ensure images in the docs have alt tags for screen readers. Fixes #2903
2018-01-11 10:58:30 -06:00
:alt: pgAdmin object menu bar
Major doc cleanup: - Reformat source so it's wrapped. - Standardise markup. - Center images. - Restructure in various places to improve the indexing. - Remove duplicated Query Tool toolbar descriptions. - Ensure the structure works in both HTML and LaTeX.
2019-03-08 09:29:05 -06:00
:align: center
Doc restructuring
2016-06-21 03:06:44 -05:00
Major doc cleanup: - Reformat source so it's wrapped. - Standardise markup. - Center images. - Restructure in various places to improve the indexing. - Remove duplicated Query Tool toolbar descriptions. - Ensure the structure works in both HTML and LaTeX.
2019-03-08 09:29:05 -06:00
The *Object* menu is context-sensitive. Use the *Object* menu to access the
following options (in alphabetical order):
More doc updates.
2016-06-07 03:04:58 -05:00
Add support to save and clear SSH Tunnel password. Fixes #3511
2018-08-06 05:26:46 -05:00
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Option | Action |
+=============================+==========================================================================================================================+
| *Change Password...* | Click to open the :ref:`Change Password... <change_password_dialog>` dialog to change your password. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *Clear Saved Password* | If you have saved the database server password, click to clear the saved password. |
| | Enable only when password is already saved. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *Clear SSH Tunnel Password* | If you have saved the ssh tunnel password, click to clear the saved password. |
| | Enable only when password is already saved. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *Connect Server...* | Click to open the :ref:`Connect to Server <connect_to_server>` dialog to establish a connection with a server. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *Create* | Click *Create* to access a context menu that provides context-sensitive selections. |
| | Your selection opens a *Create* dialog for creating a new object. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *Delete/Drop* | Click to delete the currently selected object from the server. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
1) Fixed issue where Drop and Disconnect connection menu points are too close to each other. Fixes #3279 2) Rename the context menu from 'Drop Server' to 'Remove Server'. Fixes #3859
2019-11-07 01:41:24 -06:00
| *Disconnect Server...* | Click to disconnect the currently selected server. |
Add support to save and clear SSH Tunnel password. Fixes #3511
2018-08-06 05:26:46 -05:00
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *Drop Cascade* | Click to delete the currently selected object and all dependent objects from the server. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *Properties...* | Click to review or modify the currently selected object's properties. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *Refresh...* | Click to refresh the currently selected object. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
1) Fixed issue where Drop and Disconnect connection menu points are too close to each other. Fixes #3279 2) Rename the context menu from 'Drop Server' to 'Remove Server'. Fixes #3859
2019-11-07 01:41:24 -06:00
| *Remove Server* | Click to remove the currently selected server. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
Add support to save and clear SSH Tunnel password. Fixes #3511
2018-08-06 05:26:46 -05:00
| *Scripts* | Click to open the :ref:`Query tool <query_tool>` to edit or view the selected script from the flyout menu. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *Trigger(s)* | Click to *Disable* or *Enable* trigger(s) for the currently selected table. Options are displayed on the flyout menu. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *Truncate* | Click to remove all rows from a table (*Truncate*) or to remove all rows from a table and its child tables |
| | (*Truncate Cascade*). Options are displayed on the flyout menu. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *View Data* | Click to access a context menu that provides several options for viewing data (see below). |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
Documentation of ERD Diagram support. Fixes #6152
2021-01-25 00:48:47 -06:00
| *Generate ERD* | Click to open the ERD tool with automatically generated diagram for the database selected. |
| | This option is available only when a database is selected. Options are displayed on the flyout menu. |
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
More doc updates.
2016-06-07 03:04:58 -05:00
Major doc cleanup: - Reformat source so it's wrapped. - Standardise markup. - Center images. - Restructure in various places to improve the indexing. - Remove duplicated Query Tool toolbar descriptions. - Ensure the structure works in both HTML and LaTeX.
2019-03-08 09:29:05 -06:00
The Tools Menu
**************
More doc updates.
2016-06-07 03:04:58 -05:00
Doc restructuring
2016-06-21 03:06:44 -05:00
.. image:: /images/tool_menu.png
Ensure images in the docs have alt tags for screen readers. Fixes #2903
2018-01-11 10:58:30 -06:00
:alt: pgAdmin tools menu bar
Major doc cleanup: - Reformat source so it's wrapped. - Standardise markup. - Center images. - Restructure in various places to improve the indexing. - Remove duplicated Query Tool toolbar descriptions. - Ensure the structure works in both HTML and LaTeX.
2019-03-08 09:29:05 -06:00
:align: center
Doc restructuring
2016-06-21 03:06:44 -05:00
Ensure images in the docs have alt tags for screen readers. Fixes #2903
2018-01-11 10:58:30 -06:00
Use the *Tools* menu to access the following options (in alphabetical order):
More doc updates.
2016-06-07 03:04:58 -05:00
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Option | Action |
+===========================+===========================================================================================================================================+
Doc restructuring
2016-06-21 03:06:44 -05:00
| *Add named restore point* | Click to open the :ref:`Add named restore point... <add_restore_point_dialog>` dialog to take a point-in-time snapshot of the current |
| | server state. |
More doc updates.
2016-06-07 03:04:58 -05:00
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *Backup...* | Click to open the :ref:`Backup... <backup_dialog>` dialog to backup database objects. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *Backup Globals...* | Click to open the :ref:`Backup Globals... <backup_globals_dialog>` dialog to backup cluster objects. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *Backup Server...* | Click to open the :ref:`Backup Server... <backup_server_dialog>` dialog to backup a server. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *Grant Wizard...* | Click to access the :ref:`Grant Wizard <grant_wizard>` tool. |
Ensure images in the docs have alt tags for screen readers. Fixes #2903
2018-01-11 10:58:30 -06:00
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
More doc updates.
2016-06-07 03:04:58 -05:00
| *Import/Export...* | Click to open the :ref:`Import/Export data... <import_export_data>` dialog to import or export data from a table. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *Maintenance...* | Click to open the :ref:`Maintenance... <maintenance_dialog>` dialog to VACUUM, ANALYZE, REINDEX, or CLUSTER. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
Ensure images in the docs have alt tags for screen readers. Fixes #2903
2018-01-11 10:58:30 -06:00
| *Pause replay of WAL* | Click to pause the replay of the WAL log. |
More doc updates.
2016-06-07 03:04:58 -05:00
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
Ensure images in the docs have alt tags for screen readers. Fixes #2903
2018-01-11 10:58:30 -06:00
| *Query tool* | Click to open the :ref:`Query tool <query_tool>` for the currently selected object. |
More doc updates.
2016-06-07 03:04:58 -05:00
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *Reload Configuration...* | Click to update configuration files without restarting the server. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *Restore...* | Click to access the :ref:`Restore <restore_dialog>` dialog to restore database files from a backup. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
Ensure images in the docs have alt tags for screen readers. Fixes #2903
2018-01-11 10:58:30 -06:00
| *Resume replay of WAL* | Click to resume the replay of the WAL log. |
More doc updates.
2016-06-07 03:04:58 -05:00
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
Documentation of Storage Manager. Fixes #5938
2020-11-04 06:01:21 -06:00
| *Storage Manager* | Click to open the :ref:`Storage Manager <storage_manager>` to upload, delete, or download the backup files. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
Documentation of ERD Diagram support. Fixes #6152
2021-01-25 00:48:47 -06:00
| *New ERD Project* | Click to open the :ref:`ERD Tool <erd_tool>` and start designing your database. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
Documentation of Quick Search support. Fixes #6196
2021-02-15 03:26:50 -06:00
| *Schema Diff* | Click to open the :ref:`Schema Diff <schema_diff_feature>` and start comparing two database or two schema. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *Search Objects...* | Click to open the :ref:`Search Objects... <search_objects>` and start searching any kind of objects in a database. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
More doc updates.
2016-06-07 03:04:58 -05:00
Major doc cleanup: - Reformat source so it's wrapped. - Standardise markup. - Center images. - Restructure in various places to improve the indexing. - Remove duplicated Query Tool toolbar descriptions. - Ensure the structure works in both HTML and LaTeX.
2019-03-08 09:29:05 -06:00
The Help Menu
*************
More doc updates.
2016-06-07 03:04:58 -05:00
Doc restructuring
2016-06-21 03:06:44 -05:00
.. image:: images/help_menu.png
Ensure images in the docs have alt tags for screen readers. Fixes #2903
2018-01-11 10:58:30 -06:00
:alt: pgAdmin help menu bar
Major doc cleanup: - Reformat source so it's wrapped. - Standardise markup. - Center images. - Restructure in various places to improve the indexing. - Remove duplicated Query Tool toolbar descriptions. - Ensure the structure works in both HTML and LaTeX.
2019-03-08 09:29:05 -06:00
:align: center
Doc restructuring
2016-06-21 03:06:44 -05:00
Major doc cleanup: - Reformat source so it's wrapped. - Standardise markup. - Center images. - Restructure in various places to improve the indexing. - Remove duplicated Query Tool toolbar descriptions. - Ensure the structure works in both HTML and LaTeX.
2019-03-08 09:29:05 -06:00
Use the options on the *Help* menu to access online help documents, or to review
information about the pgAdmin installation (in alphabetical order):
More doc updates.
2016-06-07 03:04:58 -05:00
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| Option | Action |
+======================+=========================================================================================================================================+
Documentation of Quick Search support. Fixes #6196
2021-02-15 03:26:50 -06:00
| *Quick Search* | Type your keywords in the Quick Search field. Typing at least three characters will display all the matching possibilities under Menu |
| | items and the relevant documents under Help articles. Click on the options under Menu items to perform action of particular |
| | functionality or object. Click on any of the Help articles to open the help of that topic with highlighted text in a separate window. |
| | |
| | **Note**:- If any of the option under Menu items is disabled, then it will provide information via info icon. |
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
Doc updates.
2016-09-02 09:27:10 -05:00
| *About pgAdmin 4* | Click to open a window where you will find information about pgAdmin; this includes the current version and the current user. |
More doc updates.
2016-06-07 03:04:58 -05:00
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
Ensure images in the docs have alt tags for screen readers. Fixes #2903
2018-01-11 10:58:30 -06:00
| *Online Help* | Click to open documentation support for using pgAdmin utilities, tools and dialogs. |
| | Navigate (in the newly opened tab?) help documents in the left browser pane or use the search bar to specify a topic. |
More doc updates.
2016-06-07 03:04:58 -05:00
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| *pgAdmin Website* | Click to open the *pgAdmin.org* website in a browser window. |
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
Ensure images in the docs have alt tags for screen readers. Fixes #2903
2018-01-11 10:58:30 -06:00
| *PostgreSQL Website* | Click to access the PostgreSQL core documentation hosted at the PostgreSQL site. The site also offers guides, tutorials, and resources. |
More doc updates.
2016-06-07 03:04:58 -05:00
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
Reference in New Issue Copy Permalink