ApexSQL Doc Command Line Interface (CLI) switches

Applies to
ApexSQL Doc

Summary
This article explains the ApexSQL Doc CLI switches, and their usage through the examples.

Description

Using the CLI in ApexSQL Doc allows you to set the documenting process for SQL databases, SSIS packages, SSAS cubes, SSRS items and automate the documenting process. Using an argument file or a project file allows you to save the settings into one of these files and run it in the CLI.

Connection switches

/dbesInclude specific database engine servers and databases
Format: server1.database1.database2[:user[.password]]
/ispsInclude specific Integration services packages from the package store
Format: services1:SQL2014.package1.package2[:password]
/asdbInclude specific Analysis services database engine servers and databases.
Format: server1.database1.database2[:user[.password]]
/pfsInclude specific package files from the file system
Format: file1:[password]
/sspInclude specific SQL Server packages.
Format: server1.user.password:package1.package2
Quick tip icon

Quick tip:

SQL Server or Integration Service name can be: servername/servicename or [ipaddress])

/edTreat databases as an exclude list.
/edbesSpecifies server and exclude database list.
Format: server1.database1.database2…databaseN[:user[.password]]…serverK.database1.database2…databaseM[:user[.password]]
Note: server can be either servername or [ipaddress]
/eispsSpecifies Integration services and exclude package list
Format: service1[:SQL2005|SQL2008|SQL2012|SQL2014].package1.package2…packageN …serviceK[:SQL2005|SQL2008|SQL2012|SQL2014].package1.package2… packageM
Note: services can be either services name or [ipaddress]
/easdbSpecifies Analysis services server and exclude SSAS database list.
Format: server1.database1.database2…databaseN[:user[.password]]… serverK.database1.database2…databaseM[:user[.password]]
Note: server can be servername or [ipaddress]
/esspSpecifies SQL Server and an exclude package list.
Format: server1[.user[.password]:package1.package2…packageN
Note: server can be either server name or [ipaddress]
/rsffInclude Reporting Services items from the file system
Format: ssrsitempath1.ssrsitempath2 … ssrsitempathN
/ersffExclude Reporting Services items from file
Format: ssrsitempath1.ssrsitempath2 … ssrsitempathN
/rsfnInclude Reporting Services items from the Native web service.
Format: [WebService].[folder]
Note: specifying a folder is optional
/ersfnExclude Reporting Services items from Native web service.
Format: [WebService].[folder]
/rsfsInclude Reporting Services items from the SharePoint web service.
Format: [WebService].[folder].[user].[password]
/ersfsExclude Reporting Services items from SharePoint web service.
Format: [WebService].[folder].[user].[password]

Export options

/iflThe intermediary files location.
Note: If the switch is omitted, the default directory is used
/ifkKeep intermediary files
Quick tip icon

Quick tip:

Using this switch allows you to keep the intermediary files and edit them after the documentation is finished. Once edited, those files can be compiled manually to CHM. If the switch is omitted, the intermediary files will be deleted after the documentation is created.
Note: This applies only when the output format is set to chm

/ctiSpecifies the chm compilation timeout in minutes.
Note: the default value is 600 seconds (10 minutes)
/odSpecifies the output directory.
Note: if the switch is omitted, the current directory is used
/onSpecifies the filename template for CHM files, or the directory name template for the HTML documentation. A full or relative path cannot be used here.
Note: If the switch is omitted ‘{servername}.{databasename}’ format is used
/of

Specifies the output file format CHM, HTML, Doc, Docx and PDF

CHM [chm] – CHM output file format
HTML [htm] – HTML output file format
Doc [doc] – Doc output file format
Docx [docx] – Docx output file format
PDF [pdf] – PDF output file format

Note: CHM file format will be used if the switch is omitted

Specific options

/incInclude specific objects specified via regular expressions.
Format: Server1.Database1.TypeConstant1: Expr1
(TypeConstant is a bitwise value of the object type)
/excExclude specific object specified via regular expressions.
Format: Server1.Database1.TypeConstant1: Expr1
(TypeConstant is a bitwise value of the object type)
/sincInclude specific server objects specified via regular expressions. Format: Server1.TypeConstant1:Expr1
(TypeConstant is a bitwise value of the object type)
/sexcExclude specific server objects specified via regular expressions. Format: Server1.Typeconstant1:Expr1
(TypeConstant is a bitwise value of the server object type)
/dcDocument comments.
Note: if the switch is omitted, an empty string will be used
/sfSpecifies the style sheet file path.
Note: if the switch is omitted, default path will be ‘Templates\style.css’
/dfSpecifies date format.
Note: if the switch is omitted mm/ss/yyyy format will be used
/csMake sections collapsible

DEFAULT – Default
NONE – None

/oiOptional items

ExtProperties [e] – include the “Extended properties” section
ResultSet [s] – include the “Result Set” section
Glossary [g] – include the “Glossary” section
ShowDefaultOwner [do] – use the default owner/schema qualification in the generated documentation
DDL [dd] – include the “DDL” section
DataModels [dm] – include the ‘Data model’ section
None [n] – None of the available options
Default [d] – Default options (Extended properties, Result set, Glossary, DDL)

/piPerformance intensive items

SyntaxHighlighting [h] – include the “Syntax highlighting” section
GrDeps [dp] – include the “Graphical dependencies” section
Dependencies [de] – include the “Dependencies” section
ExplicitlyParse [ep] – explicitly parse the database
StatisticalDataAnalysis [sd] – include the “Statistical data analysis” section
IncludeSystemObjects [is] – include system objects in processing
DDL [dd] – include the “DDL” section
ResultSet [s] – include the “Result Set” section
Bookmarks [b] – include bookmarks and hyperlinks
ExtraAttributes [ea] – Include “Data size KB”, “Index size KB”, “Creation date” in “Tables”, and “Default”, “IsGUID”, “SPARSE”, “Computed value” in “Columns” documentation.
None [n] – None of the available options
Default [d] – Default (SyntaxHighlighting, Dependencies, DDL and Resultset)

/grAdditional groupings

GroupOwner [o] – include the “Owner” grouping
GroupFilegroup [f] – include the “Group filegroup” grouping
GroupPartitionScheme [p] – include the “Group partition scheme” grouping
ShowWordToc [t] – Include TOC in Word documentation
None [n] – None of the available options
Default [d] – Default (GroupOwner, GroupFilegroup, GroupPartitionScheme)

/emEmpty items

ShowEmptySections [s] – include the “Show empty sections” section
ShowEmptyNodes [nd] – include the “Show empty nodes” section
ShowSrvNode [ssn] – show the Server node as the index one when documenting in .chm
ShowExternalProperties [exp] – include the ‘Graphical dependencies’ section
None [n] – None of the available options
Default [d] – Default (ShowEmptySections, ShowEmptyNodes)

/dbdDatabase details

DatabaseSummaryInfo [ds] – include database summary information
None [n] – None of the available options
Default [d] – Default (DatabaseSummaryInfo)
Note: arguments can be combined

/srdServer details

Properties [sp] – include the “Server info” section
None [n] – None of the available options
Default [d] – Default (Properties)

/isdIntegration Service details

ConnectionManagers [cm] – include the “Connection managers” section
ControlFlowDiagrams [cfd] – include control flow diagrams
DataFlowDiagrams [dfd] – include data flow diagrams
EventHandlers [eh] – include the “Event Handlers” section
Executables [ex] – include the “Executables” section
LogProviders [lp] – include the “Log providers” section
PrecedenceConstraints [pc] – include the “Precedence constraints” section
Variables [vr] – include the “Variables” section
SystemVariables [sysvr] – include system variables
IncludePackageSource [ps] – Include package source (*.dtsx)
None [n] – None of the available options
Default [d] – Default (ConnectionManagers, EventHandlers, Executables, LogProviders, PrecedenceConstraints and Variables)

/asdAnalisys Services details

DataSources [das] – include “Data sources” section)
DataSourceViews [dsv] – include “Data sources views” section
Cubes [cub] – include “Cubes” section
Dimensions [dim] – include “Dimensions” section
MiningStructures [ms] – include “Mining structures” section
Connections [con] – include “Connections” section
Tables [tb] – include “Tables” section
Perspectives [per] – include “Perspectives” section
Roles [rol] – include “Roles” section
MultidimensionalRoles [mrol] – include “Multidimensional roles” section
None [n] – None of the available options
Default [d] – Default (DataSources, DataSourceViews, Cubes, Dimensions, MiningStructures, MultidimensionalRoles, Connections, Tables, Perspectives and roles)

