More doc updates.

This commit is contained in:
Susan Douglas 2016-06-08 10:23:12 +01:00 committed by Dave Page
parent 615882e1ee
commit c7862cadad
38 changed files with 291 additions and 2 deletions

View File

@ -0,0 +1,20 @@
.. _add_restore_point_dialog:
**********************************
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
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.
For more information about using a restore point as a recovery target, please see the `PostgreSQL
documentation <http://www.postgresql.org/docs/9.5/static/recovery-target-settings.html#RECOVERY-TARGET-NAME>`_.
* Click the *OK* button to save the restore point.
* Click the *Cancel* button to exit without saving work.

View File

@ -0,0 +1,29 @@
.. _backup_globals_dialog:
****************************
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
Use the fields in the *General* tab to specify the following:
* Enter the name of the backup file in the *Filename* field. Optionally, select the *Browser* icon (ellipsis) to the right to navigate into a directory and select a file that will contain the archive.
* Use the drop-down listbox next to *Role name* to specify a role with connection privileges on the selected server. The role will be used for authentication during the backup.
Move switches in the **Miscellaneous** field box to specify the type of statements that should be included in the backup.
* Move the *Verbose messages* switch to the *No* position to exclude status messages from the backup. The default is *Yes*.
* Move the *Force double quote on identifiers* switch to the *Yes* position to name identifiers without changing case. The default is *No*.
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
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
If the backup is unsuccessful, review the error message returned by the *Process Watcher* to resolve any issue.

View File

@ -0,0 +1,28 @@
.. _backup_server_dialog:
****************************
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
Use the fields in the *General* tab to specify the following:
* Enter the name of the backup file in the *Filename* field. Optionally, select the *Browser* icon (ellipsis) to the right to navigate into a directory and select a file that will contain the archive.
* Use the drop-down listbox next to *Role name* to specify a role with connection privileges on the selected server. The role will be used for authentication during the backup.
Move switches in the *Miscellaneous* box to specify the type of statements that should be included in the backup.
* Move the *Verbose messages* switch to the *No* position to exclude status messages from the backup. The default is *Yes*.
* Move the *Force double quote on identifiers* switch to the *Yes* position to name identifiers without changing case. The default is *No*.
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
If the backup is successful, a popup window will confirm success. Click *Click here for details* on the popup window to launch the *Process Watcher*. The *Process Watcher* logs all the activity associated with the backup and provides additional information for troubleshooting.
.. image:: images/backup_server_process_watcher.png
If the backup is unsuccessful, review the error message returned by the *Process Watcher* to resolve any issue.

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 281 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 274 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 101 KiB

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 146 KiB

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 116 KiB

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 165 KiB

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 99 KiB

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 79 KiB

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 126 KiB

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 138 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 124 KiB

After

Width:  |  Height:  |  Size: 51 KiB

View File

@ -0,0 +1,60 @@
.. _import_export_data:
*****************************
The Import/Export data Dialog
*****************************
Use the *Import/Export data* dialog to copy data from a table to a file, or copy data from a file into a table.
The *Import/Export data* dialog organizes the import/export of data through the *Options* and *Columns* tabs.
.. image:: images/import_export_options.png
Use the fields in the *Options* tab to specify import and export preferences:
* Move the *Import/Export* switch to the *Import* position to specify that the server should import data to a table from a file. The default is *Export*.
* Use the fields in the *File Info* field box to specify information about the source or target file:
* Enter the name of the source or target file in the *Filename* field. Optionally, select the *Browser* icon (ellipsis) to the right to navigate into a directory and select a file.
* Use the drop-down listbox in the *Format* field to specify the file type. Select:
* *binary* for a .bin file.
* *csv* for a .csv file.
* *text* for a .txt file.
* Use the drop-down listbox in the *Encoding* field to specify the type of character encoding.
.. image:: images/import_export_miscellaneous.png
* Use the fields in the *Miscellaneous* field box to specify additional information:
* Move the *OID* switch to the *Yes* position to include the *OID* column. The *OID* is a system-assigned value that may not be modified. The default is *No*.
* Move the *Header* switch to the *Yes* position to include the table header with the data rows. If you include the table header, the first row of the file will contain the column names.
* If you are exporting data, specify the delimiter that will separate the columns within the target file in the *Delimiter* field. The separating character can be a colon, semicolon, a vertical bar, or a tab.
* Specify a quoting character used in the *Quote* field. Quoting can be applied to string columns only (i.e. numeric columns will not be quoted) or all columns regardless of data type. The character used for quoting can be a single quote or a double quote.
* Specify a character that should appear before a data character that matches the *QUOTE* value in the *Escape* field.
Click the *Columns* tab to continue.
.. image:: images/import_export_columns.png
Use the fields in the *Columns* tab to select the columns that will be imported or exported:
* Click inside the *Columns to export/import* field to select one or more columns from the drop-down listbox. To delete a selection, click the *x* to the left of the column name.
* Use the *NULL Strings* field to specify a string that will represent a null value within the source or target file.
* If enabled, click inside the *Not null columns* field to select one or more columns that will not be checked for a NULL value. To delete a column, click the *x* to the left of the column name.
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
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

View File

