Announcement: You can find the guides for Commerce 7.5 and later on the new Elastic Path Documentation site. The Developer Center continues to support Commerce 6.13.0 through 7.4.1.Visit new site

Database Documentation

Database Documentation

Using SchemaSpy, a Java-based command-line interface tool, you can generate database schema documents from your database.

Generating Database Schema Documents

Warning: Before you start

You must have Graphviz installed on your machine. Graphviz is required in the generation of the table/view relationships graph.

To generate your Elastic Path database schema documents:

  1. Open the command prompt and navigate to <Elastic Path root>/liquibase/schema-documentation
  2. Execute the command below to run Maven's site cycle.
    mvn site
  3. Open a window to <Elastic Path root>/liquibase/schema-documentation/target/site/schemaspy
  4. With your favorite web browser, open index.html to view your schema documents.