|
| 1 | +<# |
| 2 | + .SYNOPSIS |
| 3 | + Creates a new database in a SQL Server Database Engine instance. |
| 4 | +
|
| 5 | + .DESCRIPTION |
| 6 | + This command creates a new database in a SQL Server Database Engine instance. |
| 7 | +
|
| 8 | + .PARAMETER ServerObject |
| 9 | + Specifies current server connection object. |
| 10 | +
|
| 11 | + .PARAMETER Name |
| 12 | + Specifies the name of the database to be created. |
| 13 | +
|
| 14 | + .PARAMETER Collation |
| 15 | + The name of the SQL collation to use for the new database. |
| 16 | + Default value is server collation. |
| 17 | +
|
| 18 | + .PARAMETER CompatibilityLevel |
| 19 | + The version of the SQL compatibility level to use for the new database. |
| 20 | + Default value is server version. |
| 21 | +
|
| 22 | + .PARAMETER RecoveryModel |
| 23 | + The recovery model to be used for the new database. |
| 24 | + Default value is Full. |
| 25 | +
|
| 26 | + .PARAMETER OwnerName |
| 27 | + Specifies the name of the login that should be the owner of the database. |
| 28 | +
|
| 29 | + .PARAMETER Force |
| 30 | + Specifies that the database should be created without any confirmation. |
| 31 | +
|
| 32 | + .PARAMETER Refresh |
| 33 | + Specifies that the **ServerObject**'s databases should be refreshed before |
| 34 | + creating the database object. This is helpful when databases could have been |
| 35 | + modified outside of the **ServerObject**, for example through T-SQL. But |
| 36 | + on instances with a large amount of databases it might be better to make |
| 37 | + sure the **ServerObject** is recent enough. |
| 38 | +
|
| 39 | + .EXAMPLE |
| 40 | + $serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance' |
| 41 | + $serverObject | New-SqlDscDatabase -Name 'MyDatabase' |
| 42 | +
|
| 43 | + Creates a new database named **MyDatabase**. |
| 44 | +
|
| 45 | + .EXAMPLE |
| 46 | + $serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance' |
| 47 | + $serverObject | New-SqlDscDatabase -Name 'MyDatabase' -Collation 'SQL_Latin1_General_Pref_CP850_CI_AS' -RecoveryModel 'Simple' -Force |
| 48 | +
|
| 49 | + Creates a new database named **MyDatabase** with the specified collation and recovery model |
| 50 | + without prompting for confirmation. |
| 51 | +
|
| 52 | + .OUTPUTS |
| 53 | + `[Microsoft.SqlServer.Management.Smo.Database]` |
| 54 | +#> |
| 55 | +function New-SqlDscDatabase |
| 56 | +{ |
| 57 | + [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('UseSyntacticallyCorrectExamples', '', Justification = 'Because the rule does not yet support parsing the code when a parameter type is not available. The ScriptAnalyzer rule UseSyntacticallyCorrectExamples will always error in the editor due to https://github.com/indented-automation/Indented.ScriptAnalyzerRules/issues/8.')] |
| 58 | + [OutputType([Microsoft.SqlServer.Management.Smo.Database])] |
| 59 | + [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'Medium')] |
| 60 | + param |
| 61 | + ( |
| 62 | + [Parameter(Mandatory = $true, ValueFromPipeline = $true)] |
| 63 | + [Microsoft.SqlServer.Management.Smo.Server] |
| 64 | + $ServerObject, |
| 65 | + |
| 66 | + [Parameter(Mandatory = $true)] |
| 67 | + [ValidateNotNullOrEmpty()] |
| 68 | + [System.String] |
| 69 | + $Name, |
| 70 | + |
| 71 | + [Parameter()] |
| 72 | + [ValidateNotNullOrEmpty()] |
| 73 | + [System.String] |
| 74 | + $Collation, |
| 75 | + |
| 76 | + [Parameter()] |
| 77 | + [ValidateSet('Version80', 'Version90', 'Version100', 'Version110', 'Version120', 'Version130', 'Version140', 'Version150', 'Version160')] |
| 78 | + [System.String] |
| 79 | + $CompatibilityLevel, |
| 80 | + |
| 81 | + [Parameter()] |
| 82 | + [ValidateSet('Simple', 'Full', 'BulkLogged')] |
| 83 | + [System.String] |
| 84 | + $RecoveryModel, |
| 85 | + |
| 86 | + [Parameter()] |
| 87 | + [System.String] |
| 88 | + $OwnerName, |
| 89 | + |
| 90 | + [Parameter()] |
| 91 | + [System.Management.Automation.SwitchParameter] |
| 92 | + $Force, |
| 93 | + |
| 94 | + [Parameter()] |
| 95 | + [System.Management.Automation.SwitchParameter] |
| 96 | + $Refresh |
| 97 | + ) |
| 98 | + |
| 99 | + begin |
| 100 | + { |
| 101 | + if ($Force.IsPresent -and -not $Confirm) |
| 102 | + { |
| 103 | + $ConfirmPreference = 'None' |
| 104 | + } |
| 105 | + } |
| 106 | + |
| 107 | + process |
| 108 | + { |
| 109 | + if ($Refresh.IsPresent) |
| 110 | + { |
| 111 | + # Refresh the server object's databases collection |
| 112 | + $ServerObject.Databases.Refresh() |
| 113 | + } |
| 114 | + |
| 115 | + Write-Verbose -Message ($script:localizedData.Database_Create -f $Name, $ServerObject.InstanceName) |
| 116 | + |
| 117 | + # Check if the database already exists |
| 118 | + if ($ServerObject.Databases[$Name]) |
| 119 | + { |
| 120 | + $errorMessage = $script:localizedData.Database_AlreadyExists -f $Name, $ServerObject.InstanceName |
| 121 | + New-InvalidOperationException -Message $errorMessage |
| 122 | + } |
| 123 | + |
| 124 | + # Validate compatibility level if specified |
| 125 | + if ($PSBoundParameters.ContainsKey('CompatibilityLevel')) |
| 126 | + { |
| 127 | + $supportedCompatibilityLevels = @{ |
| 128 | + 8 = @('Version80') |
| 129 | + 9 = @('Version80', 'Version90') |
| 130 | + 10 = @('Version80', 'Version90', 'Version100') |
| 131 | + 11 = @('Version90', 'Version100', 'Version110') |
| 132 | + 12 = @('Version100', 'Version110', 'Version120') |
| 133 | + 13 = @('Version100', 'Version110', 'Version120', 'Version130') |
| 134 | + 14 = @('Version100', 'Version110', 'Version120', 'Version130', 'Version140') |
| 135 | + 15 = @('Version100', 'Version110', 'Version120', 'Version130', 'Version140', 'Version150') |
| 136 | + 16 = @('Version100', 'Version110', 'Version120', 'Version130', 'Version140', 'Version150', 'Version160') |
| 137 | + } |
| 138 | + |
| 139 | + if ($CompatibilityLevel -notin $supportedCompatibilityLevels.$($ServerObject.VersionMajor)) |
| 140 | + { |
| 141 | + $errorMessage = $script:localizedData.Database_InvalidCompatibilityLevel -f $CompatibilityLevel, $ServerObject.InstanceName |
| 142 | + New-InvalidArgumentException -ArgumentName 'CompatibilityLevel' -Message $errorMessage |
| 143 | + } |
| 144 | + } |
| 145 | + |
| 146 | + # Validate collation if specified |
| 147 | + if ($PSBoundParameters.ContainsKey('Collation')) |
| 148 | + { |
| 149 | + if ($Collation -notin $ServerObject.EnumCollations().Name) |
| 150 | + { |
| 151 | + $errorMessage = $script:localizedData.Database_InvalidCollation -f $Collation, $ServerObject.InstanceName |
| 152 | + New-InvalidArgumentException -ArgumentName 'Collation' -Message $errorMessage |
| 153 | + } |
| 154 | + } |
| 155 | + |
| 156 | + $verboseDescriptionMessage = $script:localizedData.Database_Create_ShouldProcessVerboseDescription -f $Name, $ServerObject.InstanceName |
| 157 | + $verboseWarningMessage = $script:localizedData.Database_Create_ShouldProcessVerboseWarning -f $Name |
| 158 | + $captionMessage = $script:localizedData.Database_Create_ShouldProcessCaption |
| 159 | + |
| 160 | + if ($PSCmdlet.ShouldProcess($verboseDescriptionMessage, $verboseWarningMessage, $captionMessage)) |
| 161 | + { |
| 162 | + try |
| 163 | + { |
| 164 | + $sqlDatabaseObjectToCreate = New-Object -TypeName 'Microsoft.SqlServer.Management.Smo.Database' -ArgumentList $ServerObject, $Name |
| 165 | + |
| 166 | + if ($PSBoundParameters.ContainsKey('RecoveryModel')) |
| 167 | + { |
| 168 | + $sqlDatabaseObjectToCreate.RecoveryModel = $RecoveryModel |
| 169 | + } |
| 170 | + |
| 171 | + if ($PSBoundParameters.ContainsKey('Collation')) |
| 172 | + { |
| 173 | + $sqlDatabaseObjectToCreate.Collation = $Collation |
| 174 | + } |
| 175 | + |
| 176 | + if ($PSBoundParameters.ContainsKey('CompatibilityLevel')) |
| 177 | + { |
| 178 | + $sqlDatabaseObjectToCreate.CompatibilityLevel = $CompatibilityLevel |
| 179 | + } |
| 180 | + |
| 181 | + Write-Verbose -Message ($script:localizedData.Database_Creating -f $Name) |
| 182 | + |
| 183 | + $sqlDatabaseObjectToCreate.Create() |
| 184 | + |
| 185 | + <# |
| 186 | + This must be run after the object is created because |
| 187 | + the owner property is read-only and the method cannot |
| 188 | + be call until the object has been created. |
| 189 | + #> |
| 190 | + if ($PSBoundParameters.ContainsKey('OwnerName')) |
| 191 | + { |
| 192 | + $sqlDatabaseObjectToCreate.SetOwner($OwnerName) |
| 193 | + } |
| 194 | + |
| 195 | + Write-Verbose -Message ($script:localizedData.Database_Created -f $Name) |
| 196 | + |
| 197 | + return $sqlDatabaseObjectToCreate |
| 198 | + } |
| 199 | + catch |
| 200 | + { |
| 201 | + $errorMessage = $script:localizedData.Database_CreateFailed -f $Name, $ServerObject.InstanceName |
| 202 | + New-InvalidOperationException -Message $errorMessage -ErrorRecord $_ |
| 203 | + } |
| 204 | + } |
| 205 | + } |
| 206 | +} |
0 commit comments