Added SQL PowerShell Examples #1787

SQLvariant · 2019-03-12T17:34:27Z

Added examples specific to the official SqlServer PowerShell module, to help customers get started.

PR Summary

Added examples specific to the official SqlServer PowerShell module, to the README_FOR_MARKETPLACE.md file.

PR Checklist

Note: Tick the boxes below that apply to this pull request by putting an x between the square brackets.
Please mark anything not applicable to this PR NA.

PR has a meaningful title
Summarized changes
PR has tests
This PR is ready to merge and is not work in progress
- If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready

Added examples specific to the official SqlServer PowerShell module, to help customers get started.

msftclas · 2019-03-12T17:34:40Z

All CLA requirements met.

SydneyhSmith · 2019-03-12T17:50:26Z

docs/azure_data_studio/README_FOR_MARKETPLACE.md

+## SQL PowerShell Examples
+In order to use these examples (below), you need to install the SqlServer module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/SqlServer).
+
+<pre><code>Install-Module -Name SqlServer -AllowPrerelease</code></pre>


Is there a reason we are recommending a prerelease version of this module rather than the last stable version?

Ah, great catch. I pulled that in from my recent post. The latest Prerelease includes Invoke-Sqlcmd working on PSCore. Since Azure Data Studio is cross-platform, having the x-plat Invoke-Sqlcmd is very useful and relevant to those customers. We can either pull the " -AllowPrerelease" portion now, or we can wait until the final version of the module ships, and pull it then.

Although, ironically, if PSCore still hasn't shipped then the customer would have to download that preview as well. (We could include a link to the post on the PowerShell blog as well, to help the x-plat customers)

In my mind, there is literally no other SQL PowerShell cmdlet as important as Invoke-Sqlcmd. I can't ever see broadly suggesting customers use a -AllowPrerelease version after this one ships.

I'm fine with leaving " -AllowPrerelease" until the ned of the month, or pulling it now. Up to you.

I'm fine with -AllowPrerelease but please add a comment as to why we're installing the prerelease one.

SydneyhSmith · 2019-03-12T17:56:44Z

This looks great to me overall, thanks for the contribution!

TylerLeonhardt · 2019-03-12T18:30:57Z

@SQLvariant can you switch your <pre><code>'s to the markdown way?

```powershell
code goes here
```

and for the output ones, use:

```
output goes here
```

TylerLeonhardt · 2019-03-12T18:32:59Z

docs/azure_data_studio/README_FOR_MARKETPLACE.md

+ServerA                   13.0.5233  SP2          CU4
+ServerB                   14.0.3045  RTM          CU12</code></pre>
+
+In this example, we will do a 'dir' (alias for Get-ChildItem) to get the list of all SQL Server instances listed in your Registered Servers file, and then use the Get-SqlDatabase cmdlet to get a list of Databases for each of those instances.


single backticks for inline markdown formatting.

Suggested change

In this example, we will do a 'dir' (alias for Get-ChildItem) to get the list of all SQL Server instances listed in your Registered Servers file, and then use the Get-SqlDatabase cmdlet to get a list of Databases for each of those instances.

In this example, we will do a `dir` (alias for `Get-ChildItem`) to get the list of all SQL Server instances listed in your Registered Servers file, and then use the `Get-SqlDatabase` cmdlet to get a list of Databases for each of those instances.

Sure thing. I can take care of that right now.

TylerLeonhardt · 2019-03-12T18:35:18Z

docs/azure_data_studio/README_FOR_MARKETPLACE.md

+WideWorldImporters   Normal         3.2 GB     2.6 GB Simple       130 sa   
+</code></pre>
+
+This example uses the Get-SqlDatabase cmdlet to retireve a list of all databases on the ServerB instance, then presents a grid/table to select which databases should be backed up.  Once the user clicks on the "OK" button, only the highlighted databases will be backed up.


Suggested change

This example uses the Get-SqlDatabase cmdlet to retireve a list of all databases on the ServerB instance, then presents a grid/table to select which databases should be backed up. Once the user clicks on the "OK" button, only the highlighted databases will be backed up.

This example uses the `Get-SqlDatabase` cmdlet to retrieve a list of all databases on the ServerB instance, then presents a grid/table (using the `Out-GridView` cmdlet) to select which databases should be backed up. Once the user clicks on the "OK" button, only the highlighted databases will be backed up.

TylerLeonhardt · 2019-03-12T18:35:39Z

docs/azure_data_studio/README_FOR_MARKETPLACE.md

+Out-GridView -PassThru |
+Backup-SqlDatabase -CompressionOption On</code></pre>
+
+This example again gets list of all SQL Server instances listed in your Registered Servers file, then reports every failed SQL Agent Job since Midnight, for each SQL Server instances listed.


Suggested change

This example again gets list of all SQL Server instances listed in your Registered Servers file, then reports every failed SQL Agent Job since Midnight, for each SQL Server instances listed.

This example, again, gets list of all SQL Server instances listed in your Registered Servers file, then reports every failed SQL Agent Job since Midnight, for each SQL Server instances listed.

TylerLeonhardt · 2019-03-12T18:37:19Z

Can you move this newly added section after the ## Example Scripts section? Then give your heading a 3rd # (so ### SQL PowerShell Examples) so it becomes a subsection of ## Example Scripts

Updated the format of the code examples.

Moved location of SQL PowerShell Examples to be after Example Scripts.

