SqlDatabase/SqlDatabase.ps1

#region Copyright & License

# Copyright © 2012 - 2022 François Chabot
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

#endregion

Set-StrictMode -Version Latest

<#
.SYNOPSIS
   Creates the necessary manifest resources to deploy and undeploy a SQL Server database.
.DESCRIPTION
   Creates the necessary manifest resources to deploy and undeploy a SQL Server database. The resources created are as
   follows:
   - a SqlDeploymentScript for the script conventionally named ($Manifest.Properties.Name).Create.$(Name).sql
   - a SqlDeploymentScript for the script conventionally named ($Manifest.Properties.Name).Create.$(Name).Objects.sql
   - a SqlUndeploymentScript for the script conventionally named ($Manifest.Properties.Name).Drop.$(Name).sql
.PARAMETER Name
   The name of the SQL Server database for which to create the necessary deployment and undeployment resources.
.PARAMETER Server
   The name of the SQL Server that will host the database.
.PARAMETER Path
   The folder where the deployment and undeployment SQL scripts are located.
.PARAMETER EnlistInBizTalkBackupJob
.NOTES
   © 2022 be.stateless.
#>

function New-SqlDatabase {
   [CmdletBinding()]
   [OutputType([PSCustomObject[]])]
   param (
      [Parameter(Mandatory = $true)]
      [ValidateNotNullOrEmpty()]
      [string[]]
      $Name,

      [Parameter(Mandatory = $true)]
      [ValidateNotNullOrEmpty()]
      [string]
      $Server,

      [Parameter(Mandatory = $true)]
      [ValidateScript( { $_ | Test-Path -PathType Container } )]
      [PSObject]
      $Path,

      [Parameter(Mandatory = $false)]
      [switch]
      $EnlistInBizTalkBackupJob,

      [Parameter(Mandatory = $false)]
      [AllowNull()]
      [HashTable]
      $Variable,

      [Parameter(Mandatory = $false)]
      [ValidateNotNullOrEmpty()]
      [ValidateScript( { $_ -is [bool] -or $_ -is [ScriptBlock] } )]
      [PSObject]
      $Condition = $true,

      [Parameter(Mandatory = $false)]
      [switch]
      $PassThru
   )
   Resolve-ActionPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState

   if ($Manifest.Properties.Type -ne 'Application') {
      throw 'A BizTalk Application''s custom SQL database can only be installed in the context of an Application manifest.'
   }

   $arguments = @{
      Server    = $Server
      Condition = $Condition
   }
   if ($null -ne $Variable -and ($Variable.Keys | Test-Any)) { $arguments.Variable = $Variable }

   $Name | ForEach-Object -Process {
      New-SqlDeploymentScript @arguments -Path (Join-Path $Path "$($Manifest.Properties.Name).Create.$_.sql") -PassThru:$PassThru
      New-SqlDeploymentScript @arguments -Path (Join-Path $Path "$($Manifest.Properties.Name).Create.$_.Objects.sql") -PassThru:$PassThru
      New-SqlUndeploymentScript @arguments -Path (Join-Path $Path "$($Manifest.Properties.Name).Drop.$_.sql") -PassThru:$PassThru

      if ($EnlistInBizTalkBackupJob) {
         New-SqlDeploymentScript -Path (Join-Path $env:BTSINSTALLPATH 'Schema\Backup_Setup_All_Tables.sql') -Server $Server -Database $_ -Condition $Condition -PassThru:$PassThru
         New-SqlDeploymentScript -Path (Join-Path $env:BTSINSTALLPATH 'Schema\Backup_Setup_All_Procs.sql') -Server $Server -Database $_ -Condition $Condition -PassThru:$PassThru
         New-SqlDeploymentScript -Path (Join-Path $PSScriptRoot 'IncludeCustomDatabaseInOtherBackupDatabases.sql') -Server ((Get-BizTalkGroupSettings).MgmtDbServerName) -Condition $Condition -PassThru:$PassThru `
            -Variable @{
            CustomDatabaseName = $_
            ServerName         = $Server
            BTSServer          = $env:COMPUTERNAME
         }
         New-SqlUndeploymentScript -Path (Join-Path $PSScriptRoot 'RemoveCustomDatabaseFromOtherBackupDatabases.sql') -Server ((Get-BizTalkGroupSettings).MgmtDbServerName) -Condition $Condition -PassThru:$PassThru `
            -Variable @{ CustomDatabaseName = $_ }
      }
   }
}

