diff --git a/docs/en_US/browser.rst b/docs/en_US/browser.rst index a8892e1b2..08b96c403 100644 --- a/docs/en_US/browser.rst +++ b/docs/en_US/browser.rst @@ -19,14 +19,14 @@ Features of pgAdmin 4 include: * helpful hints * online help and information about using pgAdmin dialogs and tools. -When pgAdmin opens, the interface features a menu bar and a window divided into two panes: the *pgAdmin* tree control in the left pane, and the 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 Select an icon from the *Quick Links* panel on the *Dashboard* tab to: -* Open the :ref:`Create - Server dialog ` to add a new server definition. -* Open the :ref:`Preferences dialog ` to customize your pgAdmin client. +* Click the *Add New Server* button to open the :ref:`Create - Server dialog ` to add a new server definition. +* Click the *Configure pgAdmin* button to open the :ref:`Preferences dialog ` to customize your pgAdmin client. Links in the *Getting Started* panel open a new browser tab that provide useful information for Postgres users: diff --git a/docs/en_US/check_dialog.rst b/docs/en_US/check_dialog.rst index 60fb8b077..17c6f71ae 100644 --- a/docs/en_US/check_dialog.rst +++ b/docs/en_US/check_dialog.rst @@ -12,7 +12,8 @@ The *Check* dialog organizes the development of a check constraint through the * Use the fields in the *General* tab to identify the check constraint: -* Use the *Name* field to add a descriptive name for the check constraint. The name will be displayed in the *pgAdmin* tree control. With PostgreSQL 9.5 forward, when a table has multiple check constraints, they will be tested for each row in alphabetical order by name and after NOT NULL constraints. +* Use the *Name* field to provide a descriptive name for the check constraint that will be displayed in the *pgAdmin* tree control. With PostgreSQL 9.5 forward, when a table has multiple check constraints, they will be tested for each row in alphabetical order by name and after NOT NULL constraints. +* Store notes about the check constraint in the *Comment* field. Click the *Definition* tab to continue. diff --git a/docs/en_US/collation_dialog.rst b/docs/en_US/collation_dialog.rst index c573f1efe..5f5985466 100644 --- a/docs/en_US/collation_dialog.rst +++ b/docs/en_US/collation_dialog.rst @@ -12,7 +12,7 @@ The *Collation* dialog organizes the development of a collation through the foll Use the fields in the *General* tab to identify the collation: -* Use the *Name* field to add a name for the collation. The collation name must be unique within a schema. The name will be displayed in the *pgAdmin* tree control. +* Use the *Name* field to provide a name for the collation. The collation name must be unique within a schema. The name will be displayed in the *pgAdmin* tree control. * Select the name of the owner from the drop-down listbox in the *Owner* field. * Select the name of the schema in which the collation will reside from the drop-down listbox in the *Schema* field. * Store notes about the collation in the *Comment* field. diff --git a/docs/en_US/images/language_definition.png b/docs/en_US/images/language_definition.png new file mode 100644 index 000000000..3b52c5145 Binary files /dev/null and b/docs/en_US/images/language_definition.png differ diff --git a/docs/en_US/images/language_general.png b/docs/en_US/images/language_general.png new file mode 100644 index 000000000..a2ea9fc49 Binary files /dev/null and b/docs/en_US/images/language_general.png differ diff --git a/docs/en_US/images/language_security.png b/docs/en_US/images/language_security.png new file mode 100644 index 000000000..21d1a55ad Binary files /dev/null and b/docs/en_US/images/language_security.png differ diff --git a/docs/en_US/images/package_code.png b/docs/en_US/images/package_code.png new file mode 100644 index 000000000..8c88cee72 Binary files /dev/null and b/docs/en_US/images/package_code.png differ diff --git a/docs/en_US/images/package_general.png b/docs/en_US/images/package_general.png new file mode 100644 index 000000000..3d3f0d49f Binary files /dev/null and b/docs/en_US/images/package_general.png differ diff --git a/docs/en_US/images/package_security.png b/docs/en_US/images/package_security.png new file mode 100644 index 000000000..044999834 Binary files /dev/null and b/docs/en_US/images/package_security.png differ diff --git a/docs/en_US/images/resource_group_general.png b/docs/en_US/images/resource_group_general.png index 475cf405d..ec5096229 100644 Binary files a/docs/en_US/images/resource_group_general.png and b/docs/en_US/images/resource_group_general.png differ diff --git a/docs/en_US/images/resource_group_sql.png b/docs/en_US/images/resource_group_sql.png index 0caf9ae7e..ac735dce1 100644 Binary files a/docs/en_US/images/resource_group_sql.png and b/docs/en_US/images/resource_group_sql.png differ diff --git a/docs/en_US/images/synonym_general.png b/docs/en_US/images/synonym_general.png new file mode 100644 index 000000000..c6ff56a50 Binary files /dev/null and b/docs/en_US/images/synonym_general.png differ diff --git a/docs/en_US/images/synonym_sql.png b/docs/en_US/images/synonym_sql.png new file mode 100644 index 000000000..49669c638 Binary files /dev/null and b/docs/en_US/images/synonym_sql.png differ diff --git a/docs/en_US/language_dialog.rst b/docs/en_US/language_dialog.rst new file mode 100644 index 000000000..061d11668 --- /dev/null +++ b/docs/en_US/language_dialog.rst @@ -0,0 +1,69 @@ +.. _language: + +******************* +The Language Dialog +******************* + +Use the CREATE LANGUAGE dialog to register a new procedural language. + +The *Language* dialog organizes the registration of a procedural language through the following dialog tabs: *General*, *Definition*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. + +.. image:: images/language_general.png + +Use the fields in the *General* tab to identify a language: + +* Use the drop-down listbox next to *Name* to select a language script. +* Use the drop-down listbox next to *Owner* to select a role. +* Store notes about the language in the *Comment* field. + +Click the *Definition* tab to continue. + +.. image:: images/language_definition.png + +Use the fields in the *Definition* tab to define parameters: + +* Move the *Trusted?* switch to the *No* position to specify only users with PostgreSQL superuser privilege can use this language. The default is *Yes*. +* When enabled, use the drop-down listbox next to *Handler Function* to select the function that will be called to execute the language's functions. +* When enabled, use the drop-down listbox next to *Inline Function* to select the function that will be called to execute an anonymous code block (DO command) in this language. +* When enabled, use the drop-down listbox next to *Validator Function* to select the function that will be called when a new function in the language is created, to validate the new function. + +Click the *Security* tab to continue. + +.. image:: images/language_security.png + +Use the *Security* tab to assign privileges and define security labels. + +Use the *Privileges* panel to assign privileges to a role. Click the *Add* icon (+) to set privileges for database objects: + +* Select the name of the role from the drop-down listbox in the *Grantee* field. +* Click inside the *Privileges* field. Check the boxes to the left of one or more privileges to grant the selected privilege to the specified user. +* Select the name of the role from the drop-down listbox in the *Grantor* field. The default grantor is the owner of the database. + +Click the *Add* icon (+) to assign additional privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the *Delete Row* popup. + +Use the *Security Labels* panel to define security labels applied to the function. Click the *Add* icon (+) to add each security label selection: + +* Specify a security label provider in the *Provider* field. The named provider must be loaded and must consent to the proposed labeling operation. +* Specify a a security label in the *Security Label* field. The meaning of a given label is at the discretion of the label provider. PostgreSQL places no restrictions on whether or how a label provider must interpret security labels; it merely provides a mechanism for storing them. + +Click the *Add* icon (+) to assign additional security labels; to discard a security label, click the trash icon to the left of the row and confirm deletion in the *Delete Row* popup. + +Click the *SQL* tab to continue. + +Your entries in the *Language* dialog generate a SQL command (see an example below). Use the *SQL* tab for review; revisit or switch tabs to make any changes to the SQL command. + +**Example** + +The following is an example of the sql command generated by user selections in the *Language* dialog: + +.. image:: images/language_sql.png + +"The example shown demonstrates creating the procedural language named *plperl*." + + +* Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation. +* Click the *Save* button to save work. +* Click the *Cancel* button to exit without saving work. +* Click the *Reset* button to restore configuration parameters. + + diff --git a/docs/en_US/managing_database_objects.rst b/docs/en_US/managing_database_objects.rst index 761c75396..c2ca43b87 100644 --- a/docs/en_US/managing_database_objects.rst +++ b/docs/en_US/managing_database_objects.rst @@ -6,7 +6,7 @@ Managing Database Objects pgAdmin 4 provides simple but powerful dialogs that you can use to design and create database objects. Each dialog contains a series of tabs that you use to describe the object that will be created by the dialog; the SQL tab displays the SQL command that the server will execute when creating the object. -To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the *Create* option for that object. For example, to create a new database, right-click on the *Casts* node, and select *Create Cast...* +To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the *Create* option for that object. For example, to create a new cast, right-click on the *Casts* node, and select *Create Cast...* Contents: @@ -26,10 +26,13 @@ Contents: fts_parser_dialog fts_template_dialog function_dialog + language_dialog materialized_view_dialog + package_dialog procedure_dialog schema_dialog sequence_dialog + synonym_dialog trigger_function_dialog type_dialog user_mapping_dialog diff --git a/docs/en_US/package_dialog.rst b/docs/en_US/package_dialog.rst new file mode 100644 index 000000000..845c5d64e --- /dev/null +++ b/docs/en_US/package_dialog.rst @@ -0,0 +1,56 @@ +.. _package: + +****************** +The Package Dialog +****************** + +Use the *Package* dialog to create a set of related database objects. + +The *Package* dialog organizes the development of a package through the following dialog tabs: *General*, *Code*, and *Security*. The *SQL* tab displays the SQL code generated by dialog selections. + +.. image:: images/package_general.png + +Use the fields in the *General* tab to identify the package: + +* Use the *Name* field to add a descriptive name for the package. The name of a new package must not match any existing package in the same schema. +* Store notes about the package in the *Comment* field. + +Click the *Code* tab to continue. + +.. image:: images/package_code.png + +Use the fields in the *Code* tab to specify the package contents and to provide implementation details: + +* Use the *Header* field to write the code that will call the database objects. +* Use the *Body* field to write the code that will implement functions, procedures, and other package contents. + +Click the *Security* tab to continue. + +.. image:: images/package_security.png + +Use the fields in the *Security* tab to to assign privileges to a role. Click the *Add* icon (+) to set privileges for the package: + +* Select the name of the role from the drop-down listbox in the *Grantee* field. +* Click inside the *Privileges* field. Check the boxes to the left of one or more privileges to grant the selected privilege to the specified user. +* Select the name of the role from the drop-down listbox in the *Grantor* field. The default grantor is the owner of the database. + +Click the *Add* icon (+) to assign additional privileges; to discard a privilege, click the trash icon to the left of the row and confirm deletion in the *Delete Row* popup. + +Click the *SQL* tab to continue. + +Your entries in the *Package* dialog generate a SQL command (see an example below). Use the *SQL* tab for review; revisit or switch tabs to make any changes to the SQL command. + +**Example** + +The following is an example of the sql command generated by user selections in the *Package* dialog: + +.. image:: images/package_sql.png + +The example shown demonstrates creating a package named *registration* that includes two functions and one procedure. + +* The *Info* button (i) is disabled for this dialog. +* Click the *Save* button to save work. +* Click the *Cancel* button to exit without saving work. +* Click the *Reset* button to restore configuration parameters. + + diff --git a/docs/en_US/synonym_dialog.rst b/docs/en_US/synonym_dialog.rst new file mode 100644 index 000000000..3a61f2533 --- /dev/null +++ b/docs/en_US/synonym_dialog.rst @@ -0,0 +1,43 @@ +.. _synonym: + +******************************** +The Synonym Dialog +********************************* + + +Use the *Synonym* dialog to substitute the name of a target object with a user-defined synonym. + +The *Synonym* dialog organizes the development of a synonym through the *General* tab. The *SQL* tab displays the SQL code generated by dialog selections. + +.. image:: images/synonym_general.png + +Use the fields in the *General* tab to identify the synonym: + +* Use the *Name* field to specify the alternate name for the target object. The name will be displayed in the *pgAdmin* tree control. +* Use the drop-down listbox next to *Owner* to select a role. +* Select the name of the local schema in which the synonym will reside from the drop-down listbox in the *Schema* field. + +In the definition panel, identify the target: + +* Use the drop-down listbox next to *Target Type* to select the the type of object the synonym references. +* Use the drop-down listbox next to *Target Schema* to select the name of the target schema. +* Use the drop-down listbox next to *Target Object* to select the name of the target object. + +Click the *SQL* tab to continue. + +Your entries in the *Synonym* dialog generate a SQL command (see an example below). Use the *SQL* tab for review; revisit the *General* tab to make any changes to the SQL command. + +**Example** + +The following is an example of the sql command generated by user selections in the *Synonym* dialog: + +.. image:: images/synonym_sql.png + +The example shown demonstrates creating a synonym that replaces *calendar_styleb* with *page-per-day*. + +* The *Info* button (i) is disabled for this dialog. +* Click the *Save* button to save work. +* Click the *Cancel* button to exit without saving work. +* Click the *Reset* button to restore configuration parameters. + +