diff --git a/docs/en_US/images/add_pgadmin_user.png b/docs/en_US/images/add_pgadmin_user.png new file mode 100644 index 000000000..1082d223d Binary files /dev/null and b/docs/en_US/images/add_pgadmin_user.png differ diff --git a/docs/en_US/images/move_objects_general.png b/docs/en_US/images/move_objects_general.png new file mode 100644 index 000000000..4106b58a8 Binary files /dev/null and b/docs/en_US/images/move_objects_general.png differ diff --git a/docs/en_US/images/move_objects_sql.png b/docs/en_US/images/move_objects_sql.png new file mode 100644 index 000000000..9a8f9f1c8 Binary files /dev/null and b/docs/en_US/images/move_objects_sql.png differ diff --git a/docs/en_US/images/pgadmin_login.png b/docs/en_US/images/pgadmin_login.png new file mode 100644 index 000000000..16c0aaf6a Binary files /dev/null and b/docs/en_US/images/pgadmin_login.png differ diff --git a/docs/en_US/images/pgadmin_login_recover.png b/docs/en_US/images/pgadmin_login_recover.png new file mode 100644 index 000000000..bf9126a51 Binary files /dev/null and b/docs/en_US/images/pgadmin_login_recover.png differ diff --git a/docs/en_US/images/pgadmin_user.png b/docs/en_US/images/pgadmin_user.png new file mode 100644 index 000000000..fba3a1cb5 Binary files /dev/null and b/docs/en_US/images/pgadmin_user.png differ diff --git a/docs/en_US/move_objects.rst b/docs/en_US/move_objects.rst new file mode 100644 index 000000000..e386c7c4b --- /dev/null +++ b/docs/en_US/move_objects.rst @@ -0,0 +1,42 @@ +.. _move_objects: + +*********************** +The Move Objects Dialog +*********************** + +Use the *Move Objects* dialog to to move database objects from one tablespace to another tablespace. + +The *Move Objects* dialog organizes the movement of database objects with the *General* tab; the *SQL* tab displays the SQL code generated by dialog selections. + +.. image:: images/move_objects_general.png + +Use the fields in the *General* tab to identify the items that will be moved and the tablespace to which they will be moved: + +* Use the *New tablespace* drop-down listbox to select a pre-existing tablespace to which the object will be moved. (To create a tablespace, use the *Tablespace* dialog; access the dialog by right clicking *Tablespaces* in the *pgAdmin* tree control and selecting *Create Tablespace...* from the context-menu.) +* Use the *Object type* drop-down listbox to select from the following: + + * Select *All* to move all tables, indexes, and materialized views from the current tablespace (currently selected in the *pgAdmin* tree control) to the new tablespace. + * Select *Tables* to move tables from the current tablespace to the new tablespace. + * Select *Indexes* to move indexes from the current tablespace to the new tablespace. + * Select *Materialized views* to move materialized views from the current tablespace to the new tablespace. + +* Use the *Object owner* drop-down listbox to select the role that owns the objects selected in the *Object type* field. This field is optional. + +Click the *SQL* tab to continue. + +Your entries in the *Move Objects* dialog generate a SQL command (see an example below). Use the *SQL* tab for review; revisit the *General* tab to modify the SQL command. + +**Example** + +The following is an example of the sql command generated by user selections in the *Move Objects* dialog: + +.. image:: images/move_objects_sql.png + +The example shown demonstrates moving materialized views owned by Alice from tablespace *tbspace_01* to *tbspace_02*. + +* Click the *Help* button (?) to access online help. +* Click the *OK* button to save work. +* Click the *Cancel* button to exit without saving work. + + + diff --git a/docs/en_US/pgadmin_login.rst b/docs/en_US/pgadmin_login.rst new file mode 100644 index 000000000..a77b0e814 --- /dev/null +++ b/docs/en_US/pgadmin_login.rst @@ -0,0 +1,28 @@ +.. _pgadmin_login: + +************************ +The pgAdmin Login Dialog +************************ + +Use the *pgAdmin Login* dialog to log in to pgAdmin: + +.. image:: images/pgadmin_login.png + +Use the fields in the *pgAdmin Login* dialog to authenticate your connection: + +#. Provide the email address associated with your account in the *Email Address* field. +#. Provide your password in the *Password* field. +#. Click the *Login* button to securely log into pgAdmin. + +Recovering a Lost Password +************************** + +If you cannot supply your password, click the *Forgotten your password?* button to launch a password recovery utility. + +.. image:: images/pgadmin_login_recover.png + +#. Provide the email address associated with your account in the *Email Address* field. +#. Click the *Recover Password* button to initiate recovery. An email, with directions on how to reset a password, will be sent to the address entered in the *Email Address* field. + +If you have forgotten the email associated with your account, please contact your administrator. + diff --git a/docs/en_US/pgadmin_user.rst b/docs/en_US/pgadmin_user.rst new file mode 100644 index 000000000..d2b37e742 --- /dev/null +++ b/docs/en_US/pgadmin_user.rst @@ -0,0 +1,42 @@ +.. _pgadmin_user: + +************************** +The User Management Dialog +************************** + +When invoking pgAdmin in desktop mode, a password is randomly generated, and then ignored. If you install pgAdmin in server mode, you will be prompted for an administrator email and password for the pgAdmin client. + +When you authenticate with pgAdmin, the server definitions associated with that login role are made available in the tree control. An administrative user can use the *User Management* dialog to + +* add or delete pgAdmin roles +* assign privileges +* manage the password associated with a role + +.. image:: images/pgadmin_user.png + +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. + +.. image:: images/add_pgadmin_user.png + +Provide information about the new pgAdmin role in the row: + +* Click in the *Email* field, and provide an email address for the user; this address will be used to recover the password associated with the role should the password be lost. +* Use the drop-down listbox next to *Role* to select whether a user is an *Administrator* or a *User*. + + * Select *Administrator* if the user will have administrative privileges within the pgAdmin client. + * Select *User* to create a non-administrative user account. + +* Move the *Active* switch to the *No* position if the account is not currently active; the default is *Yes*. Use this switch to disable account activity without deleting an account. +* Use the *New password* field to provide the password associated with the user specified in the *Email* field. +* Re-enter the password in the *Confirm password* field. + +To discard a user, and revoke access to pgAdmin, click the trash icon to the left of the row and confirm deletion in the *Delete user?* dialog. + +Users with the *Administrator* role are able to add, edit and remove pgAdmin users, but otherwise have the same capabilities as those with the *User* role. + +* Click the *Help* button (?) to access online help. +* Click the *Close* button to save work. You will be prompted to return to the dialog if your selections cannot be saved. + +