More doc updates.

This commit is contained in:
Susan Douglas 2016-06-07 09:04:58 +01:00 committed by Dave Page
parent 14ced20db0
commit b0a901e90e
41 changed files with 555 additions and 9 deletions

View File

@ -1 +1 @@
code_snippets.py
code_snippets.rst

View File

@ -1,6 +1,37 @@
*******
Browser
*******
********************
The pgAdmin 4 Client
********************
pgAdmin 4 supports all PostgreSQL features, from writing simple SQL queries to developing complex databases. It is designed to query an active database (in real-time), allowing you to stay current with modifications and implementations.
Features of pgAdmin 4 include:
* auto-detection and support for objects discovered at run-time
* a live SQL query tool with direct data editing
* support for administrative queries
* a syntax-highlighting SQL editor
* redesigned graphical interfaces
* powerful management dialogs and tools for common tasks
* responsive, context-sensitive behavior
* supportive error messages
* helpful hints
* online help and information about using pgAdmin dialogs and tools.
When pgAdmin opens, the interface features a menu bar and a window divided into two panes: the *pgAdmin* tree control in the left pane, and the tabbed browser in the right pane.
.. image:: images/pgadmin_welcome.png
Select an icon from the *Quick Links* panel on the *Dashboard* tab to:
* Open the :ref:`Create - Server dialog <server_dialog>` to add a new server definition.
* Open the :ref:`Preferences dialog <preferences>` to customize your pgAdmin client.
Links in the *Getting Started* panel open a new browser tab that provide useful information for Postgres users:
* Click the *PostgreSQL Documentation* link to navigate to the *Documentation* page for the PostgreSQL open-source project; once at the project site, you can review the manuals for the currently supported versions of the PostgreSQL server.
* Click the *pgAdmin Website* link to navigate to the pgAdmin project website. The pgAdmin site features news about recent pgAdmin releases and other project information.
* Click the *Planet PostgreSQL* link to navigate to the blog aggregator for Postgres related blogs.
* Click the *Community Support* link to navigate to the *Community* page at the PostgreSQL open-source project site; this page provides information about obtaining support for PostgreSQL features.
The Browser is the main window used in pgAdmin. It allows you to connect to
database servers and browse the objects on them.

View File

@ -0,0 +1,27 @@
.. _change_password_dialog:
**************************
The Change Password Dialog
**************************
It is a good policy to routinely change your password to protect data, even in what you may consider a 'safe' environment. In the workplace, failure to apply an appropriate password policy could leave you in breach of Data Protection laws.
Please consider the following guidelines when selecting a password:
* Ensure that your password is an adequate length; 6 characters should be the absolute minimum number of characters in the password.
* Ensure that your password is not open to dictionary attacks. Use a mixture of upper and lower case letters and numerics, and avoid words or names. Consider using the first letter from each word in a phrase that you will remember easily but is an unfamiliar acronym.
* Ensure that your password is changed regularly; at minimum, change it every ninety days.
The above should be considered a starting point: It is not a comprehensive list and it **will not guarantee security**.
.. image:: images/password.png
Use the *Change Password* dialog to change your password:
* The name displayed in the *User* field is the role for which you are modifying the password; it is the role that is associated with the server connection that is highlighted in the tree control.
* Enter the password associated with the role in the *Current Password* field.
* Enter the desired password for in the *New Password* field.
* Re-enter the new password in the *Confirm Password* field.
Click the *OK* button to change your password; click *Cancel* to exit the dialog without changing your password.

View File

