Date: Thu, 28 Mar 2024 04:01:08 +0000 (GMT) Message-ID: <717770731.363.1711598468356@ip-172-31-38-4.eu-west-1.compute.internal> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_362_1134977995.1711598468355" ------=_Part_362_1134977995.1711598468355 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Generates documentation for the validated database schema produced by th= e Invoke-DlmDatabaseValidation cmdlet.
New-DatabaseDocumentation [-InputObject] &=
lt;IProject> [-TemporaryDatabaseServer <DatabaseServerConnection>]=
[-FilterPath <string>] [-IgnoreParserErrors] [-SQLCompareOptions <=
;string>] [-SQLDataCompareOptions <string>] [<CommonParameters&=
gt;] |
The New-DatabaseDocumentation cmdlet takes the output of the Invoke-Data= baseBuild cmdlet and creates documentation for that schema. It creates a Sc= hemaDocumentation object that represents the documentation for a validated = project.
You can use the New-DatabaseBuildArtifact cmdlet to include this documen= tation in the database build artifact it creates.
In order to generate the documentation, the cmdlet creates a temporary c= opy of the database. By default, it uses LocalDB for this. Alternatively, y= ou can use the TemporaryDatabaseServer parameter to specify a SQL Server in= stance for the temporary database. This is useful if your database uses fea= tures that aren't supported by LocalDB, such as Full-Text Search.
If you don't want to use LocalDB but don't have permission to create a d= atabase on the SQL Server instance, you can use the TemporaryDatabase param= eter to specify an existing database.
-InputObject <RedGate.Versi=
oning.Automation.Compare.Domain.Projects.IProject>
The output object of Invoke-DatabaseBuild cmdlet, which represents the v= alidated database schema.
Aliases | None |
Required? | true |
Position? | 0 |
Default Value | None |
Accept Pipeline Input | true (ByValue) |
Accept Wildcard Characters | false |
-Tem=
poraryDatabaseServer <RedGate.Versioning.Automation.Compare.SchemaSource=
s.DatabaseServerConnection>
The connection string for the temporary database server used for documen= tation. For example, 'Data Source=3DTempServer01'.
By default, LocalDB is used for the temporary database. However there ma= y be some features in your database that aren't supported by LocalDB (for e= xample, Full-Text Search). In this case, or if LocalDB is not present, use = this parameter to specify an alternative SQL Server instance for the tempor= ary database.
Using this option, SQL Change Automation will create a temporary, random= ly-named database on the specified SQL Server instance.
You can't use this parameter in addition to the TemporaryDatabase parame= ter.
Aliases | None |
Required? | false |
Position? | named |
Default Value | None |
Accept Pipeline Input | false |
Accept Wildcard Characters | false |
-TemporaryDataba=
se <RedGate.Versioning.Automation.Compare.SchemaSources.DatabaseConnecti=
on>
The details of the temporary database used for documentation. This can b= e:
- a database connection object that contains connection details for a da= tabase. See New-DatabaseConnection for details.
- a database connection string. For example, 'Data Source=3DTempServer01= ;Initial Catalog=3DTempDatabase01'.
By default, LocalDB is used for the temporary database. If you don't wan= t to use LocalDB and don't have permission to create a database on the SQL = Server instance, use this option to specify an existing database to use for= the temporary copy of the database.
If you use this parameter, all existing data on the temporary database w= ill be lost.
You can't use this parameter in addition to the TemporaryDatabaseServer = parameter.
Aliases | None |
Required? | false |
Position? | named |
Default Value | None |
Accept Pipeline Input | false |
Accept Wildcard Characters | false |
-Filt=
erPath <System.String>
The path to a .scpf filter file.
Overrides any Filter.scpf file present in the InputObject schema with an= alternative filter file to be used when documenting this schema.
This parameter will be ignored if the value specified is either $null or= empty.
Aliases | None |
Required? | false |
Position? | named |
Default Value | None |
Accept Pipeline Input | false |
Accept Wildcard Characters | false |
-IgnoreParserErrors <System.Management=
.Automation.SwitchParameter>
Whether the SQL Compare engine should ignore parser errors.
This parameter will be ignored if the InputObject is a database connecti= on.
Aliases | None |
Required? | false |
Position? | named |
Default Value | False |
Accept Pipeline Input | false |
Accept Wildcard Characters | false |
-SQLCompareOptions <System.String>
Specifies the SQL Compare options to use when creating the script for va= lidation. A default set of options is listed below. To include additional o= ptions, specify a comma-delimited list of the option names (eg 'IgnoreComme= nts, ObjectExistenceChecks'). To turn off a default option, precede the opt= ion name with a minus sign (eg '-ForceColumnOrder').
This parameter will be ignored if the value specified is $null or empty.=
By default, the following Compare options are used:
- ConsiderNextFilegroupInPartitionSchemes
- DecryptPost2KEncryptedObjects
- DoNotOutputCommentHeader
- ForceColumnOrder
- IgnoreCertificatesAndCryptoKeys
- IgnoreDatabaseAndServerName
- IgnoreUsersPermissionsAndRoleMemberships
- IgnoreUserProperties
- IgnoreWhiteSpace
- IgnoreWithElementOrder
- IncludeDependencies
- ThrowOnFileParseFailed
- UseCompatibilityLevel
For more information about SQL Compare options, see http://www.red-gate.com/sca/ps/help/compareoptions.
Aliases | None |
Required? | false |
Position? | named |
Default Value | None |
Accept Pipeline Input | false |
Accept Wildcard Characters | false |
Specifies the SQL Data Compare options to use when creating the script f= or validation. To include additional options, specify a comma-delimited lis= t of the option names (eg 'DisableAndReenableDDLTriggers, CompressTemporary= Files').
Aliases | None |
Required? | false |
Position? | named |
Default Value | None |
Accept Pipeline Input | false |
Accept Wildcard Characters | false |
<CommonPara=
meters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorActi= on, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see= http://technet.microsoft.com/en-us/libr= ary/hh847884.aspx.
The input type is the type of the objects that you can pipe to the cmdle= t.
The output object of Invoke-DatabaseBuild cmdlet, which = represents the validated database schema.
The output type is the type of the objects that the cmdlet emits.
|
This example shows how to create database documentation for a validated = SQL Change Automation project using the New-DatabaseDocumentation cmdlet. T= he New-DatabaseBuildArtifact cmdlet includes this documentation in the data= base build artifact it creates.
|
This example shows how to create database documentation for a validated = SQL Source Control project using the New-DatabaseDocumentation cmdlet. The = New-DatabaseBuildArtifact cmdlet includes this documentation in the databas= e build artifact it creates.