Skip to content

Commit 16d8192

Browse files
potatoqualiteegithub-actions[bot]
authored andcommitted
refreshing docs pages
1 parent 61bb98c commit 16d8192

10 files changed

Lines changed: 715 additions & 715 deletions

Enable-DbaReplPublishing.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -504,9 +504,9 @@ <h2 id="syntax">Syntax</h2>
504504
<h2 id="examples">Examples</h2>
505505
<p> </p>
506506
<h5 id="example-1">Example: 1</h5>
507-
<pre><code>PS C:\&gt; Enable-DbaReplPublishing -SqlInstance SqlBox1\Instance2 -StartupProcedure '[dbo].[StartUpProc1]'
507+
<pre><code>PS C:\&gt; Enable-DbaReplPublishing -SqlInstance SqlBox1\Instance2
508508
</code></pre>
509-
<p>Attempts to set the procedure '[dbo].[StartUpProc1]' in the master database of SqlBox1\Instance2 for automatic execution when the instance is started.<br></p>
509+
<p>Enables replication publishing for instance SqlBox1\Instance2 using Windows Auth and the default InstallDataDirectory\ReplData as the snapshot folder<br></p>
510510
<h3 id="required-parameters">Required Parameters</h3>
511511
<h5 id="sqlinstance">-SqlInstance</h5>
512512
<p>The target SQL Server instance or instances. <br></p>

Export-DbaDbTableData.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -513,12 +513,12 @@ <h5 id="example-1">Example: 1</h5>
513513
</code></pre>
514514
<p>Exports data from EmployeePayHistory in AdventureWorks2014 in sql2017<br></p>
515515
<h5 id="example-2">Example: 2</h5>
516-
<pre><code>PS C:\&gt; Get-DbaDbTable -SqlInstance sql2017 -Database AdventureWorks2014 -Table EmployeePayHistory | Export-DbaDbTableData -Path C:\temp\export.sql -Append
516+
<pre><code>PS C:\&gt; Get-DbaDbTable -SqlInstance sql2017 -Database AdventureWorks2014 -Table EmployeePayHistory | Export-DbaDbTableData -FilePath C:\temp\export.sql -Append
517517
</code></pre>
518518
<p>Exports data from EmployeePayHistory in AdventureWorks2014 in sql2017 using a trusted connection - Will append the output to the file C:\temp\export.sql if it already exists<br>
519519
Script does not include Batch Separator and will not compile<br></p>
520520
<h5 id="example-3">Example: 3</h5>
521-
<pre><code>PS C:\&gt; Get-DbaDbTable -SqlInstance sql2016 -Database MyDatabase -Table 'dbo.Table1', 'dbo.Table2' -SqlCredential sqladmin | Export-DbaDbTableData -Path C:\temp\export.sql
521+
<pre><code>PS C:\&gt; Get-DbaDbTable -SqlInstance sql2016 -Database MyDatabase -Table 'dbo.Table1', 'dbo.Table2' -SqlCredential sqladmin | Export-DbaDbTableData -FilePath C:\temp\export.sql -Append
522522
</code></pre>
523523
<p>Exports only data from 'dbo.Table1' and 'dbo.Table2' in MyDatabase to C:\temp\export.sql and uses the SQL login &quot;sqladmin&quot; to login to sql2016<br></p>
524524
<h3 id="required-parameters">Required Parameters</h3>

Get-DbaAgDatabase.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -513,7 +513,7 @@ <h5 id="example-2">Example: 2</h5>
513513
</code></pre>
514514
<p>Returns all the databases in the availability group AG101 on sql2017a<br></p>
515515
<h5 id="example-3">Example: 3</h5>
516-
<pre><code>PS C:\&gt; Get-DbaAvailabilityGroup -SqlInstance sqlcluster -AvailabilityGroup SharePoint -Database Sharepoint_Config | Get-DbaAgDatabase
516+
<pre><code>PS C:\&gt; Get-DbaAvailabilityGroup -SqlInstance sqlcluster -AvailabilityGroup SharePoint | Get-DbaAgDatabase -Database Sharepoint_Config
517517
</code></pre>
518518
<p>Returns the database Sharepoint_Config found in the availability group SharePoint on server sqlcluster<br></p>
519519
<h3 id="optional-parameters">Optional Parameters</h3>

