New-DevartDatabaseDocumentation

Synopsis

Creates documentation for a specified schema.

Description

The cmdlet creates documentation for a specified schema.

Syntax

New-DevartDatabaseDocumentation -Connection <object> -Output <string> [-AdditionalOptions <string>] [-Format <DocumentationFormat>] [-Path <string>] [-ProjectFile <string>] [<CommonParameters>]

Parameters

-Connection

Specifies the server connection for the database to be documented.

-Connection <object>
Property Default value
Required True
Position Named
Default value -
Accept pipeline input False
Accept wildcard characters False

-Path

Specifies the destination directory for documentation.

-Path <string>
Property Default value
Required False
Position Named
Default value -
Accept pipeline input False
Accept wildcard characters False

-Output

Specifies an output file name for PDF documentation or folder name for HTML or Markdown documentation.

-Output <string>
Property Default value
Required True
Position Named
Default value -
Accept pipeline input False
Accept wildcard characters False

-ProjectFile

Specifies a project file with a .ddoc extension.

-ProjectFile <string>
Property Default value
Required False
Position Named
Default value -
Accept pipeline input False
Accept wildcard characters False

-AdditionalOptions

Specifies additional options for generating documentation.

-AdditionalOptions <string>
Property Default value
Required False
Position Named
Default value -
Accept pipeline input False
Accept wildcard characters False

For more information about additional options, see Command-line options.

-Format

Specifies the documentation format.

-Format <DocumentationFormat>
Property Default value
Required False
Position Named
Default value Html
Accept pipeline input False
Accept wildcard characters False

Common parameters

<CommonParameters>

This cmdlet supports these common parameters:

  • Verbose – Provides detailed output about the command operation.
  • Debug – Provides debugging information.
  • ErrorAction – Specifies how to respond to errors.
  • ErrorVariable – Stores error messages in a variable.
  • WarningAction – Specifies how to respond to warnings.
  • WarningVariable – Stores warning messages in a variable.
  • InformationAction – Specifies how informational messages are handled.
  • InformationVariable – Stores informational messages in a variable.
  • OutBuffer – Controls the number of objects buffered before output.
  • PipelineVariable – Stores the current pipeline object in a variable.
  • OutVariable – Stores output objects in a variable.

For more information, see About Common Parameters.

Output

System.Boolean (returns true on success and false otherwise)

System.Boolean returns:

  • true if the operation was successful.
  • false if the operation failed.

Example

$documenterResult = New-DevartDatabaseDocumentation -Connection $connection -ProjectFile "DatabaseName(MsSqlServer).ddoc" -Output "C:\Report\" -Format HTML

Related links

For a complete list of command-line options, see Command-line switches.