Skip to content

Commit

Permalink
refreshing docs pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@potatoqualitee @github-actions
potatoqualitee authored and github-actions[bot] committed Sep 28, 2023
1 parent c825c67 commit aa3189d
Show file tree
Hide file tree
Showing 42 changed files with 14,243 additions and 722 deletions.
867 changes: 867 additions & 0 deletions Add-DbaReplArticle.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion Copy-DbaDatabase.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -624,7 +624,7 @@ <h5 id="destination">-Destination</h5>
</tbody>
</table>
<h5 id="backuprestore">-BackupRestore</h5>
<p>If this switch is enabled, the copy-only backup and restore method will be used to migrate the database(s). This method requires that you specify -SharedPath in a valid UNC format (\server\share).
<p>If this switch is enabled, the copy-only backup and restore method will be used to migrate the database(s). This method requires that you specify either -SharedPath or -UseLastBackup.
Backups will be immediately deleted after use unless -NoBackupCleanup is specified.<br></p>
<table>
<thead>
Expand Down
700 changes: 700 additions & 0 deletions Disable-DbaReplDistributor.html
View file

Large diffs are not rendered by default.

701 changes: 701 additions & 0 deletions Disable-DbaReplPublishing.html
View file

Large diffs are not rendered by default.

697 changes: 697 additions & 0 deletions Enable-DbaReplDistributor.html
View file

Large diffs are not rendered by default.

723 changes: 723 additions & 0 deletions Enable-DbaReplPublishing.html
View file

Large diffs are not rendered by default.

