Partager via


Obtenir de l’aide sur SQL Server PowerShell

Il existe plusieurs sources d’informations sur l’utilisation du fournisseur SQL Server pour Windows PowerShell et les applets de commande. Cela inclut l’aide disponible dans l’environnement Windows PowerShell.

Avant de commencer

Pour en savoir plus sur Windows PowerShell, consultez le Guide de prise en main de Windows PowerShell.

Pour obtenir une vue d’ensemble des applets de commande et du fournisseur SQL Server, consultez SQL Server PowerShell.

Aide dans l’environnement Windows PowerShell

Utilisez l’applet de commande Get-Help pour obtenir de l’aide dans l’environnement Windows PowerShell. Get-Help fournit une aide de base pour le langage Windows PowerShell et les différentes applets de commande et fournisseurs disponibles dans Windows PowerShell.

Pour plus d’informations sur les façons dont vous pouvez utiliser Get-Help, consultez Obtenir de l’aide : Obtenir de l’aide.

Aide du fournisseur SQL Server PowerShell

Le fournisseur SQL Server PowerShell implémente plusieurs dossiers sur un lecteur virtuel SQLSERVER, tel que les dossiers SQLSERVER :\SQL et SQLSERVER :\DAC. Chaque dossier est associé à l’un des modèles objet de facilité de gestion SQL Server. Bien que vous puissiez répertorier les méthodes et les propriétés associées à chaque nœud dans un chemin SQL Server, vous ne pouvez pas obtenir de l’aide pour eux dans l’environnement PowerShell. Pour obtenir une table des dossiers avec des liens vers la référence de programmation associée, consultez le fournisseur SQL Server PowerShell.

Invoke-Sqlcmd Aide

L’applet de commande Invoke-Sqlcmd prend en entrée n’importe quel fichier de requête ou de script qui peut être exécuté par l’utilitaire sqlcmd . Vous pouvez utiliser Get-Help pour obtenir des informations sur Invoke-Sqlcmd et ses paramètres, mais il n’existe aucune couverture Get-Help pour les requêtes sqlcmd .

L’entrée -Query ou -QueryFromFile peut contenir :

Obtenir de l’aide pour une applet de commande SQL Server

Pour obtenir de l’aide pour une applet de commande

  • Exécutez Get-Help en spécifiant le nom de l’applet de commande et le niveau d’aide à fournir.

Exemple : cmdlet Get-Help

Les exemples suivants retournent différents niveaux d’aide pour Invoke-Sqlcmd :

## Get the basic help.  
Get-Help Invoke-Sqlcmd  
  
## Get the full help.  
Get-Help Invoke-Sqlcmd -Full  
  
## Get the parameter descriptions.  
Get-Help Invoke-Sqlcmd -Parameter *  
  
## Get the code examples.  
Get-Help Invoke-Sqlcmd -Examples  
  
## Get the syntax diagram.  
Get-Help Invoke-Sqlcmd -Syntax  

Obtenir la liste des fournisseurs

Pour obtenir la liste des fournisseurs actifs

  1. Exécutez Get-Help en spécifiant la catégorie de fournisseur.

Pour plus d’informations sur l’obtention de l’aide du fournisseur dans Windows PowerShell, consultez Lecteurs et fournisseurs.

Exemple : Obtenir une liste de fournisseurs

Ce code retourne une liste des fournisseurs actuellement activés dans votre session Windows PowerShell :

Get-Help -Category provider  

Obtenir de l’aide sur le fournisseur SQL Server

Pour obtenir de l’aide sur le fournisseur

  1. Exécuter Get-Help en spécifiant le nom SQLServer

Exemple : Obtenir de l’aide du fournisseur SQL Server

Cet exemple retourne des informations de base sur le fournisseur SQL Server :

Get-Help SQLServer  

Méthodes et propriétés de liste

Pour répertorier les méthodes et les propriétés d’un nœud dans un chemin d’accès du fournisseur SQL Server

  1. CD vers un nœud dans le chemin d’accès SQL Server ou créez une variable définie sur cet emplacement.

  2. Exécutez l’applet de commande Get-Member avec le paramètre -Type défini sur Méthodes ou Propriétés

Exemples : Affichage de la liste des méthodes et des propriétés

Cet exemple répertorie les méthodes prises en charge pour le nœud Bases de données :

Set-Location SQL:\MyComputer\DEFAULT\Databases  
Get-Item . | Get-Member -Type Methods  

Cet exemple répertorie les propriétés d’une variable qui a été définie sur un objet SMO Table :

$MyVar = New-Object Microsoft.SqlServer.Management.SMO.Table  
$MyVar | Get-Member -Type Properties  

Voir aussi

Fournisseur SQL Server PowerShell
Utiliser les applets de commande du moteur de base de données