@ -0,0 +1,50 @@
.. _connect_error:
**************************
`Connection error`:index:
**************************
When connecting to a PostgreSQL server, you may get an error message. If you encounter an error message, please review the message carefully; each error message attempts to incorporate the information you'll need to resolve the problem. For more details about specific errors, please locate the error message in the list below:
**Connection to the server has been lost**
.. image:: images/ce_timeout.png
This error message indicates that the connection attempt has taken longer than the specified threshold; there may be a problem with the connection properties provided on the *Server* dialog, network connectivity issues, or the server may not be running.
**could not connect to Server: Connection refused**
.. image:: images/ce_not_running.png
If pgAdmin displays this message, there are two possible reasons for this:
* the database server isn't running - simply start it.
* the server isn't configured to accept TCP/IP requests on the address shown.
For security reasons, a PostgreSQL server "out of the box" doesn't listen on TCP/IP ports. Instead, it must be enabled to listen for TCP/IP requests. This can be done by adding **tcpip = true** to the postgresql.conf file for Versions 7.3.x and 7.4.x, or **listen_addresses='*'** for Version 8.0.x and above; this will make the server accept connections on any IP interface.
For further information, please refer to the PostgreSQL documentation about `runtime configuration <http://www.postgresql.org/docs/current/interactive/runtime-config.html>`_.
**FATAL: no pg_hba.conf entry**
.. image:: images/ce_error_hba.png
If pgAdmin displays this message when connecting, your server can be contacted correctly over the network, but is not configured to accept your connection. Your client has not been detected as a legal user for the database.
To connect to a server, the pg_hba.conf file on the database server must be configured to accept connections from the host of the pgAdmin client. Modify the pg_hba.conf file on the database server host, and add an entry in the form:
* **host template1 postgres 192.168.0.0/24 md5** for an IPV4 network
* **host template1 postgres ::ffff:192.168.0.0/120 md5** for an IPV6 network
For more information, please refer to the PostgreSQL documentation about `client authentication <http://www.postgresql.org/docs/current/interactive/client-authentication.html>`_.
**FATAL: password authentication failed**
.. image:: images/ce_password_failed.png
* The *password authentication failed for user* error message indicates there may be a problem with the password you entered. Retry the password to confirm you entered it correctly. If the error message returns, make sure that you have the correct password, that you are authorized to access the server, and that the access has been correctly configured in the server's postgresql.conf configuration file.

View File

@ -0,0 +1,21 @@
.. _connect_to_server:
*****************
Connect to server
*****************
Use the *Connect to Server* dialog to authenticate with a defined server and access the objects stored on the server through the pgAdmin tree control. To access the dialog, right click on the server name in the *pgAdmin* tree control, and select *Connect Server...* from the context menu.
.. image:: images/connect_to_server.png
Provide authentication information for the selected server:
* Use the *Password* field to provide the password of the user that is associated with the defined server.
* Check the box next to *Save Password* to instruct the server to save the password for future connections; if you save the password, you will not be prompted when reconnecting to the database server with this server definition.
The pgAdmin client displays a message in a green status bar in the lower right corner when the server connects successfully.
If you receive an error message while attempting a connection, verify that your network is allowing the pgAdmin host and the host of the database server to communicate. For detailed information about a specific error message, please see the :ref:`Connection Error <connect_error>` help page.
To review or modify connection details, right-click on the name of the server, and select *Properties...* from the context menu.

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

View File

@ -23,9 +23,10 @@ Contents:
:maxdepth: 2
pgadmin_index
using
browser
pgadmin_menu_bar
pgadmin_tabbed_browser
pgadmin_tree_control
preferences
help
@ -42,8 +43,8 @@ Contents:
server_group_dialog
server_dialog
connecting
error_messages
connect_to_server
connect_error
Creating Cluster Level Objects
@ -140,6 +141,7 @@ Contents:
:maxdepth: 2
managing_server
change_password_dialog
configuration_editor
grant_wizard
maintenance

View File

@ -0,0 +1,113 @@
.. _pgadmin_menu_bar:
********************
The pgAdmin Menu Bar
********************
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.
.. image:: /images/file_menu.png
**The File Menu**
Use the *File* menu to access the following options:
+----------------------+---------------------------------------------------------------------------------------------------------+
| Option | Action |
+======================+=========================================================================================================+
| *Change Password...* | Click to open the :ref:`Change Password... <change_password_dialog>` dialog to change your password. |
+----------------------+---------------------------------------------------------------------------------------------------------+
| *Preferences* | Click to open the :ref:`Preferences <preferences_dialog>` dialog to to customize your pgAdmin settings. |
+----------------------+---------------------------------------------------------------------------------------------------------+
.. image:: /images/object_menu.png
**The Object Menu**
The *Object* menu is context-sensitive. Use the *Object* menu to access the following options (in alphabetical order):
+------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Option | Action |
+========================+==========================================================================================================================+
| *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. |
+------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *Disconnect Server...* | Click to refresh the currently selected object. |
+------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *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. |
+------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *Scripts* | Click to open the :ref:`Query tool <query_tool_overview>` 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). |
+------------------------+--------------------------------------------------------------------------------------------------------------------------+
.. image:: /images/tool_menu.png
**The Tool Menu**
Use the *Tools* menu to access the following options (in alphabetical order):
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Option | Action |
+===========================+===========================================================================================================================================+
| *Add named restore point* | Click to open the :ref:`Add named restore point... <add_restore_point>` dialog to take a point-in-time record of the current server state.|
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *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. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *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. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *Pause replay of WAL* | Click to pause the replay of the WAL log. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *Query tool* | Click to open the :ref:`Query tool <query_tool_overview>` for the currently selected object. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *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. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *Resume replay of WAL* | Click to resume the replay of the WAL log. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
.. image:: images/help_menu.png
**The Help Menu**
Use the options on the *Help* menu to access online help documents, or to review information about the pgAdmin installation (in alphabetical order):
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| Option | Action |
+======================+=========================================================================================================================================+
| *About pgAdmin* | Click to open a window where you will find information about pgAdmin; this includes the current version and the current user. |
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| *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. |
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| *pgAdmin Website* | Click to open the *pgAdmin.org* website in a browser window. |
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| *PostgreSQL Website* | Click to access the PostgreSQL core documentation hosted at the PostgreSQL site. The site also offers guides, tutorials, and resources. |
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+

