Devart.DbForge.DevOpsAutomation.SqlServer.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Invoke-DevartDatabaseBuild --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-DevartDatabaseBuild</command:name> <command:verb>Invoke</command:verb> <command:noun>DevartDatabaseBuild</command:noun> <maml:description> <maml:para>Builds a database on a server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-DevartDatabaseBuild</maml:name> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection to the server where a database will be built.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceScriptsFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceScriptsFolder</maml:name> <maml:description> <maml:para>Path to the folder with scripts from which a database will be built.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterPath</maml:name> <maml:description> <maml:para>Specifies the SQL Compare filter options used when validating the schema.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueryBatchTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryBatchTimeout</maml:name> <maml:description> <maml:para>Parameter is applied for each of the following expressions in a database creation script if the Connection parameter is an object of the DevartDatabaseConnectionInfo type.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <!-- Parameter: SynchronizationOptions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SynchronizationOptions</maml:name> <maml:description> <maml:para>Specifies the SQL Compare options used during creation of the script for validation.</maml:para> <maml:para>To include additional options, specify a slash-separated list of the options.</maml:para> <maml:para>For example: /IgnoreCase:Yes /IgnorePrimaryKeys:No</maml:para> <maml:para>See related links for more detailed information about options.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TransactionIsolationLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TransactionIsolationLevel</maml:name> <maml:description> <maml:para>Use this parameter to specify the isolation level for the transactions during the temporary deployment for validation.</maml:para> <maml:para>Permitted values are: Serializable, Snapshot, RepeatableRead, ReadCommitted and ReadUncommitted. The default level is Serializable.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Serializable</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection to the server where a database will be built.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceScriptsFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceScriptsFolder</maml:name> <maml:description> <maml:para>Path to the folder with scripts from which a database will be built.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterPath</maml:name> <maml:description> <maml:para>Specifies the SQL Compare filter options used when validating the schema.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SynchronizationOptions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SynchronizationOptions</maml:name> <maml:description> <maml:para>Specifies the SQL Compare options used during creation of the script for validation.</maml:para> <maml:para>To include additional options, specify a slash-separated list of the options.</maml:para> <maml:para>For example: /IgnoreCase:Yes /IgnorePrimaryKeys:No</maml:para> <maml:para>See related links for more detailed information about options.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TransactionIsolationLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TransactionIsolationLevel</maml:name> <maml:description> <maml:para>Use this parameter to specify the isolation level for the transactions during the temporary deployment for validation.</maml:para> <maml:para>Permitted values are: Serializable, Snapshot, RepeatableRead, ReadCommitted and ReadUncommitted. The default level is Serializable.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Serializable</dev:defaultValue> </command:parameter> <!-- Parameter: QueryBatchTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryBatchTimeout</maml:name> <maml:description> <maml:para>Parameter is applied for each of the following expressions in a database creation script if the Connection parameter is an object of the DevartDatabaseConnectionInfo type.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: DatabaseProject --> <command:returnValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.DatabaseProject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$databaseProject = Invoke-DevartDatabaseBuild -SourceScriptsFolder $scriptFolder -Connection $connection </dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>See web documentation for a complete list of supported SynchronizationOptions.</maml:linkText> <maml:uri>http://docs.devart.com/schema-compare-for-sql-server/using-the-comand-line/options-used-in-the-command-line.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online help:</maml:linkText> <maml:uri>https://docs.devart.com/devops-automation-for-sql-server/powershell-cmdlets/invoke-devartdbbuild.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Test-DevartDatabaseConnection --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-DevartDatabaseConnection</command:name> <command:verb>Test</command:verb> <command:noun>DevartDatabaseConnection</command:noun> <maml:description> <maml:para>Try to open the specified connection.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-DevartDatabaseConnection</maml:name> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The DevartDatabaseConnectionInfo or connection string that identifies the connection to test.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The DevartDatabaseConnectionInfo or connection string that identifies the connection to test.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The DevartDatabaseConnectionInfo or connection string that identifies the connection to test.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$connection = New-DevartSqlDatabaseConnection -Server $serverName -Database $database -UserName $userName $success = Test-DevartDatabaseConnection -Connection $connection</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online help:</maml:linkText> <maml:uri>https://docs.devart.com/devops-automation-for-sql-server/powershell-cmdlets/test-devartdatabaseconnection.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-DevartDatabaseDocumentation --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-DevartDatabaseDocumentation</command:name> <command:verb>New</command:verb> <command:noun>DevartDatabaseDocumentation</command:noun> <maml:description> <maml:para>Creates documentation for specified schema.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns false if the documentation is filled; otherwise true.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-DevartDatabaseDocumentation</maml:name> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection to the server for which documentation will be built.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Output --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Output</maml:name> <maml:description> <maml:para>The output file path or directory for generated documentation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalOptions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalOptions</maml:name> <maml:description> <maml:para>Specifies additional options used during creation of documentation.</maml:para> <maml:para>To include additional options, specify a slash-separated list of the options.</maml:para> <maml:para>For example: /autor:name /breadcrumbs:N</maml:para> <maml:para>See related links for more detailed information about additional options.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>The documentation format.</maml:para> <maml:para>Possible values: Html, Pdf, Markdown</maml:para> </maml:description> <command:parameterValue required="true">DocumentationFormat</command:parameterValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.DocumentationFormat</maml:name> <maml:uri /> <maml:description> <maml:para>Format of the documentation file.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Html</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Html</command:parameterValue> <command:parameterValue required="false" variableLength="false">Pdf</command:parameterValue> <command:parameterValue required="false" variableLength="false">Markdown</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ProjectFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectFile</maml:name> <maml:description> <maml:para>The project file with *.ddoc extension.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection to the server for which documentation will be built.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Output --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Output</maml:name> <maml:description> <maml:para>The output file path or directory for generated documentation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectFile</maml:name> <maml:description> <maml:para>The project file with *.ddoc extension.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalOptions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalOptions</maml:name> <maml:description> <maml:para>Specifies additional options used during creation of documentation.</maml:para> <maml:para>To include additional options, specify a slash-separated list of the options.</maml:para> <maml:para>For example: /autor:name /breadcrumbs:N</maml:para> <maml:para>See related links for more detailed information about additional options.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>The documentation format.</maml:para> <maml:para>Possible values: Html, Pdf, Markdown</maml:para> </maml:description> <command:parameterValue required="true">DocumentationFormat</command:parameterValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.DocumentationFormat</maml:name> <maml:uri /> <maml:description> <maml:para>Format of the documentation file.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Html</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Html</command:parameterValue> <command:parameterValue required="false" variableLength="false">Pdf</command:parameterValue> <command:parameterValue required="false" variableLength="false">Markdown</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$documenterResult = New-DevartDatabaseDocumentation -Connection $connection -ProjectFile "DababaseName(MsSqlServer).ddoc" -Output:"C:\Report\" -Format HTML</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>See web documentation for more detailed information about additional options.</maml:linkText> <maml:uri>https://docs.devart.com/documenter-for-sql-server/working-with-command-line/documenting-databases.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online help:</maml:linkText> <maml:uri>https://docs.devart.com/devops-automation-for-sql-server/powershell-cmdlets/new-devartdbdocumentation.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Export-DevartDatabaseProject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Export-DevartDatabaseProject</command:name> <command:verb>Export</command:verb> <command:noun>DevartDatabaseProject</command:noun> <maml:description> <maml:para>Exports DatabaseProject to NuGet or Zip package.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Export-DevartDatabaseProject</maml:name> <!-- Parameter: OutputDirectory --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputDirectory</maml:name> <maml:description> <maml:para>Path to the folder to which DatabaseProject is exported. If the folder doesn't exist, it will be created during the import of DatabaseProject.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>DatabaseProject object to be exported.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseProject</command:parameterValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.DatabaseProject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>Output format of DatabaseProject. If you don't use this parameter, DatabaseProject will be exported to a NuGet package by default.</maml:para> <maml:para>Possible values: NuGet, Zip</maml:para> </maml:description> <command:parameterValue required="true">ExportProjectFormat</command:parameterValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.ExportProjectFormat</maml:name> <maml:uri /> <maml:description> <maml:para>Export format for project to export.</maml:para> </maml:description> </dev:type> <dev:defaultValue>NuGet</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">NuGet</command:parameterValue> <command:parameterValue required="false" variableLength="false">Zip</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Overwrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Use this parameter to overwrite any existing build artifact with the same name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>DatabaseProject object to be exported.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseProject</command:parameterValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.DatabaseProject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputDirectory --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputDirectory</maml:name> <maml:description> <maml:para>Path to the folder to which DatabaseProject is exported. If the folder doesn't exist, it will be created during the import of DatabaseProject.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Overwrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Use this parameter to overwrite any existing build artifact with the same name.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>Output format of DatabaseProject. If you don't use this parameter, DatabaseProject will be exported to a NuGet package by default.</maml:para> <maml:para>Possible values: NuGet, Zip</maml:para> </maml:description> <command:parameterValue required="true">ExportProjectFormat</command:parameterValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.ExportProjectFormat</maml:name> <maml:uri /> <maml:description> <maml:para>Export format for project to export.</maml:para> </maml:description> </dev:type> <dev:defaultValue>NuGet</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">NuGet</command:parameterValue> <command:parameterValue required="false" variableLength="false">Zip</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Set-DevartPackageInfo -Project $databaseProject -Id Devart.DbForge.DevOpsAutomation.ScriptFolder -Version 1.0.0-beta Export-DevartDatabaseProject -Project $databaseProject -OutputDirectory C:\NuGetRepository -Format NuGet</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online help:</maml:linkText> <maml:uri>https://docs.devart.com/devops-automation-for-sql-server/powershell-cmdlets/export-devartdbproject.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-DevartDatabaseProject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-DevartDatabaseProject</command:name> <command:verb>New</command:verb> <command:noun>DevartDatabaseProject</command:noun> <maml:description> <maml:para>Creates new database project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-DevartDatabaseProject</maml:name> <!-- Parameter: SourceScriptsFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SourceScriptsFolder</maml:name> <maml:description> <maml:para>Path to the folder of source scripts to build database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SourceScriptsFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SourceScriptsFolder</maml:name> <maml:description> <maml:para>Path to the folder of source scripts to build database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: DatabaseProject --> <command:returnValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.DatabaseProject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$databaseProject = New-DevartDatabaseProject -SourceScriptsFolder $scriptFolder</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online help:</maml:linkText> <maml:uri>https://docs.devart.com/devops-automation-for-sql-server/powershell-cmdlets/new-devartdatabaseproject.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Publish-DevartDatabaseProject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Publish-DevartDatabaseProject</command:name> <command:verb>Publish</command:verb> <command:noun>DevartDatabaseProject</command:noun> <maml:description> <maml:para>Publish DatabaseProject as NuGet package to the NuGet repository.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If AutoIncrementVersion parameter is set to true and the latest version of NuGet package greater of equal the specified version - the latest version will be incremented; otherwise the specified version will be used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Publish-DevartDatabaseProject</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Instance of a DatabaseProject object to be published or a package file name. This object is produced by the Invoke-DevartDatabaseBuild and Set-DevartPackageInfo cmdlets.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Repository --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Repository</maml:name> <maml:description> <maml:para>NuGet feed that the database build artifact will be published to. It must be a valid URL or local path to a NuGet feed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>In order to authenticate a client against a NuGet repository, NuGet uses an API key for deployment requests.</maml:para> <maml:para>The API key is acts as an alias for the user account, so the same API key is used for all NuGet repositories within the repository manager.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AutoIncrementVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoIncrementVersion</maml:name> <maml:description> <maml:para>Use this parameter to auto increment package version if a package with the specified version already exists on the NuGet repository. This parameter will be ignored if the Project is not an object of the DatabaseProject.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Instance of a DatabaseProject object to be published or a package file name. This object is produced by the Invoke-DevartDatabaseBuild and Set-DevartPackageInfo cmdlets.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Repository --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Repository</maml:name> <maml:description> <maml:para>NuGet feed that the database build artifact will be published to. It must be a valid URL or local path to a NuGet feed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>In order to authenticate a client against a NuGet repository, NuGet uses an API key for deployment requests.</maml:para> <maml:para>The API key is acts as an alias for the user account, so the same API key is used for all NuGet repositories within the repository manager.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AutoIncrementVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoIncrementVersion</maml:name> <maml:description> <maml:para>Use this parameter to auto increment package version if a package with the specified version already exists on the NuGet repository. This parameter will be ignored if the Project is not an object of the DatabaseProject.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Set-DevartPackageInfo -Project $databaseProject -Id Devart.DbForge.DevOpsAutomation.ScriptFolder -Version 1.0.0-beta Publish-DevartDatabaseProject -Project $databaseProject -Repository C:/NuGetRepository -AutoIncrementVersion</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Publish-DevartDatabaseProject -Project "C:/Test/Test.DevOpsAutomation.Database.3.0.9.nupkg" -Repository C:/NuGetRepository</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online help:</maml:linkText> <maml:uri>https://docs.devart.com/devops-automation-for-sql-server/powershell-cmdlets/publish-devartdatabaseproject.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Invoke-DevartDatabaseTests --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-DevartDatabaseTests</command:name> <command:verb>Invoke</command:verb> <command:noun>DevartDatabaseTests</command:noun> <maml:description> <maml:para>Run tSQLt tests for specified database.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns false if the tests are filed; otherwise true.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-DevartDatabaseTests</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Database to run the tSQLt tests on. It can be a scripts folder, a NuGet package, or a database connection.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Class --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Class</maml:name> <maml:description> <maml:para>Use this parameter to run specific class tests. If you don't use this parameter, every test will be run.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DataGeneratorProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DataGeneratorProject</maml:name> <maml:description> <maml:para>Use this parameter to specify a Data Generator project file (.dgen) that defines the data to be added to the test database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterPath</maml:name> <maml:description> <maml:para>Specifies the SQL Compare filter options used when generating a database to test against.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeTestData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeTestData</maml:name> <maml:description> <maml:para>Use this and DataGeneratorProject parameters to add test data to the database.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InstalltSQLtFramework --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InstalltSQLtFramework</maml:name> <maml:description> <maml:para>Install tSQLt Framework before executing tests.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: OutReportFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutReportFileName</maml:name> <maml:description> <maml:para>File path to export the test results to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueryBatchTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryBatchTimeout</maml:name> <maml:description> <maml:para>Parameter is applied for each of the following expressions if the InputObject parameter or the TemporaryDatabaseServer parameter is an object of the DevartDatabaseConnectionInfo type:</maml:para> <maml:para>- temporary database creation script;</maml:para> <maml:para>- data generation script;</maml:para> <maml:para>- testing script.</maml:para> <maml:para>The default parameter value is 30 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <!-- Parameter: ReportFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReportFormat</maml:name> <maml:description> <maml:para>Format of the test results file.</maml:para> <maml:para>Possible values: JUnit, MsTest</maml:para> </maml:description> <command:parameterValue required="true">TestReportFormat</command:parameterValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.TestReportFormat</maml:name> <maml:uri /> <maml:description> <maml:para>Format of the test results file.</maml:para> </maml:description> </dev:type> <dev:defaultValue>JUnit</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">JUnit</command:parameterValue> <command:parameterValue required="false" variableLength="false">MsTest</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: RewriteReport --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RewriteReport</maml:name> <maml:description> <maml:para>Use this parameter to rewrite a report file.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SynchronizationOptions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SynchronizationOptions</maml:name> <maml:description> <maml:para>Specifies the SQL Compare options used during creation of the script for validation.</maml:para> <maml:para>To include additional options, specify a slash-separated list of the options.</maml:para> <maml:para>For example: /IgnoreCase:Yes /IgnorePrimaryKeys:No</maml:para> <maml:para>See related links for more detailed information about options.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TemporaryDatabaseServer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TemporaryDatabaseServer</maml:name> <maml:description> <maml:para>Connection to the temporary database used for validation.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UnInstalltSQLtFramework --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UnInstalltSQLtFramework</maml:name> <maml:description> <maml:para>Uninstall tSQLt Framework after execution of tests.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UnitTests --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UnitTests</maml:name> <maml:description> <maml:para>Use this parameter to run a specific test or a specific test suite. If you don't use this parameter, every test will be run.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Database to run the tSQLt tests on. It can be a scripts folder, a NuGet package, or a database connection.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstalltSQLtFramework --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InstalltSQLtFramework</maml:name> <maml:description> <maml:para>Install tSQLt Framework before executing tests.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UnInstalltSQLtFramework --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UnInstalltSQLtFramework</maml:name> <maml:description> <maml:para>Uninstall tSQLt Framework after execution of tests.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RewriteReport --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RewriteReport</maml:name> <maml:description> <maml:para>Use this parameter to rewrite a report file.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Class --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Class</maml:name> <maml:description> <maml:para>Use this parameter to run specific class tests. If you don't use this parameter, every test will be run.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UnitTests --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UnitTests</maml:name> <maml:description> <maml:para>Use this parameter to run a specific test or a specific test suite. If you don't use this parameter, every test will be run.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutReportFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutReportFileName</maml:name> <maml:description> <maml:para>File path to export the test results to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReportFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReportFormat</maml:name> <maml:description> <maml:para>Format of the test results file.</maml:para> <maml:para>Possible values: JUnit, MsTest</maml:para> </maml:description> <command:parameterValue required="true">TestReportFormat</command:parameterValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.TestReportFormat</maml:name> <maml:uri /> <maml:description> <maml:para>Format of the test results file.</maml:para> </maml:description> </dev:type> <dev:defaultValue>JUnit</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">JUnit</command:parameterValue> <command:parameterValue required="false" variableLength="false">MsTest</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IncludeTestData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeTestData</maml:name> <maml:description> <maml:para>Use this and DataGeneratorProject parameters to add test data to the database.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DataGeneratorProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DataGeneratorProject</maml:name> <maml:description> <maml:para>Use this parameter to specify a Data Generator project file (.dgen) that defines the data to be added to the test database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterPath</maml:name> <maml:description> <maml:para>Specifies the SQL Compare filter options used when generating a database to test against.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SynchronizationOptions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SynchronizationOptions</maml:name> <maml:description> <maml:para>Specifies the SQL Compare options used during creation of the script for validation.</maml:para> <maml:para>To include additional options, specify a slash-separated list of the options.</maml:para> <maml:para>For example: /IgnoreCase:Yes /IgnorePrimaryKeys:No</maml:para> <maml:para>See related links for more detailed information about options.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TemporaryDatabaseServer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TemporaryDatabaseServer</maml:name> <maml:description> <maml:para>Connection to the temporary database used for validation.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueryBatchTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryBatchTimeout</maml:name> <maml:description> <maml:para>Parameter is applied for each of the following expressions if the InputObject parameter or the TemporaryDatabaseServer parameter is an object of the DevartDatabaseConnectionInfo type:</maml:para> <maml:para>- temporary database creation script;</maml:para> <maml:para>- data generation script;</maml:para> <maml:para>- testing script.</maml:para> <maml:para>The default parameter value is 30 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$testResult = Invoke-DevartDatabaseTests -InputObject $connection -InstalltSQLtFramework -IncludeTestData -DataGeneratorProject "DababaseName(MsSqlServer).dgen" -OutReportFileName:"C:\Test Result.xml" -ReportFormat JUnit -RewriteReport</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>See web documentation for a complete list of supported SynchronizationOptions.</maml:linkText> <maml:uri>http://docs.devart.com/schema-compare-for-sql-server/using-the-comand-line/options-used-in-the-command-line.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online help:</maml:linkText> <maml:uri>https://docs.devart.com/devops-automation-for-sql-server/powershell-cmdlets/invoke-devartdbtest.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Invoke-DevartDataExport --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-DevartDataExport</command:name> <command:verb>Invoke</command:verb> <command:noun>DevartDataExport</command:noun> <maml:description> <maml:para>Exports data from a database into the files.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-DevartDataExport</maml:name> <!-- Parameter: TemplateFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TemplateFile</maml:name> <maml:description> <maml:para>Specifies a *.det data import template file containing data export settings.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Connection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The DevartDatabaseConnectionInfo or connection string.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Specifies destination file, or directory for multiple export. Option is inaccessible for ODBC format.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputTable</maml:name> <maml:description> <maml:para>Specifies destination table name, this option is available for SQL, ODBC and Access formats.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Range --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Range</maml:name> <maml:description> <maml:para>Specifies range of exported rows.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SingleFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SingleFile</maml:name> <maml:description> <maml:para>Specifies that all data has to be exported into single file, even if there are several source tables.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Table --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>Specifies source table name, there can be some tables specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Connection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The DevartDatabaseConnectionInfo or connection string.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Specifies destination file, or directory for multiple export. Option is inaccessible for ODBC format.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputTable</maml:name> <maml:description> <maml:para>Specifies destination table name, this option is available for SQL, ODBC and Access formats.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Range --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Range</maml:name> <maml:description> <maml:para>Specifies range of exported rows.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SingleFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SingleFile</maml:name> <maml:description> <maml:para>Specifies that all data has to be exported into single file, even if there are several source tables.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Table --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>Specifies source table name, there can be some tables specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TemplateFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TemplateFile</maml:name> <maml:description> <maml:para>Specifies a *.det data import template file containing data export settings.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Invoke-DevartDataExport -Connection $connection -TemplateFile "C:\Temp\template.det"</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online help:</maml:linkText> <maml:uri>https://docs.devart.com/devops-automation-for-sql-server/powershell-cmdlets/invoke-devartdataexport.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Invoke-DevartDataImport --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-DevartDataImport</command:name> <command:verb>Invoke</command:verb> <command:noun>DevartDataImport</command:noun> <maml:description> <maml:para>Imports data from the files into a database.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-DevartDataImport</maml:name> <!-- Parameter: TemplateFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TemplateFile</maml:name> <maml:description> <maml:para>Specifies template file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Connection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The DevartDatabaseConnectionInfo or connection string.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Create --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Create</maml:name> <maml:description> <maml:para>If specified, new table to import the data to will be created.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InputFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InputFile</maml:name> <maml:description> <maml:para>Specifies file with the data that you want to import. Option is inaccessible for ODBC format.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InputTable</maml:name> <maml:description> <maml:para>Specifies table or view to import the data from (for Access and ODBC formats).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Table --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>Specifies target table (the one where you want to insert the imported data).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Connection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The DevartDatabaseConnectionInfo or connection string.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Create --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Create</maml:name> <maml:description> <maml:para>If specified, new table to import the data to will be created.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InputFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InputFile</maml:name> <maml:description> <maml:para>Specifies file with the data that you want to import. Option is inaccessible for ODBC format.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InputTable</maml:name> <maml:description> <maml:para>Specifies table or view to import the data from (for Access and ODBC formats).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Table --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>Specifies target table (the one where you want to insert the imported data).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TemplateFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TemplateFile</maml:name> <maml:description> <maml:para>Specifies template file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Invoke-DevartDataImport -Connection $connection -TemplateFile "C:\Temp\template.dit"</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online help:</maml:linkText> <maml:uri>https://docs.devart.com/devops-automation-for-sql-server/powershell-cmdlets/invoke-devartdataimport.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Invoke-DevartExecuteScript --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-DevartExecuteScript</command:name> <command:verb>Invoke</command:verb> <command:noun>DevartExecuteScript</command:noun> <maml:description> <maml:para>Automates executing the scripts.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If -Input is a folder, the scripts are executed in alphabetical order (subfolders are ignored).</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-DevartExecuteScript</maml:name> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a connection to the server where to execute the script.</maml:para> <maml:para>This can be:</maml:para> <maml:para>an instance of a DevartDatabaseConnectionInfo object produced by the New-DevartSqlDatabaseConnection cmdlet.</maml:para> <maml:para>a database connection string.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Input --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Input</maml:name> <maml:description> <maml:para>This switch is used to specify an SQL or ZIP file with the script to execute or a folder with SQL or ZIP files.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies a database to execute the script to.</maml:para> <maml:para>Databases specified in the script before will be ignored.</maml:para> <maml:para>It does not affect the objects specified with fully qualified names.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Encoding --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Specifies the encoding which should be applied to open and execute the script.</maml:para> <maml:para>Usage: /encoding:<codepage|encoding name></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreError --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreError</maml:name> <maml:description> <maml:para>Use this parameter to continue executing scripts in the folder despite errors.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ZipPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZipPassword</maml:name> <maml:description> <maml:para>Specifies the password to protected archive with password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a connection to the server where to execute the script.</maml:para> <maml:para>This can be:</maml:para> <maml:para>an instance of a DevartDatabaseConnectionInfo object produced by the New-DevartSqlDatabaseConnection cmdlet.</maml:para> <maml:para>a database connection string.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Input --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Input</maml:name> <maml:description> <maml:para>This switch is used to specify an SQL or ZIP file with the script to execute or a folder with SQL or ZIP files.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies a database to execute the script to.</maml:para> <maml:para>Databases specified in the script before will be ignored.</maml:para> <maml:para>It does not affect the objects specified with fully qualified names.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Encoding --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Specifies the encoding which should be applied to open and execute the script.</maml:para> <maml:para>Usage: /encoding:<codepage|encoding name></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ZipPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZipPassword</maml:name> <maml:description> <maml:para>Specifies the password to protected archive with password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreError --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreError</maml:name> <maml:description> <maml:para>Use this parameter to continue executing scripts in the folder despite errors.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Invoke-DevartExecuteScript -Connection $connection -Database AdventureWorks -Input script.sql</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Invoke-DevartExecuteScript -Connection $connection -Database AdventureWorks -Input script.zip -ZipPassword ***</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Invoke-DevartExecuteScript -Connection $connection -Database AdventureWorks -Input D:\ScriptFolder -IgnoreError</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online help:</maml:linkText> <maml:uri>https://docs.devart.com/devops-automation-for-sql-server/powershell-cmdlets/invoke-devartexecutescript.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Invoke-DevartFormatScript --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-DevartFormatScript</command:name> <command:verb>Invoke</command:verb> <command:noun>DevartFormatScript</command:noun> <maml:description> <maml:para>Formats the SQL files.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-DevartFormatScript</maml:name> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies the source SQL file or a folder with the files to be formatted.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Connection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The DevartDatabaseConnectionInfo or connection string.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Encoding --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Specifies the encoding which should be applied to open and save files.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileExtension --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FileExtension</maml:name> <maml:description> <maml:para>Specifies the extension of the sourcefolder files that will be formatted.</maml:para> <maml:para>The .sql extension is chosen by default.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeSubfolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSubfolders</maml:name> <maml:description> <maml:para>Include the current directory and all subdirectories in search operation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Output --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Output</maml:name> <maml:description> <maml:para>Specifies the output file or path name where formatting results will be saved.</maml:para> <maml:para>If the parameter is not specified, the formatting results will be saved in the source file or folder.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the path to file that contains formatting options settings.</maml:para> <maml:para>If the parameter is not specified, default formatting options settings will be applied.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies the source SQL file or a folder with the files to be formatted.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Connection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The DevartDatabaseConnectionInfo or connection string.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Encoding --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Specifies the encoding which should be applied to open and save files.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileExtension --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FileExtension</maml:name> <maml:description> <maml:para>Specifies the extension of the sourcefolder files that will be formatted.</maml:para> <maml:para>The .sql extension is chosen by default.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeSubfolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSubfolders</maml:name> <maml:description> <maml:para>Include the current directory and all subdirectories in search operation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the path to file that contains formatting options settings.</maml:para> <maml:para>If the parameter is not specified, default formatting options settings will be applied.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Output --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Output</maml:name> <maml:description> <maml:para>Specifies the output file or path name where formatting results will be saved.</maml:para> <maml:para>If the parameter is not specified, the formatting results will be saved in the source file or folder.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Invoke-DevartFormatScript -Source "C:\Temp\actor.sql" -Output "C:\Temp\new_actor.sql"</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online help:</maml:linkText> <maml:uri>https://docs.devart.com/devops-automation-for-sql-server/powershell-cmdlets/invoke-devartformatscript.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-DevartLogger --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-DevartLogger</command:name> <command:verb>Set</command:verb> <command:noun>DevartLogger</command:noun> <maml:description> <maml:para>Configure the logger to write tracing information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns false if the tests are filed; otherwise true.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-DevartLogger</maml:name> <!-- Parameter: TraceLevel --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TraceLevel</maml:name> <maml:description> <maml:para>Specifies the trace level of the messages that will be output in cmdlet-s.</maml:para> <maml:para>Possible values: Off, Error, Warning, Info, Verbose</maml:para> </maml:description> <command:parameterValue required="true">TraceLevel</command:parameterValue> <dev:type> <maml:name>System.Diagnostics.TraceLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Off</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Off</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: OutputFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Path to the output file for logging. If not set the file will be saved in directory that serves as a common repository for application-specific data for the current roaming user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TraceLevel --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TraceLevel</maml:name> <maml:description> <maml:para>Specifies the trace level of the messages that will be output in cmdlet-s.</maml:para> <maml:para>Possible values: Off, Error, Warning, Info, Verbose</maml:para> </maml:description> <command:parameterValue required="true">TraceLevel</command:parameterValue> <dev:type> <maml:name>System.Diagnostics.TraceLevel</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Off</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Off</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: OutputFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Path to the output file for logging. If not set the file will be saved in directory that serves as a common repository for application-specific data for the current roaming user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Set-DevartLogger -TraceLevel Verbose OutputFile C:\Users\[UserName]\AppData\Roaming\Devart\[ProductName]\DevOpsAutomation_yyyy-MM-dd_HH-mm-ss.log </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-DevartPackageInfo --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-DevartPackageInfo</command:name> <command:verb>Set</command:verb> <command:noun>DevartPackageInfo</command:noun> <maml:description> <maml:para>Set the properties to identify a package before export and/or publish DatabaseProject.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-DevartPackageInfo</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Unique identifier for the package you are creating.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>"Output object of the Invoke-DevartDatabaseBuild or New-DevartDatabaseProject cmdlets which return the DatabaseProject.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseProject</command:parameterValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.DatabaseProject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the package you are creating.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Automatically generated by Devart dbForge DevOps Automation PowerShell for SQL Server.</dev:defaultValue> </command:parameter> <!-- Parameter: Documentation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>A path where the documentation of database is located.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Version of the package. It must be in a valid NuGet version format (e.g. 1.0.1-beta).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1.0.0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>"Output object of the Invoke-DevartDatabaseBuild or New-DevartDatabaseProject cmdlets which return the DatabaseProject.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseProject</command:parameterValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.DatabaseProject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Unique identifier for the package you are creating.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Version of the package. It must be in a valid NuGet version format (e.g. 1.0.1-beta).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1.0.0</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the package you are creating.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Automatically generated by Devart dbForge DevOps Automation PowerShell for SQL Server.</dev:defaultValue> </command:parameter> <!-- Parameter: Documentation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Documentation</maml:name> <maml:description> <maml:para>A path where the documentation of database is located.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Set-DevartPackageInfo -Project $databaseProject -Id Devart.DbForge.DevOpsAutomation.ScriptFolder -Version 1.0.0-beta</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online help:</maml:linkText> <maml:uri>https://docs.devart.com/devops-automation-for-sql-server/powershell-cmdlets/set-devartpackageInfo.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Invoke-DevartPopulate --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-DevartPopulate</command:name> <command:verb>Invoke</command:verb> <command:noun>DevartPopulate</command:noun> <maml:description> <maml:para>Populates a database with sample data.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-DevartPopulate</maml:name> <!-- Parameter: DataGeneratorProject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DataGeneratorProject</maml:name> <maml:description> <maml:para>Specifies data generation template to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Connection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The DevartDatabaseConnectionInfo or connection string.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Connection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The DevartDatabaseConnectionInfo or connection string.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DataGeneratorProject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DataGeneratorProject</maml:name> <maml:description> <maml:para>Specifies data generation template to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Invoke-DevartPopulate -Connection $connection -DataGeneratorProject "C:\Temp\Template.dgen"</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online help:</maml:linkText> <maml:uri>https://docs.devart.com/devops-automation-for-sql-server/powershell-cmdlets/invoke-devartpopulate.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-DevartSqlDatabaseConnection --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-DevartSqlDatabaseConnection</command:name> <command:verb>New</command:verb> <command:noun>DevartSqlDatabaseConnection</command:noun> <maml:description> <maml:para>Build connection object to database.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns DevartDatabaseConnectionInfo object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-DevartSqlDatabaseConnection</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Server</maml:name> <maml:description> <maml:para>Name or network address of the SQL Server instance to connect to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Database</maml:name> <maml:description> <maml:para>Database to connect to on the server specified in Server parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name for the SQL Server account that cmdlets will use to connect to the database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password for the SQL Server account that cmdlets will use to connect to the database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WindowsAuthentication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>WindowsAuthentication</maml:name> <maml:description> <maml:para>Allows a user to connect through a Windows user account to a server.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ConnectionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para>The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>15</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Server</maml:name> <maml:description> <maml:para>Name or network address of the SQL Server instance to connect to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Database</maml:name> <maml:description> <maml:para>Database to connect to on the server specified in Server parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name for the SQL Server account that cmdlets will use to connect to the database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password for the SQL Server account that cmdlets will use to connect to the database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WindowsAuthentication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>WindowsAuthentication</maml:name> <maml:description> <maml:para>Allows a user to connect through a Windows user account to a server.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ConnectionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para>The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>15</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: DevartDatabaseConnectionInfo --> <command:returnValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.DevartDatabaseConnectionInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$connection = New-DevartSqlDatabaseConnection -Server $serverName -Database $database -UserName $userName -Password $password</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>See web documentation for a default values for parameters.</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqlconnection.connectionstring?view=netframework-4.7.2</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online help:</maml:linkText> <maml:uri>https://docs.devart.com/devops-automation-for-sql-server/powershell-cmdlets/new-devartsqldatabaseconnection.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Invoke-DevartSyncDatabaseSchema --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-DevartSyncDatabaseSchema</command:name> <command:verb>Invoke</command:verb> <command:noun>DevartSyncDatabaseSchema</command:noun> <maml:description> <maml:para>Comparing and synchronizing schema's.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns false if synchronization failed; otherwise true.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-DevartSyncDatabaseSchema</maml:name> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Source</maml:name> <maml:description> <maml:para>Source to connect to a live database or loads database objects from the specified scripts folder or NuGet package.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Target --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Target schema to be updated.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterPath</maml:name> <maml:description> <maml:para>Use this parameter to specify a filter file to be used when performing the sync operation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueryBatchTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryBatchTimeout</maml:name> <maml:description> <maml:para>Parameter is applied for each of the expressions in a synchronization script. This parameter will be ignored if the Target is not an object of the DevartDatabaseConnectionInfo.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <!-- Parameter: Report --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Report</maml:name> <maml:description> <maml:para>Use this parameter to generate schema comparison report.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReportFilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReportFilePath</maml:name> <maml:description> <maml:para>Path to the report file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReportFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReportFormat</maml:name> <maml:description> <maml:para>Specify the format of the comparison report.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Html</dev:defaultValue> </command:parameter> <!-- Parameter: SynchronizationOptions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SynchronizationOptions</maml:name> <maml:description> <maml:para>Specifies the SQL Compare options used during creation of the script for synchronization.</maml:para> <maml:para>To include additional options, specify a slash-separated list of the options.</maml:para> <maml:para>For example: /IgnoreCase:Yes /IgnorePrimaryKeys:No</maml:para> <maml:para>See related links for more detailed information about options.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TransactionIsolationLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TransactionIsolationLevel</maml:name> <maml:description> <maml:para>Use this parameter to specify the isolation level for the transactions during the temporary deployment for validation.</maml:para> <maml:para>Permitted values are: Serializable, Snapshot, RepeatableRead, ReadCommitted and ReadUncommitted. The default level is Serializable.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Source</maml:name> <maml:description> <maml:para>Source to connect to a live database or loads database objects from the specified scripts folder or NuGet package.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Target --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Target schema to be updated.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SynchronizationOptions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SynchronizationOptions</maml:name> <maml:description> <maml:para>Specifies the SQL Compare options used during creation of the script for synchronization.</maml:para> <maml:para>To include additional options, specify a slash-separated list of the options.</maml:para> <maml:para>For example: /IgnoreCase:Yes /IgnorePrimaryKeys:No</maml:para> <maml:para>See related links for more detailed information about options.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterPath</maml:name> <maml:description> <maml:para>Use this parameter to specify a filter file to be used when performing the sync operation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TransactionIsolationLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TransactionIsolationLevel</maml:name> <maml:description> <maml:para>Use this parameter to specify the isolation level for the transactions during the temporary deployment for validation.</maml:para> <maml:para>Permitted values are: Serializable, Snapshot, RepeatableRead, ReadCommitted and ReadUncommitted. The default level is Serializable.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueryBatchTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueryBatchTimeout</maml:name> <maml:description> <maml:para>Parameter is applied for each of the expressions in a synchronization script. This parameter will be ignored if the Target is not an object of the DevartDatabaseConnectionInfo.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <!-- Parameter: Report --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Report</maml:name> <maml:description> <maml:para>Use this parameter to generate schema comparison report.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReportFilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReportFilePath</maml:name> <maml:description> <maml:para>Path to the report file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReportFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReportFormat</maml:name> <maml:description> <maml:para>Specify the format of the comparison report.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Html</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$syncResult = Invoke-DevartSyncDatabaseSchema -Source $connection -Target $targetConnection</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>See web documentation for a complete list of supported SynchronizationOptions.</maml:linkText> <maml:uri>http://docs.devart.com/schema-compare-for-sql-server/using-the-comand-line/options-used-in-the-command-line.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online help:</maml:linkText> <maml:uri>https://docs.devart.com/devops-automation-for-sql-server/powershell-cmdlets/invoke-devartsyncdatabaseschema.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Register-DevartTools --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Register-DevartTools</command:name> <command:verb>Register</command:verb> <command:noun>DevartTools</command:noun> <maml:description> <maml:para>Automates activating the Devart product.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This activation method requires an active Internet connection and you already have your activation key. Copy your activation key from the e-mail that was sent to you after your purchase, and paste it into the Key parameter. The activation key looks like a long sequence of letters and digits.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Register-DevartTools</maml:name> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies your activation key.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Product --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Product</maml:name> <maml:description> <maml:para>This switch is used to specify the Devart tool.</maml:para> <maml:para>Possible values: SqlComplete, SchemaCompare, DataCompare, DataGenerator, DataPump, Documenter, UnitTest</maml:para> </maml:description> <command:parameterValue required="true">DevartTool</command:parameterValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.DevartTool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SqlComplete</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SqlComplete</command:parameterValue> <command:parameterValue required="false" variableLength="false">SchemaCompare</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataCompare</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataGenerator</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataPump</command:parameterValue> <command:parameterValue required="false" variableLength="false">Documenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnitTest</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Product --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Product</maml:name> <maml:description> <maml:para>This switch is used to specify the Devart tool.</maml:para> <maml:para>Possible values: SqlComplete, SchemaCompare, DataCompare, DataGenerator, DataPump, Documenter, UnitTest</maml:para> </maml:description> <command:parameterValue required="true">DevartTool</command:parameterValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.DevartTool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SqlComplete</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SqlComplete</command:parameterValue> <command:parameterValue required="false" variableLength="false">SchemaCompare</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataCompare</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataGenerator</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataPump</command:parameterValue> <command:parameterValue required="false" variableLength="false">Documenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnitTest</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies your activation key.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Register-DevartTools -Product DataGenerator -Key ThdUH+tysSaJa9DvDYitE2wt6aq9AXZdkPqpqwnTRg+</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Unregister-DevartTools --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Unregister-DevartTools</command:name> <command:verb>Unregister</command:verb> <command:noun>DevartTools</command:noun> <maml:description> <maml:para>Automates deactivating the Devart product.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Unregister-DevartTools</maml:name> <!-- Parameter: Product --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Product</maml:name> <maml:description> <maml:para>This switch is used to specify the Devart tool.</maml:para> <maml:para>Possible values: SqlComplete, SchemaCompare, DataCompare, DataGenerator, DataPump, Documenter, UnitTest</maml:para> </maml:description> <command:parameterValue required="true">DevartTool</command:parameterValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.DevartTool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SqlComplete</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SqlComplete</command:parameterValue> <command:parameterValue required="false" variableLength="false">SchemaCompare</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataCompare</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataGenerator</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataPump</command:parameterValue> <command:parameterValue required="false" variableLength="false">Documenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnitTest</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Product --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Product</maml:name> <maml:description> <maml:para>This switch is used to specify the Devart tool.</maml:para> <maml:para>Possible values: SqlComplete, SchemaCompare, DataCompare, DataGenerator, DataPump, Documenter, UnitTest</maml:para> </maml:description> <command:parameterValue required="true">DevartTool</command:parameterValue> <dev:type> <maml:name>Devart.DbForge.DevOpsAutomation.SqlServer.DevartTool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SqlComplete</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SqlComplete</command:parameterValue> <command:parameterValue required="false" variableLength="false">SchemaCompare</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataCompare</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataGenerator</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataPump</command:parameterValue> <command:parameterValue required="false" variableLength="false">Documenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnitTest</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Unregister-DevartTools -Product DataGenerator</dev:code> </command:example> </command:examples> </command:command> </helpItems> |