856 changes: 856 additions & 0 deletions Export-DbaReplServerSetting.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion Export-DbaUser.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -753,7 +753,7 @@ <h5 id="destinationversion">-DestinationVersion</h5>
</tr>
<tr>
<td>Accepted Values</td>
<td>SQLServer2000,SQLServer2005,SQLServer2008/2008R2,SQLServer2012,SQLServer2014,SQLServer2016,SQLServer2017,SQLServer2019</td>
<td>SQLServer2000,SQLServer2005,SQLServer2008/2008R2,SQLServer2012,SQLServer2014,SQLServer2016,SQLServer2017,SQLServer2019,SQLServer2022</td>
</tr>
</tbody>
</table>
Expand Down
2 changes: 1 addition & 1 deletion Get-DbaAvailableCollation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@ <h5 id="example-1">Example: 1</h5>
<p>Gets all the collations from server sql2016 using NT authentication<br></p>
<h3 id="required-parameters">Required Parameters</h3>
<h5 id="sqlinstance">-SqlInstance</h5>
<p>TThe target SQL Server instance or instances. Only connect permission is required.<br></p>
<p>The target SQL Server instance or instances. Only connect permission is required.<br></p>
<table>
<thead>
<tr>
Expand Down
8 changes: 4 additions & 4 deletions Get-DbaDatabase.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -792,8 +792,8 @@ <h5 id="encrypted">-Encrypted</h5>
</tbody>
</table>
<h5 id="status">-Status</h5>
<p>Specifies one or more database statuses to filter on. Only databases in the status(es) listed will be returned. Valid options for this parameter are 'Emergency', 'Normal', 'Offline', 'Recovering',
'Restoring', 'Standby', and 'Suspect'.<br></p>
<p>Specifies one or more database statuses to filter on. Only databases in the status(es) listed will be returned. Valid options for this parameter are 'EmergencyMode', 'Normal', 'Offline',
'Recovering', 'RecoveryPending', 'Restoring', 'Standby', and 'Suspect'.<br></p>
<table>
<thead>
<tr>
Expand All @@ -816,11 +816,11 @@ <h5 id="status">-Status</h5>
</tr>
<tr>
<td>Default Value</td>
<td>@('EmergencyMode', 'Normal', 'Offline', 'Recovering', 'Restoring', 'Standby', 'Suspect')</td>
<td>@('EmergencyMode', 'Normal', 'Offline', 'Recovering', 'RecoveryPending', 'Restoring', 'Standby', 'Suspect')</td>
</tr>
<tr>
<td>Accepted Values</td>
<td>EmergencyMode,Normal,Offline,Recovering,Restoring,Standby,Suspect</td>
<td>EmergencyMode,Normal,Offline,Recovering,RecoveryPending,Restoring,Standby,Suspect</td>
</tr>
</tbody>
</table>
Expand Down
2 changes: 1 addition & 1 deletion Get-DbaDbMail.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@ <h5 id="example-3">Example: 3</h5>
<p>Returns the db mail server object for &quot;sql2014&quot;,&quot;sql2016&quot; and &quot;sqlcluster\sharepoint&quot;<br></p>
<h3 id="required-parameters">Required Parameters</h3>
<h5 id="sqlinstance">-SqlInstance</h5>
<p>TThe target SQL Server instance or instances.<br></p>
<p>The target SQL Server instance or instances.<br></p>
<table>
<thead>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion Get-DbaDbMailConfig.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,7 @@ <h5 id="example-4">Example: 4</h5>
<p>Returns the DBMail configs for &quot;sql2014&quot;,&quot;sql2016&quot; and &quot;sqlcluster\sharepoint&quot;<br></p>
<h3 id="optional-parameters">Optional Parameters</h3>
<h5 id="sqlinstance">-SqlInstance</h5>
<p>TThe target SQL Server instance or instances.<br></p>
<p>The target SQL Server instance or instances.<br></p>
<table>
<thead>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion Get-DbaDbMailHistory.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,7 @@ <h5 id="example-3">Example: 3</h5>
<p>Returns the all DBMail history for &quot;sql2014&quot;,&quot;sql2016&quot; and &quot;sqlcluster\sharepoint&quot;<br></p>
<h3 id="optional-parameters">Optional Parameters</h3>
<h5 id="sqlinstance">-SqlInstance</h5>
<p>TThe target SQL Server instance or instances.<br></p>
<p>The target SQL Server instance or instances.<br></p>
<table>
<thead>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion Get-DbaDbMailLog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,7 @@ <h5 id="example-3">Example: 3</h5>
<p>Returns only the Error and Information DBMail log for &quot;sql2014&quot;,&quot;sql2016&quot; and &quot;sqlcluster\sharepoint&quot;<br></p>
<h3 id="optional-parameters">Optional Parameters</h3>
<h5 id="sqlinstance">-SqlInstance</h5>
<p>TThe target SQL Server instance or instances.<br></p>
<p>The target SQL Server instance or instances.<br></p>
<table>
<thead>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion Get-DbaDbMailServer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,7 @@ <h5 id="example-4">Example: 4</h5>
<p>Returns the DBMail servers for &quot;sql2014&quot;,&quot;sql2016&quot; and &quot;sqlcluster\sharepoint&quot;<br></p>
<h3 id="optional-parameters">Optional Parameters</h3>
<h5 id="sqlinstance">-SqlInstance</h5>
<p>TThe target SQL Server instance or instances.<br></p>
<p>The target SQL Server instance or instances.<br></p>
<table>
<thead>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion Get-DbaDefaultPath.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -511,7 +511,7 @@ <h5 id="example-2">Example: 2</h5>
<p>Returns the default file paths for &quot;sql2014&quot;,&quot;sql2016&quot; and &quot;sqlcluster\sharepoint&quot;<br></p>
<h3 id="required-parameters">Required Parameters</h3>
<h5 id="sqlinstance">-SqlInstance</h5>
<p>TThe target SQL Server instance or instances.<br></p>
<p>The target SQL Server instance or instances.<br></p>
<table>
<thead>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion Get-DbaErrorLog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -536,7 +536,7 @@ <h5 id="example-7">Example: 7</h5>
<p>Returns every log entry found before the date 16 August 2016 from sql101\sharepoint SQL Server instance.<br></p>
<h3 id="optional-parameters">Optional Parameters</h3>
<h5 id="sqlinstance">-SqlInstance</h5>
<p>TThe target SQL Server instance or instances.<br></p>
<p>The target SQL Server instance or instances.<br></p>
<table>
<thead>
<tr>
Expand Down
2 changes: 2 additions & 0 deletions Get-DbaMaintenanceSolutionLog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,8 @@ <h2 id="synopsis">Synopsis</h2>
<p>Reads the log files generated by the IndexOptimize Agent Job from Ola Hallengren's MaintenanceSolution.</p>
<h2 id="description">Description</h2>
<p>Ola wrote a .sql script to get the content from the commandLog table. However, if LogToTable='N', there will be no logging in that table. This function reads the text files that are written in the SQL Instance's Log directory.</p>
<p>Be aware that this command only works if sqlcmd is used to execute the procedures, which is a legacy way to start them and not used by new installations.</p>
<p>We would instead recommend installing using Install-DbaMaintenanceSolution and calling the procedures with the LogToTable='Y' parameter.</p>
<h2 id="syntax">Syntax</h2>
<pre><code>Get-DbaMaintenanceSolutionLog
[-SqlInstance] &lt;DbaInstanceParameter[]&gt;
Expand Down
240 changes: 240 additions & 0 deletions Get-DbaMemoryUsage.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -496,6 +496,11 @@ <h2 id="syntax">Syntax</h2>
<pre><code>Get-DbaMemoryUsage
[[-ComputerName] &lt;DbaInstanceParameter[]&gt;]
[[-Credential] &lt;PSCredential&gt;]
[[-MemoryCounterRegex] &lt;String&gt;]
[[-PlanCounterRegex] &lt;String&gt;]
[[-BufferCounterRegex] &lt;String&gt;]
[[-SSASCounterRegex] &lt;String&gt;]
[[-SSISCounterRegex] &lt;String&gt;]
[-EnableException]
[&lt;CommonParameters&gt;]

