Doc restructuring

This commit is contained in:
Susan Douglas 2016-06-21 09:06:44 +01:00 committed by Dave Page
parent 8b8e6fe59b
commit 5051470bc7
72 changed files with 326 additions and 368 deletions

View File

@ -15,6 +15,3 @@ documentation <http://www.postgresql.org/docs/9.5/static/recovery-target-setting
* Click the *OK* button to save the restore point. * Click the *OK* button to save the restore point.
* Click the *Cancel* button to exit without saving work. * Click the *Cancel* button to exit without saving work.

View File

@ -0,0 +1,16 @@
.. _backup_and_restore:
******************
Backup and Restore
******************
A powerful, but user-friendly Backup and Restore tool provides an easy way to use pg_dump, pg_dumpall, and pg_restore to take backups and create copies of databases or database objects for use in a development environment.
Contents:
.. toctree::
backup_dialog
backup_globals_dialog
backup_server_dialog
restore_dialog

View File

@ -1,6 +1,5 @@
.. _backup_dialog: .. _backup_dialog:
***************** *****************
The Backup Dialog The Backup Dialog
***************** *****************
@ -107,7 +106,3 @@ If the backup is successful, a popup window will confirm success. Click *Click h
.. image:: images/backup_process_watcher.png .. image:: images/backup_process_watcher.png
If the backup is unsuccessful, you can review the error messages returned by the backup command on the *Process Watcher*. If the backup is unsuccessful, you can review the error messages returned by the backup command on the *Process Watcher*.

View File

@ -1,3 +1,5 @@
.. _browser:
******************** ********************
The pgAdmin 4 Client The pgAdmin 4 Client
******************** ********************

View File

@ -1,4 +1,4 @@
.. _cast: .. _cast_dialog:
*************** ***************
The Cast Dialog The Cast Dialog

View File

@ -1,6 +1,5 @@
.. _change_password_dialog: .. _change_password_dialog:
************************** **************************
The Change Password Dialog The Change Password Dialog
************************** **************************

View File

@ -41,5 +41,3 @@ The example shown demonstrates creating a check constraint named *check_price* o
* Click the *Save* button to save work. * Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work. * Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters. * Click the *Reset* button to restore configuration parameters.

View File

@ -0,0 +1,22 @@
.. _client_features:
***************
Client Features
***************
pgAdmin 4 has a highly-customizable display that features drag-and-drop panels that you can arrange to make the best use of your desktop environment. The client features a tree control that provides an elegant overview of the managed servers, and the objects that reside on each server. Tabbed dialogs provide quick access to statistical information about each object in the tree control.
Use the *Preferences* dialog to customize the content and colors of the pgAdmin display. To open the *Preferences* dialog, select *Preferences* from the *File* menu.
*Help* buttons in the lower-left corner of each dialog will open the online help for the dialog. You can access additional Postgres help by navigating through the *Help* menu, and selecting the name of the resource that you wish to open.
Contents:
.. toctree::
browser
pgadmin_menu_bar
pgadmin_tabbed_browser
pgadmin_tree_control
preferences

View File

@ -1,3 +1,5 @@
.. _code_overview:
************* *************
Code Overview Code Overview
************* *************

View File

@ -1,3 +1,5 @@
.. _code_review:
***************** *****************
Code Review Notes Code Review Notes
***************** *****************

View File

@ -1,3 +1,5 @@
.. _coding_standards:
**************** ****************
Coding Standards Coding Standards
**************** ****************

View File

@ -4,7 +4,6 @@
The Collation Dialog The Collation Dialog
******************** ********************
Use the *Collation* dialog to define a collation. A collation is an SQL schema object that maps a SQL name to operating system locales. To create a collation, you must have a CREATE privilege on the destination schema. Use the *Collation* dialog to define a collation. A collation is an SQL schema object that maps a SQL name to operating system locales. To create a collation, you must have a CREATE privilege on the destination schema.
The *Collation* dialog organizes the development of a collation through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections. The *Collation* dialog organizes the development of a collation through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections.

View File

@ -68,6 +68,3 @@ The example shown demonstrates creating a column named *territory* in the table
* Click the *Save* button to save work. * Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work. * Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters. * Click the *Reset* button to restore configuration parameters.

View File

@ -1,6 +1,5 @@
.. _connect_error: .. _connect_error:
************************** **************************
`Connection error`:index: `Connection error`:index:
************************** **************************

View File

@ -1,6 +1,5 @@
.. _connect_to_server: .. _connect_to_server:
***************** *****************
Connect to server Connect to server
***************** *****************

24
docs/en_US/connecting.rst Normal file
View File

@ -0,0 +1,24 @@
.. _connecting:
**********************
Connecting to a Server
**********************
Before you can use the pgAdmin client to manage your Postgres installation, you must define a connection to the server.
Contents:
.. toctree::
server_group_dialog
server_dialog
connect_to_server
connect_error

