Partager via


Aide de PowerShell SQL Server

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

Informations générales

Pour plus d'informations sur les ressources que vous pouvez utiliser pour en savoir plus sur Windows PowerShell, consultez En savoir plus sur PowerShell.

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

Utilisation de Get-Help

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

Les applets de commande SQL Server prennent en charge Get-Help. Get-Help retourne des informations sur l'utilisation des applets de commande, telles que la syntaxe et la description des paramètres. Les exemples suivants retournent l'aide complète pour Invoke-Sqlcmd, l'aide uniquement pour les paramètres, puis l'aide uniquement pour les exemples :

Get-Help Invoke-Sqlcmd -Full
Get-Help Invoke-Sqlcmd -Parameter *
Get-Help Invoke-Sqlcmd -Examples

Pour plus d'informations sur les façons d'utiliser Get-Help pour en savoir plus sur les applets de commande, consultez Get-Help: Getting Help (en anglais).

Le fournisseur SQL Server prend également en charge Get-Help. Par exemple, le code suivant retourne les informations de base sur le fournisseur SQL Server :

Get-Help SQLServer

Le code suivant retourne la liste des fournisseurs actuellement activés dans votre session Windows PowerShell :

Get-Help -Category provider

Pour plus d'informations sur l'obtention d'aide sur les fournisseurs dans Windows PowerShell, consultez Drives and Providers (en anglais).

Aide d'Invoke-Sqlcmd

L'applet de commande Invoke-Sqlcmd prend comme entrée une requête ou un fichier 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'y a aucune couverture de Get-Help pour les requêtes sqlcmd.

L'entrée -Query ou -QueryFromFile peut contenir les éléments suivants :

Aide du fournisseur SQL Server

Le fournisseur SQL Server présente la hiérarchie des objets SQL Server dans des chemins d'accès semblables aux chemins d'accès de système de fichiers. Voici, par exemple, le chemin d'accès à la table Vendor dans le schéma Purchasing de la base de données AdventureWorks2008R2 dans une instance par défaut du moteur de base de données :

SQL:\MyComputer\DEFAULT\Databases\AdventureWorks2008R2\Tables\Purchasing.Vendor

Le fournisseur implémente des nœuds de lecteur différents pour les objets couverts par différents modèles objets de gestion SQL Server. Les chemins d'accès contenant le lecteur SQL: utilisent les objets couverts par les objets SMO (SQL Server Management Objects), tels que les tables et les vues. Lorsque vous naviguez jusqu'à un nœud dans un chemin d'accès, vous pouvez utiliser les méthodes de modèle objet et propriétés qui s'appliquent à ce type d'objet.

Vous pouvez utiliser l'applet de commande Get-Member pour savoir quelles méthodes et propriétés sont disponibles pour un nœud de chemin d'accès. Par exemple, vous pouvez exécuter ce code pour voir les méthodes prises en charge pour le nœud Databases :

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

Ce code répertorie les propriétés pour une variable dont la valeur est un objet SMO Table :

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

La documentation de modèles objets pour les différents lecteurs est la suivante :