SQL Server database objects that can be documented with dbForge Documenter

Documenter for SQL Server is your reliable helper in creating database documentation. The tool boasts advanced features for documenting SQL Server database objects in HTML, PDF, and Markdown formats.

It has a rich set of configuration options to meet even the most demanding project requirements. With the dbForge database documentation tool, you can also automate and schedule the generation of the database documentation.

In this topic, you'll learn what database objects dbForge Documenter can document. You can generate the documentation for one, several, and all the objects if necessary.

Aggregate function

The Document project has the following sections for an aggregate function:

• Description: displays the text that was added to the aggregation function with the MS_Description extended property
• Properties: includes the properties of the documented aggregate function
• Parameters: presents information about input parameters of the aggregate function and the returned result includes Name, Data Type, Length, and Description as a table
• SQL Script: provides the creation script of the documented aggregate function

If you document all the aggregate functions, the Document project will consist of two sections:

• Objects: shows the list of all the documented aggregate functions
• Sections To Include: contains sections that you can add to the documentation of the aggregate functions

Application role

The Document project includes such sections:

• Description: shows the text that was added to the application role with the MS_Description extended property
• Properties: provides the properties of the documented application role
• SQL Script: displays the creation script of the documented application role
• Depends On: presents the list of objects the documented application role depends on
• Used By: contains the list of objects that use the documented application role

In case you document all the application roles, you'll see the following sections:

• Objects: has the list of all the documented application roles
• Sections To Include: shows sections that you can add to the documentation of the application roles

Assembly

For an assembly, you can see these sections:

• Description: contains the text that was added to the assembly with the MS_Description extended property
• Properties: presents the properties of the documented assembly
• Method Signatures: displays information about method signatures by the connected assembly (DLL files) and its physical files (name and size) in the script
• Related Files: shows information about related files of the assembly in the table
• SQL Script: contains the creation script of the documented assembly
• Depends On: has objects the documented assembly depends on
• Used By: provides the list of objects that the documented assembly uses

The Document project includes two sections for all the selected assemblies:

• Objects: consists of the list of all the documented assemblies
• Sections To Include: includes sections that you can add to the assemblies documentation

Asymmetric key

There are the following sections for an asymmetric key in the Document project:

• Properties: displays the properties of the documented asymmetric key
• SQL Script: provides the creation script of the documented asymmetric key in the section
• Depends On: shows the list of objects the documented asymmetric key depends on
• Used By: contains the list of objects the documented asymmetric key is used by

If you document all the asymmetric keys, the Document project will display such sections:

• Objects: presents the list of all the documented asymmetric keys
• Sections To Include: has sections that you can add to the documentation of the asymmetric keys

Broker priority

The generated HTML document for a broker priority presents the following:

• Properties: contains the properties of the documented broker priority
• SQL Script: displays the creation script of the documented broker priority
• Depends On: shows the list of objects the documented broker priority depends on
• Used By: includes objects the documented broker priority is used by

If you document all the broker priorities, the Document project will show the following sections:

• Objects: presents the list of all the documented broker priorities
• Sections To Include: consists of sections that you can add to the documentation of the broker priorities

Certificate

There are the following sections in the Document project:

• Description: displays the text that was added to the certificate with the MS_Description extended property
• Properties: includes the properties of the documented certificate
• SQL Script: contains the creation script of the documented certificate
• Depends On: shows the list of objects the documented certificate depends on
• Used By: presents the list of objects that the documented certificate uses

If you document all the certificates, the Document project will look as follows:

• Objects: has the list of all the documented certificates
• Sections To Include: consists of sections that you can add to the certificates documentation

Contract

The Document project provides such sections for a contract:

• Properties: contains the properties of the documented contract
• Message Usages: displays information about the usage of the contract in messages
• Dependent Services: presents information about dependent services
• SQL Script: includes the creation script of the documented contract
• Depends On: shows the list of objects the documented contract depends on
• Used By: presents the list of objects the documented contract is used by

The generated HTML document for all the contracts displays two sections:

• Objects: has the list of all the documented contracts
• Sections To Include: provides sections that you can add to the contracts documentation

Database

The Document project for a database includes such sections:

• Description: displays the text that was added to the database with the MS_Description extended property
• Properties: contains the properties of the documented database
• Object Types: has objects related to the documented database
• Options: shows options of the documented database
• Database Files: presents files of the documented database
• Sections To Include: provides sections that you can add to the database documentation

When you select to document all the databases, you will see the following sections in the Document project:

• Folder name where the databases are located: contains the list of the documented databases in the section
• Sections To Include: includes sections that you can add to the databases documentation

Database role

The Document project for a database role displays:

• Properties: includes the properties of the documented database role
• Members: contains the list of members assigned to the documented database role
• SQL Script: presents the creation script of the documented database role
• Depends On: shows the list of objects the documented database role depends on
• Used By: consists of objects the documented database role is used by

If you select all the database roles to documented, then the Document project will display two sections:

• Objects: has the list of all the documented database roles
• Sections To Include: provides sections that you can add to the documentation of the database roles

Database trigger

The Document project for a database trigger represents such sections:

• Description: displays the text that was added to the database trigger with the MS_Description extended property
• Properties: includes the properties of the documented database trigger
• SQL Script: shows the creation script of the documented database trigger

If you select all the database triggers to document, then the Document project will display two sections:

• Objects: presents the list of all the documented database triggers
• Sections To Include: consists of sections that you can add to the documentation of the database triggers

Default

There are the following sections in the Document project for a default:

• Properties: shows the properties of the documented default
• SQL Script: presents the creation script of the documented default
• Depends On: contains objects the documented default depends on
• Used By: displays the list of objects the documented default is used by

If you select all the defaults to document, then the Document project will have such sections:

• Objects: includes the list of all the documented defaults
• Sections To Include: has sections that you can add to the defaults documentation

Event Notification

The generated HTML document for an event notification is as follows:

• Description: shows the text that was added to the event notification with the MS_Description extended property
• Properties: has the properties of the documented event notification
• SQL Script: contains the creation script of the documented event notification
• Event Types: displays the name of an event type that causes the event notification to execute
• Depends On: presents the list of objects the documented event notification depends on
• Used By: consists of the list of objects the documented event notification is used by

For all the event notifications, the Document project will include these sections:

• Objects: contains the list of all the documented event notifications
• Sections To Include: consists of sections that you can add to the documentation of the event notifications

Full-text catalog

The Document project contains such sections:

• Properties: consists of the properties of the documented full-text catalog
• Assigned Tables: displays the list of tables assigned to the documented full-text catalog
• SQL Script: includes the creation script of the documented full-text catalog
• Depends On: shows the list of objects the documented full-text catalog depends on
• Used By: has the list of objects the documented full-text catalog is used by

If you select to document all the full-text catalogs, there will be two sections:

• Objects: presents the list of all the documented full-text catalogs
• Sections To Include: shows sections that you can add to the documentation of the full-text catalogs

Full-text stoplist

In the generated HTML document, you can find such data in the sections:

• Properties: includes the properties of the documented full-text stoplist
• SQL Script: displays the creation script of the documented full-text stoplist
• Depends On: shows the list of objects the documented full-text stoplist depends on
• Used By: contains the list of objects the documented full-text stoplist is used by

For all the full-text stoplists, there will be two sections in the Document project:

• Objects: has the list of all the documented full-text stoplists
• Sections To Include: consists of sections that you can add to the documentation of the full-text stoplists

Message type

There are the following sections in the Document project for a message type:

• Properties: has the properties of the documented message type
• SQL Script: displays the creation script of the documented message type
• Depends On: shows the list of objects the documented message type depends on
• Used By: includes the list of objects the documented message type is used by

If you document all the message types, then the Document project will display the following sections:

• Objects: contains the list of all the documented message types
• Sections To Include: provides sections that you can add to the documentation of the message types

Queue

For a queue, such sections are listed:

• Description: displays the text that was added to the queue with the MS_Description extended property
• Properties: consists of the properties of the documented queue
• SQL Script: includes the creation script of the documented queue
• Depends On: has the list of objects the documented queue depends on
• Used By: contains the list of objects the documented queue is used by

The Document project has such sections for all the queues:

• Objects: shows the list of all the documented queues
• Sections To Include: consists of sections that you can add to the queues documentation

Remote service binding

In the generated HTML document of a remote service binding, you can find such a list of sections:

• Description: shows the text that was added to the remote service binding with the MS_Description extended property
• Properties: includes the properties of the documented remote service binding
• SQL Script: displays the creation script of the documented remote service binding
• Depends On: has the list of objects the documented remote service binding depends on
• Used By: consists of the list of objects the documented remote service binding is used by

If you select all the remote service bindings to document, then the list of sections will look shorter:

• Objects: presents the list of all the documented remote service bindings
• Sections To Include: shows sections that you can add to the documentation of the remote service bindings

Route

The Document project provides the following sections for a route:

