Some doc restructuring and cleanup.
@ -21,7 +21,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.
|
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
|
.. image:: images/welcome.png
|
||||||
:alt: pgAdmin4 welcome page
|
:alt: pgAdmin4 welcome page
|
||||||
|
|
||||||
Select an icon from the *Quick Links* panel on the *Dashboard* tab to:
|
Select an icon from the *Quick Links* panel on the *Dashboard* tab to:
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
.. _debugger:
|
.. _debugger:
|
||||||
|
|
||||||
*************************
|
*************************
|
||||||
`pgAdmin Debugger`:index:
|
`Debugger`:index:
|
||||||
*************************
|
*************************
|
||||||
|
|
||||||
.. image:: images/debug_main.png
|
.. image:: images/debug_main.png
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
.. _deployment:
|
.. _deployment:
|
||||||
|
|
||||||
***************************
|
*******************
|
||||||
`pgAdmin Deployment`:index:
|
`Deployment`:index:
|
||||||
***************************
|
*******************
|
||||||
|
|
||||||
Pre-compiled and configured installation packages for pgAdmin 4 are available
|
Pre-compiled and configured installation packages for pgAdmin 4 are available
|
||||||
for a number of desktop environments; we recommend using an installer whenever
|
for a number of desktop environments; we recommend using an installer whenever
|
||||||
|
@ -8,7 +8,7 @@ Pre-compiled and configured installation packages for pgAdmin 4 are available
|
|||||||
for a number of desktop environments; we recommend using an installer
|
for a number of desktop environments; we recommend using an installer
|
||||||
whenever possible.
|
whenever possible.
|
||||||
|
|
||||||
In a Server Deployment, the pgAdmin application is deployed behind a webserver
|
In a *Server Deployment*, the pgAdmin application is deployed behind a webserver
|
||||||
or with the WSGI interface.
|
or with the WSGI interface.
|
||||||
If you install pgAdmin in server mode, you will be prompted to provide a role
|
If you install pgAdmin in server mode, you will be prompted to provide a role
|
||||||
name and pgAdmin password when you initially connect to pgAdmin. The first
|
name and pgAdmin password when you initially connect to pgAdmin. The first
|
||||||
@ -18,28 +18,26 @@ and manage additional pgAdmin user accounts. When a user authenticates
|
|||||||
with pgAdmin, the pgAdmin tree control displays the server definitions
|
with pgAdmin, the pgAdmin tree control displays the server definitions
|
||||||
associated with that login role.
|
associated with that login role.
|
||||||
|
|
||||||
Contents:
|
In a *Desktop Deployment*, the pgAdmin application is configured to use the
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
|
|
||||||
server_deployment
|
|
||||||
pgadmin_login
|
|
||||||
pgadmin_user
|
|
||||||
change_user_password
|
|
||||||
|
|
||||||
In a Desktop Deployment, the pgAdmin application is configured to use the
|
|
||||||
desktop runtime environment to host the program on a supported platform.
|
desktop runtime environment to host the program on a supported platform.
|
||||||
Typically, users will install a pre-built package to run pgAdmin in desktop
|
Typically, users will install a pre-built package to run pgAdmin in desktop
|
||||||
mode, but a manual desktop deployment can be installed and though it is more
|
mode, but a manual desktop deployment can be installed and though it is more
|
||||||
difficult to setup, it may be useful for developers interested in understanding
|
difficult to setup, it may be useful for developers interested in understanding
|
||||||
how pgAdmin works.
|
how pgAdmin works.
|
||||||
|
|
||||||
|
It is also possible to use a *Container Deployment* of pgAdmin, in which Server
|
||||||
|
Mode is pre-configured for security.
|
||||||
|
|
||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
desktop_deployment
|
deployment
|
||||||
|
login
|
||||||
|
user_management
|
||||||
|
change_user_password
|
||||||
|
|
||||||
|
|
||||||
.. note:: Pre-compiled and configured installation packages are available for
|
.. note:: Pre-compiled and configured installation packages are available for
|
||||||
a number of platforms. These packages should be used by end-users whereever
|
a number of platforms. These packages should be used by end-users whereever
|
||||||
@ -71,12 +69,13 @@ the *Help* menu, and selecting the name of the resource that you wish to open.
|
|||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
browser
|
browser
|
||||||
pgadmin_menu_bar
|
menu_bar
|
||||||
pgadmin_toolbar
|
toolbar
|
||||||
pgadmin_tabbed_browser
|
tabbed_browser
|
||||||
pgadmin_tree_control
|
tree_control
|
||||||
preferences
|
preferences
|
||||||
keyboard_shortcuts
|
keyboard_shortcuts
|
||||||
|
|
||||||
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 48 KiB |
Before Width: | Height: | Size: 112 KiB After Width: | Height: | Size: 112 KiB |
@ -15,6 +15,7 @@ of database objects.
|
|||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
getting_started
|
getting_started
|
||||||
connecting
|
connecting
|
||||||
@ -24,7 +25,6 @@ Contents:
|
|||||||
management_basics
|
management_basics
|
||||||
backup_and_restore
|
backup_and_restore
|
||||||
developer_tools
|
developer_tools
|
||||||
deployment
|
|
||||||
contributions
|
contributions
|
||||||
pgagent
|
pgagent
|
||||||
licence
|
licence
|
||||||
|
@ -1,15 +1,15 @@
|
|||||||
.. _pgadmin_login:
|
.. _login:
|
||||||
|
|
||||||
*****************************
|
*********************
|
||||||
`pgAdmin Login Dialog`:index:
|
`Login Dialog`:index:
|
||||||
*****************************
|
*********************
|
||||||
|
|
||||||
Use the *pgAdmin Login* dialog to log in to pgAdmin:
|
Use the *Login* dialog to log in to pgAdmin:
|
||||||
|
|
||||||
.. image:: images/pgadmin_login.png
|
.. image:: images/login.png
|
||||||
:alt: pgAdmin login dialog
|
:alt: pgAdmin login dialog
|
||||||
|
|
||||||
Use the fields in the *pgAdmin Login* dialog to authenticate your connection:
|
Use the fields in the *Login* dialog to authenticate your connection:
|
||||||
|
|
||||||
#. Provide the email address associated with your account in the *Email Address* field.
|
#. Provide the email address associated with your account in the *Email Address* field.
|
||||||
#. Provide your password in the *Password* field.
|
#. Provide your password in the *Password* field.
|
||||||
@ -19,7 +19,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.
|
If you cannot supply your password, click the *Forgotten your password?* button to launch a password recovery utility.
|
||||||
|
|
||||||
.. image:: images/pgadmin_login_recover.png
|
.. image:: images/login_recover.png
|
||||||
:alt: pgAdmin recover login password
|
:alt: pgAdmin recover login password
|
||||||
|
|
||||||
#. Provide the email address associated with your account in the *Email Address* field.
|
#. Provide the email address associated with your account in the *Email Address* field.
|
@ -1,8 +1,8 @@
|
|||||||
.. _pgadmin_menu_bar:
|
.. _menu_bar:
|
||||||
|
|
||||||
*************************
|
*****************
|
||||||
`pgAdmin Menu Bar`:index:
|
`Menu Bar`:index:
|
||||||
*************************
|
*****************
|
||||||
|
|
||||||
The pgAdmin menu bar provides drop-down menus for access to options, commands, and utilities. The menu bar displays the following selections: *File*, *Object*, Tools*, and *Help*. Selections may be grayed out which indicates they are disabled for the object currently selected in the *pgAdmin* tree control.
|
The pgAdmin menu bar provides drop-down menus for access to options, commands, and utilities. The menu bar displays the following selections: *File*, *Object*, Tools*, and *Help*. Selections may be grayed out which indicates they are disabled for the object currently selected in the *pgAdmin* tree control.
|
||||||
|
|
@ -1,8 +1,8 @@
|
|||||||
.. _pgadmin_tabbed_browser:
|
.. _tabbed_browser:
|
||||||
|
|
||||||
*******************************
|
***********************
|
||||||
`pgAdmin Tabbed Browser`:index:
|
`Tabbed Browser`:index:
|
||||||
*******************************
|
***********************
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
@ -1,14 +1,14 @@
|
|||||||
.. _pgadmin_toolbar:
|
.. _toolbar:
|
||||||
|
|
||||||
*************************
|
****************
|
||||||
`pgAdmin Toolbar`:index:
|
`Toolbar`:index:
|
||||||
*************************
|
****************
|
||||||
|
|
||||||
The pgAdmin toolbar provides shortcut buttons for frequently used features like View Data and the Query Tool
|
The pgAdmin toolbar provides shortcut buttons for frequently used features like View Data and the Query Tool
|
||||||
which are most frequently used in pgAdmin.
|
which are most frequently used in pgAdmin.
|
||||||
This toolbar is visible on the Browser panel. Buttons get enabled/disabled based on the selected browser node.
|
This toolbar is visible on the Browser panel. Buttons get enabled/disabled based on the selected browser node.
|
||||||
|
|
||||||
.. image:: /images/pgadmin_toolbar.png
|
.. image:: /images/toolbar.png
|
||||||
:alt: pgAdmin Toolbar
|
:alt: pgAdmin Toolbar
|
||||||
|
|
||||||
* Use the :ref:`Query Tool <query_tool>` button to open the Query Tool in the current database context.
|
* Use the :ref:`Query Tool <query_tool>` button to open the Query Tool in the current database context.
|
@ -1,7 +1,7 @@
|
|||||||
.. _pgadmin_tree_control:
|
.. _tree_control:
|
||||||
|
|
||||||
*****************************
|
*****************************
|
||||||
`pgAdmin Tree Control`:index:
|
`Tree Control`:index:
|
||||||
*****************************
|
*****************************
|
||||||
|
|
||||||
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.
|
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.
|
@ -1,4 +1,4 @@
|
|||||||
.. _pgadmin_user:
|
.. _user_management:
|
||||||
|
|
||||||
*******************************
|
*******************************
|
||||||
`User Management Dialog`:index:
|
`User Management Dialog`:index:
|
||||||
@ -12,14 +12,14 @@ When you authenticate with pgAdmin, the server definitions associated with that
|
|||||||
* assign privileges
|
* assign privileges
|
||||||
* manage the password associated with a role
|
* manage the password associated with a role
|
||||||
|
|
||||||
.. image:: images/pgadmin_user.png
|
.. image:: images/user.png
|
||||||
:alt: pgAdmin user management window
|
: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.
|
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.
|
To add a user, click *Add* to add new role.
|
||||||
|
|
||||||
.. image:: images/add_pgadmin_user.png
|
.. image:: images/add_user.png
|
||||||
:alt: pgAdmin user management window add new user
|
:alt: pgAdmin user management window add new user
|
||||||
|
|
||||||
Provide information about the new pgAdmin role in the row:
|
Provide information about the new pgAdmin role in the row:
|