pgadmin4/docs/en_US/synonym_dialog.rst
Dave Page 8f1f04e5f3 Major doc cleanup:
- Reformat source so it's wrapped.
- Standardise markup.
- Center images.
- Restructure in various places to improve the indexing.
- Remove duplicated Query Tool toolbar descriptions.
- Ensure the structure works in both HTML and LaTeX.
2019-03-08 15:29:05 +00:00

50 lines
1.5 KiB
ReStructuredText

.. _synonym_dialog:
***********************
`Synonym Dialog`:index:
***********************
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
:alt: Synonym dialog general tab
:align: center
Use the fields in the *General* tab to identify the synonym:
* Use the *Name* field to specify the name of synonym. The name will be
displayed in the *pgAdmin* tree control.
* Select the name of the 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 referenced by the synonym.
* Use the drop-down listbox next to *Target Schema* to select the name of the
schema in which the object resides.
* Use the drop-down listbox next to *Target Object* to select the name of the
object referenced by the synonym.
Click the *SQL* tab to continue.
Your selections and entries in the *Synonym* dialog generate a SQL command.
.. image:: images/synonym_sql.png
:alt: Synonym dialog sql tab
:align: center
The example creates a synonym for the *emp* table named *emp_hist*.
* Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters.