Skip to content

Commit 1e77eda

Browse files
niphlodactions-user
niphlod
authored and
actions-user
committed
updating build ref file
1 parent da63064 commit 1e77eda

1 file changed

Lines changed: 112 additions & 3 deletions

File tree

‎assets/dbatools-index.json‎

Lines changed: 112 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"CommandName": "Add-DbaAgDatabase",
1313
"Availability": "Windows, Linux, macOS",
1414
"Links": "https://dbatools.io/Add-DbaAgDatabase",
15-
"Examples": "-------------------------- EXAMPLE 1 --------------------------\nPS C:\\\u003eAdd-DbaAgDatabase -SqlInstance sql2017a -AvailabilityGroup ag1 -Database db1, db2 -Confirm\nAdds db1 and db2 to ag1 on sql2017a. Prompts for confirmation.\n-------------------------- EXAMPLE 2 --------------------------\nPS C:\\\u003eGet-DbaDatabase -SqlInstance sql2017a | Out-GridView -Passthru | Add-DbaAgDatabase -AvailabilityGroup ag1\nAdds selected databases from sql2017a to ag1\n-------------------------- EXAMPLE 3 --------------------------\nPS C:\\\u003eGet-DbaDbSharePoint -SqlInstance sqlcluster | Add-DbaAgDatabase -AvailabilityGroup SharePoint\nAdds SharePoint databases as found in SharePoint_Config on sqlcluster to ag1 on sqlcluster\n-------------------------- EXAMPLE 4 --------------------------\nPS C:\\\u003eGet-DbaDbSharePoint -SqlInstance sqlcluster -ConfigDatabase SharePoint_Config_2019 | Add-DbaAgDatabase -AvailabilityGroup SharePoint\nAdds SharePoint databases as found in SharePoint_Config_2019 on sqlcluster to ag1 on sqlcluster",
15+
"Examples": "-------------------------- EXAMPLE 1 --------------------------\nPS C:\\\u003eAdd-DbaAgDatabase -SqlInstance sql2017a -AvailabilityGroup ag1 -Database db1, db2 -Confirm\nAdds db1 and db2 to ag1 on sql2017a. Prompts for confirmation.\n-------------------------- EXAMPLE 2 --------------------------\nPS C:\\\u003eGet-DbaDatabase -SqlInstance sql2017a | Out-GridView -Passthru | Add-DbaAgDatabase -AvailabilityGroup ag1\nAdds selected databases from sql2017a to ag1\n-------------------------- EXAMPLE 3 --------------------------\nPS C:\\\u003eGet-DbaDbSharePoint -SqlInstance sqlcluster | Add-DbaAgDatabase -AvailabilityGroup SharePoint\nAdds SharePoint databases as found in SharePoint_Config on sqlcluster to ag1 on sqlcluster\n-------------------------- EXAMPLE 4 --------------------------\nPS C:\\\u003eGet-DbaDbSharePoint -SqlInstance sqlcluster -ConfigDatabase SharePoint_Config_2019 | Add-DbaAgDatabase -AvailabilityGroup SharePoint\nAdds SharePoint databases as found in SharePoint_Config_2019 on sqlcluster to ag1 on sqlcluster\n-------------------------- EXAMPLE 5 --------------------------\nPS C:\\\u003eAdd-DbaAgDatabase -SqlInstance sql2017a -AvailabilityGroup ag1 -Database db1 -Secondary sql2017b -SeedingMode Manual -SharedPath \\\\FS\\Backup -AdvancedBackupParams @{ CompressBackup = $true ; \r\nFileCount = 3 }\nAdds db1 to ag1 on sql2017a and sql2017b. Uses compression and three files while taking the backups.",
1616
"Params": [
1717
[
1818
"SqlInstance",
@@ -104,6 +104,15 @@
104104
"False",
105105
""
106106
],
107+
[
108+
"AdvancedBackupParams",
109+
"Provide additional parameters to the backup command as a hashtable.",
110+
"",
111+
false,
112+
"false",
113+
"",
114+
""
115+
],
107116
[
108117
"EnableException",
109118
"By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.\r\nThis avoids overwhelming you with \"sea of red\" exceptions, but is inconvenient because it basically disables advanced scripting.\r\nUsing this switch turns this \"nice by default\" feature off and enables you to catch exceptions with your own try/catch.",
@@ -132,7 +141,7 @@
132141
""
133142
]
134143
],
135-
"Syntax": "Add-DbaAgDatabase [-SqlInstance] \u003cDbaInstanceParameter\u003e [-SqlCredential \u003cPSCredential\u003e] -AvailabilityGroup \u003cString\u003e -Database \u003cString[]\u003e [-Secondary \u003cDbaInstanceParameter[]\u003e] [-SecondarySqlCredential \u003cPSCredential\u003e] [-SeedingMode \u003cString\u003e] [-SharedPath \u003cString\u003e] [-UseLastBackup] [-EnableException] [-WhatIf] [-Confirm] [\u003cCommonParameters\u003e]\nAdd-DbaAgDatabase [-AvailabilityGroup] \u003cString\u003e [-Secondary \u003cDbaInstanceParameter[]\u003e] [-SecondarySqlCredential \u003cPSCredential\u003e] -InputObject \u003cDatabase[]\u003e [-SeedingMode \u003cString\u003e] [-SharedPath \u003cString\u003e] [-UseLastBackup] [-EnableException] [-WhatIf] [-Confirm] [\u003cCommonParameters\u003e]"
144+
"Syntax": "Add-DbaAgDatabase [-SqlInstance] \u003cDbaInstanceParameter\u003e [-SqlCredential \u003cPSCredential\u003e] -AvailabilityGroup \u003cString\u003e -Database \u003cString[]\u003e [-Secondary \u003cDbaInstanceParameter[]\u003e] [-SecondarySqlCredential \u003cPSCredential\u003e] [-SeedingMode \u003cString\u003e] [-SharedPath \u003cString\u003e] [-UseLastBackup] [-AdvancedBackupParams \u003cHashtable\u003e] [-EnableException] [-WhatIf] [-Confirm] [\u003cCommonParameters\u003e]\nAdd-DbaAgDatabase [-AvailabilityGroup] \u003cString\u003e [-Secondary \u003cDbaInstanceParameter[]\u003e] [-SecondarySqlCredential \u003cPSCredential\u003e] -InputObject \u003cDatabase[]\u003e [-SeedingMode \u003cString\u003e] [-SharedPath \u003cString\u003e] [-UseLastBackup] [-AdvancedBackupParams \u003cHashtable\u003e] [-EnableException] [-WhatIf] [-Confirm] [\u003cCommonParameters\u003e]"
136145
},
137146
{
138147
"Name": "Add-DbaAgListener",
@@ -40256,7 +40265,7 @@
4025640265
"CommandName": "New-DbaDbTable",
4025740266
"Availability": "Windows, Linux, macOS",
4025840267
"Links": "https://dbatools.io/New-DbaDbTable",
40259-
"Examples": "-------------------------- EXAMPLE 1 --------------------------\nPS C:\\\u003e$col = @{\n\u003e\u003e Name = \u0027test\u0027\r\n\u003e\u003e Type = \u0027varchar\u0027\r\n\u003e\u003e MaxLength = 20\r\n\u003e\u003e Nullable = $true\r\n\u003e\u003e }\r\nPS C:\\\u003e New-DbaDbTable -SqlInstance sql2017 -Database tempdb -Name testtable -ColumnMap $col\nCreates a new table on sql2017 in tempdb with the name testtable and one column\n-------------------------- EXAMPLE 2 --------------------------\nPS C:\\\u003e# Create collection\n\u003e\u003e $cols = @()\n\u003e\u003e # Add columns to collection\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027testId\u0027\r\n\u003e\u003e Type = \u0027int\u0027\r\n\u003e\u003e Identity = $true\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test\u0027\r\n\u003e\u003e Type = \u0027varchar\u0027\r\n\u003e\u003e MaxLength = 20\r\n\u003e\u003e Nullable = $true\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test2\u0027\r\n\u003e\u003e Type = \u0027int\u0027\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test3\u0027\r\n\u003e\u003e Type = \u0027decimal\u0027\r\n\u003e\u003e MaxLength = 9\r\n\u003e\u003e Nullable = $true\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test4\u0027\r\n\u003e\u003e Type = \u0027decimal\u0027\r\n\u003e\u003e Precision = 8\r\n\u003e\u003e Scale = 2\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test5\u0027\r\n\u003e\u003e Type = \u0027Nvarchar\u0027\r\n\u003e\u003e MaxLength = 50\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e Default = \u0027Hello\u0027\r\n\u003e\u003e DefaultName = \u0027DF_Name_test5\u0027\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test6\u0027\r\n\u003e\u003e Type = \u0027int\u0027\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e Default = \u00270\u0027\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test7\u0027\r\n\u003e\u003e Type = \u0027smallint\u0027\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e Default = 100\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test8\u0027\r\n\u003e\u003e Type = \u0027Nchar\u0027\r\n\u003e\u003e MaxLength = 3\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e Default = \u0027ABC\u0027\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test9\u0027\r\n\u003e\u003e Type = \u0027char\u0027\r\n\u003e\u003e MaxLength = 4\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e Default = \u0027XPTO\u0027\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test10\u0027\r\n\u003e\u003e Type = \u0027datetime\u0027\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e Default = \u0027GETDATE()\u0027\r\n\u003e\u003e }\nPS C:\\\u003e New-DbaDbTable -SqlInstance sql2017 -Database tempdb -Name testtable -ColumnMap $cols\nCreates a new table on sql2017 in tempdb with the name testtable and ten columns.",
40268+
"Examples": "-------------------------- EXAMPLE 1 --------------------------\nPS C:\\\u003e$col = @{\n\u003e\u003e Name = \u0027test\u0027\r\n\u003e\u003e Type = \u0027varchar\u0027\r\n\u003e\u003e MaxLength = 20\r\n\u003e\u003e Nullable = $true\r\n\u003e\u003e }\r\nPS C:\\\u003e New-DbaDbTable -SqlInstance sql2017 -Database tempdb -Name testtable -ColumnMap $col\nCreates a new table on sql2017 in tempdb with the name testtable and one column\n-------------------------- EXAMPLE 2 --------------------------\nPS C:\\\u003e$col = @{\n\u003e\u003e Name = \u0027Id\u0027\r\n\u003e\u003e Type = \u0027varchar\u0027\r\n\u003e\u003e MaxLength = 36\r\n\u003e\u003e DefaultEx = \u0027NEWID()\u0027\r\n\u003e\u003e }\r\nPS C:\\\u003e New-DbaDbTable -SqlInstance sql2017 -Database tempdb -Name testtable -ColumnMap $col\nCreates a new table on sql2017 in tempdb with the name testtable and one column. Uses \"DefaultEx\" to interpret the value as an expression and not as a string.\n-------------------------- EXAMPLE 3 --------------------------\nPS C:\\\u003e# Create collection\n\u003e\u003e $cols = @()\n\u003e\u003e # Add columns to collection\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027testId\u0027\r\n\u003e\u003e Type = \u0027int\u0027\r\n\u003e\u003e Identity = $true\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test\u0027\r\n\u003e\u003e Type = \u0027varchar\u0027\r\n\u003e\u003e MaxLength = 20\r\n\u003e\u003e Nullable = $true\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test2\u0027\r\n\u003e\u003e Type = \u0027int\u0027\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test3\u0027\r\n\u003e\u003e Type = \u0027decimal\u0027\r\n\u003e\u003e MaxLength = 9\r\n\u003e\u003e Nullable = $true\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test4\u0027\r\n\u003e\u003e Type = \u0027decimal\u0027\r\n\u003e\u003e Precision = 8\r\n\u003e\u003e Scale = 2\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test5\u0027\r\n\u003e\u003e Type = \u0027Nvarchar\u0027\r\n\u003e\u003e MaxLength = 50\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e Default = \u0027Hello\u0027\r\n\u003e\u003e DefaultName = \u0027DF_Name_test5\u0027\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test6\u0027\r\n\u003e\u003e Type = \u0027int\u0027\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e Default = \u00270\u0027\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test7\u0027\r\n\u003e\u003e Type = \u0027smallint\u0027\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e Default = 100\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test8\u0027\r\n\u003e\u003e Type = \u0027Nchar\u0027\r\n\u003e\u003e MaxLength = 3\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e Default = \u0027ABC\u0027\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test9\u0027\r\n\u003e\u003e Type = \u0027char\u0027\r\n\u003e\u003e MaxLength = 4\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e Default = \u0027XPTO\u0027\r\n\u003e\u003e }\r\n\u003e\u003e $cols += @{\r\n\u003e\u003e Name = \u0027test10\u0027\r\n\u003e\u003e Type = \u0027datetime\u0027\r\n\u003e\u003e Nullable = $false\r\n\u003e\u003e Default = \u0027GETDATE()\u0027\r\n\u003e\u003e }\nPS C:\\\u003e New-DbaDbTable -SqlInstance sql2017 -Database tempdb -Name testtable -ColumnMap $cols\nCreates a new table on sql2017 in tempdb with the name testtable and ten columns.",
4026040269
"Params": [
4026140270
[
4026240271
"SqlInstance",
@@ -46045,6 +46054,106 @@
4604546054
],
4604646055
"Syntax": "Remove-DbaDbCertificate [[-SqlInstance] \u003cDbaInstanceParameter[]\u003e] [[-SqlCredential] \u003cPSCredential\u003e] [[-Database] \u003cString[]\u003e] [[-Certificate] \u003cString[]\u003e] [[-InputObject] \u003cCertificate[]\u003e] [-EnableException] [-WhatIf] [-Confirm] [\u003cCommonParameters\u003e]"
4604746056
},
46057+
{
46058+
"Name": "Remove-DbaDbCheckConstraint",
46059+
"Description": "Removes a database check constraint(s), with supported piping from Get-DbaDbCheckConstraint.",
46060+
"Tags": [
46061+
"Check",
46062+
"Constraint",
46063+
"Database"
46064+
],
46065+
"Synopsis": "Removes a database check constraint(s) from each database and SQL Server instance.",
46066+
"Alias": "",
46067+
"Author": "Mikey Bronowski (@MikeyBronowski), https://bronowski.it",
46068+
"CommandName": "Remove-DbaDbCheckConstraint",
46069+
"Availability": "Windows, Linux, macOS",
46070+
"Links": "https://dbatools.io/Remove-DbaDbCheckConstraint",
46071+
"Examples": "-------------------------- EXAMPLE 1 --------------------------\nPS C:\\\u003eRemove-DbaDbCheckConstraint -SqlInstance localhost, sql2016 -Database db1, db2\nRemoves all check constraints from db1 and db2 on the local and sql2016 SQL Server instances.\n-------------------------- EXAMPLE 2 --------------------------\nPS C:\\\u003e$chkcs = Get-DbaDbCheckConstraint -SqlInstance localhost, sql2016 -Database db1, db2\nPS C:\\\u003e $chkcs | Remove-DbaDbCheckConstraint\nRemoves all check constraints from db1 and db2 on the local and sql2016 SQL Server instances.\n-------------------------- EXAMPLE 3 --------------------------\nPS C:\\\u003eRemove-DbaDbCheckConstraint -SqlInstance localhost, sql2016 -Database db1, db2 -ExcludeSystemTable\nRemoves all check constraints except those in system tables from db1 and db2 on the local and sql2016 SQL Server instances.",
46072+
"Params": [
46073+
[
46074+
"SqlInstance",
46075+
"The target SQL Server instance or instances.",
46076+
"",
46077+
false,
46078+
"false",
46079+
"",
46080+
""
46081+
],
46082+
[
46083+
"SqlCredential",
46084+
"Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).\nWindows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.\nFor MFA support, please use Connect-DbaInstance.",
46085+
"",
46086+
false,
46087+
"false",
46088+
"",
46089+
""
46090+
],
46091+
[
46092+
"Database",
46093+
"The target database(s).",
46094+
"",
46095+
false,
46096+
"false",
46097+
"",
46098+
""
46099+
],
46100+
[
46101+
"ExcludeDatabase",
46102+
"The database(s) to exclude - this list is auto populated from the server.",
46103+
"",
46104+
false,
46105+
"false",
46106+
"",
46107+
""
46108+
],
46109+
[
46110+
"ExcludeSystemTable",
46111+
"This switch removes all system tables from the check collection.",
46112+
"",
46113+
false,
46114+
"false",
46115+
"False",
46116+
""
46117+
],
46118+
[
46119+
"InputObject",
46120+
"Allows piping from Get-DbaDbCheckConstraint.",
46121+
"",
46122+
true,
46123+
"true (ByValue)",
46124+
"",
46125+
""
46126+
],
46127+
[
46128+
"EnableException",
46129+
"By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.\r\nThis avoids overwhelming you with \"sea of red\" exceptions, but is inconvenient because it basically disables advanced scripting.\r\nUsing this switch turns this \"nice by default\" feature off and enables you to catch exceptions with your own try/catch.",
46130+
"",
46131+
false,
46132+
"false",
46133+
"False",
46134+
""
46135+
],
46136+
[
46137+
"WhatIf",
46138+
"Shows what would happen if the command were to run. No actions are actually performed.",
46139+
"wi",
46140+
false,
46141+
"false",
46142+
"",
46143+
""
46144+
],
46145+
[
46146+
"Confirm",
46147+
"Prompts you for confirmation before executing any changing operations within the command.\r\nThis is the default. Use -Confirm:$false to suppress these prompts.",
46148+
"cf",
46149+
false,
46150+
"false",
46151+
"",
46152+
""
46153+
]
46154+
],
46155+
"Syntax": "Remove-DbaDbCheckConstraint [-SqlInstance \u003cDbaInstanceParameter[]\u003e] [-SqlCredential \u003cPSCredential\u003e] [-Database \u003cObject[]\u003e] [-ExcludeDatabase \u003cObject[]\u003e] [-ExcludeSystemTable] [-WhatIf] [-Confirm] [\u003cCommonParameters\u003e]\nRemove-DbaDbCheckConstraint [-SqlInstance \u003cDbaInstanceParameter[]\u003e] [-SqlCredential \u003cPSCredential\u003e] [-Database \u003cObject[]\u003e] [-ExcludeDatabase \u003cObject[]\u003e] [-ExcludeSystemTable] -InputObject \u003cCheck[]\u003e [-EnableException] [-WhatIf] [-Confirm] [\u003cCommonParameters\u003e]"
46156+
},
4604846157
{
4604946158
"Name": "Remove-DbaDbData",
4605046159
"Description": "This command truncates all the tables in a database. If there are foreign keys and/or views they are scripted out, then dropped before the truncate, and recreated after.",

0 commit comments

Comments
 (0)