pgadmin-org
/
pgadmin4
mirror of https://github.com/pgadmin-org/pgadmin4.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Ensure images in the docs have alt tags for screen readers. Fixes #2903

pull/18/head
Murtuza Zabuawala 2018-01-11 16:58:30 +00:00 committed by Dave Page
parent 8b3aecd137
commit b78b97d89b
65 changed files with 899 additions and 599 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/en_US/add_restore_point_dialog.rst
View File

@ -7,6 +7,7 @@ The Add named restore point Dialog
Use the *Add named restore point* dialog to take a named snapshot of the state of the server for use in a recovery file. To create a named restore point, the server's postgresql.conf file must specify a *wal_level* value of *archive*, *hot_standby*, or *logical*. You must be a database superuser to create a restore point.
.. image:: images/add_restore_point.png
:alt: Restore point dialog
When the *Restore point name* window launches, use the field *Enter the name of the restore point to add* to provide a descriptive name for the restore point.

9
docs/en_US/backup_dialog.rst
View File

@ -9,6 +9,7 @@ Using the *pg_dump* utility, *pgAdmin* provides an easy way to create a backup i
You can backup a single table, a schema, or a complete database. Select the name of the backup source in the *pgAdmin* tree control, right click to open the context menu, and select *Backup...* to open the *Backup* dialog. The name of the object selected will appear in the dialog title bar.
.. image:: images/backup_general.png
:alt: Backup dialog general tab
Use the fields in the *General* tab to specify parameters for the backup:
@ -31,6 +32,7 @@ Use the fields in the *General* tab to specify parameters for the backup:
Click the *Dump options* tab to continue. Use the box fields in the *Dump options* tab to provide options for *pg_dump*.
.. image:: images/backup_sections.png
:alt: Sections option on backup dialog
* Move switches in the **Sections** field box to select a portion of the object that will be backed up.
@ -41,6 +43,7 @@ Click the *Dump options* tab to continue. Use the box fields in the *Dump option
* Move the switch next to *Post-data* to the *Yes* position to include definitions of indexes, triggers, rules, and constraints other than validated check constraints.
.. image:: images/backup_objects.png
:alt: Type of objects option on backup dialog
* Move switches in the **Type of objects** field box to specify details about the type of objects that will be backed up.
@ -51,6 +54,7 @@ Click the *Dump options* tab to continue. Use the box fields in the *Dump option
* Move the switch next to *Blobs* to the *No* position to exclude large objects in the backup.
.. image:: images/backup_do_not_save.png
:alt: Do not save option on backup dialog
* Move switches in the **Do not save** field box to select the objects that will not be included in the backup.
@ -63,6 +67,7 @@ Click the *Dump options* tab to continue. Use the box fields in the *Dump option
* Move the switch next to *Unlogged table data* to the *Yes* position to include the contents of unlogged tables.
.. image:: images/backup_queries.png
:alt: Queries option on backup dialog
* Move switches in the **Queries** field box to specify the type of statements that should be included in the backup.
@ -75,6 +80,7 @@ Click the *Dump options* tab to continue. Use the box fields in the *Dump option
* Move the switch next to *Include DROP DATABASE statement* to the *Yes* position to include a command in the backup that will drop any existing database object with the same name before recreating the object during a backup.
.. image:: images/backup_disable.png
:alt: Disable option on backup dialog
* Move switches in the **Disable** field box to specify the type of statements that should be excluded from the backup.
@ -83,6 +89,7 @@ Click the *Dump options* tab to continue. Use the box fields in the *Dump option
* Move the switch next to *$ quoting* to the *Yes* position to enable dollar quoting within function bodies; if disabled, the function body will be quoted using SQL standard string syntax.
.. image:: images/backup_miscellaneous.png
:alt: Miscellaneous option on backup dialog
* Move switches in the **Miscellaneous** field box to specify miscellaneous backup options.
@ -100,9 +107,11 @@ When you’ve specified the details that will be incorporated into the pg_dump c
* Click the *Cancel* button to exit without saving work.
.. image:: images/backup_messages.png
:alt: Backup success notification popup
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_process_watcher.png
:alt: Backup process watcher
If the backup is unsuccessful, you can review the error messages returned by the backup command on the *Process Watcher*.

3
docs/en_US/backup_globals_dialog.rst
View File

@ -7,6 +7,7 @@ The Backup Globals Dialog
Use the *Backup Globals* dialog to create a plain-text script that recreates all of the database objects within a cluster, and the global objects that are shared by those databases. Global objects include tablespaces, roles, and object properties. You can use the pgAdmin *Query Tool* to play back a plain-text script, and recreate the objects in the backup.
.. image:: images/backup_globals_general.png
:alt: Backup globals dialog
Use the fields in the *General* tab to specify the following:
@ -21,9 +22,11 @@ Move switches in the **Miscellaneous** field box to specify the type of statemen
Click the *Backup* button to build and execute a command based on your selections; click the *Cancel* button to exit without saving work.
.. image:: images/backup_globals_messages.png
:alt: Backup globals success notification popup
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_globals_process_watcher.png
:alt: Backup globals process watcher
If the backup is unsuccessful, review the error message returned by the *Process Watcher* to resolve any issue.

3
docs/en_US/backup_server_dialog.rst
View File

@ -7,6 +7,7 @@ The Backup Server Dialog
Use the *Backup Server* dialog to create a plain-text script that will recreate the selected server. You can use the pgAdmin *Query Tool* to play back a plain-text script, and recreate the server.
.. image:: images/backup_server_general.png
:alt: Backup server dialog
Use the fields in the *General* tab to specify the following:
@ -21,9 +22,11 @@ Move switches in the *Miscellaneous* box to specify the type of statements that
Click the *Backup* button to build and execute a command based on your selections; click the *Cancel* button to exit without saving work.
.. image:: images/backup_server_messages.png
:alt: Backup server success notification popup
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
:alt: Backup server process watcher
If the backup is unsuccessful, review the error message returned by the *Process Watcher* to resolve any issue.

1
docs/en_US/browser.rst
View File

@ -22,6 +22,7 @@ Features of pgAdmin 4 include:
When pgAdmin opens, the interface features a menu bar and a window divided into two panes: the *Browser* tree control in the left pane, and a tabbed browser in the right pane.
.. image:: images/pgadmin_welcome.png
:alt: pgAdmin4 welcome page
Select an icon from the *Quick Links* panel on the *Dashboard* tab to:

3
docs/en_US/cast_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Cast* dialog to define a cast. A cast specifies how to convert a value
The *Cast* dialog organizes the development of a cast through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/cast_general.png
:alt: Cast dialog general tab
Use the fields in the *General* tab to identify the cast:
@ -18,6 +19,7 @@ Use the fields in the *General* tab to identify the cast:
Click the *Definition* tab to continue.
.. image:: images/cast_definition.png
:alt: Cast dialog definition tab
Use the fields in the *Definition* tab to define parameters:
@ -35,6 +37,7 @@ Your entries in the *Cast* dialog generate a SQL command (see an example below).
The following is an example of the sql command generated by user selections in the *Cast* dialog:
.. image:: images/cast_sql.png
:alt: Cast dialog sql tab
The cast uses a function named *int4(bigint)* to convert a biginteger data type to an integer.

1
docs/en_US/change_password_dialog.rst
View File

@ -15,6 +15,7 @@ Please consider the following guidelines when selecting a password:
The above should be considered a starting point: It is not a comprehensive list and it **will not guarantee security**.
.. image:: images/password.png
:alt: Change database password dialog
Use the *Change Password* dialog to change your password:

1
docs/en_US/change_user_password.rst
View File

@ -15,6 +15,7 @@ Please consider the following guidelines when selecting a password:
The above should be considered a starting point: It is not a comprehensive list and it **will not guarantee security**.
.. image:: images/change_user_password.png
:alt: Change pgAdmin4 current user password dialog
Use the *Change Password* dialog to change your password:

3
docs/en_US/check_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Check* dialog to define or modify a check constraint. A check constrain
The *Check* dialog organizes the development of a check constraint through the *General* and *Definition* tabs. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/check_general.png
:alt: Check dialog general tab
Use the fields in the *General* tab to identify the check constraint:
@ -18,6 +19,7 @@ Use the fields in the *General* tab to identify the check constraint:
Click the *Definition* tab to continue.
.. image:: images/check_definition.png
:alt: Check dialog definition tab
Use the fields in the *Definition* tab to define the check constraint:
@ -34,6 +36,7 @@ Your entries in the *Check* dialog generate a SQL command (see an example below)
The following is an example of the sql command generated by user selections in the *Check* dialog:
.. image:: images/check_sql.png
:alt: Check dialog sql tab
The example shown demonstrates creating a check constraint named *check_price* on the *price* column of the *products* table. The constraint confirms that any values added to the column are greater than 0.