View File

@ -0,0 +1,137 @@
.. _pgadmin_tabbed_browser:
**************************
The pgAdmin Tabbed Browser
**************************
The right pane of the *pgAdmin* window features a collection of tabs that display information about the object currently selected in the *pgAdmin* tree control in the left window.
Permanent tabs are named *Dashboard, *Properties*, *SQL*, *Statistics*, *Dependencies* and *Dependents*; each tab may be repositioned as a floating window. Select a tab to access information about the highlighted object in the tree control.
.. image:: images/main_dashboard.png
The *Dashboard* tab provides a graphical analysis of the usage statistics for the selected server or database:
* The *Server sessions* or *Database sessions* graph displays the interactions with the managed server or database.
* The *Transactions per second* graph displays the commits, rollbacks, and total transactions per second that are taking place on the managed server or database.
* The *Tuples In* graph displays the number of tuples inserted, updated, and deleted into the managed server or database.
* The *Tuples out* graph displays the number of tuples fetched and returned into the managed server or database.
* The *Block I/O* graph displays the number of transactions processed by the managed server or database.
* The *Server activity* graph displays information about sessions, locks, prepared transactions and configuration. The information is presented in context-sensitive tables.
Click the *Statistics* tab to continue.
.. image:: images/main_statistics.png
The *Statistics* tab displays the statistics gathered for each database on the current server. Click a column heading to sort the table by the data displayed in the column; click again to reverse the sort order.
+----------------------------+------------------------------------------------------------------------------------------------------------+
| Panel | Description |
+============================+============================================================================================================+
| *Database* | displays the database name. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Backends* | displays the number of current connections to the database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Xact Committed* | displays the number of transactions committed to the database within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Xact Rolled Back* | displays the number of transactions rolled back within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Blocks Read* | displays the number of blocks read from memory (in megabytes) within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Blocks Hit* | displays the number of blocks hit in the cache (in megabytes) within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tuples Returned* | displays the number of tuples returned within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tuples Fetched* | displays the number of tuples fetched within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tuples Inserted* | displays the number of tuples inserted into the database within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tuples Updated* | displays the number of tuples updated in the database within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tuples Deleted* | displays the number of tuples deleted from the database within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Last statistics reset* | displays the time of the last statistics reset for the database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tablespace conflicts* | displays the number of queries canceled because of recovery conflict with dropped tablespaces in database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Lock conflicts* | displays the number of queries canceled because of recovery conflict with locks in database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Snapshot conflicts* | displays the number of queries canceled because of recovery conflict with old snapshots in database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Bufferpin conflicts* | displays the number of queries canceled because of recovery conflict with pinned buffers in database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Temporary files* | displays the total number of temporary files, including those used by the statistics collector. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Size of temporary files* | displays the size of the temporary files. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Deadlocks* | displays the number of queries canceled because of a recovery conflict with deadlocks in database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Block read time* | displays the number of milliseconds required to read the blocks read. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Block write time* | displays the number of milliseconds required to write the blocks read. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Size* | displays the size (in megabytes) of the selected database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
Click the *Properties* tab to continue.
.. image:: images/main_properties_table.png
Review properties on expandable windows specific to the *Object* selected. If multiple boxes are displayed, you can click the arrow to the left on the blue bar at the top of each box:
* Point the arrow to the right to contract the box.
* Point the arrow down to expand the window.
.. image:: images/main_properties_edit.png
Click the *Edit* icon in the toolbar under the browser tabs to launch a dialog.
.. image:: images/main_properties_icons.png
If you change properties in the opened dialog, save your work. The *Properties* tab updates to show recent modifications.
Click the *SQL* tab to continue.
.. image:: images/main_sql.png
The SQL pane on the *SQL* tab contains an SQL script that creates the highlighted object, and if applicable, a (commented out) SQL statement that will *DROP* the selected object. You can copy the SQL statements to an editor of your choice using cut & paste shortcuts.
Click the *Statistics* tab to continue.
.. image:: images/main_statistics.png
The *Statistics* tab displays available statistical information about the object currently selected in the *pgAdmin* browser.
Click the *Dependencies* tab to continue.
.. image:: images/main_dependencies.png
The *Dependencies* tab displays the objects on which the currently selected object depends. If a dependency is dropped, the object currently selected in the pgAdmin tree control will be affected. To ensure the integrity of the entire database structure, the database server makes sure that you do not accidentally drop objects that other objects depend on; you must use DROP CASCADE to remove an object with a dependency.
The *Dependencies* table displays the following information:
* The *Type* field specifies the parent object type.
* The *Name* field specifies the identifying name of the parent object.
* The *Restriction* field describes the dependency relationship between the currently selected object and the parent.
* If the field is *auto*, the selected object can be dropped separately from the parent object, and will be dropped if the parent object is dropped.
* If the field is *internal*, the selected object was created during the creation of the parent object, and will be dropped if the parent object is dropped.
* If the field is *normal*, the selected object can be dropped without dropping the parent object.
* If the field is *blank*, the selected object is required by the system, and cannot be dropped.
Click the *Dependents* tab to continue.
.. image:: images/main_dependents.png
The *Dependents* tab displays a table of objects that depend on the object currently selected in the *pgAdmin* browser. A dependent object can be dropped without affecting the object currently selected in the *pgAdmin* tree control.
* The *Type* field specifies the dependent object type.
* The *Name* field specifies the identifying name for the dependent object.
* The *Database* field specifies the database in which the object resides.
**Feature Tabs**
Additional *feature tabs* will open in the *pgAdmin* tabbed browser when you access the extended functionality offered by pgAdmin tools. For example, if you select the *Query tool* from *Tools* in the menu bar, pgAdmin will open the Query tool on a tab labeled *Query-1*. These feature tabs are not permanent and you can close them when you are finished using the tool. Like permanent tabs, these tabs may be repositioned.
.. image:: images/main_query_tool.png

