Data model diagrams in ApexSQL Doc graphically display database tables and their relationships using standard Entity-relationship notation
To include data model diagrams in the documentation, make sure Data model diagrams checkbox from Database options tab is checked before clicking the Generate button
The Data model section will be included in the generated documentation for each database table, containing the data model diagram for that table. Below is the example from AdvantureWorks2014 database documentation in .chm format (nonetheless, data model diagrams are also created in .html, .docx and .pdf file formats)
Upon clicking the provided hyperlink, the document will navigate to the page containing the data model for BusinessEntity table
Database table entities in data model diagrams
Every key property of the database table is graphically represented in data model, including:
Name and data type of the table columns, column value nullability (N), primary key columns (PK), foreign key columns (FK), and columns that are part of both primary and foreign key constraints (PFK)
Relationships between table entities in data model diagrams
Data model diagrams in ApexSQL Doc use established Entity-relationship notation to represent different types and cardinality of the table relationships. Also, every graphical representation of table relationships has a label on top of it displaying the name of that relationship in the database. Below are some of the most common examples
Non-identifying one-to-many relationship
Identifying one-to-many relationship
Identifying one-to-one relationship
Hierarchical layout is used to automatically arrange the diagram elements for the best overview of the tables and their relationships
Data model diagrams are also provided in ApexSQL Doc Command Line Interface, using the /oi:dm switch
For more information about documenting data model diagrams and automating the process of documentation please refer to the following link.
February 11, 2016
