forked from dataplat/dbatools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Add-DbaExtendedProperty.ps1
169 lines (135 loc) · 6.37 KB
/
Add-DbaExtendedProperty.ps1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
function Add-DbaExtendedProperty {
<#
.SYNOPSIS
Adds an extended property
.DESCRIPTION
Adds an extended property
This command works out of the box with databases but you can add extended properties from several different types of objects, including:
Aggregate
Assembly
Column
Constraint
Contract
Database
Event Notification
Filegroup
Function
Index
Logical File Name
Message Type
Parameter
Partition Function
Partition Scheme
Procedure
Queue
Remote Service Binding
Route
Rule
Schema
Service
Synonym
Table
Trigger
Type
View
Xml Schema Collection
.PARAMETER SqlInstance
The target SQL Server instance
.PARAMETER SqlCredential
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
.PARAMETER Database
Add an extended property to a specific database
.PARAMETER Name
The name of the extended property
.PARAMETER Value
The value for the extended property
.PARAMETER InputObject
Enables piping from Get-Dba* commands
.PARAMETER WhatIf
Shows what would happen if the command were to run. No actions are actually performed.
.PARAMETER Confirm
Prompts you for confirmation before executing any changing operations within the command.
.PARAMETER EnableException
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.
.NOTES
Tags: General, ExtendedProperty
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2021 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
.LINK
https://dbatools.io/Add-DbaExtendedProperty
.EXAMPLE
PS C:\> Add-DbaExtendedProperty -SqlInstance sql2016
Gets all extended properties on all databases
.EXAMPLE
PS C:\> Add-DbaExtendedProperty -SqlInstance Server1 -Database db1
Gets the extended properties for the db1 database
.EXAMPLE
PS C:\> Add-DbaExtendedProperty -SqlInstance Server1 -Database db1 -Name version -Value "1.0.0"
Sets the version extended property for the db1 database to 1.0.0
.EXAMPLE
PS C:\> Get-DbaDbStoredProcedure -SqlInstance localhost -Database tempdb | Add-DbaExtendedProperty -Name SPVersion -Value 10.2
Creates an extended property for all stored procedures in the tempdb database named SPVersion with a value of 10.2
.EXAMPLE
PS C:\> Get-DbaDbTable -SqlInstance localhost -Database mydb -Table mytable | Add-DbaExtendedProperty -Name MyExtendedProperty -Value "This is a test"
Creates an extended property named MyExtendedProperty for the mytable table in the mydb, with a value of "This is a test"
#>
[CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'Medium')]
param (
[DbaInstanceParameter[]]$SqlInstance,
[PSCredential]$SqlCredential,
[string[]]$Database,
[parameter(Mandatory)]
[Alias("Property")]
[string]$Name,
[parameter(Mandatory)]
[string]$Value,
[parameter(ValueFromPipeline)]
[psobject[]]$InputObject,
[switch]$EnableException
)
process {
if ($SqlInstance) {
$InputObject = Get-DbaDatabase -SqlInstance $SqlInstance -SqlCredential $SqlCredential -Database $Database | Where-Object IsAccessible
}
foreach ($object in $InputObject) {
try {
# Since the inputobject is so generic, we need to re-build these properties
$computername = $object.ComputerName
$instancename = $object.InstanceName
$sqlname = $object.SqlInstance
if (-not $computername -or -not $instancename -or -not $sqlname) {
$server = Get-ConnectionParent $object
$servername = $server.Query("SELECT @@servername as servername").servername
if (-not $computername) {
$computername = ([DbaInstanceParameter]$servername).ComputerName
}
if (-not $instancename) {
$instancename = ([DbaInstanceParameter]$servername).InstanceName
}
if (-not $sqlname) {
$sqlname = $servername
}
}
if ($Pscmdlet.ShouldProcess($object.Name, "Adding an extended propernamed named $Name with a value of '$Value'")) {
$prop = New-Object Microsoft.SqlServer.Management.Smo.ExtendedProperty ($object, $Name, $Value)
$prop.Create()
Add-Member -Force -InputObject $prop -MemberType NoteProperty -Name ComputerName -Value $computername
Add-Member -Force -InputObject $prop -MemberType NoteProperty -Name InstanceName -Value $instancename
Add-Member -Force -InputObject $prop -MemberType NoteProperty -Name SqlInstance -Value $sqlname
Add-Member -Force -InputObject $prop -MemberType NoteProperty -Name ParentName -Value $object.Name
Add-Member -Force -InputObject $prop -MemberType NoteProperty -Name Type -Value $object.GetType().Name
Add-Member -Force -InputObject $prop -MemberType NoteProperty -Name Server -Value $server
Select-DefaultView -InputObject $prop -Property ComputerName, InstanceName, SqlInstance, ParentName, Type, Name, Value
}
} catch {
Stop-Function -Message "Failed to add extended property $Name with a value of '$Value' to $($object.Name)" -ErrorRecord $_
}
}
}
}