mirror of
https://github.com/pgadmin-org/pgadmin4.git
synced 2024-11-27 11:10:19 -06:00
133 lines
5.1 KiB
ReStructuredText
133 lines
5.1 KiB
ReStructuredText
.. _schema_diff_feature:
|
||
|
||
********************
|
||
`Schema Diff`:index:
|
||
********************
|
||
|
||
**Schema Diff** is a feature that allows you to compare objects between
|
||
two databases. Use the *Tools* menu to access Schema Diff.
|
||
|
||
The Schema Diff feature allows you to:
|
||
|
||
* Compare and synchronize the database objects (from source to target).
|
||
|
||
* Visualize the differences between database objects.
|
||
|
||
* List the differences in SQL statement for target database objects.
|
||
|
||
* Generate synchronization scripts.
|
||
|
||
|
||
**Note** - The source and target database servers must be of the same major
|
||
version.
|
||
|
||
Click on *Schema Diff* under the *Tools* menu to open a selection panel. Choose
|
||
the source and target servers, and databases that will be
|
||
compared. After selecting the objects, click on the *Compare* button.
|
||
|
||
You can open multiple copies of *Schema Diff* in individual tabs
|
||
simultaneously. To close a copy of Schema Diff, click the *X* in the
|
||
upper-right hand corner of the tab bar.
|
||
|
||
.. image:: images/schema_diff_dialog.png
|
||
:alt: schema diff dialog
|
||
:align: center
|
||
|
||
Use the :ref:`Preferences <preferences>` dialog to specify following:
|
||
|
||
* *Schema Diff* should open in a new browser tab. Set *Open in new browser tab* option to true.
|
||
* *Schema Diff* should ignore the whitespaces while comparing string objects. Set *Ignore whitespaces* option to true.
|
||
* *Schema Diff* should ignore the owner while comparing objects. Set *Ignore owner* option to true.
|
||
|
||
|
||
The *Schema Diff* panel is divided into two panels; an Object Comparison panel
|
||
and a DDL Comparison panel.
|
||
|
||
|
||
The Schema Diff Object Comparison Panel
|
||
========================================
|
||
|
||
In the object comparison panel, you can select the source and target servers
|
||
of the same major version, and databases to be compared. You can
|
||
select any server listed under the browser tree whether it is connected or
|
||
disconnected. If you select a server that is not connected then it will
|
||
prompt you for the password before using the server.
|
||
|
||
Next, select the databases that will be compared. The databases can be the
|
||
same or different (and within the same server or from different servers).
|
||
|
||
.. image:: images/schema_diff_compare_button.png
|
||
:alt: Schema diff compare button
|
||
:align: center
|
||
|
||
After you select servers, and databases, click on the
|
||
*Compare* button to obtain the *Comparison Result*.
|
||
|
||
.. image:: images/schema_diff_comparison_results.png
|
||
:alt: Schema diff comparison results
|
||
:align: center
|
||
|
||
Use the drop-down lists of Database Objects to view the DDL statements.
|
||
|
||
In the upper-right hand corner of the object comparison panel is a *Filter*
|
||
option that you can use to filter the database objects based on the
|
||
following comparison criteria:
|
||
|
||
* Identical – If the object is found in both databases with the same SQL statement, then the comparison result is identical.
|
||
|
||
* Different – If the object is found in both databases but have different SQL statements, then the comparison result is different.
|
||
|
||
* Source Only – If the object is found in source database only and not in target database, then the comparison result is source only.
|
||
|
||
* Target Only – If the object is found in target database only and not in source database, then the comparison result is target only.
|
||
|
||
.. image:: images/schema_diff_filter_option.png
|
||
:alt: Schema diff filter option
|
||
:align: center
|
||
|
||
Click on any of the database objects in the object comparison panel to
|
||
display the DDL Statements of that object in the DDL Comparison panel.
|
||
|
||
|
||
Schema Diff DDL Comparison Panel
|
||
================================
|
||
|
||
The *DDL Comparison* panel displays three columns:
|
||
|
||
* The first column displays the DDL statement of the object from the source database.
|
||
|
||
* The second column displays the DDL statement of the object from the target database.
|
||
|
||
* The third column displays the difference in the SQL statement of the target database object.
|
||
|
||
.. image:: images/schema_diff_DDL_comparison.png
|
||
:alt: Schema diff DDL comparison
|
||
:align: center
|
||
|
||
You can review the DDL statements of all the database objects to
|
||
check for the differences in the SQL statements.
|
||
|
||
Also, you can generate the SQL script of the differences found in the
|
||
target database object based on the SQL statement of the source database
|
||
object. To generate the script, select the checkboxes of the database
|
||
objects in the object comparison panel and then click on the *Generate Script*
|
||
button in the upper-right hand corner of the object comparison panel.
|
||
|
||
Select the database objects and click on the *Generate Script*
|
||
button to open the *Query Tool* in a new tab, with the difference
|
||
in the SQL statement displayed in the *Query Editor*.
|
||
|
||
If you have clicked on the database object to check the difference
|
||
generated in the *DDL Comparison* Panel, and you have not selected the
|
||
checkbox of the database object, pgAdmin will open the *Query Tool* in a new
|
||
tab, with the differences in the SQL statements displayed in the *Query Editor*.
|
||
|
||
You can also use the *Copy* button to copy the difference generated in
|
||
the *DDL Comparison* panel.
|
||
|
||
.. image:: images/schema_diff_generate_script_query_editor.png
|
||
:alt: Schema diff generate script query editor
|
||
:align: center
|
||
|
||
Apply the SQL Statement in the target database to synchronize the databases.
|