View File

@ -0,0 +1,21 @@
.. _contributions:
*****************************
pgAdmin Project Contributions
*****************************
pgAdmin is an open-source project that invites you to get involved in the development process. For more information about contributing to the pgAdmin project, contact the developers on the pgAdmin mailing list <mailto:pgadmin-hackers@postgresql.org> to discuss any ideas you might have for enhancements or bug fixes.
In the sections listed below, you'll find detailed information about the development process used to develop, improve, and maintain the pgAdmin client.
Contents:
.. toctree::
submitting_patches
code_overview
coding_standards
code_snippets
code_review
translations

View File

@ -1,4 +1,4 @@
.. _database: .. _database_dialog:
******************* *******************
The Database Dialog The Database Dialog

View File

@ -1,3 +1,4 @@
.. _debugger:
************************* *************************
`pgAdmin Debugger`:index: `pgAdmin Debugger`:index:

15
docs/en_US/deployment.rst Normal file
View File

@ -0,0 +1,15 @@
.. _deployment:
******************
pgAdmin Deployment
******************
Pre-compiled and configured installation packages for pgAdmin 4 are available for a number of desktop environments; we recommend using an installer whenever possible. If you are interested in learning more about the project, or if a pgAdmin installer is not available for your environment, the pages listed below will provide detailed information about creating a custom deployment.
Contents:
.. toctree::
:maxdepth: 2
desktop_deployment
server_deployment

View File

@ -1,3 +1,5 @@
.. _desktop_deployment:
****************** ******************
Desktop Deployment Desktop Deployment
****************** ******************

View File

@ -0,0 +1,14 @@
.. _developer_tools:
***************
Developer Tools
***************
The pgAdmin *Tools* menu displays a list of powerful developer tools that you can use to execute and analyze complex SQL commands, manage data, and debug PL/SQL code.
Contents:
.. toctree::
debugger
query_tool

View File

@ -1,4 +1,4 @@
.. _domain_constraint: .. _domain_constraint_dialog:
**************************** ****************************
The Domain Constraint Dialog The Domain Constraint Dialog

View File

@ -1,4 +1,4 @@
.. _domain: .. _domain_dialog:
***************** *****************
The Domain Dialog The Domain Dialog

View File

@ -1,4 +1,4 @@
.. _event trigger: .. _event_trigger_dialog:
************************ ************************
The Event Trigger Dialog The Event Trigger Dialog

View File

@ -1,4 +1,4 @@
.. _exclusion_constraint: .. _exclusion_constraint_dialog:
******************************* *******************************
The Exclusion constraint Dialog The Exclusion constraint Dialog
@ -60,5 +60,3 @@ The example shown demonstrates creating an exclusion constraint named *exclude_d
* Click the *Save* button to save work. * Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work. * Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters. * Click the *Reset* button to restore configuration parameters.

View File

@ -1,4 +1,4 @@
.. _extension: .. _extension_dialog:
******************** ********************
The Extension Dialog The Extension Dialog

View File

@ -1,4 +1,4 @@
.. _fdw: .. _foreign_data_wrapper_dialog:
******************************* *******************************
The Foreign Data Wrapper Dialog The Foreign Data Wrapper Dialog

View File

@ -87,5 +87,3 @@ The example shown demonstrates creating a foreign key constraint named *territor
* Click the *Save* button to save work. * Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work. * Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters. * Click the *Reset* button to restore configuration parameters.

View File

@ -1,4 +1,4 @@
.. _foreign_server: .. _foreign_server_dialog:
************************* *************************
The Foreign Server Dialog The Foreign Server Dialog

View File

@ -1,4 +1,4 @@
.. _fts_configuration: .. _fts_configuration_dialog:
**************************** ****************************
The FTS Configuration dialog The FTS Configuration dialog

View File

@ -1,4 +1,4 @@
.. _fts_dictionary: .. _fts_dictionary_dialog:
************************* *************************
The FTS Dictionary Dialog The FTS Dictionary Dialog

View File

@ -1,4 +1,4 @@
.. _fts_parser: .. _fts_parser_dialog:
********************* *********************
The FTS Parser Dialog The FTS Parser Dialog

View File

@ -1,4 +1,4 @@
.. _fts_template: .. _fts_template_dialog:
*********************** ***********************
The FTS Template Dialog The FTS Template Dialog

View File

@ -0,0 +1,16 @@
.. _getting_started:
***************
Getting Started
***************
When you install pgAdmin in server mode, you will be prompted to provide a role name and pgAdmin password. The first role registered with pgAdmin will be an administrative user. When you authenticate with pgAdmin, pgAdmin displays the server definitions associated with that login role in the tree control.
An administrative role can use the pgAdmin User Management dialog to create and manage additional pgAdmin user accounts.
Contents:
.. toctree::
pgadmin_login
pgadmin_user

View File

@ -46,10 +46,6 @@ The following is an example of the sql command generated by user selections in t
The commands displayed assign a role named *Bob* *INSERT* and *UPDATE* privileges *WITH GRANT OPTION* on the *sales_meetings* and the *sales_territories* tables. The commands displayed assign a role named *Bob* *INSERT* and *UPDATE* privileges *WITH GRANT OPTION* on the *sales_meetings* and the *sales_territories* tables.
* Click the *Back* button to select or deselect additional database objects, roles and privileges. * Click the *Back* button to select or deselect additional database objects, roles and privileges.
* Click the *Cancel* button to exit without saving work. * Click the *Cancel* button to exit without saving work.
* Click the *Finish* button to save selections and exit the wizard. * Click the *Finish* button to save selections and exit the wizard.

View File

@ -4,7 +4,6 @@
The Import/Export data Dialog The Import/Export data Dialog
***************************** *****************************
Use the *Import/Export data* dialog to copy data from a table to a file, or copy data from a file into a table. Use the *Import/Export data* dialog to copy data from a table to a file, or copy data from a file into a table.
The *Import/Export data* dialog organizes the import/export of data through the *Options* and *Columns* tabs. The *Import/Export data* dialog organizes the import/export of data through the *Options* and *Columns* tabs.
@ -53,8 +52,3 @@ After completing the *Import/Export data* dialog, click the *OK* button to perfo
Use the *Click here for details* link on the notification to open the *Process Watcher* and review detailed information about the execution of the command that performed the import or export: Use the *Click here for details* link on the notification to open the *Process Watcher* and review detailed information about the execution of the command that performed the import or export:
.. image:: images/import_export_pw.png .. image:: images/import_export_pw.png

View File