/prSpecifies the project file path
/iSpecifies the selection profile path
Note: if the switch is omitted, all objects are selected
/oSpecifies the bitwise set of object types
Note: if the switch is omitted, all object types will be processed
/soSpecifies the bitwise set of server object type
Note: if the switch is omitted, all server object types will be processed
/teTreat the selection profile/selection in a project file as an exclude list
/tseTreat the server selection profile/selection in a project file as an exclude list
/ttSpecifies the documentation title template.
Note: if the switch is omitted, default tile will be ‘Database Documentation: [{servername}].[{databasename}]’
/epSpecifies the main extended property name.
Note: if the switch is omitted, the ‘MS_Description’ is used
/clSpecifies the copyright link.
Format: protocol://address/
Note: if the switch is omitted, ‘http://’ will be used
/ctSpecifies the copyright text.
Note: if the switch is omitted, ‘© – All Rights Reserved’ will be used
/utSpecifies top custom text.
Note: ‘ if the switch is omitted, ‘<DIV ALIGN=CENTER><B><FONT COLOR=”Gray”>Top Custom Text</FONT></B> </DIV><HR SIZE=”1″> will be used
/btSpecifies bottom custom text. ‘<HR
Note: ‘ if the switch is omitted, ‘<DIV ALIGN=CENTER><B><FONT COLOR=”Gray”>Bottom Custom Text</FONT></B> </DIV><HR SIZE=”1″> will be used
/daSpecifies the document author.
Note: if the switch is omitted, an empty string will be used
/psSpecifies report page size
A3
A4
Note: These arguments cannot be combined
/poChange page orientation
Landscape
Portrait
Note: These arguments cannot be combined
/cstSpecifies custom text
/csthSpecifies custom text header
/cstfSpecifies custom text footer
/ffSpecifies custom text font family
Arial
ArialBlack
ArialNarrow
Courier
SegoeUI
Tahoma
TimesNewRoman
Note: These arguments cannot be combined
/ffhSpecifies header font family
Arial
ArialBlack
ArialNarrow
Courier
SegoeUI
Tahoma
TimesNewRoman
Note: These arguments cannot be combined
/fffSpecifies footer font family
Arial
ArialBlack
ArialNarrow
Courier
SegoeUI
Tahoma
TimesNewRoman
Note: these arguments cannot be combined
/tcSpecifies custom text color
/tchSpecifies custom text header color
/tcfSpecifies custom text footer color
/imgSpecifies custom logo
/impSpecifies position of the custom logo
Header
Footer
HeaderAndFooter
Note: These arguments cannot be combined
/taSpecify text alignment
Left
Right
Center
Note: These arguments cannot be combined
/tahSpecifies header text alignment
Left
Right
Center
Note: These arguments cannot be combined
/tafSpecifies footer text alignment
Left
Right
Center
Note: These arguments cannot be combined
/tb
/tbhSpecifies header bold text
/tbfSpecifies footer bold text
/tiSpecifies italic text
/tihSpecifies header italic text
/tifSpecifies footer italic text
/tuSpecifies underline text
/tuhSpecifies header underline text
/tufSpecifies footer underline text
/fsSpecifies font size
/fshSpecifies header font size
/fsfSpecifies footer font size
/opSpecifies option presets
/sinaIncludes all server objects in documentation
/sinnExcludes server objects from documentation

