You are here

Troubleshooting schema-related problems

The Schema Difference Tool provides a way of identifying and troubleshooting problems in database schemas.

Such problems can sometimes arise when performing certain version upgrades or customized installations.


The Schema Difference Tool can be used when troubleshooting or examining the database schema for an repository. The tool has two main functions:

  1. Producing schema dumps as XML files.
  2. Validating a database schema.

Schema dumps were available in previous versions of Alfresco Community Edition. However, prior to the introduction of the Schema Difference Tool, the only way to judge the validity of the schema was to examine the file manually and compare schemas with simple text tools such as the Unix diff command. The Schema Difference Tool performs a certain amount of automatic comparison that removes much of the effort needed in making these comparisons.

If any changes are made to the database schema during server start-up (such as a fresh install) then the tool performs both schema dumping and validation as described. The dumps and validation are made both pre-upgrade (that is before the schema changes) and post-upgrade.

Definition of terms used

The terms given are used throughout the rest of this document.

Database object
A schema, sequence, table, column, index, primary key or foreign key.
Reference schema
The definitive representation of a repository schema for a given schema version on a vendor specific RDBMS. The reference schema is a model for what should be present in the database after installing or upgrading a repository to a particular version. A reference schema is presented in the same XML format as a schema dump. For example, a schema reference can be produced for MySQL on version 5025 of the repository schema.
Target schema
The database schema that will be compared and validated with respect to a reference schema. For example, if installing an repository from scratch, then the newly created schema will be a target schema for comparison against the appropriate reference schema.

Sending feedback to the Alfresco documentation team

You don't appear to have JavaScript enabled in your browser. With JavaScript enabled, you can provide feedback to us using our simple form. Here are some instructions on how to enable JavaScript in your web browser.