Database Refresh Wizard

The Database Refresh Wizard updates multiple object definitions simultaneously.

This wizard:
  • Detects changes made to your database.
  • Updates a Data Source to reflect those changes.
  • Allows you to apply additions, renames, and field changes to multiple/all Database Schemas and Adapters that reference the Data Source.
  • Applies deletions to Data Sources and Database Adapters.
  • Does not apply deletions to Database Schemas.
Note: If you previously deleted a table from a Database Schema and are applying an update to that table via the Database Refresh Wizard, the table will not be automatically inserted in the Schema. If the missing table is now needed in the Schema, you must manually add the table to the Database Schema.
Note: Database Adapters do not directly reference column data. Therefore the Database Wizard does not apply any column edits to Database Adapters.

Applying Additions

The Database Refresh Wizard displays new table and column additions to your database and gives you the option to click and drag the new tables into each Database Schema that references that Data Source. The new tables and contained columns will be available as nodes in the updated Schemas.

You can drag a new table to place it within a Schema, within a different table, or within itself (a like-named table). If you place a new table within a like-named table, Clarify will add a suffix to the name, as table names must be unique.

When a table is added to a Schema, all its columns are automatically added as well. Those tables and columns are then available in any Rulesets that reference the updated Schemas.

By extension, Database Adapters that reference those Schemas will automatically be updated. Clarify will add new tables to the Database Adapters' Data Bindings section. It will not add the new table to any Interactions.

Note: You must manually drag the tables into the Schemas if you want them to appear. If you do not manually specify which Schemas you want to update, the Wizard will not make any Schema changes.

Applying Edits

The Wizard displays edits, such as column data types and lengths, and automatically applies them to your Schemas. There is no need to click and drag to apply edits to Schemas.

An edit icon on a table signifies that a column within it has changed.

Applying Renames

The Wizard displays renamed tables and columns as deletions and additions. You must select (Control+click) both tables (original and renamed) and click the Rename Table/Column button to instruct Clarify to treat them as a rename. Once you do, any column additions, deletions, or edits are displayed beneath the renamed table. Select any other embedded renamed columns one pair at a time and press the Rename button to apply further renames.

The Wizard applies renames to the Data Source. It applies table renames to the Data Bindings section of Database Adapters, but does not change any existing Interactions.

The Wizard does not apply the rename to Schemas. Although the rename is not reflected in the Schema and Ruleset, all Rules will continue to function correctly.

Note: If you want the rename applied to any Schemas, you will have to go into those Schema manually and rename the tables and columns, then go into any Rulesets that reference those Schemas and redefine the Rules that use those nodes.

Applying Deletions

If the Wizard detects a deletion, it will remove the table or column from the Data Source. Clarify also removes the table from the Database Adapter's Data Bindings section and removes any references to them from the Interactions. If an interaction only has one binding, and that binding has been deleted, the entire interaction will be deleted.

The Database Refresh Wizard will not give you the option to delete a table or column from any Schemas.

Therefore, when deleting from a Data Source, if you want the corresponding tables or columns deleted from the Database Schema and dependent Rulesets, you must open the editors and do it manually.

In Summary

The Database Refresh Wizard can... Data Source Database Adapter Bindings Database Adapter Interaction Database Schema
Add a table to a... Yes Yes No Yes
Add a column to a... Yes Not applicable Not applicable Yes
Edit a table in a... Not applicable Not applicable Not applicable Not applicable
Edit a column in a... Yes Not applicable Not applicable Yes
Replace/Rename a table in a... Yes Yes No The name will not change, but Schema will move data correctly.
Replace/Rename a column in a... Yes Not applicable Not applicable The name will not change, but Schema will move data correctly.
Delete a table from a... Yes Yes Yes No
Delete a column from a... Yes Not applicable Not applicable No