@ -8,228 +8,35 @@ pgAdmin 4
Welcome to pgAdmin 4. pgAdmin is the leading Open Source management tool for Postgres, the world's most advanced Open Source database. pgAdmin 4 is designed to meet the needs of both novice and experienced Postgres users alike, providing a powerful graphical interface that simplifies the creation, maintenance and use of database objects. Welcome to pgAdmin 4. pgAdmin is the leading Open Source management tool for Postgres, the world's most advanced Open Source database. pgAdmin 4 is designed to meet the needs of both novice and experienced Postgres users alike, providing a powerful graphical interface that simplifies the creation, maintenance and use of database objects.
Getting Started
===============
If running on a web server, pgAdmin supports multiple users with per-user authentication. These features are hidden in desktop mode.
Contents: Contents:
.. toctree:: .. toctree::
:maxdepth: 2
pgadmin_login getting_started
pgadmin_user client_features
connecting
managing_cluster_objects
managing_database_objects
modifying_tables
management_basics
backup_and_restore
developer_tools
deployment
contributions
licence
Client Features
===============
pgAdmin 4 has a highly-customizable display that features drag-and-drop panels that you can arrange to make the best use of your desktop environment. The client features a tree control that provides an elegant overview of the managed servers, and the objects that reside on each server. Tabbed dialogs provide quick access to statistical information about each object in the tree control.
Use the *Preferences* dialog to customize the content and colors of the pgAdmin display. To open the *Preferences* dialog, select *Preferences* from the *File* menu.
*Help* buttons in the lower-left corner of each dialog will open the online help for the dialog. You can access additional Postgres help by navigating through the *Help* menu, and selecting the name of the resource that you wish to open.
Contents:
.. toctree::
:maxdepth: 2
browser
pgadmin_menu_bar
pgadmin_tabbed_browser
pgadmin_tree_control
preferences
Connecting to a Server
======================
Before you can use the pgAdmin client to manage your Postgres installation, you must define a connection to the server.
Contents:
.. toctree::
:maxdepth: 1
server_group_dialog
server_dialog
connect_to_server
connect_error
Managing Cluster Level Objects
==============================
Some object definitions reside at the cluster level; pgAdmin 4 provides dialogs that allow you to create these objects, manage them, and control their relationships to each other. To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the *Create* option for that object. For example, to create a new database, right-click on the *Databases* node, and select *Create Database...*
Contents:
.. toctree::
:maxdepth: 2
database_dialog
move_objects
resource_group_dialog
role_dialog
tablespace_dialog
Managing Database Objects
=========================
pgAdmin 4 provides simple but powerful dialogs that you can use to design and create database objects. Each dialog contains a series of tabs that you use to describe the object that will be created by the dialog; the SQL tab displays the SQL command that the server will execute when creating the object.
To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the *Create* option for that object. For example, to create a new database, right-click on the *Casts* node, and select *Create Cast...*
Contents:
.. toctree::
:maxdepth: 2
cast_dialog
collation_dialog
domain_dialog
domain_constraint_dialog
event_trigger_dialog
extension_dialog
foreign_data_wrapper_dialog
foreign_server_dialog
foreign_table_dialog
fts_configuration_dialog
fts_dictionary_dialog
fts_parser_dialog
fts_template_dialog
function_dialog
materialized_view_dialog
procedure_dialog
schema_dialog
sequence_dialog
type_dialog
user_mapping_dialog
view_dialog
Creating or Modifying a Table
=============================
pgAdmin 4 provides dialogs that allow you to modify all table properties and attributes.
To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the *Create* option for that object. For example, to create a new database, right-click on the *Casts* node, and select *Create Cast...*
Contents:
.. toctree::
:maxdepth: 2
check_dialog
column_dialog
exclusion_constraint_dialog
foreign_key_dialog
index_dialog
primary_key_dialog
rule_dialog
table_dialog
trigger_dialog
unique_constraint_dialog
Management Basics
=================
pgAdmin provides a graphical interface that you can use to manage security issues related to your Postgres servers. Point and click dialogs allow you to create login or group roles, administer object privileges, and control access to the server.
The configuration editor provides a graphical interface that allows a sufficiently-privileged user to set configuration parameters in the postgresql.conf, pg_hba.conf, and .pgpass.conf files:
* The postgresql.conf file contains parameters that you can use to control the server and server behaviors.
* The pg_hba.conf file contains settings that specify client authentication behavior enforced by the server.
* The .pgpass.conf file specifies passwords that can be used to satisfy authentication requirements.
To modify the postgresql.conf or pg_hba.conf file, you must have sufficient privileges to modify and save files in the Postgres *data* directory. Please note that incorrect configuration can slow performance, or prevent the server from restarting without reverting your changes. Please consult the PostgreSQL core documentation for detailed information about configuring your server.
Contents:
.. toctree::
:maxdepth: 2
add_restore_point_dialog
change_password_dialog
grant_wizard
import_export_data
maintenance_dialog
Backup and Restore
==================
A powerful, but user-friendly Backup and Restore tool provides an easy way to use pg_dump, pg_dumpall, and pg_restore to take backups and create copies of databases or database objects for use in a development environment.
Contents:
.. toctree::
:maxdepth: 2
backup_dialog
backup_globals_dialog
backup_server_dialog
restore_dialog
Developer Tools
===============
The pgAdmin *Tools* menu displays a list of powerful developer tools that you can use to execute and analyze complex SQL commands, manage data, and debug PL/SQL code.
Contents:
.. toctree::
:maxdepth: 2
debugger
query_tool
pgAdmin Deployment
==================
Pre-compiled and configured installation packages for pgAdmin 4 are available for a number of desktop environments; we recommend using an installer whenever possible. If you are interested in learning more about the project, or if a pgAdmin installer is not available for your environment, the pages listed below will provide detailed information about creating a custom deployment.
Contents:
.. toctree::
:maxdepth: 2
desktop_deployment
server_deployment
pgAdmin Project Contributions
=============================
pgAdmin is an open-source project that invites you to get involved in the development process. For more information about contributing to the pgAdmin project, contact the developers on the pgAdmin mailing list <mailto:pgadmin-hackers@postgresql.org> to discuss any ideas you might have for enhancements or bug fixes.
In the sections listed below, you'll find detailed information about the development process used to develop, improve, and maintain the pgAdmin client.
Contents:
.. toctree::
:maxdepth: 2
submitting_patches
code_overview
coding_standards
code_snippets
code_review
translations
Licence
=======
pgAdmin is released under the
`PostgreSQL Licence <http://www.postgresql.org/about/licence>`_, which is a
liberal Open Source licence similar to BSD or MIT, and approved by the Open
Source Initiative. The copyright for the project source code, website and
documentation is attributed to the
`pgAdmin Development Team <https://www.pgadmin.org/development/team.php>`_.

View File

@ -69,5 +69,3 @@ The example shown demonstrates creating an index named *dist_codes* that indexes
* Click the *Save* button to save work. * Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work. * Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters. * Click the *Reset* button to restore configuration parameters.

7
docs/en_US/licence.rst Normal file
View File

@ -0,0 +1,7 @@
.. _licence:
*******
Licence
*******
pgAdmin is released under the `PostgreSQL Licence <http://www.postgresql.org/about/licence>`_, which is a liberal Open Source licence similar to BSD or MIT, and approved by the Open Source Initiative. The copyright for the project source code, website and documentation is attributed to the `pgAdmin Development Team <https://www.pgadmin.org/development/team.php>`_.

View File

@ -1,6 +1,5 @@
.. _maintenance_dialog: .. _maintenance_dialog:
************************* *************************
The Maintenance... Dialog The Maintenance... Dialog
************************* *************************
@ -36,6 +35,3 @@ pgAdmin will inform you when the background process completes:
Use the *Click here for details* link on the notification to open the *Process Watcher* and review detailed information about the execution of the command that performed the import or export: Use the *Click here for details* link on the notification to open the *Process Watcher* and review detailed information about the execution of the command that performed the import or export:
.. image:: images/maintenance_pw.png .. image:: images/maintenance_pw.png