Set-Alias -Option Readonly -Name SqlDatabase -Value New-SqlDatabase

# SIG # Begin signature block
# MIII0QYJKoZIhvcNAQcCoIIIwjCCCL4CAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUTIuIeVs9UvFJZ8VLz7v7x9Qe
# oLmgggVMMIIFSDCCAzCgAwIBAgIJAJkr3mJdTBkUMA0GCSqGSIb3DQEBCwUAMEEx
# PzA9BgNVBAMeNgBpAGMAcgBhAGYAdABzAG8AZgB0AHcAYQByAGUAQABzAHQAYQB0
# AGUAbABlAHMAcwAuAGIAZTAeFw0yMTA2MjUxNDEyMjNaFw00MTA2MjAxNDEyMjNa
# MEExPzA9BgNVBAMeNgBpAGMAcgBhAGYAdABzAG8AZgB0AHcAYQByAGUAQABzAHQA
# YQB0AGUAbABlAHMAcwAuAGIAZTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoC
# ggIBAOeqdUHBv7sxSeX3aj6yPKj7PAvs8izpVXjyEBl5aR8mQneVcXuF53AH7EW1
# 6E5p4+Az5pJPGUD5c3tXhiGMF7vgLhQjO6hlaVBRIqiIYHikNLwMNy6YBMc/QQYM
# rPhqHEFsZ53dkBIIj3M8e3kFcTFA09n25yDtTPDab4nd9yUhc9Qc8+nfpIzfYsoP
# 1pZ3nCzhw6hN2/44v1dkQrG3dRYwt+px65p6NPNZWEJpt4VCJjIFh+lBYJdxm9d4
# X/rAnlHIkbv7liOavWDzgHVabS3hdAWtcDmynm+7+FcZDFqPWNCl3e4SS7xe4s/R
# CKFKA0IsfKkSk9YJlLgeSQIEXUOOWXJAGaLqnRD8xWLZsc4Oi9GZg7XV1mv/S88c
# oztXnwtAN3OOlRKBh2QbomMgxeMO0GvsLE/cq5Q/YKAoz+KGr/7LcZq9jzQ8IPus
# ZvWLeDXmxPiwJjpZc1koLgfGIEX2NStQTT3QmacWr9thrWcKvI+4uBmI4exS9B4a
# R3nV91w5EY+2RoYsHqej9LWwNamO96+jMX9pxprTX+EkLUuMAikw/po8sBC9MUUn
# 5pMWmUv7DCtQOLGGBDDMMMkn4ZcjpCEEdPGHRKfqNnD27ssGtDjiNzfQrsm67toU
# bBwUF+gyJq/YckWquYJhA9ZOFWEADuIwGnsOzsoRvuQyY+p9AgMBAAGjQzBBMA4G
# A1UdDwEB/wQEAwIHgDAWBgNVHSUBAf8EDDAKBggrBgEFBQcDAzAXBgNVHREEEDAO
# ggxzdGF0ZWxlc3MuYmUwDQYJKoZIhvcNAQELBQADggIBACithYM3qckZRc9+Xbfu
# a6gWr3HwjrW+FHKgjfrcOm8ZnLVapb9xFqsqrRQqd3RXWQDINEGrtI2rSfrzyfoK
# UiTgldIfQNP1ZcGY229d++90t3hdo2mlt05hjYlbMENloJHpsEP0vQZmwOcEimCT
# ex1pymYM+P9pj3j8UD1PT1eIZot6or8fBRl63UybyDSrM7L4UOkkAOniKxWy5pW6
# 6duS8SR+SZpr3Bv44NyXPj0Nv+MIpLmsLrd7XPBFmnGxzY01ZO9vzi9KEhM2wT5i
# jPqHDNOvfPiADtAa+EyUBzdJiqy9heCz/TMZQgMWGwtfqJNxWZmsHcha2anW4Qt+
# mzrLO4GojWoVog9uVSAq+l0a+YQsd1u1kUmm4vgZCFyUA+lEp4LkI7ca2VBHkLPD
# w+u2DoDMRiqFPZjO7BCKjGc0jj9B/qGR3JVt+tqDdB621xXf2YGF2oFvxZQ/keGt
# 0ujfJ+JwN3nCulDAA4773q6KUnfykyrvAgITNbRJL6TngeRKtw9VIJBPxzqMzLpV
# 5ggXNituwLaD1CCBJ1oo9DZHpL9gplXp1wGrelJOTiJhh+pdNsPtRH7CrranWa5h
# LFLuigqin0eewQ5giJ1VaiBVEseOmiZog+27UpFIv40aDzgGL3YxB/Mu0ojwrQtp
# WLmqJCmWnR5qxOm0yK+zNWe0MYIC7zCCAusCAQEwTjBBMT8wPQYDVQQDHjYAaQBj
# AHIAYQBmAHQAcwBvAGYAdAB3AGEAcgBlAEAAcwB0AGEAdABlAGwAZQBzAHMALgBi
# AGUCCQCZK95iXUwZFDAJBgUrDgMCGgUAoHgwGAYKKwYBBAGCNwIBDDEKMAigAoAA
# oQKAADAZBgkqhkiG9w0BCQMxDAYKKwYBBAGCNwIBBDAcBgorBgEEAYI3AgELMQ4w
# DAYKKwYBBAGCNwIBFTAjBgkqhkiG9w0BCQQxFgQUCSJekoLrqTTRY6eU8iqKJgmR
# xZ8wDQYJKoZIhvcNAQEBBQAEggIAXokNgSlOyGXyoWTLHOHE5P//SbfF60MTPHUN
# kRE20ZoCm4LbOoSChfW0+W1lMFR8zVSB7wDWphgy2G7PbUuw53erBnCvNIf+9uub
# d7pW50ixhsn0mT718q13sKP0pFepSOiTVVLVY/7iMKnc+4/udLvq6X37jpRo9jWH
# wOnkkxS89YiXQytyVSJgRT/7ROEEbsMZC5pI/l1xU5xg3/mXEPktvK9N45i3jlUs
# skTp4igoPp5zfick6p3zWGTju6CVxDOnsbjIFO3r/YT1d/bmH0DhO7OC1cQ+3hyY
# O4QN1Oi9m2n7EEicFA7f+Kh5LZaZpxMJRbBiAy6i3n0qtQvvBjy2lDcWOEH2AEml
# hAZJR1VzANg8RXucbQdVY0VolVPFyZC20TdLoxDGdrcx8CLl2KYgNk05cGLsJqux
# HHu4rrm0ENT7n5cj8GnX9woqQURIRgp/Qe9qZtIjUHKzSbORJYyQN42MM8G1hzY6
# cBEIYij/qRfTQEuat9ND8joC9g1CNn16kFyuFvMhz+EnCGByeHxZdsHyJ20xU1rL
# 5Vp9U5jCHLSdywquOc07hnBQIzKatHTi6dlego6JRSVsnv5RZdzVz6KiJ2z58QQ+
# hPM0Lb+Vrj9K+5OBgfPPJ8xJolWxUkVy5dnjPXRxQ8U8Qevz3Uf90hOeFHP1Myjp
# MAHl+tw=
# SIG # End signature block