The Document task
Synopsis
Creates documentation for a specified schema.
Description
The Document task generates documentation about the database. This could include details about the schema, tables, stored procedures, views, and other database components.
Create the Document task
1. Click Add a task to Agent job.
2. In the search box, enter the extension name, for example, dbforge.
3. Select dbForge DevOps Automation for SQL Server – Document and click Add.
4. Specify the location of your database source project.
5. Specify the server name, database name, and connection parameters.
6. To verify the settings, click Save & queue.
7. Open the pipeline execution log to verify the configuration.
Customization options
The table provides a list of options you can customize for the Document task.
| Name | Description |
|---|---|
| SQL Server | Enter the target database server, for example, SERVERNAME\INSTANCENAME. For a local default instance, use (local). |
| Database | Enter the target database name. |
| Authentication method | Select the authentication method. |
| User Name | Enter the login name you want to use for the SQL Server authentication. |
| Password | Enter the password you want to use for SQL Server authentication. |
| Additional options | Specify the additional parameters for the Documenter command-line interface (CLI). |
| ProjectFile | Enter the full path to the documentation project file. |
Control options
The table provides a list of options you can configure for the Document task.
| Name | Description |
|---|---|
| Enabled | Select to turn on the task in your pipeline. If the task is turned off, it will be skipped during the pipeline execution. |
| Continue on error | Select to continue the pipeline running even if this task fails. |
| Number of retries if task failed | 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. |
| Timeout | 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. |
| Run this task | Specify when this task should run. Select Custom conditions to specify more complex conditions. The available options are:
|
Output variables
The table provides output variables you can configure for the Document task.
| Name | Description |
|---|---|
| Reference name | Any changes to the reference name will require updates to downstream tasks that use this reference name, a valid reference name can only contain a-z, A-Z, 0-9 and _. |