New-DlmDatabasePackage

Packages the build artifacts of a validated project produced by the Invoke-DlmDatabaseSchemaValidation cmdlet.

Syntax

Description

The New-DlmDatabasePackage cmdlet takes a validated project from the output of the Invoke-DlmDatabaseSchemaValidation cmdlet and creates a package containing it's build artifacts. It can also include the documentation for your database using the output of the New-DlmDatabaseDocumentation cmdlet.

You can use the Export-DlmDatabasePackage cmdlet to export the build artifacts as a NuGet package.

Parameters

-InputObject <RedGate.DLMAutomation.Compare.Domain.Projects.IProject>

The output object of Invoke-DlmDatabaseSchemaValidation cmdlet, which represents the validated project.

-PackageId <System.String>

The unique identifier for the package you are creating.

This mustn't contain more than 100 characters and must be a valid NuGet package identifier.

-PackageVersion <System.String>

The version of the package. This must be in a valid NuGet version format (eg 3.2.1, 3.2.1-beta1).

-PackageDescription <System.String>

The description of the package you are creating.

-Documentation <RedGate.DLMAutomation.Compare.Documentation.SchemaDocumentation>

The documentation object created by New-DlmDatabaseDocumentation to include in the database package.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• RedGate.DLMAutomation.Compare.Domain.Projects.IProject

  The output object of Invoke-DlmDatabaseSchemaValidation cmdlet, which represents the validated project.

Return values

The output type is the type of the objects that the cmdlet emits.

• RedGate.DLMAutomation.Compare.Domain.BuildArtifacts.IBuildArtifact

Examples

---------- EXAMPLE 1 ----------

$project = "C:\Work\scripts"
$validatedProject = $project | Invoke-DlmDatabaseSchemaValidation
$databasePackage = $validatedProject | New-DlmDatabasePackage -PackageId MyDatabase -PackageVersion 1.0.0
$databasePackage | Export-DlmDatabasePackage -Path "C:\Export\packages"

This example shows how to use the New-DlmDatabasePackage cmdlet to create a NuGet package from a validated SQL Source Control project.

First the Invoke-DlmDatabaseSchemaValidation cmdlet validates the database schema. Then the New-DlmDatabasePackage cmdlet creates the package. Finally the Export-DlmDatabasePackage cmdlet exports the package to file.

---------- EXAMPLE 2 ----------

$project = "C:\Work\project\project.sqlproj"
$validatedProject = $project | Invoke-DlmDatabaseSchemaValidation
$databasePackage = $validatedProject | New-DlmDatabasePackage -PackageId MyDatabase -PackageVersion 1.0.0
$databasePackage | Export-DlmDatabasePackage -Path "C:\Export\packages"

This example shows how to use the New-DlmDatabasePackage cmdlet to create a package from a validated Redgate database project.

First the Invoke-DlmDatabaseSchemaValidation cmdlet validates the project. Then the New-DlmDatabasePackage cmdlet creates the package. Finally the Export-DlmDatabasePackage cmdlet exports the package to file.

---------- EXAMPLE 3 ----------

$project = "C:\Work\scripts"
$validatedProject = $project | Invoke-DlmDatabaseSchemaValidation
$documentation = $validatedProject | New-DlmDatabaseDocumentation

$databasePackage = $validatedProject | New-DlmDatabasePackage -PackageId MyDatabase -PackageVersion 1.0.0 -Documentation $documentation
$databasePackage | Export-DlmDatabasePackage -Path "C:\Export\packages"

This example shows how to use the New-DlmDatabasePackage cmdlet to create a NuGet database package that also includes database documentation.

The documentation is created by the New-DlmDatabaseDocumentation cmdlet.