diff --git a/docs/en_US/add_restore_point_dialog.rst b/docs/en_US/add_restore_point_dialog.rst index 2938d4689..06330be9a 100644 --- a/docs/en_US/add_restore_point_dialog.rst +++ b/docs/en_US/add_restore_point_dialog.rst @@ -14,7 +14,4 @@ For more information about using a restore point as a recovery target, please se documentation `_. * 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. \ No newline at end of file diff --git a/docs/en_US/backup_and_restore.rst b/docs/en_US/backup_and_restore.rst new file mode 100644 index 000000000..77e770d06 --- /dev/null +++ b/docs/en_US/backup_and_restore.rst @@ -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 \ No newline at end of file diff --git a/docs/en_US/backup_dialog.rst b/docs/en_US/backup_dialog.rst index 9b3ae7c14..af9288dd7 100644 --- a/docs/en_US/backup_dialog.rst +++ b/docs/en_US/backup_dialog.rst @@ -1,6 +1,5 @@ .. _backup_dialog: - ***************** The Backup Dialog ***************** @@ -106,8 +105,4 @@ If the backup is successful, a popup window will confirm success. Click *Click h .. 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*. \ No newline at end of file diff --git a/docs/en_US/backup_globals_dialog.rst b/docs/en_US/backup_globals_dialog.rst index 9858a4884..dc4c50b21 100644 --- a/docs/en_US/backup_globals_dialog.rst +++ b/docs/en_US/backup_globals_dialog.rst @@ -26,4 +26,4 @@ If the backup is successful, a popup window will confirm success. Click *Click h .. image:: images/backup_globals_process_watcher.png -If the backup is unsuccessful, review the error message returned by the *Process Watcher* to resolve any issue. +If the backup is unsuccessful, review the error message returned by the *Process Watcher* to resolve any issue. \ No newline at end of file diff --git a/docs/en_US/backup_server_dialog.rst b/docs/en_US/backup_server_dialog.rst index 9a36cda56..0261ceee4 100644 --- a/docs/en_US/backup_server_dialog.rst +++ b/docs/en_US/backup_server_dialog.rst @@ -25,4 +25,4 @@ Click the *Backup* button to build and execute a command based on your selection If the backup is successful, a popup window will confirm success. Click *Click here for details* on the popup window to launch the *Process Watcher*. The *Process Watcher* logs all the activity associated with the backup and provides additional information for troubleshooting. .. image:: images/backup_server_process_watcher.png - If the backup is unsuccessful, review the error message returned by the *Process Watcher* to resolve any issue. \ No newline at end of file + If the backup is unsuccessful, review the error message returned by the *Process Watcher* to resolve any issue. \ No newline at end of file diff --git a/docs/en_US/browser.rst b/docs/en_US/browser.rst index c02f3e39a..a8892e1b2 100644 --- a/docs/en_US/browser.rst +++ b/docs/en_US/browser.rst @@ -1,3 +1,5 @@ +.. _browser: + ******************** The pgAdmin 4 Client ******************** diff --git a/docs/en_US/cast_dialog.rst b/docs/en_US/cast_dialog.rst index 95b32dc3e..fffbbce46 100644 --- a/docs/en_US/cast_dialog.rst +++ b/docs/en_US/cast_dialog.rst @@ -1,4 +1,4 @@ -.. _cast: +.. _cast_dialog: *************** The Cast Dialog diff --git a/docs/en_US/change_password_dialog.rst b/docs/en_US/change_password_dialog.rst index d8e406383..a4cc74aab 100644 --- a/docs/en_US/change_password_dialog.rst +++ b/docs/en_US/change_password_dialog.rst @@ -1,6 +1,5 @@ .. _change_password_dialog: - ************************** The Change Password Dialog ************************** @@ -24,4 +23,4 @@ Use the *Change Password* dialog to change your password: * 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. +Click the *OK* button to change your password; click *Cancel* to exit the dialog without changing your password. \ No newline at end of file diff --git a/docs/en_US/check_dialog.rst b/docs/en_US/check_dialog.rst index 930d319f5..60fb8b077 100644 --- a/docs/en_US/check_dialog.rst +++ b/docs/en_US/check_dialog.rst @@ -40,6 +40,4 @@ The example shown demonstrates creating a check constraint named *check_price* o * Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation. * Click the *Save* button to save 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. \ No newline at end of file diff --git a/docs/en_US/client_features.rst b/docs/en_US/client_features.rst new file mode 100644 index 000000000..24861c1ac --- /dev/null +++ b/docs/en_US/client_features.rst @@ -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 + diff --git a/docs/en_US/code_overview.rst b/docs/en_US/code_overview.rst index f9eb64bdd..28dddcd3c 100644 --- a/docs/en_US/code_overview.rst +++ b/docs/en_US/code_overview.rst @@ -1,3 +1,5 @@ +.. _code_overview: + ************* Code Overview ************* @@ -210,4 +212,4 @@ divided each module in small chunks as much as possible. Not all javascript modules are required to be loaded (i.e. loading a javascript module for database will make sense only when a server node is loaded competely.) Please look at the the javascript files node.js, browser.js, menu.js, panel.js, etc for -better understanding of the code. +better understanding of the code. \ No newline at end of file diff --git a/docs/en_US/code_review.rst b/docs/en_US/code_review.rst index 1a836fc46..f2085f0d9 100644 --- a/docs/en_US/code_review.rst +++ b/docs/en_US/code_review.rst @@ -1,3 +1,5 @@ +.. _code_review: + ***************** Code Review Notes ***************** diff --git a/docs/en_US/coding_standards.rst b/docs/en_US/coding_standards.rst index c234c8b1a..bde82ef0e 100644 --- a/docs/en_US/coding_standards.rst +++ b/docs/en_US/coding_standards.rst @@ -1,3 +1,5 @@ +.. _coding_standards: + **************** Coding Standards **************** diff --git a/docs/en_US/collation_dialog.rst b/docs/en_US/collation_dialog.rst index 5f37aeff8..589c0e9dd 100644 --- a/docs/en_US/collation_dialog.rst +++ b/docs/en_US/collation_dialog.rst @@ -4,7 +4,6 @@ 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. 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. diff --git a/docs/en_US/column_dialog.rst b/docs/en_US/column_dialog.rst index 61b9af7d0..3a007c5b6 100644 --- a/docs/en_US/column_dialog.rst +++ b/docs/en_US/column_dialog.rst @@ -67,7 +67,4 @@ The example shown demonstrates creating a column named *territory* in the table * Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation. * Click the *Save* button to save 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. \ No newline at end of file diff --git a/docs/en_US/connect_error.rst b/docs/en_US/connect_error.rst index 281602a6f..33bd70b84 100644 --- a/docs/en_US/connect_error.rst +++ b/docs/en_US/connect_error.rst @@ -1,6 +1,5 @@ .. _connect_error: - ************************** `Connection error`:index: ************************** diff --git a/docs/en_US/connect_to_server.rst b/docs/en_US/connect_to_server.rst index a7bbc2a67..988b9b8dc 100644 --- a/docs/en_US/connect_to_server.rst +++ b/docs/en_US/connect_to_server.rst @@ -1,6 +1,5 @@ .. _connect_to_server: - ***************** Connect to server ***************** diff --git a/docs/en_US/connecting.rst b/docs/en_US/connecting.rst new file mode 100644 index 000000000..71111a19e --- /dev/null +++ b/docs/en_US/connecting.rst @@ -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 + + + + + + + + diff --git a/docs/en_US/contributions.rst b/docs/en_US/contributions.rst new file mode 100644 index 000000000..a395e1218 --- /dev/null +++ b/docs/en_US/contributions.rst @@ -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 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 + diff --git a/docs/en_US/database_dialog.rst b/docs/en_US/database_dialog.rst index 4918d6b25..aff9dd774 100644 --- a/docs/en_US/database_dialog.rst +++ b/docs/en_US/database_dialog.rst @@ -1,4 +1,4 @@ -.. _database: +.. _database_dialog: ******************* The Database Dialog diff --git a/docs/en_US/debugger.rst b/docs/en_US/debugger.rst index 5159c9bd5..eb541915a 100644 --- a/docs/en_US/debugger.rst +++ b/docs/en_US/debugger.rst @@ -1,3 +1,4 @@ +.. _debugger: ************************* `pgAdmin Debugger`:index: diff --git a/docs/en_US/deployment.rst b/docs/en_US/deployment.rst new file mode 100644 index 000000000..112a6ea66 --- /dev/null +++ b/docs/en_US/deployment.rst @@ -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 \ No newline at end of file diff --git a/docs/en_US/desktop_deployment.rst b/docs/en_US/desktop_deployment.rst index 8251f8de9..13437ab59 100644 --- a/docs/en_US/desktop_deployment.rst +++ b/docs/en_US/desktop_deployment.rst @@ -1,3 +1,5 @@ +.. _desktop_deployment: + ****************** Desktop Deployment ****************** diff --git a/docs/en_US/developer_tools.rst b/docs/en_US/developer_tools.rst new file mode 100644 index 000000000..2e48cfd3c --- /dev/null +++ b/docs/en_US/developer_tools.rst @@ -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 diff --git a/docs/en_US/domain_constraint_dialog.rst b/docs/en_US/domain_constraint_dialog.rst index ca5798273..270845d54 100644 --- a/docs/en_US/domain_constraint_dialog.rst +++ b/docs/en_US/domain_constraint_dialog.rst @@ -1,4 +1,4 @@ -.. _domain_constraint: +.. _domain_constraint_dialog: **************************** The Domain Constraint Dialog diff --git a/docs/en_US/domain_dialog.rst b/docs/en_US/domain_dialog.rst index 29cb5c0e7..5fcbd0984 100644 --- a/docs/en_US/domain_dialog.rst +++ b/docs/en_US/domain_dialog.rst @@ -1,4 +1,4 @@ -.. _domain: +.. _domain_dialog: ***************** The Domain Dialog diff --git a/docs/en_US/event_trigger_dialog.rst b/docs/en_US/event_trigger_dialog.rst index f01280149..b79d36437 100644 --- a/docs/en_US/event_trigger_dialog.rst +++ b/docs/en_US/event_trigger_dialog.rst @@ -1,4 +1,4 @@ -.. _event trigger: +.. _event_trigger_dialog: ************************ The Event Trigger Dialog diff --git a/docs/en_US/exclusion_constraint_dialog.rst b/docs/en_US/exclusion_constraint_dialog.rst index e79ae4fe7..c3d73bc91 100644 --- a/docs/en_US/exclusion_constraint_dialog.rst +++ b/docs/en_US/exclusion_constraint_dialog.rst @@ -1,4 +1,4 @@ -.. _exclusion_constraint: +.. _exclusion_constraint_dialog: ******************************* The Exclusion constraint Dialog @@ -59,6 +59,4 @@ The example shown demonstrates creating an exclusion constraint named *exclude_d * Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation. * Click the *Save* button to save 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. \ No newline at end of file diff --git a/docs/en_US/extension_dialog.rst b/docs/en_US/extension_dialog.rst index 51f433d22..7d3f586ff 100644 --- a/docs/en_US/extension_dialog.rst +++ b/docs/en_US/extension_dialog.rst @@ -1,4 +1,4 @@ -.. _extension: +.. _extension_dialog: ******************** The Extension Dialog diff --git a/docs/en_US/foreign_data_wrapper_dialog.rst b/docs/en_US/foreign_data_wrapper_dialog.rst index 05cc577fa..77172fd3f 100644 --- a/docs/en_US/foreign_data_wrapper_dialog.rst +++ b/docs/en_US/foreign_data_wrapper_dialog.rst @@ -1,4 +1,4 @@ -.. _fdw: +.. _foreign_data_wrapper_dialog: ******************************* The Foreign Data Wrapper Dialog diff --git a/docs/en_US/foreign_key_dialog.rst b/docs/en_US/foreign_key_dialog.rst index 7b4a1cc1c..b8f981a48 100644 --- a/docs/en_US/foreign_key_dialog.rst +++ b/docs/en_US/foreign_key_dialog.rst @@ -86,6 +86,4 @@ The example shown demonstrates creating a foreign key constraint named *territor * Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation. * Click the *Save* button to save 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. \ No newline at end of file diff --git a/docs/en_US/foreign_server_dialog.rst b/docs/en_US/foreign_server_dialog.rst index 48665db66..ab4cba8a3 100644 --- a/docs/en_US/foreign_server_dialog.rst +++ b/docs/en_US/foreign_server_dialog.rst @@ -1,4 +1,4 @@ -.. _foreign_server: +.. _foreign_server_dialog: ************************* The Foreign Server Dialog diff --git a/docs/en_US/fts_configuration_dialog.rst b/docs/en_US/fts_configuration_dialog.rst index 63c7de840..e4ed706d1 100644 --- a/docs/en_US/fts_configuration_dialog.rst +++ b/docs/en_US/fts_configuration_dialog.rst @@ -1,4 +1,4 @@ -.. _fts_configuration: +.. _fts_configuration_dialog: **************************** The FTS Configuration dialog diff --git a/docs/en_US/fts_dictionary_dialog.rst b/docs/en_US/fts_dictionary_dialog.rst index a08993924..150732f74 100644 --- a/docs/en_US/fts_dictionary_dialog.rst +++ b/docs/en_US/fts_dictionary_dialog.rst @@ -1,4 +1,4 @@ -.. _fts_dictionary: +.. _fts_dictionary_dialog: ************************* The FTS Dictionary Dialog diff --git a/docs/en_US/fts_parser_dialog.rst b/docs/en_US/fts_parser_dialog.rst index 40e0777cd..345bdc526 100644 --- a/docs/en_US/fts_parser_dialog.rst +++ b/docs/en_US/fts_parser_dialog.rst @@ -1,4 +1,4 @@ -.. _fts_parser: +.. _fts_parser_dialog: ********************* The FTS Parser Dialog diff --git a/docs/en_US/fts_template_dialog.rst b/docs/en_US/fts_template_dialog.rst index 1bc035bb4..8d42fcb91 100644 --- a/docs/en_US/fts_template_dialog.rst +++ b/docs/en_US/fts_template_dialog.rst @@ -1,4 +1,4 @@ -.. _fts_template: +.. _fts_template_dialog: *********************** The FTS Template Dialog diff --git a/docs/en_US/getting_started.rst b/docs/en_US/getting_started.rst new file mode 100644 index 000000000..a2257e137 --- /dev/null +++ b/docs/en_US/getting_started.rst @@ -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 diff --git a/docs/en_US/grant_wizard.rst b/docs/en_US/grant_wizard.rst index f8c7c7d1a..a369e6315 100644 --- a/docs/en_US/grant_wizard.rst +++ b/docs/en_US/grant_wizard.rst @@ -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. - * 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 *Finish* button to save selections and exit the wizard. - - - +* Click the *Finish* button to save selections and exit the wizard. \ No newline at end of file diff --git a/docs/en_US/import_export_data.rst b/docs/en_US/import_export_data.rst index 3a68e9f1e..5c57e7708 100644 --- a/docs/en_US/import_export_data.rst +++ b/docs/en_US/import_export_data.rst @@ -4,7 +4,6 @@ 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. The *Import/Export data* dialog organizes the import/export of data through the *Options* and *Columns* tabs. @@ -52,9 +51,4 @@ 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: -.. image:: images/import_export_pw.png - - - - - +.. image:: images/import_export_pw.png \ No newline at end of file diff --git a/docs/en_US/index.rst b/docs/en_US/index.rst index 144d956a5..6318d592c 100644 --- a/docs/en_US/index.rst +++ b/docs/en_US/index.rst @@ -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. -Getting Started -=============== - -If running on a web server, pgAdmin supports multiple users with per-user authentication. These features are hidden in desktop mode. - Contents: .. toctree:: - :maxdepth: 2 - pgadmin_login - pgadmin_user + getting_started + 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 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 `_, 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 `_. diff --git a/docs/en_US/index_dialog.rst b/docs/en_US/index_dialog.rst index cd10e10cf..673dbbb62 100644 --- a/docs/en_US/index_dialog.rst +++ b/docs/en_US/index_dialog.rst @@ -68,6 +68,4 @@ The example shown demonstrates creating an index named *dist_codes* that indexes * Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation. * Click the *Save* button to save 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. \ No newline at end of file diff --git a/docs/en_US/licence.rst b/docs/en_US/licence.rst new file mode 100644 index 000000000..d2e6499b5 --- /dev/null +++ b/docs/en_US/licence.rst @@ -0,0 +1,7 @@ +.. _licence: + +******* +Licence +******* + +pgAdmin is released under the `PostgreSQL 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 `_. \ No newline at end of file diff --git a/docs/en_US/maintenance_dialog.rst b/docs/en_US/maintenance_dialog.rst index 2b2215e6e..b41f378d9 100755 --- a/docs/en_US/maintenance_dialog.rst +++ b/docs/en_US/maintenance_dialog.rst @@ -1,6 +1,5 @@ .. _maintenance_dialog: - ************************* The Maintenance... Dialog ************************* @@ -35,7 +34,4 @@ 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: -.. image:: images/maintenance_pw.png - - - +.. image:: images/maintenance_pw.png \ No newline at end of file diff --git a/docs/en_US/management_basics.rst b/docs/en_US/management_basics.rst new file mode 100644 index 000000000..3440a5338 --- /dev/null +++ b/docs/en_US/management_basics.rst @@ -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 \ No newline at end of file diff --git a/docs/en_US/managing_cluster_objects.rst b/docs/en_US/managing_cluster_objects.rst new file mode 100644 index 000000000..9a7a3bd95 --- /dev/null +++ b/docs/en_US/managing_cluster_objects.rst @@ -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 \ No newline at end of file diff --git a/docs/en_US/managing_database_objects.rst b/docs/en_US/managing_database_objects.rst new file mode 100644 index 000000000..e7337cbf7 --- /dev/null +++ b/docs/en_US/managing_database_objects.rst @@ -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 diff --git a/docs/en_US/materialized_view_dialog.rst b/docs/en_US/materialized_view_dialog.rst index b14ec0ed3..4c7fa2a7e 100644 --- a/docs/en_US/materialized_view_dialog.rst +++ b/docs/en_US/materialized_view_dialog.rst @@ -1,4 +1,4 @@ -.. _materialized_view: +.. _materialized_view_dialog: **************************** The Materialized View Dialog diff --git a/docs/en_US/modifying_tables.rst b/docs/en_US/modifying_tables.rst new file mode 100644 index 000000000..275437df2 --- /dev/null +++ b/docs/en_US/modifying_tables.rst @@ -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 \ No newline at end of file diff --git a/docs/en_US/pgadmin_login.rst b/docs/en_US/pgadmin_login.rst index a77b0e814..6b8cf4397 100644 --- a/docs/en_US/pgadmin_login.rst +++ b/docs/en_US/pgadmin_login.rst @@ -14,8 +14,7 @@ Use the fields in the *pgAdmin Login* dialog to authenticate your connection: #. Provide your password in the *Password* field. #. 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. diff --git a/docs/en_US/pgadmin_menu_bar.rst b/docs/en_US/pgadmin_menu_bar.rst index 8f0a85955..f82e12dab 100644 --- a/docs/en_US/pgadmin_menu_bar.rst +++ b/docs/en_US/pgadmin_menu_bar.rst @@ -4,13 +4,12 @@ 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** +.. image:: /images/file_menu.png + 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... ` dialog to change your password. | +----------------------+---------------------------------------------------------------------------------------------------------+ -| *Preferences* | Click to open the :ref:`Preferences ` dialog to to customize your pgAdmin settings. | +| *Preferences* | Click to open the :ref:`Preferences ` dialog to to customize your pgAdmin settings. | +----------------------+---------------------------------------------------------------------------------------------------------+ -.. image:: /images/object_menu.png - **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): +------------------------+--------------------------------------------------------------------------------------------------------------------------+ @@ -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. | +------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| *Scripts* | Click to open the :ref:`Query tool ` to edit or view the selected script from the flyout menu. | +| *Scripts* | Click to open the :ref:`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. | +------------------------+--------------------------------------------------------------------------------------------------------------------------+ @@ -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). | +------------------------+--------------------------------------------------------------------------------------------------------------------------+ -.. image:: /images/tool_menu.png - **The Tool Menu** +.. image:: /images/tool_menu.png + 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... ` 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... ` dialog to take a point-in-time snapshot of the current | +| | server state. | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | *Backup...* | Click to open the :ref:`Backup... ` 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. | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| *Query tool* | Click to open the :ref:`Query tool ` for the currently selected object. | +| *Query tool* | Click to open the :ref:`Query tool ` for the currently selected object. | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | *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. | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -.. image:: images/help_menu.png - **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): +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/docs/en_US/pgadmin_tree_control.rst b/docs/en_US/pgadmin_tree_control.rst index f3d231323..7262a4f71 100644 --- a/docs/en_US/pgadmin_tree_control.rst +++ b/docs/en_US/pgadmin_tree_control.rst @@ -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. | | | Your selection opens a *Create* dialog for creating a new object. | +---------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| *CREATE Script* | Click to open the :ref:`Query tool ` to edit or view the CREATE script. | +| *CREATE Script* | Click to open the :ref:`Query tool ` to edit or view the CREATE script. | +---------------------------+---------------------------------------------------------------------------------------------------------------------------+ | *Debugging* | Click through to open the :ref:`Debug ` 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. | +-------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| *Scripts* | Click to open the :ref:`Query tool ` to edit or view the selected script from the flyout menu. | +| *Scripts* | Click to open the :ref:`Query tool ` to edit or view the selected script from the flyout menu. | +-------------------------+------------------------------------------------------------------------------------------------------------------------------+ | *Truncate* | Click to remove all rows from a table. | +-------------------------+------------------------------------------------------------------------------------------------------------------------------+ diff --git a/docs/en_US/preferences.rst b/docs/en_US/preferences.rst index 6a4ae5b52..bf1830306 100644 --- a/docs/en_US/preferences.rst +++ b/docs/en_US/preferences.rst @@ -1,6 +1,5 @@ .. _preferences: - ******************* pgAdmin Preferences ******************* diff --git a/docs/en_US/primary_key_dialog.rst b/docs/en_US/primary_key_dialog.rst index 7e1a49a75..d477f0fad 100644 --- a/docs/en_US/primary_key_dialog.rst +++ b/docs/en_US/primary_key_dialog.rst @@ -43,6 +43,4 @@ The example shown demonstrates creating a primary key constraint named *dept_pke * Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation. * Click the *Save* button to save 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. \ No newline at end of file diff --git a/docs/en_US/procedure_dialog.rst b/docs/en_US/procedure_dialog.rst index d69e27320..503750643 100644 --- a/docs/en_US/procedure_dialog.rst +++ b/docs/en_US/procedure_dialog.rst @@ -104,6 +104,4 @@ The example demonstrates creating a procedure that returns a list of employees f * Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation. * Click the *Save* button to save 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. \ No newline at end of file diff --git a/docs/en_US/query_tool.rst b/docs/en_US/query_tool.rst index ec70373d0..7141675bc 100644 --- a/docs/en_US/query_tool.rst +++ b/docs/en_US/query_tool.rst @@ -1,6 +1,5 @@ .. _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. - **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. @@ -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. | +--------------------+---------------------------------------------------------------------------------------------------+ - **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. .. 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 lower case by pressing Control+Shift+U. - **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. The *Data Output* panel organizes output through the following tabs: *Data Output*, *Explain*, *Messages*, and *History*. @@ -180,10 +174,4 @@ Use the *History* tab to review activity for the current session: .. 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. \ No newline at end of file diff --git a/docs/en_US/resource_group_dialog.rst b/docs/en_US/resource_group_dialog.rst index a5fba38e8..fa8b4e86d 100644 --- a/docs/en_US/resource_group_dialog.rst +++ b/docs/en_US/resource_group_dialog.rst @@ -1,4 +1,4 @@ -.. _resource_group: +.. _resource_group_dialog: ************************* The Resource Group Dialog diff --git a/docs/en_US/restore_dialog.rst b/docs/en_US/restore_dialog.rst index 57112e918..0f54d4265 100755 --- a/docs/en_US/restore_dialog.rst +++ b/docs/en_US/restore_dialog.rst @@ -1,6 +1,5 @@ .. _restore_dialog: - ****************** The Restore Dialog ****************** @@ -77,31 +76,4 @@ When you’ve 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. -.. image:: images/restore_process_watcher.png - - - - - - - - - - - - - - - - - - - - - - - - - - - +.. image:: images/restore_process_watcher.png \ No newline at end of file diff --git a/docs/en_US/role_dialog.rst b/docs/en_US/role_dialog.rst index 5ecfe4017..32e427434 100644 --- a/docs/en_US/role_dialog.rst +++ b/docs/en_US/role_dialog.rst @@ -1,4 +1,4 @@ -.. _role: +.. _role_dialog: *************************** The Login/Group Role Dialog diff --git a/docs/en_US/rule_dialog.rst b/docs/en_US/rule_dialog.rst index 44f7e325d..196070e38 100644 --- a/docs/en_US/rule_dialog.rst +++ b/docs/en_US/rule_dialog.rst @@ -41,6 +41,4 @@ The example sends a notification when an UPDATE executes against a table. * Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation. * Click the *Save* button to save 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. \ No newline at end of file diff --git a/docs/en_US/schema_dialog.rst b/docs/en_US/schema_dialog.rst index 19938cb08..351faa0a1 100644 --- a/docs/en_US/schema_dialog.rst +++ b/docs/en_US/schema_dialog.rst @@ -1,4 +1,4 @@ -.. _schema: +.. _schema_dialog: ***************** The Schema Dialog diff --git a/docs/en_US/sequence_dialog.rst b/docs/en_US/sequence_dialog.rst index 583d2f9e2..d34f2cfb7 100644 --- a/docs/en_US/sequence_dialog.rst +++ b/docs/en_US/sequence_dialog.rst @@ -1,4 +1,4 @@ -.. _sequence: +.. _sequence_dialog: ******************* The Sequence Dialog diff --git a/docs/en_US/server_deployment.rst b/docs/en_US/server_deployment.rst index d47eb84a4..b48c3ee3b 100644 --- a/docs/en_US/server_deployment.rst +++ b/docs/en_US/server_deployment.rst @@ -1,3 +1,5 @@ +.. _server_deployment: + ***************** Server Deployment ***************** diff --git a/docs/en_US/server_dialog.rst b/docs/en_US/server_dialog.rst index a1862aa40..23f9639c6 100644 --- a/docs/en_US/server_dialog.rst +++ b/docs/en_US/server_dialog.rst @@ -1,4 +1,4 @@ -.. _server: +.. _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 "/". * 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 ` schema and :ref:`adminpack ` 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 *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: diff --git a/docs/en_US/server_group_dialog.rst b/docs/en_US/server_group_dialog.rst index 9fe751081..ead3b26b7 100644 --- a/docs/en_US/server_group_dialog.rst +++ b/docs/en_US/server_group_dialog.rst @@ -1,4 +1,4 @@ -.. _server_group: +.. _server_group_dialog: *********************** The Server Group Dialog diff --git a/docs/en_US/submitting_patches.rst b/docs/en_US/submitting_patches.rst index 69518db90..b4bbebe8c 100644 --- a/docs/en_US/submitting_patches.rst +++ b/docs/en_US/submitting_patches.rst @@ -1,3 +1,5 @@ +.. _submitting_patches: + ****************** Submitting Patches ****************** diff --git a/docs/en_US/table_dialog.rst b/docs/en_US/table_dialog.rst index 37a53a071..1a1dd5573 100644 --- a/docs/en_US/table_dialog.rst +++ b/docs/en_US/table_dialog.rst @@ -280,13 +280,4 @@ The example shown demonstrates creating a table named *product_category*. It has * Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation. * Click the *Save* button to save 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. \ No newline at end of file diff --git a/docs/en_US/tablespace_dialog.rst b/docs/en_US/tablespace_dialog.rst index 8eb1718b4..ab3de588f 100644 --- a/docs/en_US/tablespace_dialog.rst +++ b/docs/en_US/tablespace_dialog.rst @@ -1,4 +1,4 @@ -.. _tablespace: +.. _tablespace_dialog: ********************* The Tablespace Dialog diff --git a/docs/en_US/trigger_dialog.rst b/docs/en_US/trigger_dialog.rst index 0128527b3..ea4f4d877 100644 --- a/docs/en_US/trigger_dialog.rst +++ b/docs/en_US/trigger_dialog.rst @@ -4,7 +4,6 @@ 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. 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. @@ -62,6 +61,4 @@ The example demonstrates creating a trigger named *log_update* that calls a proc * Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation. * Click the *Save* button to save 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. \ No newline at end of file diff --git a/docs/en_US/type_dialog.rst b/docs/en_US/type_dialog.rst index 0c3beab66..75c7e783b 100644 --- a/docs/en_US/type_dialog.rst +++ b/docs/en_US/type_dialog.rst @@ -1,10 +1,9 @@ -.. _type: +.. _type_dialog: *************** The Type Dialog *************** - 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. diff --git a/docs/en_US/unique_constraint_dialog.rst b/docs/en_US/unique_constraint_dialog.rst index cb327bfe2..fdce248b9 100644 --- a/docs/en_US/unique_constraint_dialog.rst +++ b/docs/en_US/unique_constraint_dialog.rst @@ -43,6 +43,4 @@ The example shown demonstrates creating a unique constraint named *name_con* on * Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation. * Click the *Save* button to save 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. \ No newline at end of file diff --git a/docs/en_US/user_mapping_dialog.rst b/docs/en_US/user_mapping_dialog.rst index a18768c09..4842d8686 100644 --- a/docs/en_US/user_mapping_dialog.rst +++ b/docs/en_US/user_mapping_dialog.rst @@ -1,4 +1,4 @@ -.. _user_mapping: +.. _user_mapping_dialog: *********************** The User Mapping Dialog diff --git a/docs/en_US/view_dialog.rst b/docs/en_US/view_dialog.rst index 58bd4830e..6b27437e7 100644 --- a/docs/en_US/view_dialog.rst +++ b/docs/en_US/view_dialog.rst @@ -1,4 +1,4 @@ -.. _view: +.. _view_dialog: *************** The View Dialog