Object type options

/dtoDatatype options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Columns [cl] – include the “Columns” section
None [n] – None of the available options
Default [d] – Default (Properties, Columns)

/dfoDefault options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Columns [cl] – include the “Columns” section
None [n] – None of the available options
Default [d] – Default (Properties, Columns)

/fnoFunction options

Permissions and Recordsets if the switch is omitted
Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Parameters [pa] – include the “Parameters” section
Recordset [rs] – include the “Recordsets” section
Permissions [pe] – include the “Permissions” section
Options [op] – include the “Options” section
None [n] – None of the available options
Default [d] – Default (Properties, Options, Parameters, Permissions, Recordsets)

/proProcedure options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Parameters [pa] – include the “Parameters” section
Permissions [pe] – include the “Permissions” section
Options [op] – include the “Options” section
None [n] – None of the available options
Default [d] – Default (Properties, Options, Parameters, Permissions)

/rooRole options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
DbPermissions [dp] – include the “Database permissions” section
Permissions [pe] – include the “Permissions” section
Users [us] – include the “Users” section
None [n] – None of the available options
Default [d] – Default (Properties, Users, Permissions)

/ruoRole options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Columns [cl] – include the “Columns” section
None [n] – None of the available options
Default [d] – Default (Properties, Columns)

/tboTable options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Indexes [ix] – include the “Indexes” section
ExplicitIndexes [eix] – include the “Indexes” sub node
Columns [cl] – include the “Columns” section
Permissions [pe] – include the “Permissions” section
CreationOptions [cr] – include the “Creation options” section
Triggers [tr] – include the “Triggers” section
ExplicitTriggers [etr] – include the “Triggers” sub node
Statistics [st] – include the “Statistics” section
ExplicitStatistics [est] – include the “Statistics” sub node
Checks [ch] – include the “Checks” section
Identity [it] – include the “Identity” section
Relationships [rl] – include the “Relationships” section
ExplicitRelationships [erl] – include the “Relationships” sub node
Collations [ct] – include the “Collations” section
Options [op] – include the “Options” section
StatisticalDataAnalysis [sd] – include the “Statistical data analysis” section
None [n] – None of the available options
Default [d] – Default (Checks, Columns, CreationOptions, Collations, Identity, Indexes, Options, Permissions, Properties, Relationships, Statistics, Triggers)