SQLvariant · 2019-03-12T19:52:32Z

Can you move this newly added section after the ## Example Scripts section?

Done.

Fixed typo in description.

Commas.

TylerLeonhardt

LGTM just some minor nitpicks.

docs/azure_data_studio/README_FOR_MARKETPLACE.md

Co-Authored-By: SQLvariant <[email protected]>

TylerLeonhardt

LGTM

Added SQL PowerShell Examples

162701e

Added examples specific to the official SqlServer PowerShell module, to help customers get started.

TylerLeonhardt requested review from TylerLeonhardt and SydneyhSmith March 12, 2019 17:46

SydneyhSmith reviewed Mar 12, 2019

View reviewed changes

TylerLeonhardt reviewed Mar 12, 2019

View reviewed changes

SQLvariant added 2 commits March 12, 2019 15:49

Update Code Formatting

a66c7c7

Updated the format of the code examples.

Moved SQL PowerShell Examples

8602abe

Moved location of SQL PowerShell Examples to be after Example Scripts.

SQLvariant added 2 commits March 12, 2019 15:54

Typo

159515d

Fixed typo in description.

Commas

cd867b4

Commas.

TylerLeonhardt approved these changes Mar 12, 2019

View reviewed changes

TylerLeonhardt reviewed Mar 12, 2019

View reviewed changes

docs/azure_data_studio/README_FOR_MARKETPLACE.md Outdated Show resolved Hide resolved

TylerLeonhardt and others added 4 commits March 13, 2019 12:19

Update docs/azure_data_studio/README_FOR_MARKETPLACE.md

5cade58

Co-Authored-By: SQLvariant <[email protected]>

Update docs/azure_data_studio/README_FOR_MARKETPLACE.md

0d8f68d

Co-Authored-By: SQLvariant <[email protected]>

Update docs/azure_data_studio/README_FOR_MARKETPLACE.md

6d08212

Co-Authored-By: SQLvariant <[email protected]>

Apply suggestions from code review

af15e85

Co-Authored-By: SQLvariant <[email protected]>

TylerLeonhardt approved these changes Mar 13, 2019

View reviewed changes

TylerLeonhardt merged commit 910bd62 into PowerShell:master Mar 13, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added SQL PowerShell Examples #1787

Added SQL PowerShell Examples #1787

SQLvariant commented Mar 12, 2019 •

edited

Loading

msftclas commented Mar 12, 2019 •

edited

Loading

SydneyhSmith Mar 12, 2019

SQLvariant Mar 12, 2019

TylerLeonhardt Mar 12, 2019

SydneyhSmith commented Mar 12, 2019

TylerLeonhardt commented Mar 12, 2019 •

edited

Loading

TylerLeonhardt Mar 12, 2019 •

edited

Loading

SQLvariant Mar 12, 2019

TylerLeonhardt Mar 12, 2019

SQLvariant Mar 12, 2019

TylerLeonhardt Mar 12, 2019

SQLvariant Mar 12, 2019

TylerLeonhardt commented Mar 12, 2019 •

edited

Loading

SQLvariant commented Mar 12, 2019

TylerLeonhardt left a comment

TylerLeonhardt left a comment

	In this example, we will do a 'dir' (alias for Get-ChildItem) to get the list of all SQL Server instances listed in your Registered Servers file, and then use the Get-SqlDatabase cmdlet to get a list of Databases for each of those instances.
	In this example, we will do a `dir` (alias for `Get-ChildItem`) to get the list of all SQL Server instances listed in your Registered Servers file, and then use the `Get-SqlDatabase` cmdlet to get a list of Databases for each of those instances.

	This example uses the Get-SqlDatabase cmdlet to retireve a list of all databases on the ServerB instance, then presents a grid/table to select which databases should be backed up. Once the user clicks on the "OK" button, only the highlighted databases will be backed up.
	This example uses the `Get-SqlDatabase` cmdlet to retrieve a list of all databases on the ServerB instance, then presents a grid/table (using the `Out-GridView` cmdlet) to select which databases should be backed up. Once the user clicks on the "OK" button, only the highlighted databases will be backed up.

	This example again gets list of all SQL Server instances listed in your Registered Servers file, then reports every failed SQL Agent Job since Midnight, for each SQL Server instances listed.
	This example, again, gets list of all SQL Server instances listed in your Registered Servers file, then reports every failed SQL Agent Job since Midnight, for each SQL Server instances listed.

Added SQL PowerShell Examples #1787

Added SQL PowerShell Examples #1787

Conversation

SQLvariant commented Mar 12, 2019 • edited Loading

PR Summary

PR Checklist

msftclas commented Mar 12, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SydneyhSmith commented Mar 12, 2019

TylerLeonhardt commented Mar 12, 2019 • edited Loading

TylerLeonhardt Mar 12, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TylerLeonhardt commented Mar 12, 2019 • edited Loading

SQLvariant commented Mar 12, 2019

TylerLeonhardt left a comment

Choose a reason for hiding this comment

TylerLeonhardt left a comment

Choose a reason for hiding this comment

SQLvariant commented Mar 12, 2019 •

edited

Loading

msftclas commented Mar 12, 2019 •

edited

Loading

TylerLeonhardt commented Mar 12, 2019 •

edited

Loading

TylerLeonhardt Mar 12, 2019 •

edited

Loading

TylerLeonhardt commented Mar 12, 2019 •

edited

Loading