View File

@ -0,0 +1,88 @@
.. _pgadmin_tree_control:
************************
The pgAdmin Tree Control
************************
The left pane of the main window displays a tree control (the *pgAdmin* tree control) that provides access to the objects that reside on a server.
.. image:: /images/main_left_pane.png
You can expand nodes in the tree control to view the database objects that reside on a selected server. The tree control expands to display a hierarchical view:
* Use the plus sign (+) to the left of a node to expand a segment of the tree control.
* Click the minus sign (-) to the left of a node to close that node.
Access context-sensitive menus by right-clicking on a node of the tree control to perform common tasks. Menus display options that include one or more of the following selections (options appear in alphabetical order):
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| Option | Action |
+===========================+===========================================================================================================================+
| *Add named restore point* | Click to create and enter the name of a restore point. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *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. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *Connect Server...* | Click to open the :ref:`Connect to Server <connect_to_server>` dialog to establish a connection with a server. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *Create* | Click to access a context menu that provides context-sensitive selections. |
| | Your selection opens a *Create* dialog for creating a new object. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *CREATE Script* | Click to open the :ref:`Query tool <query_tool_overview>` to edit or view the CREATE script. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *Debugging* | Click through to open the :ref:`Debug <debugger>` tool or to select *Set breakpoint* to stop or pause a script execution. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *Delete/Drop* | Click to delete the currently selected object from the server. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *Disconnect Database...* | Click to terminate a database connection. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *Disconnect Server...* | Click to refresh the currently selected object. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *Drop Cascade* | Click to delete the currently selected object and all dependent objects from the server. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *Debugging* | Click to access the :ref:`Debugger <debugger>` tool. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *Grant Wizard* | Click to access the :ref:`Grant Wizard <grant_wizard>` tool. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *Maintenance...* | Click to open the :ref:`Maintenance... <maintenance_dialog>` dialog to VACUUM, ANALYZE, REINDEX, or CLUSTER. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *Properties...* | Click to review or modify the currently selected object's properties. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *Refresh...* | Click to refresh the currently selected object. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *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. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| *View Data* | Use the *View Data* option to access the data stored in a selected table with the *Data Output* tab of the *Query Tool*. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
The context-sensitive menus associated with *Tables* and nested *Table* nodes provides additional display options (options appear in alphabetical order):
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+
| Option | Action |
+=========================+==============================================================================================================================+
| *Import/Export...* | Click open the :ref:`Import/Export... <import_export_data>` dialog to import data to or export data from the selected table. |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+
| *Reset Statistics* | Click to reset statistics for the selected table. |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+
| *Scripts* | Click to open the :ref:`Query tool <query_tool_overview>` to edit or view the selected script from the flyout menu. |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+
| *Truncate* | Click to remove all rows from a table. |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+
| *Truncate Cascade* | Click to remove all rows from a table and its child tables. |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+
| *View First 100 Rows* | Click to access a data grid that displays the first 100 rows of the selected table. |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+
| *View Last 100 Rows* | Click to access a data grid that displays the last 100 rows of the selected table. |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+
| *View All Rows* | Click to access a a data grid that displays all rows of the selected table. |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+
| *View Filtered Rows...* | Click to access the *Data Filter* popup to apply a filter to a set of data. |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+

