Chapter 5. Root Schema Actions
Prev | Part VII. Kodo Development Workbench Guide | Next

## Chapter 5. Root Schema Actions

These actions represent actions that operate on the database-wide level, such as synchronizing the actual database with the virtual one in Kodo Workbench, and importing / exporting schema information from file.

## 5.1. Run SchemaTool

This will provide a front-end to Kodo's Schema Tool. This tool will allow one to update your actual database with the one stored in Kodo Workbench.

The dialog that appears when the action is selected has four major elements. The first two select which action you want to take. While these correspond to those of Schema Tool, they are listed to illustrate what this means in Kodo Workbench:

- `Add` - This will cause Kodo Workbench to only add to the existing database schema. Thus objects that are in Kodo Workbench's schema will be added to the database. However objects in the database but not in Kodo Workbench will be left alone.

- `Refresh` - The Schema Tool will add objects that are in Kodo Workbench's schema that are abset in the database. In addition, components that appear in the database that are not in Kodo Workbench's will be removed. This will cause Kodo Workbench and the actual database schema to become totally synchronized.

- `Create` - The Schema Tool will execute the SQL to recreate Kodo Workbench's schema in the database, irregardless of the current existing schema. This is best used when initializing a database.

- `Retain` - The Schema Tool attempt to drop all components in the database that are not present in Kodo Workbench's schema. This will effectively trim the actual database of unnecessary columns and tables.

- `Drop` - The Schema Tool will drop all components that are currently in Kodo Workbench's schema from the database.

The last two options control the details of the Schema Tool's actions which corresponding to the matching command line option. `Ignore Errors?`, when checked, will cause the SchemaTool to ignore any errors that occur in the schema manipulation process. `Drop Unused Tables?` checkbox will tell the SchemaTool to drop tables that appear to be unused.

Prev | Up | Next
4.8. Visualize Mapping | Home | 5.2. Refresh Schema From DB