Expand Down Expand Up @@ -574,6 +579,241 @@ <h5 id="credential">-Credential</h5>
</tr>
</tbody>
</table>
<h5 id="memorycounterregex">-MemoryCounterRegex</h5>
<p>Regular expression that is applied to the paths of the counters returned for the counter list set '<em>sql</em>:Memory Manager*' to display relevant Memory Manager counters.
Default: '(Total Server Memory |Target Server Memory |Connection Memory |Lock Memory |SQL Cache Memory |Optimizer Memory |Granted Workspace Memory |Cursor memory usage|Maximum Workspace)'
The default works for English language systems and has to be adapted for other languages.<br></p>
<table>
<thead>
<tr>
<th></th>
<th></th>
<th></th>
<th></th>
<th></th>
<th></th>
<th></th>
<th></th>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td>Alias</td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Required</td>
<td>False</td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Pipeline</td>
<td>false</td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Default Value</td>
<td>(Total Server Memory</td>
<td>Target Server Memory</td>
<td>Connection Memory</td>
<td>Lock Memory</td>
<td>SQL Cache Memory</td>
<td>Optimizer Memory</td>
<td>Granted Workspace Memory</td>
<td>Cursor memory usage</td>
<td>Maximum Workspace)</td>
</tr>
</tbody>
</table>
<h5 id="plancounterregex">-PlanCounterRegex</h5>
<p>Regular expression that is applied to the paths of the counters returned for the counter list set '<em>sql</em>:Plan Cache*' to display relevant Plan Cache counters.
Default: '(cache pages|procedure plan|ad hoc sql plan|prepared SQL Plan)'
The default works for English language systems and has to be adapted for other languages.<br></p>
<table>
<thead>
<tr>
<th></th>
<th></th>
<th></th>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td>Alias</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Required</td>
<td>False</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Pipeline</td>
<td>false</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Default Value</td>
<td>(cache pages</td>
<td>procedure plan</td>
<td>ad hoc sql plan</td>
<td>prepared SQL Plan)</td>
</tr>
</tbody>
</table>
<h5 id="buffercounterregex">-BufferCounterRegex</h5>
<p>Regular expression that is applied to the paths of the counters returned for the counter list set '<em>Buffer Manager</em>' to display relevant Buffer Manager counters.
Default: '(Free pages|Reserved pages|Stolen pages|Total pages|Database pages|target pages|extension .* pages)'
The default works for English language systems and has to be adapted for other languages.<br></p>
<table>
<thead>
<tr>
<th></th>
<th></th>
<th></th>
<th></th>
<th></th>
<th></th>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td>Alias</td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Required</td>
<td>False</td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Pipeline</td>
<td>false</td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Default Value</td>
<td>(Free pages</td>
<td>Reserved pages</td>
<td>Stolen pages</td>
<td>Total pages</td>
<td>Database pages</td>
<td>target pages</td>
<td>extension .* pages)</td>
</tr>
</tbody>
</table>
<h5 id="ssascounterregex">-SSASCounterRegex</h5>
<p>Regular expression that is applied to the paths of the counters returned for the counter list set 'MSAS*:Memory' to display relevant SSAS counters.
Default: '(\memory )'
The default works for English language systems and has to be adapted for other languages.<br></p>
<table>
<thead>
<tr>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td>Alias</td>
<td></td>
</tr>
<tr>
<td>Required</td>
<td>False</td>
</tr>
<tr>
<td>Pipeline</td>
<td>false</td>
</tr>
<tr>
<td>Default Value</td>
<td>(\memory )</td>
</tr>
</tbody>
</table>
<h5 id="ssiscounterregex">-SSISCounterRegex</h5>
<p>Regular expression that is applied to the paths of the counters returned for the counter list set '<em>SSIS</em>' to display relevant SSIS counters.
Default: '(memory)'
The default works for English language systems and has to be adapted for other languages.<br></p>
<table>
<thead>
<tr>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td>Alias</td>
<td></td>
</tr>
<tr>
<td>Required</td>
<td>False</td>
</tr>
<tr>
<td>Pipeline</td>
<td>false</td>
</tr>
<tr>
<td>Default Value</td>
<td>(memory)</td>
</tr>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>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 &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.
Expand Down
Loading

0 comments on commit aa3189d

Please sign in to comment.