View File

@ -0,0 +1,25 @@
.. _management_basics:
*****************
Management Basics
*****************
pgAdmin provides a graphical interface that you can use to manage security issues related to your Postgres servers. Point and click dialogs allow you to create login or group roles, administer object privileges, and control access to the server.
The configuration editor provides a graphical interface that allows a sufficiently-privileged user to set configuration parameters in the postgresql.conf, pg_hba.conf, and .pgpass.conf files:
* The postgresql.conf file contains parameters that you can use to control the server and server behaviors.
* The pg_hba.conf file contains settings that specify client authentication behavior enforced by the server.
* The .pgpass.conf file specifies passwords that can be used to satisfy authentication requirements.
To modify the postgresql.conf or pg_hba.conf file, you must have sufficient privileges to modify and save files in the Postgres *data* directory. Please note that incorrect configuration can slow performance, or prevent the server from restarting without reverting your changes. Please consult the PostgreSQL core documentation for detailed information about configuring your server.
Contents:
.. toctree::
add_restore_point_dialog
change_password_dialog
grant_wizard
import_export_data
maintenance_dialog

View File

@ -0,0 +1,17 @@
.. _managing_cluster_objects:
******************************
Managing Cluster Level Objects
******************************
Some object definitions reside at the cluster level; pgAdmin 4 provides dialogs that allow you to create these objects, manage them, and control their relationships to each other. To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the *Create* option for that object. For example, to create a new database, right-click on the *Databases* node, and select *Create Database...*
Contents:
.. toctree::
database_dialog
move_objects
resource_group_dialog
role_dialog
tablespace_dialog

View File

@ -0,0 +1,35 @@
.. _managing_database_objects:
*************************
Managing Database Objects
*************************
pgAdmin 4 provides simple but powerful dialogs that you can use to design and create database objects. Each dialog contains a series of tabs that you use to describe the object that will be created by the dialog; the SQL tab displays the SQL command that the server will execute when creating the object.
To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the *Create* option for that object. For example, to create a new database, right-click on the *Casts* node, and select *Create Cast...*
Contents:
.. toctree::
cast_dialog
collation_dialog
domain_dialog
domain_constraint_dialog
event_trigger_dialog
extension_dialog
foreign_data_wrapper_dialog
foreign_server_dialog
foreign_table_dialog
fts_configuration_dialog
fts_dictionary_dialog
fts_parser_dialog
fts_template_dialog
function_dialog
materialized_view_dialog
procedure_dialog
schema_dialog
sequence_dialog
type_dialog
user_mapping_dialog
view_dialog

View File

@ -1,4 +1,4 @@
.. _materialized_view: .. _materialized_view_dialog:
**************************** ****************************
The Materialized View Dialog The Materialized View Dialog

View File

@ -0,0 +1,24 @@
.. _modifying_tables:
*****************************
Creating or Modifying a Table
*****************************
pgAdmin 4 provides dialogs that allow you to modify all table properties and attributes.
To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the *Create* option for that object. For example, to create a new database, right-click on the *Casts* node, and select *Create Cast...*
Contents:
.. toctree::
check_dialog
column_dialog
exclusion_constraint_dialog
foreign_key_dialog
index_dialog
primary_key_dialog
rule_dialog
table_dialog
trigger_dialog
unique_constraint_dialog

View File

@ -14,8 +14,7 @@ Use the fields in the *pgAdmin Login* dialog to authenticate your connection:
#. Provide your password in the *Password* field. #. Provide your password in the *Password* field.
#. Click the *Login* button to securely log into pgAdmin. #. Click the *Login* button to securely log into pgAdmin.
Recovering a Lost Password **Recovering a Lost Password**
**************************
If you cannot supply your password, click the *Forgotten your password?* button to launch a password recovery utility. If you cannot supply your password, click the *Forgotten your password?* button to launch a password recovery utility.

View File

