Synopsis
Creates documentation for a specified schema.
Description
The Document task in an Azure DevOps database pipeline is typically used for generating documentation about the database. This could include details about the schema, tables, stored procedures, views, and other database components.
How to create the Document task
To create the Document task, add the dbForge DevOps Automation for SQL Server – Document task to the pipeline:
Customization options
Enter target database server. E.g. SERVERNAME\INSTANCENAME. For local default instance use ‘(local).’
Enter the target database name.
Select the Authentication method, either SQL Server authentication or Windows authentication.
Enter the login name to use for SQL Server authentication.
Enter the password to use for SQL Server authentication.
Specify the additional parameters for dbForge Documenter CLI.
Enter a path to the dbForge Documenter project file. The project file name and extension should be included in the path.
Control Options
Select to enable the task in your pipeline. If a task is disabled, it will be skipped during the pipeline execution.
Select to continue the pipeline running even if this task fails.
Specify the number of retries for this task that will happen in case of task failure.
Note
This requires agent version 2.194.0 or later. Not supported for agentless tasks.
Specify the maximum time, in minutes, that a task is allowed to execute before being canceled by server. A zero value indicates an infinite timeout.
Specify when this task should run. Choose Custom conditions to specify more complex conditions.
Here you can select from the following options:
Output Variables
Any changes to the reference name will require updates to downstream tasks that uses this reference name, a valid reference name can only contain ‘a-z’, ‘A-Z’, ‘0-9’ and ‘_’.