Classical database documentation tools analyze the database and create thereof a
documentation of tables, columns, constraints and other database properties or
artefacts. However, this is often not helpful. It lacks meaningful descriptions, the context, business relevance and an overall understanding of
the application.

Japedo goes beyond that – it documents the complete persistence layer of any Java application that uses Java Persistence API.


- Tables, views, columns, constraints, indexes and their properties and inter-relations
- The corresponding Java entities, types, persistent fields and relevant properties.
- The linkage between tables and entities, between columns and fields and between
   table constraints and entity inter-relations.
- A single-source description of database and JPA artefacts based on JavaDoc.

Tutorial and Demo

This 12 min tutorial video shows what Japedo finds out about your application and database, how it is presented and and how to use and navigate in the GUI.

Now that you know how Japedo documentation works its time for a real demo where you can click around and find out yourself

(The sources and SQL for the demo can be downloaded here)


Easy To Use

You only have to provide your application, the source files and the database connection. The documentation is just one click away.

Single Source Documentation

Documentation for domain objects, JPA entities and database tables.

Direct Linkage

Connects your database and JPA artefacts

Show Column Value Restrictions

There are much more restrictions on columns than nullable or not.

Primary Key Algorithms

Show which algorithm generates your IDs and primary keys

Single Source Description

Describe your database items and persistent types in one place

Column and Table types

Gather additional information from the persistence application

Relations and Multiplicy

Examines relations between entities and tables. It also shows multiplicies between these elements.


Easy integration with Japedo Maven Plugin

Consistency checks

Check for consistency, find flaws and bugs in persistence implementation

Graphical Representation

Complete graphical representation of persistent class and table relations


Sophisticated search with auto-completion for tables, columns, indexes, constraints, classes, attributes