KS DB Merge Tools logo KS DB Merge Tools
Documentation
MssqlMerge logo for SQL Server
aka MssqlMerge
KS DB Merge Tools for Oracle logo
KS DB Merge Tools for MySQL logo
KS DB Merge Tools for PostgreSQL logo
KS DB Merge Tools for SQLite logo
AccdbMerge logo
KS DB Merge Tools for Cross-DBMS logo

Home Tab

  • Opened from: N\A (always shown, default application tab)
  • Applicable tab-specific toolbar actions:
    • Refresh object definitions and diff results
    • Export to Xlsx or Json
    • Generate automation script stub for schema changes summary (with LogTo(), DbOpen() and BatchObjectsDiff() statements relevant for the current databases)
    • Copy selection to clipboard
    • Show all, new and changed, new, changed objects
  • Applicable object types: all

That's the initial application tab. It is used to open databases and to get a summary about all database objects. Note that it does not provide information about data/content changes, only about object definitions.

for SQL Server, home tab

Tab is splinted in two parts, each of them represents a database being compared. Each part shows name and server name of the loaded database and allows the following actions:

  • Open database - opens Open database(s) dialog to load database object definitions to the given side
  • Open database from connection string in clipboard - you can copy database connection string and then open that database here using this command.
  • Open database from *.msdbs - opens the standard file open dialog to specify *.msdbs file and opens/reloads database object definitions from the database described in that file
  • Refresh - reload currently loaded database - update its definitions and re-compare with other side
  • click on object type name: Opens object list tab for the given object type (all objects)
  • click on object count: Opens object list tab for the given object type filtered to objects representing this count
  • small batch data diff buttons : for tables and views you can open batch data diff tab filtered for tables or views respectively

Vertical toolbar between two panels contains toggle buttons to show/hide table-dependant and view-dependant object types:

  • Show foreign keys
  • Show table and view indexes
  • Show table and view triggers
  • Show table change tracking

Note that some object types can be marked with MERGE NEW ONLY. It means that you can't merge existing objects as a single merge action - it is either not supported at all (no corresponding TSQL ALTER statement) or DROP & CREATE scenario can be blocked by dependent objects. You can try to DROP and then import such objects as a new, but this may require additional deletions of dependent objects of different object types (for example delete stored procedures depending on the given user-defined table type). In some cases this is done to pay your attention that you're not altering something, but instead it is going to be dropped completely.

At the bottom there are two collapsible sections: Recent databases and Diff profiles.

Recent databases section showing last file pairs that were opened. Note that if you're running multiple application instances in parallel then one application can overwrite recent files data saved by another application instance. Maximum number of recent pairs is 10 for Standard and 3 for Free. Each file pair has the following actions:

  • Open both databases
  • Open this database in the left panel
  • Open this database in the right panel

Diff profiles section showing the list of bound diff profiles. Diff profile contains a list of preset custom mappings and queries. If 'Diff profiles' section is expanded, then it has two actions to add profile:

  • Add new profile - Create a new (empty) diff profile file and bind it to application
  • Open existing profile - Open some existing diff profile file and bind it to application

Each bound diff profile has the following columns and actions:

  • Profile - full path of the diff profile file
  • Status of the diff profile. It can be:
    • Not loaded - just a bound profile presented in list
    • Not loaded (some error text) - there was an attempt to load this profile but it has failed with the mentioned error
    • Loaded (number of mappings and queries) - it is a loaded active profile. Its mappings are automatically applied for corresponding data diff operations and it can be used to save new mappings and queries. Loaded status represents a hyperlink action which opens Diff profile editor tab
  • Load on start - If enabled, profile is auto-loaded on application start. Only one profile in the list can be selected to load on start. If we select any profile, any other selected profile is unselected.
  • Load profile action, also represents that profile is not loaded. Only one profile from the list can be loaded. If we load any profile, any other loaded profile is unloaded
  • Unload profile action, also represents that profile is loaded. Profile mappings are no longer applied for further data diff actions. Diff profile editor tab is closed if it was opened. Any related Query result diff tab remains opened, but becomes no longer related to the diff profile
  • Show in folder - opens windows exlorer with folder containing diff profile file
  • Delete from list - unbind diff profile and therefore remove it from the diff profile list. This action does not remove the file itself. If profile was loaded, then it is made unloaded first.

Free version limitations:

  • Reduced number of loaded and shown object types: only Schemas (MERGE NEW ONLY), Table definitions (MERGE NEW ONLY), Views, Stored procedures and Functions
  • Batch data diff buttons are not available
  • Command from conn. str. in clipboard is not available
  • No Excel export
  • No vertical toolbar actions to show table-dependant and view-dependant object types
  • 3 items in the Recent projects list
  • No Diff profiles

Last updated: 2024-10-21