/troTrigger options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Options [op] – include the “Options” section
Type [tp] – include the “Type” section
None [n] – None of the available options
Default [d] – Default (Properties, Options, Type)

/usoUser options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Objects [ob] – include the “Objects” section
DbPermissions [dp] – include the “Database permissions” section
Permissions [pe] – include the “Permissions” section
Roles [ro] – include the “Roles” section
None [n] – None of the available options
Default [d] – Default (Properties, Objects, Permissions, Roles)

/vioView options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Indexes [ix] – include the “Indexes” section
ExplicitIndexes [eix] – include the “Indexes” sub node
Columns [cl] – include the “Columns” section
Permissions [pe] – include the “Permissions” section
Options [op] – include the “Options” section
Triggers [tr] – include the “Triggers” section
ExplicitTriggers [etr] – include the “Triggers” sub node
Statistics [st] – include the “Statistics” section
ExplicitStatistics [est] – include the “Statistics” sub node
None [n] – None of the available options
Default [d] – Default (Columns, Indexes, Options, Properties, Statistics, Permissions, Triggers)

/asoAssembly options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)

/akoAsymmetric key options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)

/ckoCertificate options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)

/ctoContract options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)

/ddoDDL trigger options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Options [op] – include the “Options” section
None [n] – None of the available options
Default [d] – Default (Properties, Options)

/enoEvent notification options

ExtendedProperties [expr] – include the “Extended properties” section
None [n] – None of the available options
Default [d] – Default (Properties)

/fcoFulltext catalog options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)

/fsoFulltext stoplist options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)

/mtoMessage type options

Properties [pr] – include the “Properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)

/pfoPartition function options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
None [n] – None of the available options
Default [d] – Default (Properties)

/psoPartition scheme options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
None [n] – None of the available options
Default [d] – Default (Properties)

/quoQueue options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)

/rsoRemote service binding options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)

/rtoRoute options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)

/shoSchema options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
Objects [ob] – include the “Objects” section
None [n] – None of the available options
Default [d] – Default (Properties, Objects, Permissions)

/sroService options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)

/seoSequence options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)

/sploSearch property list options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)

/skoSymmetric key options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)

/snoSymmetric key options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)
Note: if the switch is omitted, combination of Properties and Permissions is used

/xcoXML schema collection options

Properties [pr] – include the “Properties” section
ExtendedProperties [expr] – include the “Extended properties” section
Permissions [pe] – include the “Permissions” section
None [n] – None of the available options
Default [d] – Default (Properties, Permissions)

Graphical dependency options

/gdlThe graphical dependency layout

[c] – arrange objects so that the links between them form a circle
[f] – place the most used objects closer to the center of the diagram, less used ones are placed on the outside
[h] – place objects with Parents on top and Descendants at the bottom, with each generation sharing the same vertical level
[o] – arrange objects so that they are at a right angle to each other

/gdtthe graphical dependency type

[co] – show the object and its Children
[ds] – show the object and all Descendants, including Children and Grandchildren, in the dependency graph
[pc] – show the object and its Parents and Children in the dependency graph. Descendants are not shown
[pd] – show all objects, including Parents, Children and Descendants

/gdsThe graphical dependencies scale.
Note: if the switch is omitted, 100% scale will be used

/mc1The maximum children depth level to be displayed.
Note: if the switch is omitted, 1 will be used
/dusnUse short names in graphical dependencies diagrams
Note: if the switch is omitted, long names will be used

Additional options

/?Prints help message
Quick tip icon