View File

@ -0,0 +1,77 @@
.. _preferences:
*******************
pgAdmin Preferences
*******************
pgAdmin 4 has a selection of configuration options (*Preferences*) that you can use to customize your pgAdmin client. To open the *Preferences* dialog, select *Preferences* from the *File* menu.
.. image:: images/preferences_tree.png
The left pane of the *Preferences* dialog displays a tree control; each node of the tree control provides access to options that are related to the selected node.
* Use the plus sign (+) to the left of a node to expand a segment of the tree control.
* Click the minus sign (-) to the left of a node to close that node.
Expand the **Browser** node of the tree control to personalize your workspace.
.. image:: images/preferences_browser_display.png
Use the options on the *Display* dialog to specify general display preferences:
Move the *Show system objects* switch to the *True* position to display system objects in the *pgAdmin* tree control. This option instructs pgAdmin to display objects such as system schemas (e.g. pg_temp*) and system columns (e.g. xmin, ctid) in the tree control.
Use the options on the *Nodes* dialog to select the object types that will be displayed in the *pgAdmin* tree control.
.. image:: images/preferences_browser_nodes.png
The right pane of the *Preferences* dialog displays a list of database objects. Slide the switch located next to each object to *Show* or *Hide* the database object. When querying system catalogs, you can reduce the number of object types displayed to increase speed.
Expand the **Dashboards** node to specify your graphing preferences.
.. image:: images/preferences_dashboard_graphs.png
Use the options on the *Graphs* dialog specify a refresh rate for statistics, transaction throughput and tuples. The rate you specify will affect a corresponding graph on the *Dashboard* tab of the *pgAdmin* tabbed browser.
Expand the **Paths** node to specify the locations of supporting files.
.. image:: images/preferences_paths_binary.png
Use the fields in the *Binary paths* node to specify paths to the PostgreSQL binary utilities and EnterpriseDB Postgres Advanced Server binary utilities.
.. image:: images/preferences_paths_help.png
Use the *Help* dialog to customize links to support documentation.
* Use the *EDB Advanced Server Help Path* to find a link path for EnterpriseDB Postgres Advanced Server documentation on the company website. This link is editable: substitute the applicable PostgreSQL version number for *$VERSION$*, or provide an alternate link path.
* Use the *PostgreSQL Help Path* to find a link path to the current set of PostgreSQL core documentation. This link is editable: substitute the applicable PostgreSQL version number for *$VERSION$*, or provide an alternate link path.
Expand the **SQL Editor** node to specify your preferences for the SQL Editor tool.
.. image:: images/preferences_sql_display.png
Use the *Display* dialog to specify your preferences for the SQL Editor display. Specify a value in the *Items per page in grid* to instruct the *SQL Editor* on how many rows to display per page.
The default is *50*.
.. image:: images/preferences_sql_explain_options.png
Use the options on the *Explain Options* dialog to specify the level of detail included in a graphical EXPLAIN.
* Move the *Buffers* switch to the *True* position to include information on buffer usage.
* Move the *Costs* switch to the *True* position to include information on the estimated startup and total cost of each plan, as well as the estimated number of rows and the estimated width of each row.
* Move the *Timing* switch to the *True* position to include actual startup time and time spent in each node in the output.
* Move the *Verbose* switch to the *True* position to display additional information regarding the plan.
.. image:: images/preferences_sql_options.png
Use the options in the *Options* dialog to manage modifications to a SQL statement.
* Move the *Auto-Commit* switch to the *True* position to commit a SQL statement upon completion.
* Move the *Auto-Rollback* switch to the *True* to rollback a SQL statement to the beginning of the statement or to a prior rollback.
Expand the **Storage** node to specify a maximum file size for uploads.
.. image:: images/preferences_storage_options.png
Use the *Maximum file upload size(MB)* in the *Options* node of the **Storage** node to specify the maximum file size for an upload.