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

More doc restructuring.

pull/3/head
Susan Douglas 2016-06-21 14:07:52 +01:00 committed by Dave Page
parent fc34f85aa3
commit 4f5eeffd1f
6 changed files with 47 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/en_US/client_features.rst
View File

@ -1,22 +0,0 @@
.. _client_features:
***************
Client Features
***************
pgAdmin 4 has a highly-customizable display that features drag-and-drop panels that you can arrange to make the best use of your desktop environment. The client features a tree control that provides an elegant overview of the managed servers, and the objects that reside on each server. Tabbed dialogs provide quick access to statistical information about each object in the tree control.
Use the *Preferences* dialog to customize the content and colors of the pgAdmin display. To open the *Preferences* dialog, select *Preferences* from the *File* menu.
*Help* buttons in the lower-left corner of each dialog will open the online help for the dialog. You can access additional Postgres help by navigating through the *Help* menu, and selecting the name of the resource that you wish to open.
Contents:
.. toctree::
browser
pgadmin_menu_bar
pgadmin_tabbed_browser
pgadmin_tree_control
preferences

16
docs/en_US/getting_started.rst
View File

@ -4,7 +4,15 @@
Getting Started
***************
When you install pgAdmin in server mode, you will be prompted to provide a role name and pgAdmin password. The first role registered with pgAdmin will be an administrative user. When you authenticate with pgAdmin, pgAdmin displays the server definitions associated with that login role in the tree control.
pgAdmin 4 features a highly-customizable display that features drag-and-drop panels that you can arrange to make the best use of your desktop environment.
When you install pgAdmin in server mode, you will be prompted to provide a role name and pgAdmin password. The first role registered with pgAdmin will be an administrative user. When you authenticate with pgAdmin, pgAdmin displays the server definitions associated with that login role in the tree control. The tree control provides an elegant overview of the managed servers, and the objects that reside on each server. Right-click on a node within the tree control to access context-sensitive menus that provide quick access to management tasks for the selected object.
The tabbed browser provide quick access to statistical information about each object in the tree control, and pgAdmin tools and utilities (such as the Query tool and the debugger). pgAdmin opens additional feature tabs each time you access the extended functionality offered by pgAdmin tools; you can open, close, and re-arrange feature tabs as needed.
Use the *Preferences* dialog to customize the content and colors of the pgAdmin display. To open the *Preferences* dialog, select *Preferences* from the *File* menu.
*Help* buttons in the lower-left corner of each dialog will open the online help for the dialog. You can access additional Postgres help by navigating through the *Help* menu, and selecting the name of the resource that you wish to open.
An administrative role can use the pgAdmin User Management dialog to create and manage additional pgAdmin user accounts.
@ -13,4 +21,10 @@ Contents:
.. toctree::
pgadmin_login
browser
pgadmin_menu_bar
pgadmin_tabbed_browser
pgadmin_tree_control
preferences
pgadmin_user

BIN
docs/en_US/images/main_dashboard.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 206 KiB

BIN
docs/en_US/images/main_statistics.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 338 KiB

1
docs/en_US/index.rst
View File

@ -13,7 +13,6 @@ Contents:
.. toctree::
getting_started
client_features
connecting
managing_cluster_objects
managing_database_objects

64
docs/en_US/pgadmin_tabbed_browser.rst
View File

@ -17,21 +17,51 @@ The *Dashboard* tab provides a graphical analysis of the usage statistics for th
* The *Tuples In* graph displays the number of tuples inserted, updated, and deleted into the managed server or database.
* The *Tuples out* graph displays the number of tuples fetched and returned into the managed server or database.
* The *Block I/O* graph displays the number of transactions processed by the managed server or database.
* The *Server activity* graph displays information about sessions, locks, prepared transactions and configuration. The information is presented in context-sensitive tables.
The *Server activity* panel displays information about sessions, locks, prepared transactions and configuration. The information is presented in context-sensitive tables.
Click the *Properties* tab to continue.
.. image:: images/main_properties_table.png
Review properties on expandable windows specific to the *Object* selected. If multiple boxes are displayed, you can click the arrow to the left on the blue bar at the top of each box:
* Point the arrow to the right to contract the box.
* Point the arrow down to expand the window.
.. image:: images/main_properties_edit.png
Click the *Edit* icon in the toolbar under the browser tabs to launch a dialog.
.. image:: images/main_properties_icons.png
If you change properties in the opened dialog, save your work. The *Properties* tab updates to show recent modifications.
Click the *SQL* tab to continue.
.. image:: images/main_sql.png
The SQL pane on the *SQL* tab contains an SQL script that creates the highlighted object, and if applicable, a (commented out) SQL statement that will *DROP* the selected object. You can copy the SQL statements to an editor of your choice using cut & paste shortcuts.
Click the *Statistics* tab to continue.
.. image:: images/main_statistics.png
The *Statistics* tab displays the statistics gathered for each database on the current server. Click a column heading to sort the table by the data displayed in the column; click again to reverse the sort order.
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:
+----------------------------+------------------------------------------------------------------------------------------------------------+
| Panel | Description |
+============================+============================================================================================================+
| *PID* | The process ID associated with the row. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *User* | The name of the user that owns the object. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Database* | displays the database name. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Backends* | displays the number of current connections to the database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Backend start* | The start time of the backend process. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Xact Committed* | displays the number of transactions committed to the database within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Xact Rolled Back* | displays the number of transactions rolled back within the last week. |
@ -73,36 +103,6 @@ The *Statistics* tab displays the statistics gathered for each database on the c
| *Size* | displays the size (in megabytes) of the selected database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
Click the *Properties* tab to continue.
.. image:: images/main_properties_table.png
Review properties on expandable windows specific to the *Object* selected. If multiple boxes are displayed, you can click the arrow to the left on the blue bar at the top of each box:
* Point the arrow to the right to contract the box.
* Point the arrow down to expand the window.
.. image:: images/main_properties_edit.png
Click the *Edit* icon in the toolbar under the browser tabs to launch a dialog.
.. image:: images/main_properties_icons.png
If you change properties in the opened dialog, save your work. The *Properties* tab updates to show recent modifications.
Click the *SQL* tab to continue.
.. image:: images/main_sql.png
The SQL pane on the *SQL* tab contains an SQL script that creates the highlighted object, and if applicable, a (commented out) SQL statement that will *DROP* the selected object. You can copy the SQL statements to an editor of your choice using cut & paste shortcuts.
Click the *Statistics* tab to continue.
.. image:: images/main_statistics.png
The *Statistics* tab displays available statistical information about the object currently selected in the *pgAdmin* browser.
Click the *Dependencies* tab to continue.
.. image:: images/main_dependencies.png