@ -140,11 +140,13 @@ Contents:
.. toctree::
:maxdepth: 2
add_restore_point_dialog
managing_server
change_password_dialog
configuration_editor
grant_wizard
maintenance
import_export_data
maintenance_dialog
Backup and Restore
@ -158,7 +160,9 @@ Contents:
:maxdepth: 2
backup_dialog
restore
backup_globals_dialog
backup_server_dialog
restore_dialog
Developer Tools

View File

@ -0,0 +1,41 @@
.. _maintenance_dialog:
*************************
The Maintenance... Dialog
*************************
Use the *Maintenance...* dialog to VACUUM, ANALYZE, REINDEX or CLUSTER a database or selected database objects.
.. image:: images/maintenance.png
While this utility is useful for ad-hoc maintenance purposes, you are encouraged to perform automatic VACUUM jobs on a regular schedule.
Select a button next to *Maintenance operation* to specify the type of maintenance:
* Click *VACUUM* to scan the selected database or table to reclaim storage used by dead tuples.
* Move the *FULL* switch to the *Yes* position to compact tables by writing a completely new version of the table file without dead space. The default is *No*.
* Move the *FREEZE* switch to the *Yes* position to freeze data in a table when it will have no further updates. The default is *No*.
* Move the *ANALYZE* switch to the *Yes* position to issue ANALYZE commands whenever the content of a table has changed sufficiently. The default is *No*.
* Click *ANALYZE* to update the stored statistics used by the query planner. This enables the query optimizer to select the fastest query plan for optimal performance.
* Click *REINDEX* to rebuild any index in case it has degenerated due to the insertion of unusual data patterns. This happens, for example, if you insert rows with increasing index values, and delete low index values.
* Click *CLUSTER* to instruct PostgreSQL to cluster the selected table.
To exclude status messages from the process output, move the *Verbose Messages* switch to the *No* position; by default, status messages are included.
When you've completed the dialog, click *OK* to start the background process; to exit the dialog without performing maintenance operations, click *Cancel*.
pgAdmin will inform you when the background process completes:
.. image:: images/maintenance_complete.png
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

107
docs/en_US/restore_dialog.rst Executable file
View File

@ -0,0 +1,107 @@
.. _restore_dialog:
******************
The Restore Dialog
******************
The *Restore* dialog provides an easy way to use a Custom, tar, or Directory format backup taken with the pgAdmin *Backup* dialog to recreate a database or database object. The *Backup* dialog invokes options of the pg_dump client utility; the *Restore* dialog invokes options of the pg_restore client utility.
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
Use the fields on the *General* tab to specify general information about the restore process:
* Use the drop-down listbox in the *Format* field to select the format of your backup file.
* Select *Custom or tar* to restore from a custom archive file to create a copy of the backed-up object.
* Select *Directory* to restore from a compressed directory-format archive.
* Enter the complete path to the backup file in the *Filename* field. Optionally, select the *Browser* icon (ellipsis) to the right to navigate into a directory and select the file that contains the archive.
* Use the *Number of Jobs* field to specify if pg_restore should use multiple (concurrent) jobs to process the restore. Each job uses a separate connection to the server.
* Use the drop-down listbox next to *Rolename* to specify the role that will be used to authenticate with the server during the restore process.
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
* Use the switches in the **Sections** box to specify the content that will be restored:
* Move the switch next to *Pre-data* to the *Yes* position to restore all data definition items not included in the data or post-data item lists.
* Move the switch next to *Data* to the *Yes* position to restore actual table data, large-object contents, and sequence values.
* 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
* Use the switches in the **Type of objects** box to specify the objects that will be restored:
* Move the switch next to *Only data* to the *Yes* position to limit the restoration to data.
* Move the switch next to *Only schema* to limit the restoration to schema-level database objects.
.. image:: images/restore_do_not_save.png
* Use the switches in the **Do not save** box to specify which objects will not be restored:
* Move the switch next to *Owner* to the *Yes* position to exclude commands that set object ownership.
* Move the switch next to *Privilege* to the *Yes* position to exclude commands that create access privileges.
* Move the switch next to *Tablespace* to the *Yes* position to exclude tablespaces.
.. image:: images/restore_queries.png
* Use the switches in the **Queries** box to specify the type of statements that should be included in the restore:
* Move the switch next to *Include CREATE DATABASE statement* to the *Yes* position to include a command that creates a new database before performing the restore.
* Move the switch next to *Clean before restore* to the *Yes* position to drop each existing database object (and data) before restoring.
* 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
* Use the switches in the **Disable** box to specify the type of statements that should be excluded from the restore:
* Move the switch next to *Trigger* (active when creating a data-only restore) to the *Yes* position to include commands that will disable triggers on the target table while the data is being loaded.
* 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
* Use the switches in the **Miscellaneous/Behavior** box to specify miscellaneous restore options:
* Move the switch next to *Verbose messages* to the *No* position to instruct *pg_restore* to exclude verbose messages.
* Move the switch next to *Use SET SESSION AUTHORIZATION* to the *Yes* position to include a statement that will use a SET SESSION AUTHORIZATION command to determine object ownership (instead of an ALTER OWNER command).
* Move the switch next to *Exit on error* to the *Yes* position to instruct *pg_restore* to exit restore if there is an error in sending SQL commands. The default is to continue and to display a count of errors at the end of the restore.
When youve 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
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