@ -4,13 +4,12 @@
The 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. 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** **The File Menu**
.. image:: /images/file_menu.png
Use the *File* menu to access the following options: Use the *File* menu to access the following options:
+----------------------+---------------------------------------------------------------------------------------------------------+ +----------------------+---------------------------------------------------------------------------------------------------------+
@ -18,13 +17,13 @@ Use the *File* menu to access the following options:
+======================+=========================================================================================================+ +======================+=========================================================================================================+
| *Change Password...* | Click to open the :ref:`Change Password... <change_password_dialog>` dialog to change your password. | | *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. | | *Preferences* | Click to open the :ref:`Preferences <preferences>` dialog to to customize your pgAdmin settings. |
+----------------------+---------------------------------------------------------------------------------------------------------+ +----------------------+---------------------------------------------------------------------------------------------------------+
.. image:: /images/object_menu.png
**The Object Menu** **The Object Menu**
.. image:: /images/object_menu.png
The *Object* menu is context-sensitive. Use the *Object* menu to access the following options (in alphabetical order): The *Object* menu is context-sensitive. Use the *Object* menu to access the following options (in alphabetical order):
+------------------------+--------------------------------------------------------------------------------------------------------------------------+ +------------------------+--------------------------------------------------------------------------------------------------------------------------+
@ -45,7 +44,7 @@ The *Object* menu is context-sensitive. Use the *Object* menu to access the foll
+------------------------+--------------------------------------------------------------------------------------------------------------------------+ +------------------------+--------------------------------------------------------------------------------------------------------------------------+
| *Refresh...* | Click to refresh the currently selected object. | | *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. | | *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. | | *Trigger(s)* | Click to *Disable* or *Enable* trigger(s) for the currently selected table. Options are displayed on the flyout menu. |
+------------------------+--------------------------------------------------------------------------------------------------------------------------+ +------------------------+--------------------------------------------------------------------------------------------------------------------------+
@ -55,16 +54,17 @@ The *Object* menu is context-sensitive. Use the *Object* menu to access the foll
| *View Data* | Click to access a context menu that provides several options for viewing data (see below). | | *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** **The Tool Menu**
.. image:: /images/tool_menu.png
Use the *Tools* menu to access the following options (in alphabetical order): Use the *Tools* menu to access the following options (in alphabetical order):
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Option | Action | | 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.| | *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. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *Backup...* | Click to open the :ref:`Backup... <backup_dialog>` dialog to backup database objects. | | *Backup...* | Click to open the :ref:`Backup... <backup_dialog>` dialog to backup database objects. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
@ -80,7 +80,7 @@ Use the *Tools* menu to access the following options (in alphabetical order):
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *Pause replay of WAL* | Click to pause the replay of the WAL log. | | *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. | | *Query tool* | Click to open the :ref:`Query tool <query_tool>` for the currently selected object. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| *Reload Configuration...* | Click to update configuration files without restarting the server. | | *Reload Configuration...* | Click to update configuration files without restarting the server. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
@ -89,10 +89,10 @@ Use the *Tools* menu to access the following options (in alphabetical order):
| *Resume replay of WAL* | Click to resume the replay of the WAL log. | | *Resume replay of WAL* | Click to resume the replay of the WAL log. |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
.. image:: images/help_menu.png
**The Help Menu** **The Help Menu**
.. image:: images/help_menu.png
Use the options on the *Help* menu to access online help documents, or to review information about the pgAdmin installation (in alphabetical order): Use the options on the *Help* menu to access online help documents, or to review information about the pgAdmin installation (in alphabetical order):
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+

View File

@ -31,7 +31,7 @@ Access context-sensitive menus by right-clicking on a node of the tree control t
| *Create* | Click to access a context menu that provides context-sensitive selections. | | *Create* | Click to access a context menu that provides context-sensitive selections. |
| | Your selection opens a *Create* dialog for creating a new object. | | | 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. | | *CREATE Script* | Click to open the :ref:`Query tool <query_tool>` 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. | | *Debugging* | Click through to open the :ref:`Debug <debugger>` tool or to select *Set breakpoint* to stop or pause a script execution. |
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+ +---------------------------+---------------------------------------------------------------------------------------------------------------------------+
@ -69,7 +69,7 @@ The context-sensitive menus associated with *Tables* and nested *Table* nodes pr
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+------------------------------------------------------------------------------------------------------------------------------+
| *Reset Statistics* | Click to reset statistics for 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. | | *Scripts* | Click to open the :ref:`Query tool <query_tool>` to edit or view the selected script from the flyout menu. |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+------------------------------------------------------------------------------------------------------------------------------+
| *Truncate* | Click to remove all rows from a table. | | *Truncate* | Click to remove all rows from a table. |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+------------------------------------------------------------------------------------------------------------------------------+

View File

@ -1,6 +1,5 @@
.. _preferences: .. _preferences:
******************* *******************
pgAdmin Preferences pgAdmin Preferences
******************* *******************

View File

@ -44,5 +44,3 @@ The example shown demonstrates creating a primary key constraint named *dept_pke
* Click the *Save* button to save work. * Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work. * Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters. * Click the *Reset* button to restore configuration parameters.

View File

@ -105,5 +105,3 @@ The example demonstrates creating a procedure that returns a list of employees f
* Click the *Save* button to save work. * Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work. * Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters. * Click the *Reset* button to restore configuration parameters.

View File

