Explore and Document MySQL and MariaDB Databases

dbForge Documenter for MySQL is a valuable tool for MySQL and MariaDB databases that helps automatically generate documentation of an entire database in HTML, PDF, and MARKDOWN file formats. A wealth of options allow users to fine-tune the created documentation.

Create MySQL documentation in several file formats automatically
Tailor the documentation to your needs with outstanding built-in options
Waste no time manually creating documentation and boost your efficiency
Adjust the layout of documentation with various themes for ease of reading
Gain an accurate picture of your database objects and their properties
Analyze inter-object dependencies and DDL code in a convenient interface
Find required database objects in the documentation as you start typing
Add and modify the description of database objects as you see appropriate

Features

Broad picture
of database structure

Documenter extracts extensive database information, including a broad spectrum of MySQL and MariaDB object types, their details, and properties, as well as inter-object dependencies and DDL codes.

The information about the following objects is available in the documentation:

owners
descriptions
properties
table and view columns
indexes and constraints
routine parameters
creation script
object dependencies

Broad picture of database structure in Documenter for MySQL

Rich customization features

Documenter supports a selection of individual database objects and their properties that will be documented. The tool contains a rich set of style templates and allows for changing documentation layout using various themes.

Variety of objects for documentation and a wide collection of themes within Documenter

Formats supported

The documenter gives a possibility to create documentation in a number of file formats, including HTML, PDF, and Markdown.

HTML is suited for databases to be published on the web.
PDF is good for distributing to various systems and devices.
Both HTML and PDF are searchable formats, which is especially convenient for large databases.
Markdown is perfect for being converted to multiple output formats

Extended properties support

The information about most of the database objects is extracted from the extended properties of the objects to which these properties are attributed.

The documentation tool allows editing an object description as well as adding it if the object description is not specified.

Extended properties support within dbForge Documenter for MySQL

Searchable documentation

The search for database objects across the created documentation is implemented through the search as you type principle.

As soon as you start typing the name of a required object in the search field, the Documentation tool highlights the matching text in the object tree. Additionally, with built-in hyperlinks you can also navigate throughout the documentation.

Search objects as you type with dbForge Documenter

Broad Compatibility Options

dbForge Documenter for MySQL is compatible with:

MySQL server versions 5.5-8.3
MariaDB server versions up to 11.4
Cloud services: Amazon RDS, Amazon Aurora, Google Cloud, Oracle MySQL Cloud, Alibaba Cloud
Security connections: Secure Sockets Layer (SSL), Secure Shell (SSH), HTTP Tunneling, PAM Percona

Explore Examples

Study example documentation generated by dbForge Documenter for the AdventureWorks and Sakila sample databases and see what the tool is capable of.

Sakila HTML Documentation

Sakila PDF Documentation

Adventure Works PDF Documentation

Adventure Works HTML Documentation

Takes part in DevOps Automation

Use Data Compare along with dbForge DevOps Automation for SQL Server to extend DevOps practices to SQL Server databases. The solution helps optimizing productivity, reducing database release costs, and making the overall workflow consistent and safe.

Unveil benefits