Documentation of Storage Manager. Fixes #5938
@ -4,7 +4,7 @@
|
||||
`Backup Dialog`:index:
|
||||
**********************
|
||||
|
||||
Using the *pg_dump* utility, *pgAdmin* provides an easy way to create a backup
|
||||
*pgAdmin* uses the *pg_dump* utility to provide an easy way to create a backup
|
||||
in a plain-text or archived format. You can then use a client application (like
|
||||
*psql* or the *Query Tool*) to restore a plain-text backup file, or use the
|
||||
Postgres *pg_restore* utility to restore an archived backup. The *pg_dump*
|
||||
@ -205,14 +205,15 @@ command:
|
||||
|
||||
Use the **Stop Process** button to stop the Backup process.
|
||||
|
||||
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.
|
||||
If the backup is successful, a popup window will confirm success. Click *More 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
|
||||
:align: center
|
||||
|
||||
If the backup is unsuccessful, you can review the error messages returned by the
|
||||
backup command on the *Process Watcher*.
|
||||
backup command on the *Process Watcher*.
|
||||
|
||||
.. note:: If you are running *pgAdmin* in *Server Mode* you can click on the |sm_icon| icon in the process watcher window to open the file location in the Storage Manager. You can use the :ref:`Storage Manager <storage_manager>` to download the backup file on the client machine .
|
||||
|
||||
.. |sm_icon| image:: images/sm_icon.png
|
||||
|
@ -50,4 +50,8 @@ additional information for troubleshooting.
|
||||
:align: center
|
||||
|
||||
If the backup is unsuccessful, review the error message returned by the
|
||||
*Process Watcher* to resolve any issue.
|
||||
*Process Watcher* to resolve any issue.
|
||||
|
||||
.. note:: If you are running *pgAdmin* in *Server Mode* you can click on the |sm_icon| icon in the process watcher window to open the file location in the Storage Manager. You can use the :ref:`Storage Manager <storage_manager>` to download the backup file on the client machine .
|
||||
|
||||
.. |sm_icon| image:: images/sm_icon.png
|
||||
|
@ -135,4 +135,8 @@ additional information for troubleshooting.
|
||||
:align: center
|
||||
|
||||
If the backup is unsuccessful, review the error message returned by the
|
||||
*Process Watcher* to resolve any issue.
|
||||
*Process Watcher* to resolve any issue.
|
||||
|
||||
.. note:: If you are running *pgAdmin* in *Server Mode* you can click on the |sm_icon| icon in the process watcher window to open the file location in the Storage Manager. You can use the :ref:`Storage Manager <storage_manager>` to download the backup file on the client machine .
|
||||
|
||||
.. |sm_icon| image:: images/sm_icon.png
|
||||
|
BIN
docs/en_US/images/delete.png
Normal file
After Width: | Height: | Size: 5.3 KiB |
BIN
docs/en_US/images/download.png
Normal file
After Width: | Height: | Size: 5.6 KiB |
BIN
docs/en_US/images/edit.png
Normal file
After Width: | Height: | Size: 5.7 KiB |
BIN
docs/en_US/images/folder.png
Normal file
After Width: | Height: | Size: 5.7 KiB |
BIN
docs/en_US/images/gridview.png
Normal file
After Width: | Height: | Size: 5.6 KiB |
BIN
docs/en_US/images/home.png
Normal file
After Width: | Height: | Size: 5.9 KiB |
BIN
docs/en_US/images/process_watcher_storage_manager.png
Normal file
After Width: | Height: | Size: 196 KiB |
BIN
docs/en_US/images/refresh.png
Normal file
After Width: | Height: | Size: 6.0 KiB |
BIN
docs/en_US/images/sm_icon.png
Normal file
After Width: | Height: | Size: 5.7 KiB |
BIN
docs/en_US/images/storage_manager.png
Normal file
After Width: | Height: | Size: 113 KiB |
BIN
docs/en_US/images/tableview.png
Normal file
After Width: | Height: | Size: 5.0 KiB |
BIN
docs/en_US/images/uparrow.png
Normal file
After Width: | Height: | Size: 4.9 KiB |
BIN
docs/en_US/images/upload.png
Normal file
After Width: | Height: | Size: 5.6 KiB |
@ -94,3 +94,8 @@ that performed the import or export:
|
||||
.. image:: images/import_export_pw.png
|
||||
:alt: Import Export data process watcher
|
||||
:align: center
|
||||
|
||||
.. note:: If you are running *pgAdmin* in *Server Mode* you can click on the |sm_icon| icon in the process watcher window to open the file location in the Storage Manager. You can use the :ref:`Storage Manager <storage_manager>` to download the backup file on the client machine .
|
||||
|
||||
|
||||
.. |sm_icon| image:: images/sm_icon.png
|
||||
|
@ -15,4 +15,5 @@ granting user privileges, and performing VACUUM, ANALYZE and REINDEX functions.
|
||||
change_password_dialog
|
||||
grant_wizard
|
||||
import_export_data
|
||||
maintenance_dialog
|
||||
maintenance_dialog
|
||||
storage_manager
|
||||
|
@ -114,6 +114,8 @@ Use the *Tools* menu to access the following options (in alphabetical order):
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| *Resume replay of WAL* | Click to resume the replay of the WAL log. |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| *Storage Manager* | Click to open the :ref:`Storage Manager <storage_manager>` to upload, delete, or download the backup files. |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
The Help Menu
|
||||
*************
|
||||
@ -137,7 +139,3 @@ information about the pgAdmin installation (in alphabetical order):
|
||||
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| *PostgreSQL Website* | Click to access the PostgreSQL core documentation hosted at the PostgreSQL site. The site also offers guides, tutorials, and resources. |
|
||||
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
|
||||
|
||||
|
||||
|
@ -17,6 +17,7 @@ New features
|
||||
Housekeeping
|
||||
************
|
||||
|
||||
| `Issue #5938 <https://redmine.postgresql.org/issues/5938>`_ - Documentation of Storage Manager.
|
||||
|
||||
Bug fixes
|
||||
*********
|
||||
|
71
docs/en_US/storage_manager.rst
Normal file
@ -0,0 +1,71 @@
|
||||
.. _storage_manager:
|
||||
|
||||
************************
|
||||
`Storage Manager`:index:
|
||||
************************
|
||||
|
||||
*Storage Manager* is a feature that helps you manage your systems storage device. You can use *Storage Manager* to:
|
||||
|
||||
* Download, upload, or manage operating system files. To use this feature, *pgAdmin* must be running in *Server Mode* on your client machine.
|
||||
* Download *backup* or *export* files (custom, tar and plain text format) on a client machine.
|
||||
* Download *export* dump files of tables.
|
||||
|
||||
You can access *Storage Manager* from the *Tools* Menu.
|
||||
|
||||
.. image:: images/storage_manager.png
|
||||
:alt: Storage Manager
|
||||
:align: center
|
||||
|
||||
Use icons on the top of the *Storage Manager* window to manage storage:
|
||||
|
||||
Use the ``Home`` icon |home| to return to the home directory.
|
||||
|
||||
.. |home| image:: images/home.png
|
||||
|
||||
Use the ``Up Arrow`` icon |uparrow| to return to the previous directory.
|
||||
|
||||
.. |uparrow| image:: images/uparrow.png
|
||||
|
||||
Use the ``Refresh`` icon |refresh| to display the most-recent files available.
|
||||
|
||||
.. |refresh| image:: images/refresh.png
|
||||
|
||||
Select the ``Download`` icon |download| to download the selected file.
|
||||
|
||||
.. |download| image:: images/download.png
|
||||
|
||||
Select the ``Delete`` icon |delete| to delete the selected file or folder.
|
||||
|
||||
.. |delete| image:: images/delete.png
|
||||
|
||||
Select the ``Edit`` icon |edit| to rename a file or folder.
|
||||
|
||||
.. |edit| image:: images/edit.png
|
||||
|
||||
Use the ``Upload`` icon |upload| to upload a file.
|
||||
|
||||
.. |upload| image:: images/upload.png
|
||||
|
||||
Use the ``New Folder`` icon |folder| to add a new folder.
|
||||
|
||||
.. |folder| image:: images/folder.png
|
||||
|
||||
Use the ``Grid View`` icon |gridview| to display all the files and folders in a grid view.
|
||||
|
||||
.. |gridview| image:: images/gridview.png
|
||||
|
||||
Use the ``Table View`` icon |tableview| to display all the files and folders in a list view.
|
||||
|
||||
.. |tableview| image:: images/tableview.png
|
||||
|
||||
Click on the check box next to *Show hidden files and folders* at the bottom of the window to view hidden files and folders.
|
||||
|
||||
Use the *Format* drop down list to select the format of the files to be displayed; choose from *sql*, *csv*, or *All Files*.
|
||||
|
||||
You can also download backup files through *Storage Manager* at the successful completion of the backups taken through :ref:`Backup Dialog <backup_dialog>`, :ref:`Backup Global Dialog <backup_globals_dialog>`, or :ref:`Backup Server Dialog <backup_server_dialog>`.
|
||||
|
||||
At the successful completion of a backup, click on the icon to open the current backup file in *Storage Manager* on the *process watcher* window.
|
||||
|
||||
.. image:: images/process_watcher_storage_manager.png
|
||||
:alt: Process watcher with storage manager icon
|
||||
:align: center
|