@ -1,6 +1,5 @@
.. _query_tool: .. _query_tool:
************** **************
The Query tool The Query tool
************** **************
@ -30,7 +29,6 @@ The Query tool features a toolbar with frequently used options, and a work envir
pgAdmin allows you to open multiple copies of the Query tool (in individual tabs) simultaneously. For example, if you select *Query tool* from the *Tools* menu, the Query tool opens in a tab labeled *Query-1*; if you open the Query tool again (without closing *Query-1*), a second copy will open in *Query-2*. To close a copy of the Query tool, click the *X* in the upper-right hand corner of the tab bar. pgAdmin allows you to open multiple copies of the Query tool (in individual tabs) simultaneously. For example, if you select *Query tool* from the *Tools* menu, the Query tool opens in a tab labeled *Query-1*; if you open the Query tool again (without closing *Query-1*), a second copy will open in *Query-2*. To close a copy of the Query tool, click the *X* in the upper-right hand corner of the tab bar.
**The Query tool Toolbar** **The Query tool Toolbar**
The *Query tool* toolbar uses context-sensitive icons that provide shortcuts to frequently performed tasks. If an icon is highlighted, the option is enabled; if the icon is grayed-out, the task is disabled. The *Query tool* toolbar uses context-sensitive icons that provide shortcuts to frequently performed tasks. If an icon is highlighted, the option is enabled; if the icon is grayed-out, the task is disabled.
@ -108,10 +106,8 @@ Hover over an icon to display a tooltip that describes the icon's functionality.
| *Search* | Use the *Search* field to search the result set for specific content. | | *Search* | Use the *Search* field to search the result set for specific content. |
+--------------------+---------------------------------------------------------------------------------------------------+ +--------------------+---------------------------------------------------------------------------------------------------+
**The SQL Editor Panel** **The SQL Editor Panel**
The *SQL editor* panel contains a workspace for entering commands; you can read a query from a file, or type a query. It features syntax coloring and autocompletion to help you write queries. The *SQL editor* panel contains a workspace for entering commands; you can read a query from a file, or type a query. It features syntax coloring and autocompletion to help you write queries.
.. image:: images/query_sql_editor.png .. image:: images/query_sql_editor.png
@ -138,10 +134,8 @@ The editor also offers several features that help with code formatting:
* Shift the selected text to upper case by pressing Control+U. * Shift the selected text to upper case by pressing Control+U.
* Shift the selected text to lower case by pressing Control+Shift+U. * Shift the selected text to lower case by pressing Control+Shift+U.
**The Data Output Panel** **The Data Output Panel**
Use the *Data Output* panel of the *Query tool* to view data and information generated by a query in the *SQL editor*, or to *View Data* for an object currently selected in the *pgAdmin* tree control. Use the *Data Output* panel of the *Query tool* to view data and information generated by a query in the *SQL editor*, or to *View Data* for an object currently selected in the *pgAdmin* tree control.
The *Data Output* panel organizes output through the following tabs: *Data Output*, *Explain*, *Messages*, and *History*. The *Data Output* panel organizes output through the following tabs: *Data Output*, *Explain*, *Messages*, and *History*.
@ -181,9 +175,3 @@ Use the *History* tab to review activity for the current session:
.. image:: images/query_output_history.png .. image:: images/query_output_history.png
To erase the content of the *History* tab, select *Clear history* from the *Edit* drop-down menu. To erase the content of the *History* tab, select *Clear history* from the *Edit* drop-down menu.

View File

@ -1,4 +1,4 @@
.. _resource_group: .. _resource_group_dialog:
************************* *************************
The Resource Group Dialog The Resource Group Dialog

View File

@ -1,6 +1,5 @@
.. _restore_dialog: .. _restore_dialog:
****************** ******************
The Restore Dialog The Restore Dialog
****************** ******************
@ -78,30 +77,3 @@ When youve specified the details that will be incorporated into the pg_restor
Click *Click here for details* on the popup to launch the *Process Watcher*. The *Process Watcher* logs all the activity associated with the restore, and provides additional information for troubleshooting should the restore command encounter problems. Click *Click here for details* on the popup to launch the *Process Watcher*. The *Process Watcher* logs all the activity associated with the restore, and provides additional information for troubleshooting should the restore command encounter problems.
.. image:: images/restore_process_watcher.png .. image:: images/restore_process_watcher.png

View File

@ -1,4 +1,4 @@
.. _role: .. _role_dialog:
*************************** ***************************
The Login/Group Role Dialog The Login/Group Role Dialog

View File

@ -42,5 +42,3 @@ The example sends a notification when an UPDATE executes against a table.
* Click the *Save* button to save work. * Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work. * Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters. * Click the *Reset* button to restore configuration parameters.

View File

@ -1,4 +1,4 @@
.. _schema: .. _schema_dialog:
***************** *****************
The Schema Dialog The Schema Dialog

View File

@ -1,4 +1,4 @@
.. _sequence: .. _sequence_dialog:
******************* *******************
The Sequence Dialog The Sequence Dialog

View File

@ -1,3 +1,5 @@
.. _server_deployment:
***************** *****************
Server Deployment Server Deployment
***************** *****************

View File