• Description: presents the text that was added to the route with the MS_Description extended property
• Properties: has the properties of the documented route
• SQL Script: displays the creation script of the documented route
• Depends On: shows the list of objects the documented route depends on
• Used By: includes the list of objects the documented route is used by

If you select all the routes to document, you will be able to see two sections:

• Objects: provides the list of all the documented routes
• Sections To Include: consists of sections that you can add to the routes documentation

Rule

In the Document project, you can find such sections for a rule:

• Description: has the text that was added to the rule with the MS_Description extended property
• Properties: includes the properties of the documented rule
• SQL Script: displays the creation script of the documented rule
• Depends On: presents the list of objects the documented rule depends on
• Used By: contains the list of objects the documented rule is used by

If you document all the rules, then there will be two sections in the Document project:

• Objects: shows the list of all the documented rules
• Sections To Include: provides sections that you can add to the rules documentation

User-defined table type

The Document project displays such sections:

• Description: presents the text that was added to the user-defined table type with the MS_Description extended property
• Properties: consists of the properties of the documented user-defined table type
• SQL Script: includes the creation script of the documented user-defined table type
• Depends On: shows the list of objects the documented user-defined table type depends on
• Used By: provides the list of objects the documented user-defined table type is used by

If you select all the user-defined table types, then the Document project will contain such sections:

• Objects: has the list of all the documented user-defined table types
• Sections To Include: contains sections that you can add to the documentation of the user-defined table types

User

You can find the following sections in the Document project:

• Properties: provides the properties of the documented users
• Database Level Permissions: displays information about granted or denied database level permission on the table
• Owned Schemas: has the list of schemas owned by the user
• SQL Script: displays the creation script of the documented user
• Depends On: shows the list of objects the documented user depends on
• Used By: contains the list of objects the documented user is used by

When you select all the users to document, then you will see two sections:

• Objects: presents the list of all the documented users
• Sections To Include: includes sections that you can add to the documentation of the users

Scalar-valued function

In the Document project, you can see such sections:

• Properties: has the properties of the documented scalar-valued function
• Parameters: presents information about input parameters of the scalar-valued function and the returned result includes Name, Data Type, Length, and Description as a table
• SQL Script: displays the creation script of the documented scalar-valued function in the section

For all the scalar-valued functions, there will be the following sections in the Document project:

• Objects: shows the list of all the documented scalar-valued functions
• Sections To Include: contains sections that you can add to the documentation of the scalar-valued functions

Schema

The Document project displays the following sections for a schema:

• Properties: includes the properties of the documented schema
• SQL Script: has the creation script of the documented schema
• Depends On: shows the list of objects the documented schema depends on
• Used By: consists of the list of objects the documented schema is used by

If you select all the schemas to document, then the Document project will consist of such sections:

• Objects: presents the list of all the documented schemas
• Sections To Include: provides sections that you can add to the documentation of schemas

Server

You can find such sections in the Document project for a server:

• Databases: provides the list of databases of the documented server
• Properties: presents the properties of the documented server
• Settings: displays the list of settings of the documented server
• Sections To Include: contains sections that you can add to the server documentation

In case you select all the servers, then there will be visible two sections in the Document project:

• Objects: has the list of all the documented servers
• Sections To Include: consists of sections that you can add to the servers documentation

Service

The Document project provides such sections for a service:

• Properties: includes the properties of the documented service
• Contracts: shows information about the contracts used for the documented service
• Queues: displays data about queues
• Event Notifications: presents information about event notifications
• SQL Script: has the creation script of the documented service
• Depends On: consists of the list of objects the documented service depends on
• Used By: contains the list of objects the documented service is used by

If you document all the services, the Document project will display the following sections:

• Objects: provides the list of all the documented services
• Sections To Include: presents sections that you can add to the services documentation

Sequence

The Document project contains the following sections:

• Description: provides the text that was added to the sequence with the MS_Description extended property
• Properties: consists of the properties of the documented sequence
• SQL Script: displays the creation script of the documented sequence
• Depends On: includes the list of objects the documented sequence depends on
• Used By: shows the list of objects the documented sequence is used by

In case you select all the sequences to document, then the Document project will present such sections:

• Objects: has the list of all the documented sequences
• Sections To Include: contains sections that you can add to the sequences documentation

Stored procedure

The Document project includes the following sections:

• Description: presents the text that was added to the stored procedure with the MS_Description extended property
• Properties: has the properties of the documented stored procedure
• Parameters: displays data about stored procedure parameters such as Name, Data Type, Length, and Description as a table view
• SQL Script: provides the creation script of the documented stored procedure
• Depends On: consists of the list of objects the documented stored procedure depends on
• Used By: contains the list of objects the documented stored procedure is used by

