dbForge Documenter for MySQL

You are viewing an old version of this article. View the current version here.

dbForge Documenter for MySQL is a handy MySQL and MariaDB documentation tool that automatically generates documentation of an entire MySQL database in HTML, PDF, and MARKDOWN file formats. The tool allows users to customize the generated documentation up to their needs with help of a bunch of options and settings.

The key functionality of the tool includes the following features:

  • Database structure from A to Z dbForge Documenter for MySQL extracts an extensive database info about all MySQL objects, including their details, properties, SQL script and inter-object dependencies.
  • Rich customization options Documenter supports a selection of individual database objects and their properties that will be documented. The tool also contains a rich set of style templates and themes for fine-tuning of the document layout.
  • Support for multiple file formats dbForge Documenter for MySQL can generate documentation in the HTML, PDF, and MARKDOWN file formats. The documentation files generated in any of the formats is searchable.
  • Object annotations The description of specific database objects is read out from the COMMENT property of the self-described objects to which this property is attributed.
  • Navigation through documentation file Documenter for MySQL allows users search across the generated documentation for database objects. For instance, the tool highlights all items matching the text a user is looking for. Also, Documenter offers handy navigation throughout the documentation via the built-in breadcrumbs.
  • Automatic database documenting With support for the command line interface, dbForge Documenter for MySQL allows setting up automatic database documenting. In addition, the tool includes the option to create a command line execution file to run routine database documentation tasks in a single click.

Learn more about dbForge Documenter for MySQL at the product page


Comments loading...
Content reproduced on this site is the property of its respective owners, and this content is not reviewed in advance by MariaDB. The views, information and opinions expressed by this content do not necessarily represent those of MariaDB or any other party.