Database options

Include certain optional groupings and documentation attributes. To access these database options:

From the Data sources and objects pane, select Database options

Database details

Include database summary information - This option will add a database information page in the documentation, which will include the following sections and information

Database information

Name
Owner
ID
Creation date
Current compatibility level
Status
Collation
Total size

Data space in use and reserved for use
Index space usage
Allocated and unused space
Full text search enabled
Primary file path
On disk sructure version
Recovery model

Database options

Access: members of db_owner, dbcreator or sysadmin
Access: read only
Access: single user
Cursor close on commit
Cursors in a batch are with local scope
Select into/bulkcopy

Settings: ANSI NULL default
Settings: auto close
Settings: auto create statistics
Settings auto shrink
Settings: auto update statistics
Settings: recursive triggers
Settings: torn page detection
Settings: use quoted identifiers
Truncate log on checkpoint

Data files and transaction log files

File name
Location
Space allocated
FileGroup

AutoGrow
Growth
Maximum file size

Include system obects - If this option is selected, ApexSQL Doc will document system objects like system stored procedures, functions, and system tables

Selecting this option can significantly slow the documentation process

DDL options

Include data definition language (DDL) script – This option will include the object creation script for each object

Selecting this option can significantly slow the documentation process

Highlight Transact-SQL keywords – This option will add syntax highlighting to the object creation scripts

Selecting this option can significantly slow the documentation process

ToC options

The ToC options allow customizing certain sections of the table of contents in the documentation

Include parameter/column names dictionary – This option will add a dictionary of parameters, and view and table columns, to the table of contents, organized alphabetically. This dictionary will include all parameters and columns from all chosen databases

Include objects by filegroup section – This option will add an index of all objects to the table of contents, organized by FileGroup

Include objects by owner/schema section – This option will add an index of all objects to the table of contents, organized by the object owners/schemas

Miscellaneous

Include documentation of procedure/function result sets – When this option is selected, ApexSQL Doc will document procedure and function result sets. Selecting this option will case extra calls to the database to define result sets

Selecting this option can significantly slow the documentation process

Use default owner/schema qualification in generated documentation – When this option is selected, ApexSQL Doc will qualify all object names with the schema or owner

Show sections with no relevent metadata to document – This option will force generated documentation to include all document sections, even when there is no information to display

Show nodes for object types that don’t exist in documented database – This option will cause the documentation to include pages for all object types, even if that object type doesn’t exist in the database

Extended properties

Include extended properties – This option will include all extended properties in the documentation

Extended property name for custom description – This drop-down menu allows specifying a common name for all the extended properties that will be documented