If you document all the stored procedures, there will be two sections in the Document project:

• Objects: shows the list of all the documented stored procedures
• Sections To Include: includes sections that you can add to the documentation of the stored procedures

Symmetric key

The Document project displays the following sections for a symmetric key:

• Properties: presents the properties of the documented symmetric key
• SQL Script: shows the creation script of the documented symmetric key
• Depends On: provides the list of objects the documented symmetric key depends on
• Used By: contains the list of objects the documented symmetric key is used by

For all the selected symmetric keys, the Document project will contain such sections:

• Objects: presents the list of all the documented symmetric keys
• Sections To Include: includes sections that you can add to the documentation of the symmetric keys

Synonym

The Document project contains the following sections:

• Properties: displays the properties of the documented synonym
• SQL Script: presents the creation script of the documented synonym
• Depends On: consists of the list of objects the documented synonym depends on
• Used By: has the list of objects the documented synonym is used by

If you document all the synonyms, then there will be such sections in the Document project:

• Objects: shows the list of all the documented synonyms
• Sections To Include: contains sections that you can add to the synonyms documentation

Table

In the Document project, there are the following sections for a table:

• Properties: consists of the properties of the documented table
• Columns: displays information about the properties of the columns as a table view
• Indexes: shows data about the table indexes
• SQL Script: provides the creation script of the documented table
• Depends On: includes the list of objects the documented table depends on
• Used By: contains the objects that the documented table uses

If you select all the tables to document, then the Document project will present such sections:

• Objects: shows the list of all the documented tables
• Sections To Include: presents sections that you can add to the tables documentation

Table-valued function

The Document project displays the following sections:

• Properties: includes the properties of the documented table-valued function
• Parameters: shows data about function parameters such as Name, Data Type, Length, and Description as a table view
• Permissions: presents information about the object permission as a table view
• SQL Script: contains the creation script of the documented table-valued function
• Depends On: consists of the list of objects the documented table-valued function depends on
• Used By: provides the list of objects the documented table-valued function is used by

The Document project has such sections for all the selected table-valued functions:

• Objects: displays the list of all the documented table-valued functions
• Sections To Include: contains sections that you can add to the documentation of the table-valued functions

View

You can see such sections in the Document project:

• Description: shows the text that was added to the view with the MS_Description extended property
• Properties: consists of the properties of the documented view
• Columns: provides information about the properties of the columns as a table view
• Indexes: displays data about the view indexes
• SQL Script: includes the creation script of the documented view
• Depends On: presents the list of objects the documented view depends on
• Used By: has the list of objects the documented view is used by

If you document all the views, then you'll see two sections:

• Objects: includes the list of all the documented views
• Sections To Include: contains sections that you can add to the views documentation

User-defined data type

The Document project has such sections:

• Description: provides the text that was added to the user-defined data type with the MS_Description extended property
• Properties: has the properties of the documented user-defined data type
• SQL Script: includes the creation script of the documented user-defined data type
• Depends On: displays the list of objects the documented user-defined data type depends on
• Used By: consists of the list of objects the documented user-defined data type is used by

If you select all the user-defined data types to document, two sections will be displayed in the Document project:

• Objects: shows the list of all the documented user-defined data types
• Sections To Include: contains sections that you can add to the documentation of the user-defined data types

User-defined type

The Document project displays the following sections for a user-defined type:

• Description: presents the text that was added to the user-defined type with the MS_Description extended property
• Properties: includes the properties of the documented user-defined type
• SQL Script: has the creation script of the documented user-defined type
• Depends On: contains the list of objects the documented user-defined type depends on
• Used By: shows the objects that the documented user-defined type uses

In case you document all the user-defined types, in the Document project, you will see such sections:

• Objects: displays the list of all the documented user-defined types
• Sections To Include: consists of sections that you can add to the documentation of the user-defined types

XML schema collection

The Document project contains the following sections for an XML schema collection:

• Description: shows the text that was added to the XML schema collection with the MS_Description extended property
• Dependent Message Types: includes message types dependent on the Service Broker objects
• SQL Script: displays the creation script of the documented XML schema collection
• Depends On: consists of the list of objects the documented XML schema collection depends on
• Used By: presents the list of objects the documented XML schema collection is used by

If you select all the XML schema collections to document, then there will be two sections in the Document project:

• Objects: has the list of all the documented XML schema collections
• Sections To Include: contains sections that you can add to the documentation of the XML schema collections