diff --git a/docs/en_US/backup_dialog.rst b/docs/en_US/backup_dialog.rst index 56ef32a47..df80a942a 100644 --- a/docs/en_US/backup_dialog.rst +++ b/docs/en_US/backup_dialog.rst @@ -67,8 +67,8 @@ Use the fields in the *General* tab to specify parameters for the backup: * Use the dropdown listbox next to *Rolename* to specify the role that owns the backup. -Click the *Dump options* tab to continue. Use the box fields in the *Dump -options* tab to provide options for *pg_dump*. +Click the *Data/Objects* tab to continue. Use the fields in the *Data/Objects* +tab to provide options related to data or pgAdmin objects that correspond to *pg_dump*. .. image:: images/backup_sections.png :alt: Sections option on backup dialog @@ -77,13 +77,13 @@ options* tab to provide options for *pg_dump*. * Move switches in the **Sections** field box to select a portion of the object that will be backed up. - * Move the switch next to *Pre-data* to the *Yes* position to include all + * Move the switch next to *Pre-data* towards right position to include 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 backup actual table + * Move the switch next to *Data* towards right position to backup actual table data, large-object contents, and sequence values. - * Move the switch next to *Post-data* to the *Yes* position to include + * Move the switch next to *Post-data* towards right position to include definitions of indexes, triggers, rules, and constraints other than validated check constraints. @@ -94,13 +94,13 @@ options* tab to provide options for *pg_dump*. * Move switches in the **Type of objects** field box to specify details about the type of objects that will be backed up. - * Move the switch next to *Only data* to the *Yes* position to limit the back + * Move the switch next to *Only data* towards right position to limit the back up to data. * Move the switch next to *Only schema* to limit the back up to schema-level database objects. - * Move the switch next to *Blobs* to the *No* position to exclude large + * Move the switch next to *Blobs* towards left position to exclude large objects in the backup. .. image:: images/backup_do_not_save.png @@ -110,22 +110,26 @@ options* tab to provide options for *pg_dump*. * Move switches in the **Do not save** field box to select the objects that will not be included in the backup. - * Move the switch next to *Owner* to the *Yes* position to exclude commands + * Move the switch next to *Owner* towards right position to exclude commands that set object ownership. - * Move the switch next to *Privilege* to the *Yes* position to exclude + * Move the switch next to *Privilege* towards right position to exclude commands that create access privileges. - * Move the switch next to *Tablespace* to the *Yes* position to exclude + * Move the switch next to *Tablespace* towards right position to exclude tablespaces. - * Move the switch next to *Unlogged table data* to the *Yes* position to + * Move the switch next to *Unlogged table data* towards right position to exclude the contents of unlogged tables. - * Move the switch next to *Comments* to the *Yes* position to exclude + * Move the switch next to *Comments* towards right position to exclude commands that set the comments. **Note:** This option is visible only for database server greater than or equal to 11. +Click the *Options* tab to continue. Use these additional fields to specify +options like including ddl statements, verbose message or using set session +authorization corresponding to *pg_dump* options. + .. image:: images/backup_queries.png :alt: Queries option on backup dialog :align: center @@ -133,24 +137,24 @@ options* tab to provide options for *pg_dump*. * Move switches in the **Queries** field box to specify the type of statements that should be included in the backup. - * Move the switch next to *Use Column Inserts* to the *Yes* position to dump + * Move the switch next to *Use Column Inserts* towards right position to dump the data in the form of INSERT statements and include explicit column names. Please note: this may make restoration from backup slow. - * Move the switch next to *Use Insert commands* to the *Yes* position to + * Move the switch next to *Use Insert commands* towards right position to dump the data in the form of INSERT statements rather than using a COPY command. Please note: this may make restoration from backup slow. - * Move the switch next to *Include CREATE DATABASE statement* to the *Yes* + * Move the switch next to *Include CREATE DATABASE statement* towards right position to include a command in the backup that creates a new database when restoring the backup. - * Move the switch next to *Include DROP DATABASE statement* to the *Yes* + * Move the switch next to *Include DROP DATABASE statement* towards right 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. - * Move the switch next to *Load Via Partition Root* to the *Yes* position, + * Move the switch next to *Load Via Partition Root* towards right position, so when dumping a COPY or INSERT statement for a partitioned table, target the root of the partitioning hierarchy which contains it rather than the partition itself. **Note:** This option is visible only for database server @@ -164,10 +168,10 @@ options* tab to provide options for *pg_dump*. that should be excluded from the backup. * Move the switch next to *Trigger* (active when creating a data-only backup) - to the *Yes* position to include commands that will disable triggers on the + towards right position to include commands that will disable triggers on the target table while the data is being loaded. - * Move the switch next to *$ quoting* to the *Yes* position to enable dollar + * Move the switch next to *$ quoting* towards right position to enable dollar quoting within function bodies; if disabled, the function body will be quoted using SQL standard string syntax. @@ -178,16 +182,16 @@ options* tab to provide options for *pg_dump*. * Move switches in the **Miscellaneous** field box to specify miscellaneous backup options. - * Move the switch next to *With OIDs* to the *Yes* position to include object + * Move the switch next to *With OIDs* towards right position to include object identifiers as part of the table data for each table. - * Move the switch next to *Verbose messages* to the *No* position to instruct + * Move the switch next to *Verbose messages* towards left position to instruct *pg_dump* to exclude verbose messages. - * Move the switch next to *Force double quotes on identifiers* to the *Yes* + * Move the switch next to *Force double quotes on identifiers* towards right position to force the quoting of all identifiers. - * Move the switch next to *Use SET SESSION AUTHORIZATION* to the *Yes* + * Move the switch next to *Use SET SESSION AUTHORIZATION* towards right position to include a statement that will use a SET SESSION AUTHORIZATION command to determine object ownership (instead of an ALTER OWNER command). diff --git a/docs/en_US/backup_server_dialog.rst b/docs/en_US/backup_server_dialog.rst index 11b1dec62..cc5234aa2 100644 --- a/docs/en_US/backup_server_dialog.rst +++ b/docs/en_US/backup_server_dialog.rst @@ -28,10 +28,13 @@ Use the fields in the *General* tab to specify the following: :alt: Type of objects option on backup server dialog :align: center +Click the *Data/Objects* tab to continue. Use the fields in the *Data/Objects* +tab to provide options related to data or pgAdmin objects that correspond to *pg_dump*. + * Move switches in the **Type of objects** field box to specify details about the type of objects that will be backed up. - * Move the switch next to *Only data* to the *Yes* position to limit the back + * Move the switch next to *Only data* towards right position to limit the back up to data. * Move the switch next to *Only schema* to limit the back up to schema-level @@ -44,19 +47,19 @@ Use the fields in the *General* tab to specify the following: * Move switches in the **Do not save** field box to select the objects that will not be included in the backup. - * Move the switch next to *Owner* to the *Yes* position to exclude commands + * Move the switch next to *Owner* towards right position to exclude commands that set object ownership. - * Move the switch next to *Privilege* to the *Yes* position to exclude + * Move the switch next to *Privilege* towards right position to exclude commands that create access privileges. - * Move the switch next to *Tablespace* to the *Yes* position to exclude + * Move the switch next to *Tablespace* towards right position to exclude tablespaces. - * Move the switch next to *Unlogged table data* to the *Yes* position to + * Move the switch next to *Unlogged table data* towards right position to exclude the contents of unlogged tables. - * Move the switch next to *Comments* to the *Yes* position to exclude + * Move the switch next to *Comments* towards right position to exclude commands that set the comments. **Note:** This option is visible only for database server greater than or equal to 11. @@ -67,15 +70,15 @@ Use the fields in the *General* tab to specify the following: * Move switches in the **Queries** field box to specify the type of statements that should be included in the backup. - * Move the switch next to *Use Column Inserts* to the *Yes* position to dump + * Move the switch next to *Use Column Inserts* towards right position to dump the data in the form of INSERT statements and include explicit column names. Please note: this may make restoration from backup slow. - * Move the switch next to *Use Insert commands* to the *Yes* position to dump + * Move the switch next to *Use Insert commands* towards right position to dump the data in the form of INSERT statements rather than using a COPY command. Please note: this may make restoration from backup slow. - * Move the switch next to *Include DROP DATABASE statement* to the *Yes* + * Move the switch next to *Include DROP DATABASE statement* towards right 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. @@ -89,10 +92,10 @@ Use the fields in the *General* tab to specify the following: that should be excluded from the backup. * Move the switch next to *Trigger* (active when creating a data-only backup) - to the *Yes* position to include commands that will disable triggers on the + towards right position to include commands that will disable triggers on the target table while the data is being loaded. - * Move the switch next to *$ quoting* to the *Yes* position to enable dollar + * Move the switch next to *$ quoting* towards right position to enable dollar quoting within function bodies; if disabled, the function body will be quoted using SQL standard string syntax. @@ -103,16 +106,16 @@ Use the fields in the *General* tab to specify the following: * Move switches in the **Miscellaneous** field box to specify miscellaneous backup options. - * Move the switch next to *With OIDs* to the *Yes* position to include object + * Move the switch next to *With OIDs* towards right position to include object identifiers as part of the table data for each table. - * Move the switch next to *Verbose messages* to the *No* position to instruct + * Move the switch next to *Verbose messages* towards left position to instruct *pg_dump* to exclude verbose messages. - * Move the switch next to *Force double quotes on identifiers* to the *Yes* + * Move the switch next to *Force double quotes on identifiers* towards right position to force the quoting of all identifiers. - * Move the switch next to *Use SET SESSION AUTHORIZATION* to the *Yes* + * Move the switch next to *Use SET SESSION AUTHORIZATION* towards right position to include a statement that will use a SET SESSION AUTHORIZATION command to determine object ownership (instead of an ALTER OWNER command). diff --git a/docs/en_US/images/backup_disable.png b/docs/en_US/images/backup_disable.png index 1df41fa08..d57955e3b 100644 Binary files a/docs/en_US/images/backup_disable.png and b/docs/en_US/images/backup_disable.png differ diff --git a/docs/en_US/images/backup_do_not_save.png b/docs/en_US/images/backup_do_not_save.png index 7bb25b998..c643d2a8c 100644 Binary files a/docs/en_US/images/backup_do_not_save.png and b/docs/en_US/images/backup_do_not_save.png differ diff --git a/docs/en_US/images/backup_general.png b/docs/en_US/images/backup_general.png index 74a254dcb..c818c0883 100644 Binary files a/docs/en_US/images/backup_general.png and b/docs/en_US/images/backup_general.png differ diff --git a/docs/en_US/images/backup_globals_general.png b/docs/en_US/images/backup_globals_general.png index 3d9b21c78..5f23b215c 100644 Binary files a/docs/en_US/images/backup_globals_general.png and b/docs/en_US/images/backup_globals_general.png differ diff --git a/docs/en_US/images/backup_globals_messages.png b/docs/en_US/images/backup_globals_messages.png index fee4ed102..c56440e61 100644 Binary files a/docs/en_US/images/backup_globals_messages.png and b/docs/en_US/images/backup_globals_messages.png differ diff --git a/docs/en_US/images/backup_globals_process_watcher.png b/docs/en_US/images/backup_globals_process_watcher.png index dff9921c3..a5617a0ae 100644 Binary files a/docs/en_US/images/backup_globals_process_watcher.png and b/docs/en_US/images/backup_globals_process_watcher.png differ diff --git a/docs/en_US/images/backup_messages.png b/docs/en_US/images/backup_messages.png index 8364b97c2..db85032f1 100644 Binary files a/docs/en_US/images/backup_messages.png and b/docs/en_US/images/backup_messages.png differ diff --git a/docs/en_US/images/backup_miscellaneous.png b/docs/en_US/images/backup_miscellaneous.png index 78f184c31..4d0ad28ae 100644 Binary files a/docs/en_US/images/backup_miscellaneous.png and b/docs/en_US/images/backup_miscellaneous.png differ diff --git a/docs/en_US/images/backup_objects.png b/docs/en_US/images/backup_objects.png index 91526a739..82a6c8aed 100644 Binary files a/docs/en_US/images/backup_objects.png and b/docs/en_US/images/backup_objects.png differ diff --git a/docs/en_US/images/backup_process_watcher.png b/docs/en_US/images/backup_process_watcher.png index b060a540d..0e8f9e4c8 100644 Binary files a/docs/en_US/images/backup_process_watcher.png and b/docs/en_US/images/backup_process_watcher.png differ diff --git a/docs/en_US/images/backup_queries.png b/docs/en_US/images/backup_queries.png index d590644d1..f725c5661 100644 Binary files a/docs/en_US/images/backup_queries.png and b/docs/en_US/images/backup_queries.png differ diff --git a/docs/en_US/images/backup_sections.png b/docs/en_US/images/backup_sections.png index 26f152515..fb63f87ad 100644 Binary files a/docs/en_US/images/backup_sections.png and b/docs/en_US/images/backup_sections.png differ diff --git a/docs/en_US/images/backup_server_disable.png b/docs/en_US/images/backup_server_disable.png index 1df41fa08..dd5bb227f 100644 Binary files a/docs/en_US/images/backup_server_disable.png and b/docs/en_US/images/backup_server_disable.png differ diff --git a/docs/en_US/images/backup_server_do_not_save.png b/docs/en_US/images/backup_server_do_not_save.png index e7d758eb0..241261160 100644 Binary files a/docs/en_US/images/backup_server_do_not_save.png and b/docs/en_US/images/backup_server_do_not_save.png differ diff --git a/docs/en_US/images/backup_server_general.png b/docs/en_US/images/backup_server_general.png index e3702ba16..8a5b67f5d 100644 Binary files a/docs/en_US/images/backup_server_general.png and b/docs/en_US/images/backup_server_general.png differ diff --git a/docs/en_US/images/backup_server_messages.png b/docs/en_US/images/backup_server_messages.png index e40de3e32..0c8dcc6c2 100644 Binary files a/docs/en_US/images/backup_server_messages.png and b/docs/en_US/images/backup_server_messages.png differ diff --git a/docs/en_US/images/backup_server_miscellaneous.png b/docs/en_US/images/backup_server_miscellaneous.png index 944071bc1..58905afb9 100644 Binary files a/docs/en_US/images/backup_server_miscellaneous.png and b/docs/en_US/images/backup_server_miscellaneous.png differ diff --git a/docs/en_US/images/backup_server_objects.png b/docs/en_US/images/backup_server_objects.png index c6d44e949..41468e1d8 100644 Binary files a/docs/en_US/images/backup_server_objects.png and b/docs/en_US/images/backup_server_objects.png differ diff --git a/docs/en_US/images/backup_server_process_watcher.png b/docs/en_US/images/backup_server_process_watcher.png index 371496fb4..725a0062e 100644 Binary files a/docs/en_US/images/backup_server_process_watcher.png and b/docs/en_US/images/backup_server_process_watcher.png differ diff --git a/docs/en_US/images/backup_server_queries.png b/docs/en_US/images/backup_server_queries.png index 4f7cece19..0b1352095 100644 Binary files a/docs/en_US/images/backup_server_queries.png and b/docs/en_US/images/backup_server_queries.png differ diff --git a/docs/en_US/images/restore_disable.png b/docs/en_US/images/restore_disable.png index bad14356e..966ad34fc 100644 Binary files a/docs/en_US/images/restore_disable.png and b/docs/en_US/images/restore_disable.png differ diff --git a/docs/en_US/images/restore_do_not_save.png b/docs/en_US/images/restore_do_not_save.png index 09276221e..ca7d49c03 100644 Binary files a/docs/en_US/images/restore_do_not_save.png and b/docs/en_US/images/restore_do_not_save.png differ diff --git a/docs/en_US/images/restore_general.png b/docs/en_US/images/restore_general.png index cd5969406..a89bd2451 100644 Binary files a/docs/en_US/images/restore_general.png and b/docs/en_US/images/restore_general.png differ diff --git a/docs/en_US/images/restore_miscellaneous.png b/docs/en_US/images/restore_miscellaneous.png index 27ae99032..3aea0d2cf 100644 Binary files a/docs/en_US/images/restore_miscellaneous.png and b/docs/en_US/images/restore_miscellaneous.png differ diff --git a/docs/en_US/images/restore_objects.png b/docs/en_US/images/restore_objects.png index 8d793ee8e..e6aa7140b 100644 Binary files a/docs/en_US/images/restore_objects.png and b/docs/en_US/images/restore_objects.png differ diff --git a/docs/en_US/images/restore_process_watcher.png b/docs/en_US/images/restore_process_watcher.png index 10e72d821..95358cf59 100644 Binary files a/docs/en_US/images/restore_process_watcher.png and b/docs/en_US/images/restore_process_watcher.png differ diff --git a/docs/en_US/images/restore_queries.png b/docs/en_US/images/restore_queries.png index 62af4831f..fc5568335 100644 Binary files a/docs/en_US/images/restore_queries.png and b/docs/en_US/images/restore_queries.png differ diff --git a/docs/en_US/images/restore_sections.png b/docs/en_US/images/restore_sections.png index c91e8badc..de998f9f2 100644 Binary files a/docs/en_US/images/restore_sections.png and b/docs/en_US/images/restore_sections.png differ diff --git a/docs/en_US/restore_dialog.rst b/docs/en_US/restore_dialog.rst index 0971dc96d..02468a082 100644 --- a/docs/en_US/restore_dialog.rst +++ b/docs/en_US/restore_dialog.rst @@ -38,8 +38,9 @@ restore process: * 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. +Click the *Data/Objects* tab to continue. Use the fields on the *Data/Objects* +tab to specify options related to data or pgAdmin objects that correspond to +*pg_restore* options. .. image:: images/restore_sections.png :alt: Restore dialog options section @@ -48,11 +49,11 @@ options* tab to specify options that correspond to *pg_restore* options. * 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 + * Move the switch next to *Pre-data* towards right 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 + * Move the switch next to *Data* towards right 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 + * Move the switch next to *Post-data* towards right position position to restore definitions of indexes, triggers, rules, and constraints (other than validated check constraints). @@ -63,7 +64,7 @@ options* tab to specify options that correspond to *pg_restore* options. * 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 + * Move the switch next to *Only data* towards right position to limit the restoration to data. * Move the switch next to *Only schema* to limit the restoration to schema-level database objects. @@ -75,16 +76,20 @@ options* tab to specify options that correspond to *pg_restore* options. * 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 + * Move the switch next to *Owner* towards right position to exclude commands that set object ownership. - * Move the switch next to *Privilege* to the *Yes* position to exclude + * Move the switch next to *Privilege* towards right position to exclude commands that create access privileges. - * Move the switch next to *Tablespace* to the *Yes* position to exclude + * Move the switch next to *Tablespace* towards right position to exclude tablespaces. - * Move the switch next to *Comments* to the *Yes* position to exclude + * Move the switch next to *Comments* towards right position to exclude commands that set the comments. **Note:** This option is visible only for database server greater than or equal to 11. +Click the *Options* tab to continue. Use these additional fields to specify +options like cleaning before restore, verbose message or using set session +authorization that correspond to *pg_restore* options. + .. image:: images/restore_queries.png :alt: Restore dialog queries section :align: center @@ -92,12 +97,11 @@ options* tab to specify options that correspond to *pg_restore* options. * 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 + * Move the switch next to *Include CREATE DATABASE statement* towards right position + to include a command that creates a new database before performing the restore. + * Move the switch next to *Clean before restore* towards right position to drop each existing database object (and data) before restoring. - * Move the switch next to *Single transaction* to the *Yes* position to + * Move the switch next to *Single transaction* towards right 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 @@ -111,9 +115,9 @@ options* tab to specify options that correspond to *pg_restore* options. 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 + restore) towards right 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 + * Move the switch next to *No data for Failed Tables* towards right position to ignore data that fails a trigger. .. image:: images/restore_miscellaneous.png @@ -123,13 +127,13 @@ options* tab to specify options that correspond to *pg_restore* options. * 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 + * Move the switch next to *Verbose messages* towards left 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 + * Move the switch next to *Use SET SESSION AUTHORIZATION* towards right 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 + * Move the switch next to *Exit on error* towards right 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.