@ -1,4 +1,4 @@
.. _server: .. _server_dialog:
***************** *****************
The Server Dialog The Server Dialog
@ -24,7 +24,7 @@ Use the fields in the *Connection* tab to configure a connection:
* Specify the IP address of the server host, or the fully qualified domain name in the *Host Name/Address* field. On Unix based systems, the address field may be left blank to use the default PostgreSQL Unix Domain Socket on the local machine, or may be set to an alternate path containing a PostgreSQL socket. If you enter a path, the path must begin with a "/". * Specify the IP address of the server host, or the fully qualified domain name in the *Host Name/Address* field. On Unix based systems, the address field may be left blank to use the default PostgreSQL Unix Domain Socket on the local machine, or may be set to an alternate path containing a PostgreSQL socket. If you enter a path, the path must begin with a "/".
* Enter the listener port number of the server host in the *Port* field. * Enter the listener port number of the server host in the *Port* field.
* Use the *Maintenance Database* field to specify the name of the initial database to which the client will connect. If you will be using pgAgent or adminpack objects, the :ref:`pgAgent <pgagent>` schema and :ref:`adminpack <extend>` objects should be installed on that database. * Use the *Maintenance Database* field to specify the name of the initial database to which the client will connect. If you will be using pgAgent or adminpack objects, the pgAgent schema and adminpack objects should be installed on that database.
* Use the *User Name* field to specify the name of a role that will be used when authenticating with the server. * Use the *User Name* field to specify the name of a role that will be used when authenticating with the server.
* Use the *Role* field to specify the name of a role that has privileges that will be conveyed to the client after authentication with the server. This selection allows you to connect as one role, and then assume the permissions of this specified role after the connection is established. Note that the connecting role must be a member of the role specified. * Use the *Role* field to specify the name of a role that has privileges that will be conveyed to the client after authentication with the server. This selection allows you to connect as one role, and then assume the permissions of this specified role after the connection is established. Note that the connecting role must be a member of the role specified.
* Use the drop-down list box in the SSL field to select the type of SSL connection the server should use. For more information about using SSL encryption, see Section 31.18 of the Postgres documentation: * Use the drop-down list box in the SSL field to select the type of SSL connection the server should use. For more information about using SSL encryption, see Section 31.18 of the Postgres documentation:

View File

@ -1,4 +1,4 @@
.. _server_group: .. _server_group_dialog:
*********************** ***********************
The Server Group Dialog The Server Group Dialog

View File

@ -1,3 +1,5 @@
.. _submitting_patches:
****************** ******************
Submitting Patches Submitting Patches
****************** ******************

View File

@ -281,12 +281,3 @@ The example shown demonstrates creating a table named *product_category*. It has
* Click the *Save* button to save work. * Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work. * Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters. * Click the *Reset* button to restore configuration parameters.

View File

@ -1,4 +1,4 @@
.. _tablespace: .. _tablespace_dialog:
********************* *********************
The Tablespace Dialog The Tablespace Dialog

View File

@ -4,7 +4,6 @@
The Trigger Dialog The Trigger Dialog
****************** ******************
Use the *Trigger* dialog to create a trigger or modify an existing trigger. A trigger executes a specified function when certain events occur. Use the *Trigger* dialog to create a trigger or modify an existing trigger. A trigger executes a specified function when certain events occur.
The *Trigger* dialog organizes the development of a trigger through the following dialog tabs: *General*, *Definition*, *Events*, and *Code*. The *SQL* tab displays the SQL code generated by dialog selections. The *Trigger* dialog organizes the development of a trigger through the following dialog tabs: *General*, *Definition*, *Events*, and *Code*. The *SQL* tab displays the SQL code generated by dialog selections.
@ -63,5 +62,3 @@ The example demonstrates creating a trigger named *log_update* that calls a proc
* Click the *Save* button to save work. * Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work. * Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters. * Click the *Reset* button to restore configuration parameters.

View File

@ -1,10 +1,9 @@
.. _type: .. _type_dialog:
*************** ***************
The Type Dialog The Type Dialog
*************** ***************
Use the *Type* dialog to register a custom data type. Use the *Type* dialog to register a custom data type.
The *Type* dialog organizes the development of a data type through the following dialog tabs: *General*, *Definition*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. The *Type* dialog organizes the development of a data type through the following dialog tabs: *General*, *Definition*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.

View File

@ -44,5 +44,3 @@ The example shown demonstrates creating a unique constraint named *name_con* on
* Click the *Save* button to save work. * Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work. * Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters. * Click the *Reset* button to restore configuration parameters.

View File

@ -1,4 +1,4 @@
.. _user_mapping: .. _user_mapping_dialog:
*********************** ***********************
The User Mapping Dialog The User Mapping Dialog

View File

@ -1,4 +1,4 @@
.. _view: .. _view_dialog:
*************** ***************
The View Dialog The View Dialog