Quick tip:

The recommendation is to use the /? switch in combination with the /out:c:\help.txt switch which will redirect a preview of the /? switch to a text file. This way all the switches will be shown.

/afAn XML argument file with options
/cwSpecifies the width of console output
/fOverrides existing file of the same name
/outRedirects console output to specified file
/tOutputs parsed command line switches without taking any actions
/vPrints messages that are suppressed by default
/sltDisables all output to console
/bePlays sound upon finished operation
/rcOutputs all return codes to console
/logSet one of the following logging levels: Error, Warning, All or None
/hthFull path to the CLI help file, along with <.html> extension

Examples with common switches:

Quick tip icon

Quick tip:

Note: All examples assume that the current directory is the application directory. If not, the full path name to ApexSQLDoc.com must be specified

Loading project and documenting SQL databases that are defined in the project:

ApexSQLDoc.com /pr:project.axdp

Documenting Sales database on Production server, with the graph dependency scale set to 200%:

ApexSQLDoc.com /dbes:Production.Sales /gds:200

Documenting Store and Sales databases on dell\sql2012 server using “sa” user and ”sqladmin” password connection options and overriding output file/directory if exist:

ApexSQLDoc.com /dbes:dell\sql2012.Store.Sales:sa.sqladmin /f

Documenting Sales database on Production server using connection options (user and password), output format (html), output directory (c:\temp), and output file name template ({servername}):

ApexSQLDoc.com /dbes:Production.Sales:sa.sa_psw /of:html /od:c:\temp
/on:{servername}

Quick tip icon

Quick tip:

The /od: switch will not create a specified output directory, it needs to be created manually before using it in ApexSQL Doc CLI

Documenting only tables and views from the Sales database on the Production server:

ApexSQLDoc.com /dbes:Production.Sales /o:12

Loading selection profile and documenting Sales database on Production server:

ApexSQLDoc.com /dbes:Production.Sales/i:Pselection_profile.xml

Creating a CHM file with the name: 10_06_2014.servername.file01.chm:

ApexSQLDoc.com /dbes:Production.Sales /on:{date}.{servername}.file01 /of:chm

Creating a HTML documentation in the btt.10_06_2014.john directory:

ApexSQLDoc.com /dbes:CS.btt /on:{databasename}.{date}.john /of:html

Creating a CHM file with the name: db_documentation.10_06_2014.file01.chm in the c:\temp folder:

ApexSQLDoc.com /dbes:Production.Sales /on:{date}.{servername}.file01 /of:chm /on:{date}.file01/od:c:\temp

Documenting Northwind database on Production server and the project path is: c:\db_doc_Projects:

ApexSQLDoc.com /dbes:Production.Northwind /pr:c:\db_doc_Projects.axdp

Documenting Northwind database on Production server displaying the nodes for object types that don’t exist:

ApexSQLDoc.com /dbes:Production.Northwind /em:nd

Documenting Northwind database on CS server displaying TSQL code highlighted:

ApexSQLDoc.com /dbes:CS.Northwind /of:chm/pi:h

Documenting Northwind database on CI server displaying the extended properties and default server details:

ApexSQLDoc.com /dbes:CI.Northwind /oi:e /srd:d

Documenting Northwind database on CS server displaying the title name of the output file: “Northwind_db”, date when it was created and the connection timeout value set to 120 seconds, with default settings for collapsible sections, and “Owner” grouping enabled:

ApexSQLDoc.com /dbes:CS.Northwind /of:chm /tt:“Northwind_db: {date}” /cnt:120 /cs:default /gr:o

Documenting Customer database on CI server displaying the date in the filename, copyright link, and the copyright details. The output format will be HTML:

ApexSQLDoc.com /dbes:CI.Customer /of:html /tt:{date} /cl:www.apexsql.com /ct:ApexSQL

Documenting Sales database on a local server displaying the server object selection, extended properties, documentation author, applying the db_style.css style sheet from c:\styles:

ApexSQLDoc.com /dbes:local.Sales /so:170 /ep:MS_Description /da:maxkv /sf:C:\styles\db_style.css

Documenting SSIS package from SSIS 2014 Package store:

ApexSQLDoc.com /isps:[ALEN-PC]:SQL2014.”MSDB\Data Collector\SqlTraceUpload”

Documenting SSRS item from the file system:

ApexSQLDoc.com /rsff:”E:\AdventureWorks 2012 SSRS Samples\AdventureWorks Sample Reports 2012.rptproj