Get-DbatoolsChangeLog.html

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ <h1 id="get-dbatoolschangelog">Get-DbatoolsChangeLog</h1>
487487
<h2 id="synopsis">Synopsis</h2>
488488
<p>Opens the link to our online change log</p>
489489
<h2 id="description">Description</h2>
490-
<p>Opens the link to our online change log. To see the local changelog instead, use the Local parameter.</p>
490+
<p>Opens the link to our online change log.</p>
491491
<h2 id="syntax">Syntax</h2>
492492
<pre><code>Get-DbatoolsChangeLog
493493
[-Local]
@@ -502,13 +502,9 @@ <h5 id="example-1">Example: 1</h5>
502502
<pre><code>PS C:\&gt; Get-DbatoolsChangeLog
503503
</code></pre>
504504
<p>Opens a browser to our online changelog<br></p>
505-
<h5 id="example-2">Example: 2</h5>
506-
<pre><code>PS C:\&gt; Get-DbatoolsChangeLog -Local
507-
</code></pre>
508-
<p>Returns the content from changelog.md<br></p>
509505
<h3 id="optional-parameters">Optional Parameters</h3>
510506
<h5 id="local">-Local</h5>
511-
<p>Return the local change log to the console<br></p>
507+
<p>Once upon a time, there was a local changelog. This is not available anymore so a proper warning will be raised<br></p>
512508
<table>
513509
<thead>
514510
<tr>

New-DbaAgentJobStep.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -811,7 +811,7 @@ <h5 id="cmdexecsuccesscode">-CmdExecSuccessCode</h5>
811811
<h5 id="onsuccessaction">-OnSuccessAction</h5>
812812
<p>The action to perform if the step succeeds.<br />
813813
Allowed values &quot;QuitWithSuccess&quot; (default), &quot;QuitWithFailure&quot;, &quot;GoToNextStep&quot;, &quot;GoToStep&quot;.<br />
814-
The text value van either be lowercase, uppercase or something in between as long as the text is correct.<br></p>
814+
The text value can either be lowercase, uppercase or something in between as long as the text is correct.<br></p>
815815
<table>
816816
<thead>
817817
<tr>
@@ -872,8 +872,8 @@ <h5 id="onsuccessstepid">-OnSuccessStepId</h5>
872872
</table>
873873
<h5 id="onfailaction">-OnFailAction</h5>
874874
<p>The action to perform if the step fails.<br />
875-
Allowed values &quot;QuitWithSuccess&quot; (default), &quot;QuitWithFailure&quot;, &quot;GoToNextStep&quot;, &quot;GoToStep&quot;.<br />
876-
The text value van either be lowercase, uppercase or something in between as long as the text is correct.<br></p>
875+
Allowed values &quot;QuitWithFailure&quot; (default), &quot;QuitWithSuccess&quot;, &quot;GoToNextStep&quot;, &quot;GoToStep&quot;.<br />
876+
The text value can either be lowercase, uppercase or something in between as long as the text is correct.<br></p>
877877
<table>
878878
<thead>
879879
<tr>

Remove-DbaDatabase.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -577,7 +577,7 @@ <h5 id="database">-Database</h5>
577577
<tbody>
578578
<tr>
579579
<td>Alias</td>
580-
<td></td>
580+
<td>Name</td>
581581
</tr>
582582
<tr>
583583
<td>Required</td>

Remove-DbaDatabaseSafely.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -647,7 +647,7 @@ <h5 id="database">-Database</h5>
647647
<tbody>
648648
<tr>
649649
<td>Alias</td>
650-
<td></td>
650+
<td>Name</td>
651651
</tr>
652652
<tr>
653653
<td>Required</td>

Set-DbaAgentJobOutputFile.html

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -538,7 +538,7 @@ <h5 id="sqlinstance">-SqlInstance</h5>
538538
</tbody>
539539
</table>
540540
<h5 id="outputfile">-OutputFile</h5>
541-
<p>The Full Path to the New Output file <br></p>
541+
<p>The Full Path to the New Output file. <br></p>
542542
<table>
543543
<thead>
544544
<tr>
@@ -598,7 +598,8 @@ <h5 id="sqlcredential">-SqlCredential</h5>
598598
</tbody>
599599
</table>
600600
<h5 id="job">-Job</h5>
601-
<p>The job to process - this list is auto-populated from the server.<br></p>
601+
<p>The name of the job to process.<br />
602+
This parameter is not officially mandatory, but you will always be asked to provide a job if you have not.<br></p>
602603
<table>
603604
<thead>
604605
<tr>
@@ -626,7 +627,10 @@ <h5 id="job">-Job</h5>
626627
</tbody>
627628
</table>
628629
<h5 id="step">-Step</h5>
629-
<p>The Agent Job Step to provide Output File Path for. Also available dynamically<br></p>
630+
<p>The name of the Agent Job Step to provide Output File Path for.<br />
631+
Within a job, step names are unique so this is a safe way to select steps.<br />
632+
Also available dynamically. If you do not specify this parameter and the target job has only one step, then we use that step. If it has more than one, then a GUI will be used to make you pick steps.<br />
633+
If that GUI does not work, then we use all steps.<br></p>
630634
<table>
631635
<thead>
632636
<tr>

assets/dbatools-index.json

428 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)