Entity Relationships Report

Entity Relationships Report light-weight shows how all content entity types, bundles and fields of your Drupal site are connected, as a simple entity relationship (ER) diagram in the Reports admin area.

On larger projects with many bundles and entity reference fields, it quickly becomes hard to see how everything fits together. This module draws that structure for you, so you can understand an existing site, explain it to others and plan changes .

Features

• ER diagram of your content model: every bundle is shown as an entity box listing its fields, with primary keys (PK) and foreign keys (FK) marked. Bundles are grouped by entity type.
• Relations in crow's foot notation: entity reference fields (including entity reference revisions, file and image fields) are drawn as lines showing whether a reference is optional or required, and single or multiple.
• Base fields on demand: show or hide base fields such as author, created or parent, including their relations.
• Filter entity types: choose which entity types are displayed, with select/unselect all.
• Arrange and save the layout: drag entity types into place and save the layout for everyone who uses the report.
• Zoom and pan: zoom buttons, Ctrl/Cmd + mouse wheel, pinch, keyboard shortcuts and "fit to view"; drag the background to pan.
• Highlighting: hover over an entity to highlight its relations.
• Minimalistic, no third-party libraries: built with plain HTML, CSS, SVG and vanilla JavaScript. Nothing is loaded from a CDN, so it also works on offline and locked-down environments.
• Themeable: overridable Twig templates, including per entity type template suggestions.

Typical use cases:

• Getting an overview when taking over or auditing an existing Drupal project.
• Onboarding new developers and site builders.
• Documenting and discussing the content model with clients and project managers.
• Planning changes to content types, paragraphs and reference fields.

Post-Installation

1. Enable the module at Administration > Extend.
2. Grant the restricted permission "View entity relationships report" to the roles that should see the report (Administration > People > Permissions). The report reveals the complete content model of your site, so only grant it to trusted roles. Users with this permission can also save the shared layout.
3. Open Administration > Reports > Entity relationships (/admin/reports/entity-relationships).

There is no configuration page. The diagram is generated automatically from your entity types, bundles and fields and updates whenever they change. Use the toolbar to show base fields, filter entity types, zoom, and save or reset the layout.

Additional Requirements

None. The module only requires Drupal core (11.1 or newer) and does not use any external libraries or APIs.

Recommended modules/libraries

• Admin Toolbar for quick access to the report through the Reports menu.
• Field UI (Drupal core) to adjust the fields and references you discover in the diagram.

Similar projects

• Entity Relationship Diagrams: an interactive diagram builder at Structure, where you add entities to the diagram yourself. It loads its JavaScript dependencies from a CDN. Entity Relationships Report shows the whole content model directly as a read-only report and needs no external libraries.
• Entity relationship diagram: generates diagrams with Graphviz, which must be installed on the server. Entity Relationships Report renders in the browser and needs no server software.
• Entity Tracer: traces entity references recursively as nested lists. Entity Relationships Report shows all relations at once as a diagram.
• Structure Map: documents entities and bundles in detail (permissions, display modes, field settings) rather than drawing their relations.
• The core Field list report (/admin/reports/fields) lists all fields in a table, without showing how bundles reference each other.

Supporting this module

Support DROWL's ♥ FOSS work on this module on OpenCollective!

Drupal and this module are FOSS. However, it takes dedicated people to develop and maintain. And they need YOU to give back!

We're committed to building and maintaining Drupal modules that benefit the entire community.

Supporting us on OpenCollective helps us continue to improve, innovate and contribute to Drupal's future. Every pledge makes a difference!

If this module has helped you, we would be very grateful for your donation to support its further development and maintenance.

Support our FOSS development ♥️

You can also speed up the development of features or bugfixes you'd love to see, by sponsoring and giving back!

Sponsor a feature or bugfix 🚀

Let's make Drupal even better, together!

Development proudly sponsored by German Drupal Friends & Companies:

webks: websolutions kept simple (https://www.webks.de)
and
DROWL: Drupalbasierte Lösungen aus Ostwestfalen-Lippe (OWL), Germany (https://www.drowl.de)