3
docs/en_US/collation_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Collation* dialog to define a collation. A collation is an SQL schema o
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.
.. image:: images/collation_general.png
:alt: Collation dialog general tab
Use the fields in the *General* tab to identify the collation:
@ -20,6 +21,7 @@ Use the fields in the *General* tab to identify the collation:
Click the *Definition* tab to continue.
.. image:: images/collation_definition.png
:alt: Collation dialog definition tab
Use the fields in the *Definition* tab to specify the operating system locale settings:
@ -38,6 +40,7 @@ Your entries in the *Collation* dialog generate a SQL command (see an example be
The following is an example of the sql command generated by user selections in the *Collation* dialog:
.. image:: images/collation_sql.png
:alt: Collation dialog sql tab
The example shown demonstrates creating a collation named *french* that uses the rules specified for the locale, *fr_FR.utf8. The collation is owned by *postgres*.

5
docs/en_US/column_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Column* dialog to add a column to an existing table or modify a column
The *Column* dialog organizes the development of a column through the following dialog tabs: *General*, *Definition*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/column_general.png
:alt: Column dialog general tab
Use the fields in the *General* tab to identify the column:
@ -18,6 +19,7 @@ Use the fields in the *General* tab to identify the column:
Click the *Definition* tab to continue.
.. image:: images/column_definition.png
:alt: Column dialog definition tab
Use the fields in the *Definition* tab to add parameters for the column. (Fields are disabled if inapplicable.)
@ -30,6 +32,7 @@ Use the fields in the *Definition* tab to add parameters for the column. (Fields
Click the *Variables* tab to continue.
.. image:: images/column_variables.png
:alt: Column dialog variables tab
Use the *Variables* tab to to specify the number of distinct values that may be present in the column; this value overrides estimates made by the ANALYZE command. Click the *Add* icon (+) to add a *Name*/*Value* pair:
@ -45,6 +48,7 @@ Click the *Add* icon (+) to specify each additional *Name*/*Value* pair; to disc
Click the *Security* tab to continue.
.. image:: images/column_security.png
:alt: Column dialog security tab
Use the *Security* tab to assign attributes and define security labels. Click the *Add* icon (+) to add each security label selection:
@ -62,6 +66,7 @@ Your entries in the *Column* dialog generate a SQL command (see an example below
The following is an example of the sql command generated by user selections in the *Column* dialog:
.. image:: images/column_sql.png
:alt: Column dialog sql tab
The example shown demonstrates creating a column named *territory* in the table named *distributors*.

4
docs/en_US/connect_error.rst
View File

@ -9,12 +9,14 @@ When connecting to a PostgreSQL server, you may get an error message. If you enc
**Connection to the server has been lost**
.. image:: images/ce_timeout.png
:alt: Connection to the server has been lost
This error message indicates that the connection attempt has taken longer than the specified threshold; there may be a problem with the connection properties provided on the *Server* dialog, network connectivity issues, or the server may not be running.
**could not connect to Server: Connection refused**
.. image:: images/ce_not_running.png
:alt: Could not connect to server
If pgAdmin displays this message, there are two possible reasons for this:
* the database server isn't running - simply start it.
@ -27,6 +29,7 @@ For further information, please refer to the PostgreSQL documentation about `run
**FATAL: no pg_hba.conf entry**
.. image:: images/ce_error_hba.png
:alt: No pg_hba.conf entry
If pgAdmin displays this message when connecting, your server can be contacted correctly over the network, but is not configured to accept your connection. Your client has not been detected as a legal user for the database.
@ -40,6 +43,7 @@ For more information, please refer to the PostgreSQL documentation about `client
**FATAL: password authentication failed**
.. image:: images/ce_password_failed.png
:alt: Password authentication failed
* The *password authentication failed for user* error message indicates there may be a problem with the password you entered. Retry the password to confirm you entered it correctly. If the error message returns, make sure that you have the correct password, that you are authorized to access the server, and that the access has been correctly configured in the server's postgresql.conf configuration file.

1
docs/en_US/connect_to_server.rst
View File

@ -7,6 +7,7 @@ Connect to server
Use the *Connect to Server* dialog to authenticate with a defined server and access the objects stored on the server through the pgAdmin tree control. To access the dialog, right click on the server name in the *pgAdmin* tree control, and select *Connect Server...* from the context menu.
.. image:: images/connect_to_server.png
:alt: Connect to server dialog
Provide authentication information for the selected server:

5
docs/en_US/database_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Database* dialog to define or modify a database. To create a database,
The *Database* dialog organizes the development of a database through the following dialog tabs: *General*, *Definition*, *Security*, and *Parameters*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/database_general.png
:alt: Database dialog general tab
Use the fields in the *General* tab to identify the database:
@ -19,6 +20,7 @@ Use the fields in the *General* tab to identify the database:
Click the *Definition* tab to continue.
.. image:: images/database_definition.png
:alt: Database dialog definition tab
Use the *Definition* tab to set properties for the database:
@ -32,6 +34,7 @@ Use the *Definition* tab to set properties for the database:
Click the *Security* tab to continue.
.. image:: images/database_security.png
:alt: Database dialog security tab
Use the *Security* tab to assign privileges and define security labels.
@ -53,6 +56,7 @@ To discard a security label, click the trash icon to the left of the row and con
Click the *Parameters* tab to continue.
.. image:: images/database_parameters.png
:alt: Database dialog parameters tab
Use the *Parameters* tab to set parameters for the database. Click the *Add* icon (+) to add each parameter:
@ -71,6 +75,7 @@ Your entries in the *Database* dialog generate a SQL command (see an example bel
The following is an example of the sql command generated by user selections in the *Database* dialog:
.. image:: images/database_sql.png
:alt: Database dialog sql tab
The example creates a database named *hr* that is owned by *postgres*. It allows unlimited connections, and is available to all authenticated users.

10
docs/en_US/debugger.rst
View File

@ -5,6 +5,7 @@
******************
.. image:: images/debug_main.png
:alt: Debugger page
The debugger may be used to debug PL/pgSQL functions in PostgreSQL, as well as EDB-SPL functions, stored procedures and packages in Advanced Server. The Debugger is available as an extension for your PostgreSQL installation, and is distributed as part of Advanced Server. You must have superuser privileges to use the debugger.
@ -21,10 +22,12 @@ The debugger may be used for either in-context debugging or direct debugging of
To set a breakpoint at the first line of a program, right-click the name of the object you would like to debug, and select *Set breakpoint* from the *Debugging* sub-menu. The debugger window will open, waiting for another session to invoke the program.
.. image:: images/debug_set_breakpoint.png
:alt: Debugger set a breakpoint demo
When another session invokes the target, the debugger will display the code, allowing you to add break points, or step through line-by-line. The other session is suspended until the debugging completes; then control is returned to the session.
.. image:: images/debug_ic_step_in.png
:alt: Debugger step-in demo
**Direct Debugging**
@ -32,6 +35,7 @@ When another session invokes the target, the debugger will display the code, all
To use the debugger for direct debugging, right click on the name of the object that you wish to debug in the pgAdmin tree control and select *Debug* from the *Debugging* sub-menu. The debugger window will open, prompting you for any values required by the program:
.. image:: images/debug_params.png
:alt: Debugger parameter dialog
Use the fields on the *Debugger* dialog to provide a value for each parameter:
@ -46,6 +50,7 @@ Use the fields on the *Debugger* dialog to provide a value for each parameter:
Provide values required by the program, and click the *Debug* button to start stepping through the program.
.. image:: images/debug_step_in.png
:alt: Debugger step-in demo
**Using the Debugger**
@ -53,6 +58,7 @@ Provide values required by the program, and click the *Debug* button to start st
The main debugger window consists of two panels and a context-sensitive toolbar. Use toolbar icons to manage breakpoints and step into or through code; hover over an icon for a tooltip that identifies the option associated with the icon. The toolbar options are:
.. image:: images/debug_toolbar.png
:alt: Debugger navigation toolbar
+-------------------------+-----------------------------------------------------------------------------------------------------------+
| Option | Action |
@ -75,6 +81,7 @@ The main debugger window consists of two panels and a context-sensitive toolbar.
The top panel of the debugger window displays the program body; click in the grey margin next to a line number to add a breakpoint. The highlighted line in the top panel is the line that is about to execute.
.. image:: images/debug_main.png
:alt: Debugger main window
The lower panel of the debugger window provides a set of tabs that allow you to review information about the program:
@ -87,14 +94,17 @@ The lower panel of the debugger window provides a set of tabs that allow you to
As you step through a program, the *Local variables* tab displays the current value of each variable:
.. image:: images/debug_variables.png
:alt: Debugger local variables tab
When you step into a subroutine, the *Stack* tab displays the call stack, including the name of each caller, the parameter values for each caller (if any), and the line number within each caller:
.. image:: images/debug_stack.png
:alt: Debugger local stack tab
Select a caller to change focus to that stack frame and display the state of the caller in the upper panel.
When the program completes, the *Results* tab displays the message returned by the server. If the program encounters an error, the *Messages* tab displays details:
.. image:: images/debug_error_message.png
:alt: Debugger error message

3
docs/en_US/domain_constraint_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Domain Constraints* dialog to create or modify a domain constraint. A d
The *Domain Constraints* dialog organizes the development of a domain constraint through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/domain_constraint_general.png
:alt: Domain constraint dialog general tab
Use the fields in the *General* tab to identify the domain constraint:
@ -18,6 +19,7 @@ Use the fields in the *General* tab to identify the domain constraint:
Click the *Definition* tab to continue.
.. image:: images/domain_constraint_definition.png
:alt: Domain constraint dialog general tab
Use the fields in the *Definition* tab to define the domain constraint:
@ -33,6 +35,7 @@ Your entries in the *Domain Constraints* dialog generate a SQL command (see an e
The following is an example of the sql command generated by user selections in the *Domain Constraints* dialog:
.. image:: images/domain_constraint_sql.png
:alt: Domain constraint dialog general tab
The example shown demonstrates creating a domain constraint on the domain *timesheets* named *weekday*. It constrains a value to equal *Friday*.

5
docs/en_US/domain_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Domain* dialog to define a domain. A domain is a data type definition t
The *Domain* dialog organizes the development of a domain through the following tabs: *General*, *Definition*, *Constraints*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/domain_general.png
:alt: Domain dialog general tab
Use the fields on the *General* tab to identify a domain:
@ -20,6 +21,7 @@ Use the fields on the *General* tab to identify a domain:
Click the *Definition* tab to continue.
.. image:: images/domain_definition.png
:alt: Domain dialog definition tab
Use the fields in the *Definition* tab to describe the domain:
@ -33,6 +35,7 @@ Use the fields in the *Definition* tab to describe the domain:
Click the *Constraints* tab to continue.
.. image:: images/domain_constraints.png
:alt: Domain dialog constraints tab
Use the fields in the *Constraints* tab to specify rules for the domain. Click the *Add* icon (+) to set constraints:
@ -47,6 +50,7 @@ Click the *Add* icon (+) to set additional constraints; to discard a constraint,
Click the *Security* tab to continue.
.. image:: images/domain_security.png
:alt: Domain dialog security tab
Use the *Security Labels* panel to assign security labels. Click the *Add* icon (+) to add a label:
@ -64,6 +68,7 @@ Your entries in the *Domain* dialog generate a SQL command (see an example below
The following is an example of the sql command generated by selections made in the *Domain* dialog:
.. image:: images/domain_sql.png
:alt: Domain dialog sql tab
The example shown demonstrates creating a domain named *minimum-wage* that confirms that the value entered is greater than or equal to *7.25*.

2
docs/en_US/editgrid.rst
View File

@ -8,6 +8,7 @@
To review or modify data, right click on a table or view name in the *Browser* tree control. When the context menu opens, use the *View/Edit Data* menu to specify the number of rows you would like to display in the editor panel.
.. image:: images/editgrid.png
:alt: Edit grid window
To modify the content of a table, each row in the table must be uniquely identifiable. If the table definition does not include an OID or a primary key, the displayed data is read only. Note that views cannot be edited; updatable views (using rules) are not supported.
@ -21,6 +22,7 @@ The editor features a toolbar that allows quick access to frequently used option
The toolbar includes context-sensitive icons that provide shortcuts to frequently performed tasks.
.. image:: images/editgrid_toolbar.png
:alt: Edit grid toolbar
Hover over an icon to display a tooltip that describes the icon's functionality.

4
docs/en_US/event_trigger_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Domain Trigger* dialog to define an event trigger. Unlike regular trigg
The *Domain Trigger* dialog organizes the development of a event trigger through the following dialog tabs: *General*, *Definition*, and *Security Labels*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/event_trigger_general.png
:alt: Event trigger dialog general tab
Use the fields in the *General* tab to identify the event trigger:
@ -19,6 +20,7 @@ Use the fields in the *General* tab to identify the event trigger:
Click the *Definition* tab to continue.
.. image:: images/event_trigger_definition.png
:alt: Event trigger dialog definition tab
Use the fields in the *Definition* tab to define the event trigger:
@ -30,6 +32,7 @@ Use the fields in the *Definition* tab to define the event trigger:
Click the *Security Labels* tab to continue.
.. image:: images/event_trigger_security.png
:alt: Event trigger dialog security tab
Use the *Security* tab to define security labels applied to the trigger. Click the *Add* icon (+) to add each security label.
@ -47,6 +50,7 @@ Your entries in the *Domain Trigger* dialog generate a generate a SQL command. U
The following is an example of the sql command generated by user selections in the *Domain Trigger* dialog:
.. image:: images/event_trigger_sql.png
:alt: Event trigger dialog sql tab
The command creates an event trigger named *accounts* that invokes the procedure named *acct_due*.

4
docs/en_US/exclusion_constraint_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Exclusion constraint* dialog to define or modify the behavior of an exc
The *Exclusion constraint* dialog organizes the development of an exclusion constraint through the following dialog tabs: *General*, *Definition*, and *Columns*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/exclusion_constraint_general.png
:alt: Exclusion constraint dialog general tab
Use the fields in the *General* tab to identify the exclusion constraint:
@ -17,6 +18,7 @@ Use the fields in the *General* tab to identify the exclusion constraint:
Click the *Definition* tab to continue.
.. image:: images/exclusion_constraint_definition.png
:alt: Exclusion constraint dialog definition tab
Use the fields in the *Definition* tab to define the exclusion constraint:
@ -36,6 +38,7 @@ Use the fields in the *Definition* tab to define the exclusion constraint:
Click the *Columns* tab to continue.
.. image:: images/exclusion_constraint_columns.png
:alt: Exclusion constraint dialog columns tab
Use the fields in the *Columns* tab to to specify the column(s) to which the constraint applies. Use the drop-down listbox next to *Column* to select a column and click the *Add* icon (+) to provide details of the action on the column:
@ -54,6 +57,7 @@ Your entries in the *Exclusion Constraint* dialog generate a SQL command (see an
The following is an example of the sql command generated by user selections in the *Exclusion Constraint* dialog:
.. image:: images/exclusion_constraint_sql.png
:alt: Exclusion constraint dialog sql tab
The example shown demonstrates creating an exclusion constraint named *exclude_department* that restricts additions to the dept table to those additions that are not equal to the value of the *deptno* column. The constraint uses a btree index.

3
docs/en_US/extension_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Extension* dialog to install a new extension into the current database.
The *Extension* dialog allows you to implement options of the CREATE EXTENSION command through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/extension_general.png
:alt: Extension dialog general tab
Use the fields in the *General* tab to identify an extension:
@ -18,6 +19,7 @@ Use the fields in the *General* tab to identify an extension:
Click the *Definition* tab to continue.
.. image:: images/extension_definition.png
:alt: Extension dialog definition tab
Use the *Definition* tab to select the *Schema* and *Version*:
@ -33,6 +35,7 @@ Your entries in the *Extension* dialog generate a SQL command (see an example be
The following is an example of the sql command generated by user selections in the *Extension* dialog:
.. image:: images/extension_sql.png
:alt: Extension dialog sql tab
The command creates the *chkpass* extension in the *public* schema. It is version *1.0* of *chkpass*.

5
docs/en_US/foreign_data_wrapper_dialog.rst
View File

@ -11,6 +11,7 @@ You must be a superuser to create a foreign data wrapper.
The *Foreign Data Wrapper* dialog organizes the development of a foreign data wrapper through the following dialog tabs: *General*, *Definition*, *Options*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/foreign_data_wrapper_general.png
:alt: Foreign data wrapper dialog general tab
Use the fields in the *General* tab to identify the foreign data wrapper:
@ -21,6 +22,7 @@ Use the fields in the *General* tab to identify the foreign data wrapper:
Click the *Definition* tab to continue.
.. image:: images/foreign_data_wrapper_definition.png
:alt: Foreign data wrapper dialog definition tab
Use the fields in the *Definition* tab to set parameters:
@ -30,6 +32,7 @@ Use the fields in the *Definition* tab to set parameters:
Click the *Options* tab to continue.
.. image:: images/foreign_data_wrapper_options.png
:alt: Foreign data wrapper dialog options tab
Use the fields in the *Options* tab to specify options:
@ -41,6 +44,7 @@ Click the *Add* icon (+) to specify each additional pair; to discard an option,
Click the *Security* tab to continue.
.. image:: images/foreign_data_wrapper_security.png
:alt: Foreign data wrapper dialog security tab
Use the *Security* tab to assign security privileges. Click the *Add* icon (+) to assign a set of privileges.
@ -59,6 +63,7 @@ Your entries in the *Foreign Data Wrapper* dialog generate a SQL command (see an
The following is an example of the sql command generated by user selections in the *Foreign Data Wrapper* dialog:
.. image:: images/foreign_data_wrapper_sql.png
:alt: Foreign data wrapper dialog sql tab
The example creates a foreign data wrapper named *libpq_debug* that uses pre-existing validator and handler functions, *dblink_fdw_validator* and *libpg_fdw_handler*. Selections on the *Options* tab set *debug* equal to *true*. The foreign data wrapper is owned by *postgres*.

5
docs/en_US/foreign_key_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Foreign key* dialog to specify the behavior of a foreign key constraint
The *Foreign key* dialog organizes the development of a foreign key constraint through the following dialog tabs: *General*, *Definition*, *Columns*, and *Action*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/foreign_key_general.png
:alt: Foreign key dialog general tab
Use the fields in the *General* tab to identify the foreign key constraint:
@ -18,6 +19,7 @@ Use the fields in the *General* tab to identify the foreign key constraint:
Click the *Definition* tab to continue.
.. image:: images/foreign_key_definition.png
:alt: Foreign key dialog definition tab
Use the fields in the *Definition* tab to define the foreign key constraint:
@ -35,6 +37,7 @@ Use the fields in the *Definition* tab to define the foreign key constraint:
Click the *Columns* tab to continue.
.. image:: images/foreign_key_columns.png
:alt: Foreign key dialog columns tab
Use the fields in the *Columns* tab to specify one or more reference column(s). A Foreign Key constraint requires that one or more columns of a table must only contain values that match values in the referenced column(s) of a row of a referenced table:
@ -47,6 +50,7 @@ Click the *Add* icon (+) to add a column to the list; repeat the steps above and
Click the *Action* tab to continue.
.. image:: images/foreign_key_action.png
:alt: Foreign key dialog action tab
Use the drop-down listboxes on the *Action* tab to specify behavior related to the foreign key constraint that will be performed when data within the table is updated or deleted:
@ -81,6 +85,7 @@ Your entries in the *Foreign key* dialog generate a SQL command (see an example
The following is an example of the sql command generated by user selections in the *Foreign key* dialog:
.. image:: images/foreign_key_sql.png
:alt: Foreign key dialog sql tab
The example shown demonstrates creating a foreign key constraint named *territory_fkey* that matches values in the *distributors* table *territory* column with those of the *sales_territories* table *region* column.

5
docs/en_US/foreign_server_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Foreign Server* dialog to create a foreign server. A foreign server typ
The *Foreign Server* dialog organizes the development of a foreign server through the following dialog tabs: *General*, *Definition*, *Options*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/foreign_server_general.png
:alt: Foreign server dialog general tab
Use the fields in the *General* tab to identify the foreign server:
@ -19,6 +20,7 @@ Use the fields in the *General* tab to identify the foreign server:
Click the *Definition* tab to continue.
.. image:: images/foreign_server_definition.png
:alt: Foreign server dialog definition tab
Use the fields in the *Definition* tab to set parameters:
@ -28,6 +30,7 @@ Use the fields in the *Definition* tab to set parameters:
Click the *Options* tab to continue.
.. image:: images/foreign_server_options.png
:alt: Foreign server dialog options tab
Use the fields in the *Options* tab to specify options. Click the *Add* button to create an option clause for the foreign server.
@ -39,6 +42,7 @@ Click *Add* to create each additional clause; to discard an option, click the tr
Click the *Security* tab to continue.
.. image:: images/foreign_server_security.png
:alt: Foreign server dialog security tab
Use the *Security* tab to assign security privileges to the foreign server. Click *Add* before you assign a set of privileges.
@ -57,6 +61,7 @@ Your entries in the *Foreign Server* dialog generate a SQL command (see an examp
The following is an example of the sql command generated by user selections in the *Foreign Server* dialog:
.. image:: images/foreign_server_sql.png
:alt: Foreign server dialog sql tab
The example shown demonstrates creating a foreign server for the foreign data wrapper *hdfs_fdw*. It has the name *hdfs_server*; its type is *hiveserver2*. Options for the foreign server include a host and a port.

7
docs/en_US/foreign_table_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Foreign Table* dialog to define a foreign table in the current database
The *Foreign Table* dialog organizes the development of a foreign table through the following dialog tabs: *General*, *Definition*, *Columns*, *Constraints*, *Options*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/foreign_table_general.png
:alt: Foreign table dialog general tab
Use the fields in the *General* tab to identify the foreign table:
@ -20,6 +21,7 @@ Use the fields in the *General* tab to identify the foreign table:
Click the *Definition* tab to continue.
.. image:: images/foreign_table_definition.png
:alt: Foreign table dialog definition tab
Use the fields in the *Definition* tab to define the external data source:
@ -29,6 +31,7 @@ Use the fields in the *Definition* tab to define the external data source:
Click the *Columns* tab to continue.
.. image:: images/foreign_table_columns.png
:alt: Foreign table dialog columns tab
Use the fields in the *Columns* tab to to add columns and their attributes to the table. Click the *Add* icon (+) to define a column:
@ -40,6 +43,7 @@ Click the *Add* icon (+) to specify each additional column; to discard a column,
Click the *Constraints* tab to continue.
.. image:: images/foreign_table_constraints.png
:alt: Foreign table dialog constraints tab
Use the fields in the *Constraints* tab to apply a table constraint to the foreign table. Click the *Add* icon (+) to define a constraint:
@ -53,6 +57,7 @@ Click the *Add* icon (+) to specify each additional constraint; to discard a con
Click the *Options* tab to continue.
.. image:: images/foreign_table_options.png
:alt: Foreign table dialog options tab
Use the fields in the *Options* tab to specify options to be associated with the new foreign table or one of its columns; the accepted option names and values are specific to the foreign data wrapper associated with the foreign server. Click the *Add* icon (+) to add an option/value pair.
@ -64,6 +69,7 @@ Click the *Add* icon (+) to specify each additional option/value pair; to discar
Click the *Security* tab to continue.
.. image:: images/foreign_table_security.png
:alt: Foreign table dialog security tab
Use the *Security* tab to assign privileges and define security labels.
@ -91,6 +97,7 @@ Your entries in the *Foreign Table* dialog generate a SQL command (see an exampl
The following is an example of the sql command generated by user selections in the *Foreign Table* dialog:
.. image:: images/foreign_table_sql.png
:alt: Foreign table dialog sql tab
The example shown demonstrates creating a foreign table *weblogs* with multiple columns and two options.

4
docs/en_US/fts_configuration_dialog.rst
View File

@ -11,6 +11,7 @@ The *FTS Configuration* dialog organizes the development of a FTS configuration
Click the *General* tab to begin.
.. image:: images/fts_configuration_general.png
:alt: FTS configuration dialog general tab
Use the fields in the *General* tab to identify a FTS configuration:
@ -22,6 +23,7 @@ Use the fields in the *General* tab to identify a FTS configuration:
Click the *Definition* tab to continue.
.. image:: images/fts_configuration_definition.png
:alt: FTS configuration dialog definition tab
Use the fields in the *Definition* tab to define parameters:
@ -31,6 +33,7 @@ Use the fields in the *Definition* tab to define parameters:
Click the *Tokens* tab to continue.
.. image:: images/fts_configuration_tokens.png
:alt: FTS configuration dialog tokens tab
Use the fields in the *Tokens* tab to add a token:
@ -49,6 +52,7 @@ Your entries in the *FTS Configuration* dialog generate a SQL command (see an ex
The following is an example of the sql command generated by user selections in the *FTS Configuration* dialog:
.. image:: images/fts_configuration_sql.png
:alt: FTS configuration dialog sql tab
The example shown demonstrates creating a FTS configuration named *meme_phrases*. It uses the *default* parser.

4
docs/en_US/fts_dictionary_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *FTS Dictionary* dialog to create a full text search dictionary. You can
The *FTS Dictionary* dialog organizes the development of a FTS dictionary through the following dialog tabs: *General*, *Definition*, and *Options*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/fts_dictionary_general.png
:alt: FTS dictionary dialog general tab
Use the fields in the *General* tab to identify the dictionary:
@ -20,6 +21,7 @@ Use the fields in the *General* tab to identify the dictionary:
Click the *Definition* tab to continue.
.. image:: images/fts_dictionary_definition.png
:alt: FTS dictionary dialog definition tab
Use the field in the *Definition* tab to choose a template from the drop-down listbox:
@ -32,6 +34,7 @@ Use the field in the *Definition* tab to choose a template from the drop-down li
Click the *Options* tab to continue.
.. image:: images/fts_dictionary_options.png
:alt: FTS dictionary dialog options tab
Use the fields in the *Options* tab to provide template-specific options. Click the *Add* icon (+) to add an option clause:
@ -49,6 +52,7 @@ Your entries in the *FTS Dictionary* dialog generate a generate a SQL command. U
The following is an example of the sql command generated by user selections in the *FTS Dictionary* dialog:
.. image:: images/fts_dictionary_sql.png
:alt: FTS dictionary dialog sql tab
The example shown demonstrates creating a custom dictionary named *more_stopwords* which is based on the simple template and is configured to use standard English.

3
docs/en_US/fts_parser_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *FTS Parser* dialog to create a new text search parser. A text search pa
The *FTS Parser* dialog organizes the development of a text search parser through the following dialog tabs: *General*, and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/fts_parser_general.png
:alt: FTS parser dialog general tab
Use the fields in the *General* tab to identify a text search parser:
@ -19,6 +20,7 @@ Use the fields in the *General* tab to identify a text search parser:
Click the *Definition* tab to continue.
.. image:: images/fts_parser_definition.png
:alt: FTS parser dialog definition tab
Use the fields in the *Definition* tab to define parameters:
@ -31,6 +33,7 @@ Use the fields in the *Definition* tab to define parameters:
Click the *SQL* tab to continue.
.. image:: images/fts_parser_sql.png
:alt: FTS parser dialog sql tab
Your entries in the *FTS Parser* dialog generate a generate a SQL command. Use the *SQL* tab for review; revisit or switch tabs to make any changes to the SQL command.

3
docs/en_US/fts_template_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *FTS Template* dialog to create a new text search template. A text searc
The *FTS Template* dialog organizes the development of a text search Template through the following dialog tabs: *General*, and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/fts_template_general.png
:alt: FTS template dialog general tab
Use the fields in the *General* tab to identify a template:
@ -19,6 +20,7 @@ Use the fields in the *General* tab to identify a template:
Click the *Definition* tab to continue.
.. image:: images/fts_template_definition.png
:alt: FTS template dialog definition tab
Use the fields in the *Definition* tab to define function parameters:
@ -34,6 +36,7 @@ Your entries in the *FTS Template* dialog generate a SQL command (see an example
The following is an example of the sql command generated by user selections in the *FTS Template* dialog:
.. image:: images/fts_template_sql.png
:alt: FTS template dialog sql tab
The example shown demonstrates creating a fts template named *ru_template* that uses the ispell dictionary.

7
docs/en_US/function_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Function* dialog to define a function. If you drop and then recreate a
The *Function* dialog organizes the development of a function through the following dialog tabs: *General*, *Definition*, *Options*, *Arguments*, *Parameters*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/function_general.png
:alt: Function dialog general tab
Use the fields in the *General* tab to identify a function:
@ -20,6 +21,7 @@ Use the fields in the *General* tab to identify a function:
Click the *Definition* tab to continue.
.. image:: images/function_definition.png
:alt: Function dialog definition tab
Use the fields in the *Definition* tab to define the function:
@ -30,6 +32,7 @@ Use the fields in the *Definition* tab to define the function:
Click the *Options* tab to continue.
.. image:: images/function_options.png
:alt: Function dialog options tab
Use the fields in the *Options* tab to describe or modify the action of the function:
@ -53,6 +56,7 @@ Use the fields in the *Options* tab to describe or modify the action of the func
Click the *Arguments* tab to continue.
.. image:: images/function_arguments.png
:alt: Function dialog arguments tab
Use the fields in the *Arguments* tab to define an argument. Click the *Add* icon (+) to set parameters and values for the argument:
@ -66,6 +70,7 @@ Click the *Add* icon (+) to define another argument; to discard an argument, cli
Click the *Parameters* tab to continue.
.. image:: images/function_parameters.png
:alt: Function dialog parameters tab
Use the fields in the *Parameters* tab to specify settings that will be applied when the function is invoked. Click the *Add* icon (+) to add a *Name*/*Value* field in the table.
@ -75,6 +80,7 @@ Use the fields in the *Parameters* tab to specify settings that will be applied
Click the *Security* tab to continue.
.. image:: images/function_security.png
:alt: Function dialog security tab
Use the *Security* tab to assign privileges and define security labels.
@ -102,6 +108,7 @@ Your entries in the *Function* dialog generate a generate a SQL command (see an
The following is an example of the sql command generated by selections made in the *Function* dialog:
.. image:: images/function_sql.png
:alt: Function dialog sql tab
The example demonstrates creating an *edbspl* function named *emp_comp*. The function adds two columns (p_sal and p_comm), and then uses the result to compute a yearly salary, returning a NUMERIC value.

3
docs/en_US/grant_wizard.rst
View File

@ -11,6 +11,7 @@ The wizard organizes privilege management through a sequence of windows: *Object
To launch the *Grant Wizard* tool, select a database object in the *pgAdmin* tree control, then navigate through *Tools* on the menu bar to click on the *Grant Wizard* option.
.. image:: images/grant_wizard_step1.png
:alt: Grant wizard step one page
Use the fields in the *Object Selection (step 1 of 3)* window to select the object or objects on which you are modifying privileges. Use the *Search by object type or name* field to locate a database object, or use the scrollbar to scroll through the list of all accessible objects.
@ -23,6 +24,7 @@ Use the fields in the *Object Selection (step 1 of 3)* window to select the obje
Click the *Next* button to continue, or the *Cancel* button to close the wizard without modifying privileges.
.. image:: images/grant_wizard_step2.png
:alt: Grant wizard step two page
Use the fields in the *Privileges Selection (step 2 of 3)* window to grant privileges. If you grant a privilege WITH GRANT OPTION, the Grantee will have the right to grant privileges on the object to others. If WITH GRANT OPTION is subsequently revoked, any role who received access to that object from that Grantee (directly or through a chain of grants) will lose thier privileges on the object.
@ -43,6 +45,7 @@ Your entries in the *Grant Wizard* tool generate a SQL command; you can review t
The following is an example of the sql command generated by user selections in the *Grant Wizard* tool:
.. image:: images/grant_wizard_step3.png
:alt: Grant wizard step three page
The commands displayed assign a role named *Bob* *INSERT* and *UPDATE* privileges *WITH GRANT OPTION* on the *sales_meetings* and the *sales_territories* tables.

5
docs/en_US/import_export_data.rst
View File

@ -9,6 +9,7 @@ Use the *Import/Export data* dialog to copy data from a table to a file, or copy
The *Import/Export data* dialog organizes the import/export of data through the *Options* and *Columns* tabs.
.. image:: images/import_export_options.png
:alt: Import Export data dialog options tab
Use the fields in the *Options* tab to specify import and export preferences:
@ -26,6 +27,7 @@ Use the fields in the *Options* tab to specify import and export preferences:
* Use the drop-down listbox in the *Encoding* field to specify the type of character encoding.
.. image:: images/import_export_miscellaneous.png
:alt: Import Export data dialog miscellaneous tab
* Use the fields in the *Miscellaneous* field box to specify additional information:
@ -38,6 +40,7 @@ Use the fields in the *Options* tab to specify import and export preferences:
Click the *Columns* tab to continue.
.. image:: images/import_export_columns.png
:alt: Import Export data dialog columns tab
Use the fields in the *Columns* tab to select the columns that will be imported or exported:
@ -48,7 +51,9 @@ Use the fields in the *Columns* tab to select the columns that will be imported
After completing the *Import/Export data* dialog, click the *OK* button to perform the import or export. pgAdmin will inform you when the background process completes:
.. image:: images/import_export_complete.png
:alt: Import Export data completion notification
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
:alt: Import Export data process watcher

3
docs/en_US/index_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Index* dialog to create an index on a specified table or materialized v
The *Index* dialog organizes the development of a index through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/index_general.png
:alt: Index dialog general tab
Use the fields in the *General* tab to identify the index:
@ -19,6 +20,7 @@ Use the fields in the *General* tab to identify the index:
Click the *Definition* tab to continue.
.. image:: images/index_definition.png
:alt: Index dialog definition tab
Use the fields in the *Definition* tab to define the index:
@ -62,6 +64,7 @@ Your entries in the *Index* dialog generate a SQL command (see an example below)
The following is an example of the sql command generated by user selections in the *Index* dialog:
.. image:: images/index_sql.png
:alt: Index dialog sql tab
The example shown demonstrates creating an index named *dist_codes* that indexes the values in the *code* column of the *distributors* table.

4
docs/en_US/language_dialog.rst
View File

@ -9,6 +9,7 @@ Use the CREATE LANGUAGE dialog to register a new procedural language.
The *Language* dialog organizes the registration of a procedural language through the following dialog tabs: *General*, *Definition*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/language_general.png
:alt: Language dialog general tab
Use the fields in the *General* tab to identify a language:
@ -19,6 +20,7 @@ Use the fields in the *General* tab to identify a language:
Click the *Definition* tab to continue.
.. image:: images/language_definition.png
:alt: Language dialog definition tab
Use the fields in the *Definition* tab to define parameters:
@ -30,6 +32,7 @@ Use the fields in the *Definition* tab to define parameters:
Click the *Security* tab to continue.
.. image:: images/language_security.png
:alt: Language dialog security tab
Use the *Security* tab to assign privileges and define security labels.
@ -57,6 +60,7 @@ Your entries in the *Language* dialog generate a SQL command (see an example bel
The following is an example of the sql command generated by user selections in the *Language* dialog:
.. image:: images/language_sql.png
:alt: Language dialog sql tab
"The example shown demonstrates creating the procedural language named *plperl*."

3
docs/en_US/maintenance_dialog.rst
View File

@ -7,6 +7,7 @@ The Maintenance Dialog
Use the *Maintenance* dialog to VACUUM, ANALYZE, REINDEX or CLUSTER a database or selected database objects.
.. image:: images/maintenance.png
:alt: Maintenance dialog
While this utility is useful for ad-hoc maintenance purposes, you are encouraged to perform automatic VACUUM jobs on a regular schedule.
@ -31,7 +32,9 @@ When you've completed the dialog, click *OK* to start the background process; to
pgAdmin will inform you when the background process completes:
.. image:: images/maintenance_complete.png
:alt: Maintenance completion notification
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
:alt: Maintenance process watcher

6
docs/en_US/materialized_view_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Materialized View* dialog to define a materialized view. A materialized
The *Materialized View* dialog organizes the development of a materialized_view through the following dialog tabs: *General*, *Definition*, *Storage*, *Parameter*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/materialized_view_general.png
:alt: Materialized view dialog general tab
Use the fields in the *General* tab to identify the materialized view:
@ -20,12 +21,14 @@ Use the fields in the *General* tab to identify the materialized view:
Click the *Definition* tab to continue.
.. image:: images/materialized_view_definition.png
:alt: Materialized view dialog definition tab
Use the text editor field in the *Definition* tab to provide the query that will populate the materialized view.
Click the *Storage* tab to continue.
.. image:: images/materialized_view_storage.png
:alt: Materialized view dialog storage tab
Use the fields in the *Storage* tab to maintain the materialized view:
@ -36,6 +39,7 @@ Use the fields in the *Storage* tab to maintain the materialized view:
Click the *Parameter* tab to continue.
.. image:: images/materialized_view_parameter.png
:alt: Materialized view dialog parameter tab
Use the tabs nested inside the *Parameter* tab to specify VACUUM and ANALYZE thresholds; use the *Table* tab and the *Toast Table* tab to customize values for the table and the associated toast table. To change the default values:
@ -45,6 +49,7 @@ Use the tabs nested inside the *Parameter* tab to specify VACUUM and ANALYZE thr
Click the *Security* tab to continue.
.. image:: images/materialized_view_security.png
:alt: Materialized view dialog security tab
Use the *Security* tab to assign privileges and define security labels.
@ -72,6 +77,7 @@ Your entries in the *Materialized View* dialog generate a SQL command (see an ex
The following is an example of the sql command generated by user selections in the *Materialized View* dialog:
.. image:: images/materialized_view_sql.png
:alt: Materialized view dialog sql tab
The example shown creates a query named *new_hires* that stores the result of the displayed query in the *pg_default* tablespace.

2
docs/en_US/move_objects.rst
View File

@ -9,6 +9,7 @@ Use the *Move Objects* dialog to to move database objects from one tablespace to
The *Move Objects* dialog organizes the movement of database objects with the *General* tab; the *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/move_objects_general.png
:alt: Move objects dialog general tab
Use the fields in the *General* tab to identify the items that will be moved and the tablespace to which they will be moved:
@ -31,6 +32,7 @@ Your entries in the *Move Objects* dialog generate a SQL command (see an example
The following is an example of the sql command generated by user selections in the *Move Objects* dialog:
.. image:: images/move_objects_sql.png
:alt: Move Objects dialog sql tab
The example shown demonstrates moving materialized views owned by Alice from tablespace *tbspace_01* to *tbspace_02*.

4
docs/en_US/package_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Package* dialog to create a (user-defined) package specification.
The *Package* dialog organizes the management of a package through the following dialog tabs: *General*, *Code*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/package_general.png
:alt: Package dialog general tab
Use the fields in the *General* tab to identify the package:
@ -19,6 +20,7 @@ Use the fields in the *General* tab to identify the package:
Click the *Code* tab to continue.
.. image:: images/package_code.png
:alt: Package dialog code tab
Use the fields in the *Code* tab to specify the package contents and to provide implementation details:
@ -28,6 +30,7 @@ Use the fields in the *Code* tab to specify the package contents and to provide
Click the *Security* tab to continue.
.. image:: images/package_security.png
:alt: Package dialog security tab
Use the fields in the *Security* tab to to assign EXECUTE privileges for the package to a role. Click the *Add* icon (+) to set privileges for the package:
@ -42,6 +45,7 @@ Click the *SQL* tab to continue.
Your entries in the *Package* dialog generate a SQL command that creates or modifies a package definition:
.. image:: images/package_sql.png
:alt: Package dialog sql tab
The example shown demonstrates creating a package named *empinfo* that includes one function and one procedure.

2
docs/en_US/pgadmin_login.rst
View File

@ -7,6 +7,7 @@ The pgAdmin Login Dialog
Use the *pgAdmin Login* dialog to log in to pgAdmin:
.. image:: images/pgadmin_login.png
:alt: pgAdmin login dialog
Use the fields in the *pgAdmin Login* dialog to authenticate your connection:
@ -19,6 +20,7 @@ Use the fields in the *pgAdmin Login* dialog to authenticate your connection:
If you cannot supply your password, click the *Forgotten your password?* button to launch a password recovery utility.
.. image:: images/pgadmin_login_recover.png
:alt: pgAdmin recover login password
#. Provide the email address associated with your account in the *Email Address* field.
#. Click the *Recover Password* button to initiate recovery. An email, with directions on how to reset a password, will be sent to the address entered in the *Email Address* field.

4
docs/en_US/pgadmin_menu_bar.rst
View File

@ -9,6 +9,7 @@ The pgAdmin menu bar provides drop-down menus for access to options, commands, a
**The File Menu**
.. image:: /images/file_menu.png
:alt: pgAdmin file menu bar
Use the *File* menu to access the following options:
@ -25,6 +26,7 @@ Use the *File* menu to access the following options:
**The Object Menu**
.. image:: /images/object_menu.png
:alt: pgAdmin object menu bar
The *Object* menu is context-sensitive. Use the *Object* menu to access the following options (in alphabetical order):
@ -59,6 +61,7 @@ The *Object* menu is context-sensitive. Use the *Object* menu to access the foll
**The Tools Menu**
.. image:: /images/tool_menu.png
:alt: pgAdmin tools menu bar
Use the *Tools* menu to access the following options (in alphabetical order):
@ -94,6 +97,7 @@ Use the *Tools* menu to access the following options (in alphabetical order):
**The Help Menu**
.. image:: images/help_menu.png
:alt: pgAdmin help menu bar
Use the options on the *Help* menu to access online help documents, or to review information about the pgAdmin installation (in alphabetical order):

9
docs/en_US/pgadmin_tabbed_browser.rst
View File

@ -7,6 +7,7 @@ The pgAdmin Tabbed Browser
The right pane of the *pgAdmin* window features a collection of tabs that display information about the object currently selected in the *pgAdmin* tree control in the left window. Select a tab to access information about the highlighted object in the tree control.
.. image:: images/main_dashboard.png
:alt: Dashboard panel
The graphs on the *Dashboard* tab provides an active analysis of the usage statistics for the selected server or database:
@ -28,22 +29,27 @@ You can use icons in the *Sessions* table to review or control the state of a se
* Use the *Details* icon (located in the third column) to open the *Details* tab; the tab displays information about the selected session.
.. image:: images/main_properties_table.png
:alt: Properties panel
The *Properties* tab displays information about the object selected. Click the *Edit* icon in the toolbar under the browser tabs to launch the *Properties* dialog for the selected object.
.. image:: images/main_properties_icons.png
:alt: Object editor icon
To preserve any changes to the *Properties* dialog, click the *Save* icon; your modifications will be displayed in the updated *Properties* tab.
.. image:: images/main_properties_edit.png
:alt: Object editor window
Details about the object highlighted in the tree control are displayed in one or more collapsible panels. You can use the arrow to the left of each panel label to open or close a panel.
.. image:: images/main_sql.png
:alt: SQL panel
The *SQL* tab displays the SQL script that created the highlighted object, and when applicable, a (commented out) SQL statement that will *DROP* the selected object. You can copy the SQL statements to the editor of your choice using cut and paste shortcuts.
.. image:: images/main_statistics.png
:alt: Statistics panel
The *Statistics* tab displays the statistics gathered for each object on the tree control; the statistics displayed in the table vary by the type of object that is selected. Click a column heading to sort the table by the data displayed in the column; click again to reverse the sort order. The following table lists some of the statistics that are available:
@ -102,6 +108,7 @@ The *Statistics* tab displays the statistics gathered for each object on the tre
+----------------------------+------------------------------------------------------------------------------------------------------------+
.. image:: images/main_dependencies.png
:alt: Dependencies panel
The *Dependencies* tab displays the objects on which the currently selected object depends. If a dependency is dropped, the object currently selected in the pgAdmin tree control will be affected. To ensure the integrity of the entire database structure, the database server makes sure that you do not accidentally drop objects that other objects depend on; you must use the DROP CASCADE command to remove an object with a dependency.
@ -116,6 +123,7 @@ The *Dependencies* table displays the following information:
* If the field is *blank*, the selected object is required by the system, and cannot be dropped.
.. image:: images/main_dependents.png
:alt: Dependents panel
The *Dependents* tab displays a table of objects that depend on the object currently selected in the *pgAdmin* browser. A dependent object can be dropped without affecting the object currently selected in the *pgAdmin* tree control.
@ -124,6 +132,7 @@ The *Dependents* tab displays a table of objects that depend on the object curre
* The *Database* field specifies the database in which the object resides.
.. image:: images/main_query_tool.png
:alt: Query tool panel
Additional tabs open when you access the extended functionality offered by pgAdmin tools (such as the Query tool, Debugger, or SQL editor). Use the close icon (X) located in the upper-right corner of each tab to close the tab when you are finished using the tool. Like permanent tabs, these tabs may be repositioned in the pgAdmin client window.

1
docs/en_US/pgadmin_tree_control.rst
View File

@ -7,6 +7,7 @@ The pgAdmin Tree Control
The left pane of the main window displays a tree control (the *pgAdmin* tree control) that provides access to the objects that reside on a server.
.. image:: /images/main_left_pane.png
:alt: Browser tree panel
You can expand nodes in the tree control to view the database objects that reside on a selected server. The tree control expands to display a hierarchical view:

2
docs/en_US/pgadmin_user.rst
View File

@ -13,12 +13,14 @@ When you authenticate with pgAdmin, the server definitions associated with that
* manage the password associated with a role
.. image:: images/pgadmin_user.png
:alt: pgAdmin user management window
Use the *Filter by email* search field to find a user; enter a user's email address to find a user. If the user exists, the *User Management* table will display the user's current information.
To add a user, click *Add* to add new role.
.. image:: images/add_pgadmin_user.png
:alt: pgAdmin user management window add new user
Provide information about the new pgAdmin role in the row:

10
docs/en_US/pgagent_jobs.rst
View File

@ -12,6 +12,7 @@ To create or manage a job, use the pgAdmin tree control to browse to the server
When the pgAgent dialog opens, use the tabs on the *pgAgent Job* dialog to define the steps and schedule that make up a pgAgent job.
.. image:: images/pgagent_general.png
:alt: pgAgent dialog general tab
Use the fields on the *General* tab to provide general information about a job:
@ -29,10 +30,12 @@ Use the fields on the *General* tab to provide general information about a job:
* Use the *Comment* field to store notes about the job.
.. image:: images/pgagent_steps.png
:alt: pgAgent dialog steps tab
Use the *Steps* tab to define and manage the steps that the job will perform. Click the Add icon (+) to add a new step; then click the compose icon (located at the left side of the header) to open the step definition dialog:
.. image:: images/pgagent_step_definition.png
:alt: pgAgent dialog definition tab
Use fields on the step definition dialog to define the step:
@ -55,6 +58,7 @@ Use fields on the step definition dialog to define the step:
* Use the *Comment* field to provide a comment about the step.
.. image:: images/pgagent_step_definition_code.png
:alt: pgAgent dialog step definition code tab
Use the context-sensitive field on the step definition dialog's *Code* tab to provide the SQL code or batch script that will be executed during the step:
@ -64,10 +68,12 @@ Use the context-sensitive field on the step definition dialog's *Code* tab to pr
When you've provided all of the information required by the step, click the compose icon to close the step definition dialog. Click the add icon (+) to add each additional step, or select the *Schedules* tab to define the job schedule.
.. image:: images/pgagent_schedules.png
:alt: pgAgent dialog schedules tab
Click the Add icon (+) to add a schedule for the job; then click the compose icon (located at the left side of the header) to open the schedule definition dialog:
.. image:: images/pgagent_schedule_definition.png
:alt: pgAgent dialog schedules definition tab
Use the fields on the schedule definition tab to specify the days and times at which the job will execute.
@ -80,6 +86,7 @@ Use the fields on the schedule definition tab to specify the days and times at w
Select the *Repeat* tab to define the days on which the schedule will execute.
.. image:: images/pgagent_schedule_repeat.png
:alt: pgAgent dialog schedule repeat tab
Use the fields on the *Repeat* tab to specify the details about the schedule in a cron-style format. The job will execute on each date or time element selected on the *Repeat* tab.
@ -99,6 +106,7 @@ Use the fields within the *Times* box to specify the times at which the job will
Select the *Exceptions* tab to specify any days on which the schedule will *not* execute.
.. image:: images/pgagent_schedule_exceptions.png
:alt: pgAgent dialog schedule exceptions tab
Use the fields on the *Exceptions* tab to specify days on which you wish the job to not execute; for example, you may wish for jobs to not execute on national holidays.
@ -110,12 +118,14 @@ Click the Add icon (+) to add a row to the exception table, then:
When you've finished defining the schedule, you can use the *SQL* tab to review the code that will create or modify your job.
.. image:: images/pgagent_sql.png
:alt: pgAgent dialog sql tab
Click the *Save* button to save the job definition, or *Cancel* to exit the job without saving. Use the *Reset* button to remove your unsaved entries from the dialog.
After saving a job, the job will be listed under the *pgAgent Jobs* node of the pgAdmin tree control of the server on which it was defined. The *Properties* tab in the main pgAdmin window will display a high-level overview of the selected job, and the *Statistics* tab will show the details of each run of the job.
.. image:: images/pgagent_properties.png
:alt: pgAgent object properties
To modify an existing job or to review detailed information about a job, right-click on a job name, and select *Properties* from the context menu.

14
docs/en_US/preferences.rst
View File

@ -14,6 +14,7 @@ Use options on the *Preferences* dialog to customize the behavior of the client.
Use preferences found in the *Browser* node of the tree control to personalize your workspace.
.. image:: images/preferences_browser_display.png
:alt: Preferences dialog browser display options
Use the fields on the *Display* panel to specify general display preferences:
@ -22,12 +23,14 @@ Use the fields on the *Display* panel to specify general display preferences:
Use the fields on the *Nodes* panel to select the object types that will be displayed in the *Browser* tree control:
.. image:: images/preferences_browser_nodes.png
:alt: Preferences dialog browser nodes section
* The panel displays a list of database objects; slide the switch located next to each object to *Show* or *Hide* the database object. When querying system catalogs, you can reduce the number of object types displayed to increase speed.
Use fields on the *Properties* panel to specify browser properties:
.. image:: images/preferences_browser_properties.png
:alt: Preferences dialog browser properties section
* Include a value in the *Count rows if estimated less than* field to perform a SELECT count(*) if the estimated number of rows in a table (as read from the table statistics) is below the specified limit. After performing the SELECT count(*), pgAdmin will display the row count. The default is 2000.
@ -36,6 +39,7 @@ Use fields on the *Properties* panel to specify browser properties:
Expand the *Dashboards* node to specify your dashboard display preferences.
.. image:: images/preferences_dashboard_graphs.png
:alt: Preferences dialog dashboard graph options
Use the fields on the *Graphs* panel to specify your display preferences for the graphs on the *Dashboard* tab:
@ -54,6 +58,7 @@ Use the fields on the *Graphs* panel to specify your display preferences for the
Expand the *Debugger* node to specify your debugger display preferences.
.. image:: images/preferences_debugger_display.png
:alt: Preferences dialog debugger display options
* When the *Open in new browser tab* switch is set to *True*, the Debugger will open in a new browser tab when invoked.
@ -62,6 +67,7 @@ Expand the *Debugger* node to specify your debugger display preferences.
Expand the *Miscellaneous* node to specify miscellaneous display preferences.
.. image:: images/preferences_misc_user_language.png
:alt: Preferences dialog user language section
* Use the *User language* drop-down listbox to select the display language for the client.
@ -70,6 +76,7 @@ Expand the *Miscellaneous* node to specify miscellaneous display preferences.
Expand the *Paths* node to specify the locations of supporting utility and help files.
.. image:: images/preferences_paths_binary.png
:alt: Preferences dialog binary path section
Use the fields on the *Binary paths* panel to specify the path to the directory that contains the utility programs (pg_dump, pg_restore, and pg_dumpall) for monitored databases:
@ -80,6 +87,7 @@ Use the fields on the *Binary paths* panel to specify the path to the directory
* Use the *PostgreSQL Binary Path* field to specify the location of the PostgreSQL utility programs. If this path is not set, pgAdmin will attempt to find the utilities in standard locations used by PostgreSQL.
.. image:: images/preferences_paths_help.png
:alt: Preferences dialog binary path help section
Use the fields on the *Help* panel to specify the location of help files.
@ -94,6 +102,7 @@ Please note: the default help paths include the *VERSION* placeholder; the $VERS
Expand the *SQL Editor* node to access panels that allow you to specify your preferences for the SQL Editor tool.
.. image:: images/preferences_sql_csv_output.png
:alt: Preferences dialog sqleditor csv output option
Use the fields on the *CSV Output* panel to control the CSV output.
@ -102,6 +111,7 @@ Use the fields on the *CSV Output* panel to control the CSV output.
* Use the *CSV quoting* drop-down listbox to select the fields that will be quoted in the CSV output; select *Strings*, *All*, or *None*.
.. image:: images/preferences_sql_display.png
:alt: Preferences dialog sqleditor display options
Use the fields on the *Display* panel to specify your preferences for the SQL Editor display.
@ -110,6 +120,7 @@ Use the fields on the *Display* panel to specify your preferences for the SQL Ed
* Use the *Query info notifier timeout* field to control the behaviour of the notifier that is displayed when query execution completes. A value of *-1* will disable the notifier, and a value of 0 will display it until clicked. If a positive value above zero is specified, the notifier will be displayed for the specified number of seconds. The default is *5*.
.. image:: images/preferences_sql_explain.png
:alt: Preferences dialog sqleditor explain options
Use the fields on the *Explain* panel to specify the level of detail included in a graphical EXPLAIN.
@ -122,6 +133,7 @@ Use the fields on the *Explain* panel to specify the level of detail included in
* When the *Verbose output?* switch is set to *True*, graphical explain details will include extended information about the query execution plan.
.. image:: images/preferences_sql_options.png
:alt: Preferences dialog sqleditor options section
Use the fields on the *Options* panel to manage editor preferences.
@ -146,6 +158,7 @@ Use the fields on the *Options* panel to manage editor preferences.
* When the *Use spaces* switch is set to *True*, the editor will insert spaces (instead of tab characters) when the tab key or auto-indent are used.
.. image:: images/preferences_sql_results_grid.png
:alt: Preferences dialog sql results grid section
Use the fields on the *Results grid* panel to specify your formatting preferences for copied data.
@ -158,6 +171,7 @@ Use the fields on the *Results grid* panel to specify your formatting preference
Expand the *Storage* node to specify your storage preferences.
.. image:: images/preferences_storage_options.png
:alt: Preferences dialog storage section
Use the fields on the *Options* panel to specify storage preferences.

3
docs/en_US/primary_key_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Primary key* dialog to create or modify a primary key constraint. A pri
The *Primary key* dialog organizes the development of a primary key constraint through the *General* and *Definition* tabs. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/primary_key_general.png
:alt: Primary key dialog general tab
Use the fields in the *General* tab to identify the primary key:
@ -17,6 +18,7 @@ Use the fields in the *General* tab to identify the primary key:
Click the *Definition* tab to continue.
.. image:: images/primary_key_definition.png
:alt: Primary key dialog definition tab
Use the fields in the *Definition* tab to define the primary key constraint:
@ -36,6 +38,7 @@ Your entries in the *Primary key* dialog generate a SQL command (see an example
The following is an example of the sql command generated by user selections in the *Primary key* dialog:
.. image:: images/primary_key_sql.png
:alt: Primary key dialog sql tab
The example shown demonstrates creating a primary key constraint named *dept_pkey* on the *dept_id* column of the *dept* table.

7
docs/en_US/procedure_dialog.rst
View File

@ -11,6 +11,7 @@ Use the *Procedure* dialog to create a procedure; procedures are supported by ED
The *Procedure* dialog organizes the development of a procedure through the following dialog tabs: *General*, *Definition*, *Options*, *Arguments*, *Parameters*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/procedure_general.png
:alt: Procedure dialog general tab
Use the fields in the *General* tab to identify a procedure:
@ -22,6 +23,7 @@ Use the fields in the *General* tab to identify a procedure:
Click the *Definition* tab to continue.
.. image:: images/procedure_definition.png
:alt: Procedure dialog definition tab
Use the fields in the *Definition* tab to define the procedure:
@ -31,6 +33,7 @@ Use the fields in the *Definition* tab to define the procedure:
Click the *Options* tab to continue.
.. image:: images/procedure_options.png
:alt: Procedure dialog options tab
Use the fields in the *Options* tab to describe or modify the behavior of the procedure:
@ -48,6 +51,7 @@ Use the fields in the *Options* tab to describe or modify the behavior of the pr
Click the *Arguments* tab to continue.
.. image:: images/procedure_arguments.png
:alt: Procedure dialog arguments tab
Use the fields in the *Arguments* tab to define an argument. Click *Add* to set parameters and values for the argument:
@ -61,6 +65,7 @@ Click *Add* to define another argument; to discard an argument, click the trash
Click the *Parameters* tab to continue.
.. image:: images/procedure_parameters.png
:alt: Procedure dialog parameters tab
Use the fields in the *Parameters* tab to specify settings that will be applied when the procedure is invoked:
@ -71,6 +76,7 @@ Use the fields in the *Parameters* tab to specify settings that will be applied
Click the *Security* tab to continue.
.. image:: images/procedure_security.png
:alt: Procedure dialog security tab
Use the *Security* tab to assign privileges and define security labels.
@ -98,6 +104,7 @@ Your entries in the *Procedure* dialog generate a SQL command (see an example be
The following is an example of the sql command generated by selections made in the *Procedure* dialog:
.. image:: images/procedure_sql.png
:alt: Procedure dialog sql tab
The example demonstrates creating a procedure that returns a list of employees from a table named *emp*. The procedure is a SECURITY DEFINER, and will execute with the privileges of the role that defined the procedure.

12
docs/en_US/query_tool.rst
View File

@ -13,6 +13,7 @@ The Query tool is a powerful, feature-rich environment that allows you to execut
* View analytical information about a SQL statement.
.. image:: images/query_tool.png
:alt: Query tool window
You can open multiple copies of the Query tool in individual tabs simultaneously. To close a copy of the Query tool, click the *X* in the upper-right hand corner of the tab bar.
@ -26,6 +27,7 @@ The Query Tool features two panels:
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. Please note that disabled icons may support functionality accessed via the :ref:`data editor <editgrid>`.
.. image:: images/query_toolbar.png
:alt: Query tool toolbar
Hover over an icon to display a tooltip that describes the icon's functionality:
@ -129,18 +131,22 @@ Hover over an icon to display a tooltip that describes the icon's functionality:
The *SQL editor* panel is a workspace where you can manually provide a query, copy a query from another source, or read a query from a file. The SQL editor features syntax coloring and autocompletion.
.. image:: images/query_sql_editor.png
:alt: Query tool editor
To use autocomplete, begin typing your query; when you would like the Query editor to suggest object names or commands that might be next in your query, press the Control+Space key combination. For example, type "\*SELECT \* FROM\* " (without quotes, but with a trailing space), and then press the Control+Space key combination to select from a popup menu of autocomplete options.
.. image:: images/query_autocomplete.png
:alt: Query tool autocomplete feature
After entering a query, select the *Execute/Refresh* icon from the toolbar. The complete contents of the SQL editor panel will be sent to the database server for execution. To execute only a section of the code that is displayed in the SQL editor, highlight the text that you want the server to execute, and click the *Execute/Refresh* icon.
.. image:: images/query_execute_section.png
:alt: Query tool execute query section
The message returned by the server when a command executes is displayed on the *Messages* tab. If the command is successful, the *Messages* tab displays execution details.
.. image:: images/query_tool_message.png
:alt: Query tool message panel
Options on the *Edit* menu offer functionality that helps with code formatting and commenting:
@ -154,6 +160,7 @@ Options on the *Edit* menu offer functionality that helps with code formatting a
The *Data Output* panel displays data and statistics generated by the most recently executed query.
.. image:: images/query_output_data.png
:alt: Query tool output panel
The *Data Output* tab displays the result set of the query in a table format. You can:
@ -166,24 +173,29 @@ All rowsets from previous queries or commands that are displayed in the *Data Ou
Use the *Explain* tab to view a graphical representation of a query:
.. image:: images/query_output_explain.png
:alt: Query tool explain panel
To generate a graphical explain diagram, open the *Explain* tab, and select *Explain*, *Explain Analyze*, or one or more options from the *Explain options* menu on the *Execute/Refresh* drop-down. Please note that *EXPLAIN VERBOSE* cannot be displayed graphically. Hover over an icon on the *Explain* tab to review information about that item; a popup window will display information about the selected object:
.. image:: images/query_output_explain_details.png
:alt: Query tool graphical explain plan
Note that the query plan that accompanies the *Explain analyze* is available on the *Data Output* tab.
Use the *Messages* tab to view information about the most recently executed query:
.. image:: images/query_output_error.png
:alt: Query tool output messages
If the server returns an error, the error message will be displayed on the *Messages* tab, and the syntax that caused the error will be underlined in the SQL editor. If a query succeeds, the *Messages* tab displays how long the query took to complete and how many rows were retrieved:
.. image:: images/query_output_messages.png
:alt: Query tool output information
Use the *Query History* tab to review activity for the current session:
.. image:: images/query_output_history.png
:alt: Query tool history panel
The Query History tab displays information about recent commands:

2
docs/en_US/resource_group_dialog.rst
View File

@ -11,6 +11,7 @@ Use the *Resource Group* dialog to create a resource group and set values for it
Fields used to create a resource group are located on the *General* tab. The *SQL* tab displays the SQL code generated by your selections on the *Resource Group* dialog.
.. image:: images/resource_group_general.png
:alt: Resource Group dialog general tab
Use the fields on the *General* tab to specify resource group attributes:
@ -27,6 +28,7 @@ Your entries in the *Resource Group* dialog generate a SQL command. Use the *SQL
The following is an example of the sql command generated by selections made in the *Resource Group* dialog:
.. image:: images/resource_group_sql.png
:alt: Resource Group dialog sql tab
The example creates a resource group named *acctg* that sets *cpu_rate_limit* to *2*, and *dirty_rate_limit* to *6144*.

9
docs/en_US/restore_dialog.rst
View File

@ -9,6 +9,7 @@ The *Restore* dialog provides an easy way to use a Custom, tar, or Directory for
You can use the *Query Tool* to play back the script created during a plain-text backup made with the *Backup* dialog. For more information about backing up or restoring, please refer to the documentation for `pg_dump <https://www.postgresql.org/docs/9.5/static/app-pgdump.html>`_ or `pg_restore <https://www.postgresql.org/docs/9.5/static/app-pgrestore.html>`_.
.. image:: images/restore_general.png
:alt: Restore dialog general tab
Use the fields on the *General* tab to specify general information about the restore process:
@ -24,6 +25,7 @@ Use the fields on the *General* tab to specify general information about the res
Click the *Restore options* tab to continue. Use the fields on the *Restore options* tab to specify options that correspond to *pg_restore* options.
.. image:: images/restore_sections.png
:alt: Restore dialog options section
* Use the switches in the **Sections** box to specify the content that will be restored:
@ -32,6 +34,7 @@ Click the *Restore options* tab to continue. Use the fields on the *Restore opti
* Move the switch next to *Post-data* to the *Yes* position to restore definitions of indexes, triggers, rules, and constraints (other than validated check constraints).
.. image:: images/restore_objects.png
:alt: Restore dialog sections section
* Use the switches in the **Type of objects** box to specify the objects that will be restored:
@ -39,6 +42,7 @@ Click the *Restore options* tab to continue. Use the fields on the *Restore opti
* Move the switch next to *Only schema* to limit the restoration to schema-level database objects.
.. image:: images/restore_do_not_save.png
:alt: Restore dialog do not save section
* Use the switches in the **Do not save** box to specify which objects will not be restored:
@ -47,6 +51,7 @@ Click the *Restore options* tab to continue. Use the fields on the *Restore opti
* Move the switch next to *Tablespace* to the *Yes* position to exclude tablespaces.
.. image:: images/restore_queries.png
:alt: Restore dialog queries section
* Use the switches in the **Queries** box to specify the type of statements that should be included in the restore:
@ -55,6 +60,7 @@ Click the *Restore options* tab to continue. Use the fields on the *Restore opti
* Move the switch next to *Single transaction* to the *Yes* position to execute the restore as a single transaction (that is, wrap the emitted commands in *BEGIN/COMMIT*). This ensures that either all the commands complete successfully, or no changes are applied. This option implies *--exit-on-error*.
.. image:: images/restore_disable.png
:alt: Restore dialog disable section
* Use the switches in the **Disable** box to specify the type of statements that should be excluded from the restore:
@ -62,6 +68,7 @@ Click the *Restore options* tab to continue. Use the fields on the *Restore opti
* Move the switch next to *No data for Failed Tables* to the *Yes* position to ignore data that fails a trigger.
.. image:: images/restore_miscellaneous.png
:alt: Restore dialog miscellaneous section
* Use the switches in the **Miscellaneous/Behavior** box to specify miscellaneous restore options:
@ -73,7 +80,9 @@ Click the *Restore options* tab to continue. Use the fields on the *Restore opti
When you’ve specified the details that will be incorporated into the pg_restore command, click the *Restore* button to start the process, or click the *Cancel* button to exit without saving your work. A popup will confirm if the restore is successful.
.. image:: images/restore_messages.png
:alt: Restore dialog notifications
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
:alt: Restore dialog process watcher

7
docs/en_US/role_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Login/Group Role* dialog to define a role. A role may be an individual
The *Login/Group Role* dialog organizes the creation and management of roles through the following dialog tabs: *General*, *Definition*, *Privileges*, *Parameters*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/role_general.png
:alt: Role dialog general tab
Use the fields on the *General* tab to identify the role.
@ -18,6 +19,7 @@ Use the fields on the *General* tab to identify the role.
Click the *Definition* tab to continue.
.. image:: images/role_definition.png
:alt: Role dialog definition tab
Use the *Definition* tab to set a password and configure connection rules:
@ -28,6 +30,7 @@ Use the *Definition* tab to set a password and configure connection rules:
Click the *Privileges* tab to continue.
.. image:: images/role_privileges.png
:alt: Role dialog privileges tab
Use the *Privileges* tab to grant privileges to the role.
@ -40,12 +43,14 @@ Use the *Privileges* tab to grant privileges to the role.
* Move the *Can initiate streaming replication and backups?* switch to the *Yes* position to control whether a role can initiate streaming replication or put the system in and out of backup mode. The default value is *No*.
.. image:: images/role_membership.png
:alt: Role dialog membership tab
* Specify members of the role in the *Role Membership* field. Click inside the *Roles* field to select role names from a drop down list. Confirm each selection by checking the checkbox to the right of the role name; delete a selection by clicking the *x* to the left of the role name. Membership conveys the privileges granted to the specified role to each of its members.
Click the *Parameters* tab to continue.
.. image:: images/role_parameters.png
:alt: Role dialog parameters tab
Use the fields on the *Parameters* tab to set session defaults for a selected configuration parameter when the role is connected to a specified database. This tab invokes the ALTER ROLE... SET configuration_parameter syntax. Click the *Add* icon (+) to assign a value for a parameter.
@ -58,6 +63,7 @@ Click the *Add* icon (+) to specify each additional parameter; to discard a para
Click the *Security* tab to continue.
.. image:: images/role_security.png
:alt: Role dialog security tab
Use the *Security* tab to define security labels applied to the role. Click the *Add* icon (+) to add each security label selection.
@ -75,6 +81,7 @@ Your entries in the *Login/Group Role* dialog generate a SQL command (see an exa
The following is an example of the sql command generated by user selections in the *Login/Group Role* dialog:
.. image:: images/role_sql.png
:alt: Role dialog sql tab
The example creates a login role named *alice* with *pem_user* privileges; the role can make unlimited connections to the server at any given time.

3
docs/en_US/rule_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Rule* dialog to define or modify a rule for a specified table or view.
The *Rule* dialog organizes the development of a rule through the *General*, and *Definition* tabs. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/rule_general.png
:alt: Rule dialog general tab
Use the fields in the *General* tab to identify the rule:
@ -18,6 +19,7 @@ Use the fields in the *General* tab to identify the rule:
Click the *Definition* tab to continue.
.. image:: images/rule_definition.png
:alt: Rule dialog definition tab
Use the fields in the *Definition* tab to write parameters:
@ -35,6 +37,7 @@ Your entries in the *Rule* dialog generate a SQL command (see an example below).
The following is an example of the sql command generated by user selections in the *Rule* dialog:
.. image:: images/rule_sql.png
:alt: Rule dialog sql tab
The example sends a notification when an UPDATE executes against a table.

4
docs/en_US/schema_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Schema* dialog to define a schema. A schema is the organizational workh
The *Schema* dialog organizes the development of schema through the following dialog tabs: *General* and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/schema_general.png
:alt: Schema dialog general tab
Use the fields on the *General* tab to identify the schema.
@ -19,6 +20,7 @@ Use the fields on the *General* tab to identify the schema.
Click the *Security* tab to continue.
.. image:: images/schema_security.png
:alt: Schema dialog security tab
Use the *Security* tab to assign privileges and security labels for the schema.
@ -40,6 +42,7 @@ Click the *Add* icon (+) to assign additional security labels; to discard a secu
Click the *Default Privileges* tab to continue.
.. image:: images/schema_default_privileges.png
:alt: Schema dialog default privileges tab
Use the *Default Privileges* tab to grant privileges for tables, sequences, functions and types. Use the tabs nested inside the *Default Privileges* tab to specify the database object and click the *Add* icon (+) to assign a set of privileges:
@ -56,6 +59,7 @@ Your entries in the *Schema* dialog generate a SQL command (see an example below
The following is an example of the sql command generated by selections made in the *Schema* dialog:
.. image:: images/schema_sql.png
:alt: Schema dialog sql tab
The example creates a schema named hr; the command grants *USAGE* privileges to *public* and assigns the ability to grant privileges to *alice*.

4
docs/en_US/sequence_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Sequence* dialog to create a sequence. A sequence generates unique val
The *Sequence* dialog organizes the development of a sequence through the following dialog tabs: *General*, *Definition*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/sequence_general.png
:alt: Sequence dialog general tab
Use the fields in the *General* tab to identify a sequence:
@ -20,6 +21,7 @@ Use the fields in the *General* tab to identify a sequence:
Click the *Definition* tab to continue.
.. image:: images/sequence_definition.png
:alt: Sequence dialog definition tab
Use the fields in the *Definition* tab to define the sequence:
@ -33,6 +35,7 @@ Use the fields in the *Definition* tab to define the sequence:
Click the *Security* tab to continue.
.. image:: images/sequence_security.png
:alt: Sequence dialog security tab
Use the *Security* tab to assign privileges and define security labels for the sequence.
@ -60,6 +63,7 @@ Your entries in the *Sequence* dialog generate a generate a SQL command (see an
The following is an example of the sql command generated by user selections in the *Sequence* dialog:
.. image:: images/sequence_sql.png
:alt: Sequence dialog sql tab
The example shown demonstrates a sequence named *seconds*. The sequence will increase in *5* second increments, and stop when it reaches a maximum value equal of *60*.

4
docs/en_US/server_dialog.rst
View File

@ -7,6 +7,7 @@ The Server Dialog
Use the *Server* dialog to describe a connection to a server. Note: you must ensure that the pg_hba.conf file of the server from which you are connecting allows connections from the host of the client.
.. image:: images/server_general.png
:alt: Server dialog general tab
Use the fields in the *General* tab to identify the server:
@ -20,6 +21,7 @@ Use the fields in the *General* tab to identify the server:
Click the *Connection* tab to continue.
.. image:: images/server_connection.png
:alt: Server dialog connection tab
Use the fields in the *Connection* tab to configure a connection:
@ -34,6 +36,7 @@ Use the fields in the *Connection* tab to configure a connection:
Click the *SSL* tab to continue.
.. image:: images/server_ssl.png
:alt: Server dialog ssl tab
Use the fields in the *SSL* tab to configure SSL:
@ -52,6 +55,7 @@ If pgAdmin is installed in Server mode (the default mode), you can use the platf
Click the *Advanced* tab to continue.
.. image:: images/server_advanced.png
:alt: Server dialog advanced tab
Use the fields in the *Advanced* tab to configure a connection:

1
docs/en_US/server_group_dialog.rst
View File

@ -7,6 +7,7 @@ The Server Group Dialog
Use the *Server Group* dialog to add a new server group. Assign servers to server groups to simplify management of multiple servers. Server groups are displayed as part of the *pgAdmin* tree control.
.. image:: images/server_group.png
:alt: Server group dialog
Use the *Name* field on the *Server Group* dialog to specify a name that will identify the server group in the *pgAdmin* tree control.

2
docs/en_US/synonym_dialog.rst
View File

@ -10,6 +10,7 @@ Use the *Synonym* dialog to substitute the name of a target object with a user-d
The *Synonym* dialog organizes the development of a synonym through the *General* tab. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/synonym_general.png
:alt: Synonym dialog general tab
Use the fields in the *General* tab to identify the synonym:
@ -27,6 +28,7 @@ Click the *SQL* tab to continue.
Your selections and entries in the *Synonym* dialog generate a SQL command.
.. image:: images/synonym_sql.png
:alt: Synonym dialog sql tab
The example creates a synonym for the *emp* table named *emp_hist*.

19
docs/en_US/table_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Table* dialog to create or modify a table.
The *Table* dialog organizes the development of a table through the following dialog tabs: *General*, *Columns*, *Constraints*, *Advanced*, *Parameter*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/table_general.png
:alt: Table dialog general tab
Use the fields in the *General* tab to identify the table:
@ -21,6 +22,7 @@ Use the fields in the *General* tab to identify the table:
Click the *Columns* tab to continue.
.. image:: images/table_columns.png
:alt: Table dialog columns tab
Use the drop-down listbox next to *Inherited from table(s)* to specify any parent table(s); the table will inherit columns from the selected parent table(s). Click inside the *Inherited from table(s)* field to select a table name from a drop-down list. Repeat to add any other parent tables. Delete a selected table by clicking the *x* to the left of the parent name. Note that inherited column names and datatypes are not editable in the current dialog; they must be modified at the parent level.
@ -37,6 +39,7 @@ Click the *Add* icon (+) to specify the names of columns and their datatypes in
Click the *Constraints* tab to continue.
.. image:: images/table_constraints.png
:alt: Table dialog constraints tab
Use the fields in the *Constraints* tab to provide a table or column constraint. Optional constraint clauses specify constraints (tests) that new or updated rows must satisfy for an *INSERT* or *UPDATE* operation to succeed. Select the appropriate constraint type by selecting one of the following tabs on the *Constraints* panel:
@ -65,6 +68,7 @@ Use the fields in the *General* tab to identify the primary key:
Click the *Definition* tab to continue.
.. image:: images/primary_key_definition.png
:alt: Table dialog primary key constraint definition
Use the fields in the *Definition* tab to define the primary key constraint:
@ -75,6 +79,7 @@ Use the fields in the *Definition* tab to define the primary key constraint:
* If enabled, move the *Deferred?* switch to the *Yes* position to specify the timing of the constraint is deferred to the end of the statement. The default is *No*.
.. image:: images/table_foreign_key.png
:alt: Table dialog foreign key constrain
To add a foreign key constraint, select the *Foreign Key* tab, and click the *Add* icon (+). To define the constraint, click the *Edit* icon to the left of the *Trash* icon. A dialog similar to the *Foreign key* dialog (accessed by right clicking on *Constraints* in the *pgAdmin* tree control) opens.
@ -86,6 +91,7 @@ Use the fields in the *General* tab to identify the foreign key constraint:
Click the *Definition* tab to continue.
.. image:: images/foreign_key_definition.png
:alt: Table dialog foreign key constraint definition
Use the fields in the *Definition* tab to define the foreign key constraint:
@ -103,6 +109,7 @@ Use the fields in the *Definition* tab to define the foreign key constraint:
Click the *Columns* tab to continue.
.. image:: images/foreign_key_columns.png
:alt: Table dialog foreign key constraint columns
Use the fields in the *Columns* tab to specify one or more reference column(s). A Foreign Key constraint requires that one or more columns of a table must only contain values that match values in the referenced column(s) of a row of a referenced table:
@ -115,6 +122,7 @@ Click the *Add* icon (+) to add a column to the list; repeat the steps above and
Click the *Action* tab to continue.
.. image:: images/foreign_key_action.png
:alt: Table dialog foreign key constraint action
Use the drop-down listboxes on the *Action* tab to specify behavior related to the foreign key constraint that will be performed when data within the table is updated or deleted:
@ -141,6 +149,7 @@ The supported actions are:
+-------------+------------------------------------------------------------------------------------------------------------+
.. image:: images/table_check.png
:alt: Table dialog check constraint
To add a check constraint, select the *Check* tab on the panel, and click the *Add* icon (+). To define the check constraint, click the *Edit* icon to the left of the *Trash* icon. A dialog similar to the *Check* dialog (accessed by right clicking on *Constraints* in the *pgAdmin* tree control) opens.
@ -152,6 +161,7 @@ Use the fields in the *General* tab to identify the check constraint:
Click the *Definition* tab to continue.
.. image:: images/check_definition.png
:alt: Table dialog check constraint definition
Use the fields in the *Definition* tab to define the check constraint:
@ -160,6 +170,7 @@ Use the fields in the *Definition* tab to define the check constraint:
* Move the *Don't validate?* switch to the *No* position to skip validation of existing data; the constraint may not hold for all rows in the table. The default is *Yes*.
.. image:: images/table_unique.png
:alt: Table dialog unique constraint
To add a unique constraint, select the *Unique* tab on the panel, and click the *Add* icon (+). To define the constraint, click the *Edit* icon to the left of the *Trash* icon. A dialog similar to the *Unique constraint* dialog (accessed by right clicking on *Constraints* in the *pgAdmin* tree control) opens.
@ -171,6 +182,7 @@ Use the fields in the *General* tab to identify the unique constraint:
Click the *Definition* tab to continue.
.. image:: images/unique_constraint_definition.png
:alt: Table dialog unique constraint definition
Use the fields in the *Definition* tab to define the unique constraint:
@ -181,6 +193,7 @@ Use the fields in the *Definition* tab to define the unique constraint:
* If enabled, move the *Deferred?* switch to the *Yes* position to specify the timing of the constraint is deferred to the end of the statement. The default is *No*.
.. image:: images/table_exclude.png
:alt: Table dialog exclude constraint
To add an exclusion constraint, select the *Exclude* tab on the panel, and click the *Add* icon (+). To define the constraint, click the *Edit* icon to the left of the *Trash* icon. A dialog similar to the *Exclusion constraint* dialog (accessed by right clicking on *Constraints* in the *pgAdmin* tree control) opens.
@ -192,6 +205,7 @@ Use the fields in the *General* tab to identify the exclusion constraint:
Click the *Definition* tab to continue.
.. image:: images/exclusion_constraint_definition.png
:alt: Table dialog exclusion constraint definition
Use the fields in the *Definition* tab to define the exclusion constraint:
@ -211,6 +225,7 @@ Use the fields in the *Definition* tab to define the exclusion constraint:
Click the *Columns* tab to continue.
.. image:: images/exclusion_constraint_columns.png
:alt: Table dialog exclusion constraint columns
Use the fields in the *Columns* tab to to specify the column(s) to which the constraint applies. Use the drop-down listbox next to *Column* to select a column and click the *Add* icon (+) to provide details of the action on the column:
@ -223,6 +238,7 @@ Use the fields in the *Columns* tab to to specify the column(s) to which the con
Click the *Advanced* tab to continue.
.. image:: images/table_advanced.png
:alt: Table dialog advanced tab
Use the fields in the *Advanced* tab to define advanced features for the table:
@ -243,6 +259,7 @@ Use the fields in the **Like** box to specify which attributes of an existing ta
Click the *Parameter* tab to continue.
.. image:: images/table_parameter.png
:alt: Table dialog parameter tab
Use the tabs nested inside the *Parameter* tab to specify VACUUM and ANALYZE thresholds; use the *Table* tab and the *Toast Table* tab to customize values for the table and the associated toast table:
@ -254,6 +271,7 @@ Provide a custom value in the *Value* column for each metric listed in the *Labe
Click the *Security* tab to continue.
.. image:: images/table_security.png
:alt: Table dialog security tab
Use the *Security* tab to assign privileges and define security labels.
@ -281,6 +299,7 @@ Your entries in the *Table* dialog generate a SQL command (see an example below)
The following is an example of the sql command generated by user selections in the *Table* dialog:
.. image:: images/table_sql.png
:alt: Table dialog sql tab
The example shown demonstrates creating a table named *product_category*. It has three columns and a primary key constraint on the *category_id* column.

5
docs/en_US/tablespace_dialog.rst
View File

@ -9,6 +9,7 @@ Use The *Tablespace* dialog to define a tablespace. A tablespace allows superuse
The *Tablespace* dialog organizes the definition of a tablespace through the following tabs: *General*, *Definition*, *Parameters*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/tablespace_general.png
:alt: Tablespace dialog general tab
* Use the *Name* field to identify the tablespace with a descriptive name. The name cannot begin with pg\_; these names are reserved for system tablespaces.
* Select the owner of the tablespace from the drop-down listbox in the *Owner* field.
@ -17,12 +18,14 @@ The *Tablespace* dialog organizes the definition of a tablespace through the fol
Click the *Definition* tab to continue.
.. image:: images/tablespace_definition.png
:alt: Tablespace dialog definition tab
* Use the *Location* field to specify an absolute path to a directory that will contain the tablespace.
Click the *Parameters* tab to continue.
.. image:: images/tablespace_parameters.png
:alt: Tablespace dialog parameters tab
Use the *Parameters* tab to set parameters for the tablespace. Click the *Add* icon (+) to add a row to the table below.
@ -34,6 +37,7 @@ Click the *Add* icon (+) to specify each additional parameter; to discard a para
Click the *Security* tab to continue.
.. image:: images/tablespace_security.png
:alt: Tablespace dialog security tab
Use the *Security* tab to assign privileges and define security labels for the tablespace.
@ -61,6 +65,7 @@ Your entries in the *Tablespace* dialog generate a SQL command (see an example b
The following is an example of the sql command generated by user selections in the *Tablespace* dialog:
.. image:: images/tablespace_sql.png
:alt: Tablespace dialog sql tab
The example shown demonstrates creating a tablespace named *space_01*. It has a *random_page_cost* value equal to *4*.

5
docs/en_US/trigger_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Trigger* dialog to create a trigger or modify an existing trigger. A t
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.
.. image:: images/trigger_general.png
:alt: Trigger dialog general tab
Use the fields in the *General* tab to identify the trigger:
@ -18,6 +19,7 @@ Use the fields in the *General* tab to identify the trigger:
Click the *Definition* tab to continue.
.. image:: images/trigger_definition.png
:alt: Trigger dialog definition tab
Use the fields in the *Definition* tab to define the trigger:
@ -31,6 +33,7 @@ Use the fields in the *Definition* tab to define the trigger:
Click the *Events* tab to continue.
.. image:: images/trigger_events.png
:alt: Trigger dialog events tab
Use the fields in the *Events* tab to specify how and when the trigger fires:
@ -42,6 +45,7 @@ Use the fields in the *Events* tab to specify how and when the trigger fires:
Click the *Code* tab to continue.
.. image:: images/trigger_code.png
:alt: Trigger dialog code tab
Use the *Code* field to specify any additional code that will be invoked when the trigger fires.
@ -54,6 +58,7 @@ Your entries in the *Trigger* dialog generate a SQL command (see an example belo
The following is an example of the sql command generated by user selections in the *Trigger* dialog:
.. image:: images/trigger_sql.png
:alt: Trigger dialog sql tab
The example demonstrates creating a trigger named *log_update* that calls a procedure named *log_account_update* that logs any updates to the *distributors* table.

6
docs/en_US/trigger_function_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Trigger function* dialog to create or manage a trigger_function. A trig
The *Trigger function* dialog organizes the development of a trigger function through the following dialog tabs: *General*, *Definition*, *Options*, *Parameters* and *Security*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/trigger_function_general.png
:alt: Trigger function dialog general tab
Use the fields in the *General* tab to identify the trigger function:
@ -20,6 +21,7 @@ Use the fields in the *General* tab to identify the trigger function:
Click the *Definition* tab to continue.
.. image:: images/trigger_function_definition.png
:alt: Trigger function dialog definition tab
Use the fields in the *Definition* tab to define the trigger function:
@ -34,6 +36,7 @@ Use the fields in the *Definition* tab to define the trigger function:
Click the *Options* tab to continue.
.. image:: images/trigger_function_options.png
:alt: Trigger function dialog options tab
Use the fields in the *Options* tab to describe or modify the action of the trigger function:
@ -54,6 +57,7 @@ Use the fields in the *Options* tab to describe or modify the action of the trig
Click the *Parameters* tab to continue.
.. image:: images/trigger_function_parameters.png
:alt: Trigger function dialog parameters tab
Use the fields in the *Parameters* tab to specify settings that will be applied when the trigger function is invoked. Click the *Add* icon (+) to add a *Name*/*Value* pair to the table below.
@ -65,6 +69,7 @@ Click the *Add* icon (+) to set additional parameters; to discard a parameter, c
Click the *Security* tab to continue.
.. image:: images/trigger_function_security.png
:alt: Trigger function dialog security tab
Use the *Security* tab to assign privileges and define security labels.
@ -92,6 +97,7 @@ Your entries in the *Trigger function* dialog generate a SQL command (see an exa
The following is an example of the sql command generated by user selections in the *Trigger function* dialog:
.. image:: images/trigger_function_sql.png
:alt: Trigger function dialog sql tab
The example shown demonstrates creating a trigger function named *emp_stamp* that checks for a new employee's name, and checks that the employee's salary is a positive value.

8
docs/en_US/type_dialog.rst
View File

@ -9,6 +9,7 @@ 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.
.. image:: images/type_general.png
:alt: Type dialog general tab
Use the fields in the *General* tab to identify the custom data type:
@ -32,6 +33,7 @@ There are five data types:
If you select *Composite* in the *Type* field, the *Definition* tab displays the *Composite Type* panel:
.. image:: images/type_composite.png
:alt: Type dialog composite section
Click the *Add* icon (+) to provide attributes of the type. Fields on the *General* panel are context sensitive and may be disabled.
@ -46,6 +48,7 @@ Click the *Add* icon (+) to define an additional member; click the trash icon to
If you select the *Enumeration* in the *Type* field, the *Definition* tab displays the *Enumeration Type* panel:
.. image:: images/type_enumeration.png
:alt: Type dialog enumeration section
Click the *Add* icon (+) to provide a label for the type.
@ -56,6 +59,7 @@ Click the *Add* icon (+) after each selection to create additional labels; to di
If you select *External*, the *Definition* tab displays the *External Type* panel:
.. image:: images/type_external.png
:alt: Type dialog external section
On the *Required* tab:
@ -87,6 +91,7 @@ On the *Optional-2* tab:
If you select *Range* in the *Type* field, the *Definition* tab displays the *Range* panel. Fields on the *Range* panel are context-sensitive and may be disabled.
.. image:: images/type_range.png
:alt: Type dialog range section
* Use the drop-down listbox next to *Sub-type* to select an associated b-tree operator class (to determine the ordering of values for the range type).
* Use the drop-down listbox next to *Sub-type operator class* to use a non-default operator class.
@ -97,12 +102,14 @@ If you select *Range* in the *Type* field, the *Definition* tab displays the *Ra
If you select *Shell* in the *Type* field, the *Definition* tab displays the *Shell* panel:
.. image:: images/type_shell.png
:alt: Type dialog shell section
A shell type is a placeholder for a type and has no parameters.
Click the *Security* tab to continue.
.. image:: images/type_security.png
:alt: Type dialog security tab
Use the *Security* tab to assign privileges and define security labels.
@ -130,6 +137,7 @@ Your entries in the *Type* dialog generate a SQL command (see an example below).
The following is an example of a sql command generated by user selections made in the *Type* dialog:
.. image:: images/type_sql.png
:alt: Type dialog sql tab
The example shown demonstrates creating a data type named *work_order*. The data type is an enumerated type with three labels: new, open and closed.

3
docs/en_US/unique_constraint_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *Unique constraint* dialog to define a unique constraint for a specified
The *Unique constraint* dialog organizes the development of a unique constraint through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/unique_constraint_general.png
:alt: Unique Constraint dialog general tab
Use the fields in the *General* tab to identify the unique constraint:
@ -17,6 +18,7 @@ Use the fields in the *General* tab to identify the unique constraint:
Click the *Definition* tab to continue.
.. image:: images/unique_constraint_definition.png
:alt: Unique Constraint dialog definition tab
Use the fields in the *Definition* tab to define the unique constraint:
@ -36,6 +38,7 @@ Your entries in the *Unique constraint* dialog generate a SQL command (see an ex
The following is an example of the sql command generated by user selections in the *Unique constraint* dialog:
.. image:: images/unique_constraint_sql.png
:alt: Unique Constraint dialog sql tab
The example shown demonstrates creating a unique constraint named *name_con* on the *name* column of the *distributors* table.

3
docs/en_US/user_mapping_dialog.rst
View File

@ -9,6 +9,7 @@ Use the *User Mapping* dialog to define a new mapping of a user to a foreign ser
The *User Mapping* dialog organizes the development of a user mapping through the following dialog tabs: *General* and *Options*. The *SQL* tab displays the SQL code generated by dialog selections.
.. image:: images/user_mapping_general.png
:alt: User Mapping dialog general tab
Use the drop-down listbox in the *User* field in the *General* tab to identify the connecting role:
@ -19,6 +20,7 @@ Use the drop-down listbox in the *User* field in the *General* tab to identify t
Click the *Options* tab to continue.
.. image:: images/user_mapping_options.png
:alt: User Mapping dialog options tab
Use the fields in the *Options* tab to specify connection options; the accepted option names and values are specific to the foreign data wrapper associated with the server specified in the user mapping. Click the *Add* button to add an option/value pair.
@ -36,6 +38,7 @@ Your entries in the *User Mapping* dialog generate a SQL command (see an example
The following is an example of the sql command generated by user selections in the *User Mapping* dialog:
.. image:: images/user_mapping_sql.png
:alt: User Mapping dialog sql tab
The example shown demonstrates a user mapping for the *hdfs_server*. The user is *CURRENT_USER* with a password *secret*.

4
docs/en_US/view_dialog.rst
View File

@ -11,6 +11,7 @@ The *View* dialog organizes the development of a View through the following dial
Click the *General* tab to begin.
.. image:: images/view_general.png
:alt: View dialog general tab
Use the fields in the *General* tab to identify a view:
@ -22,6 +23,7 @@ Use the fields in the *General* tab to identify a view:
Click the *Definition* tab to continue.
.. image:: images/view_definition.png
:alt: View dialog definition tab
Use the fields in the *Definition* tab to define properties of the view:
@ -34,6 +36,7 @@ Use the fields in the *Definition* tab to define properties of the view:
Click the *Security* tab to continue.
.. image:: images/view_security.png
:alt: View dialog security tab
Use the *Security* tab to assign privileges and define security labels.
@ -61,6 +64,7 @@ Your entries in the *View* dialog generate a SQL command (see an example below).
The following is an example of the sql command generated by user selections in the *View* dialog:
.. image:: images/view_sql.png
:alt: View dialog sql tab
The example shown demonstrates creating a view named *distributor_codes* that includes the content of the *code* column from the *distributors* table.