Applies to
ApexSQL Doc
Summary
This article explains the ApexSQL Doc CLI switches, and their usage through the examples.
Using the CLI in ApexSQL Doc allows you to set the documenting process for SQL databases, SSIS packages, SSAS cubes, SSRS items, Tableau server sites 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.
/database_engines | Include specific database engine servers and databases
Alias: /dbes
Format: /database_engines:“[server] .[database1].[database2]:user.password” |
/integration_services_ packages | Include specific Integration services packages from SQL Server package store
Alias: /isps
Format: /integration_services_packages:services: SQL2014.”package1”.”package2”[:password] |
/analisys_services_ databases | Include specific Analysis services database engine servers and databases Alias: /asdb Format: /analisys_services_databases:“[server].[database1].[database2]:user.password” |
/package_files | Include specific package files from the file system Alias: /pfs Format: /package_files:“packagepath”:[password] |
/sql_server_packages | Include specific packages from SQL Server
Alias: /ssp
Format: /sql_server_packages:server.user .password:”package1”.”package2” |
|
Quick tip: SQL Server or Integration Service name can be: server name/service name or [ipaddress]. |
/integration_ services_ catalog | Include specific Integration services packages from SSIS DB Catalog
Alias: /isdbc
Format: /integration_services_database_ catalog:“[server]“:package1.package2 |
/integration_ services_ project_file | Include specific Integration services project files
Alias: /ispf
Format: /integration_services_project_file: “ssisprojectfilepath“:package1.package2 |
/exclude_databases | Treat databases as an exclude list Alias: /ed |
/exclude_database_ engines | Specifies server and exclude database list
Alias: /edbes
Format: /exclude_database_engines:“[server] .[database1].[database2]:user.password” Note: server can be either server name or [ipaddress] |
/exclude_integration_ services_packages | Specifies Integration services package store and excludes the package list
Alias: /eisps
Format: /exclude_integration_services_packages: services:SQL2014.”package1”.”package2” [:password] |
/exclude_analisys_ services_databases | Specifies Analysis services server and exclude SSAS database list
Alias: /easdb
Format: /exclude_analisys_services_databases: “[server].[database1].[database2]:user.password” Note: server can be server name or [ipaddress] |
/exclude_sql_server_ packages | Specifies SQL Server and an exclude the package list
Alias: /essp
Format: /exclude_sql_server_packages: server.user.password:”package1” .”package2” Note: server can be either server name or [ipaddress] |
/reporting_services_ items_from_file | Include Reporting Services items from the file system
Alias: /rsff
Format: /reporting_services_items_from_ file:“ssrsitempath1”.”ssrsitempath2” |
/exclude_reporting_ services_items_ from_file | Exclude Reporting Services items from file
Alias: /ersff
Format: /exclude_reporting_services_ items_from_file:“ssrsitempath1” .”ssrsitempath2” |
/reporting_services_ items_from_native | Include Reporting Services items from the Native web service Alias: /rsfn Format: /reporting_services_items_from_native:[nativeservice].[folder] Note: specifying a folder is optional |
/exclude_reporting_ services_items_ from_native | Exclude Reporting Services items from Native web service
Alias: /ersfn
Format: /exclude_reporting_services_ items_from_native:[nativeservice].[folder] |
/reporting_services_ items_from_sharepoint | Include Reporting Services items from the SharePoint web service
Alias: /rsfs
Format: /reporting_services_items_from_ sharepoint:[webservice].[folder] .[user].[password] |
/exclude_reporting_ services_items_ from_sharepoint | Exclude Reporting Services items from SharePoint web service
Alias: /ersfs
Format: /exclude_reporting_services_items_ from_sharepoint:[webservice].[folder] .[user].[password] |
/tableau_server_sites | Include Tableau Server sites into the processing
Alias: /tss
Format: /tableau_server_sites:server .site1.site2[:user[.password]] |
/exclude_tableau_ server_sites | Specifies Tableau Server and exclude sites list
Alias: /etss
Format: /exclude_tableau_server_sites: server.site1.site2[:user[.password]] |
/tableau_online_sites | Include Tableau Online sites into the processing
Alias: /tos
Format: /tableau_online_sites:server .site[:user[.password]] |
/database_snapshot | Include database snapshot into the processing Alias: /dbsnp Format: /database_snapshot:“shapshotpath” |
/sharepoint_farm | Include SharePoint farm into the processing. Mandatory argument is [connect]. If no other SharePoint switch is present, the switch includes all objects and options. Alias: /sp Format: /sp:connect |
/sharepoint_server_ object_details | Include specific SharePoint server object details
Alias: /spobj
If no SharePoint option switch is specified, the switch selects all options for the specified objects
[appm] – include Application management section [app] – include Application section [bnr] – include Backup and restore section [frmo] – include Farm overview section [gas] – include General application settings section [mon] – include Monitoring section [secu] – include Security object section [sif] – include Servers in farm object section [sos] – include Services on server object section [syss] – include System settings object [upam] – include Update and migration object [usrl] – include User licensing object |
/sharepoint_server_ options_details | Include options for SharePoint object details
Alias: /spopt
[spdb] - include database as part of Application management [ssa] - include service applications as part of Application management [scol] - include site collection as part of Application management [wapp] - include web applications as part of Application management [appu] - include Application URLs as part of Application [appl] - include Applications licenses as part of Application [mapp] - include Monitored applications as part of Application [bh] - include Backup history as part of Backup and restore [bs] - include Backup settings as part of Backup and restore [cdbs] - include Content databases as part of Farm overview [sif] - include Servers in farm as part of Farm overview [wasc] - include Web applications and site collections as part of Farm overview [cd] - include Content deployment as part of General application settings [esc] - include External service connections as part of General application settings |
/create_database_ snapshot | Specify the database to create a database snapshot Alias: /cdbsnp |
/database_snapshot_ output_directory | Specify the output directory in which the database snapshot will be created Alias: /dbsnpod |
/database_snapshot_ file_name | Specify the file name of the database snapshot that will be created Alias: /dbsnpfn |
/intermediary_files_ location | The intermediary files location Alias: /ifl Note: If the switch is omitted, the default directory is used |
/intermediary_files_ keep | Keep intermediary files Alias: /ifk |
|
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 |
/compile_timeout | Specifies the chm compilation timeout in minutes Alias: /cti Note: the default value is 600 seconds (10 minutes) |
/output_directory | Specifies the output directory Alias: /od Note: if the switch is omitted, the current directory is used |
/output_name | Specifies the filename template for CHM files, or the directory name template for the HTML documentation. A full or relative path cannot be used here Alias: /on Note: If the switch is omitted “/output_name:[servername].[databasename]” format is used |
/output_type | Specifies the output file format type
|
/include | Include specific objects specified via regular expressions.
Alias: /inc
Format: “/include:Server1.Database1 .TypeConstant1: Expr1” (TypeConstant is a bitwise value of the object type) |
/exclude | Exclude specific object specified via regular expressions.
Alias: /exc
Format: “/exclude:Server1.Database1 .TypeConstant1: Expr1” (TypeConstant is a bitwise value of the object type) |
/server_include | Include specific server objects specified via regular expressions.
Alias: /sinc
Format: “/server_include:Server1 .TypeConstant1:Expr1” (TypeConstant is a bitwise value of the object type) |
/server_exclude | Exclude specific server objects specified via regular expressions.
Alias: /sexc
Format: “/server_exclude Server1 .Typeconstant1:Expr1” (TypeConstant is a bitwise value of the server object type) |
/comments | Document user comments. Alias: /dc Note: If the switch is omitted, an empty string will be used. |
/stylesheet | Specifies the style sheet file path. Alias: /sf Note: If the switch is omitted, default path will be ‘/sf:Templates\style.css’. |
/date_format | Specifies date format. Alias: /df Note: If the switch is omitted “/df:mm/ss/yyyy” format will be used. |
/collapsible_sections | Make documentation sections collapsible. DEFAULT – Default NONE – None Alias: /cs |
/optional_items | Optional documentation settings. 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) Alias: /oi |
/performance_ intensitive_items | Performance intensive settings. 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) Alias: /pi |
/groupings | Additional grouping settings. 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 |
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy Cookie Preference Center