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 des applets de commande. Cela inclut l'aide qui est disponible dans l'environnement Windows PowerShell.
Avant de commencer
Pour en savoir plus sur Windows PowerShell, consultez le Guide Mise en route 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 l'aide de base pour le langage Windows PowerShell, ainsi que les différentes applets de commande et divers fournisseurs disponibles dans Windows PowerShell.
Pour plus d'informations sur les moyens d'utiliser Get-Help, consultez Get-Help : obtention d'aide.
Aide du fournisseur PowerShell SQL Server
Le fournisseur SQL Server PowerShell implémente plusieurs dossiers sur un lecteur virtuel SQLSERVER, tels que les dossiers SQLSERVER:\SQL et SQLSERVER:\DAC. Chaque dossier est associé à l'un des modèles d'objet de gestion SQL Server. Vous pouvez répertorier les méthodes et les propriétés associées à chaque nœud dans un chemin d'accès SQL Server, mais vous ne pouvez pas obtenir de l'aide sur celles-ci dans l'environnement PowerShell. Pour obtenir un tableau des dossiers avec des liens à la référence de programmation associée, consultez Fournisseur PowerShell SQL Server.
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 :
Variables et commandes sqlcmd. Pour plus d'informations sur ces variables et commandes, consultez la section Notes de Utilitaire sqlcmd.
Instructions Transact-SQL. Pour plus d'informations sur le langage Transact-SQL, consultez Référence Transact-SQL (moteur de base de données).
Instructions XQuery. Pour plus d'informations sur le langage XQuery pris en charge par SQL Server, consultez Références relatives au langage Xquery (SQL Server).
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 de l'aide à retourner.
Exemple : applet de commande Get-Help
Les exemples suivants retournent différents niveaux d'aide pourInvoke-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 une liste de fournisseurs
Pour obtenir une liste des fournisseurs actifs
- Exécutez Get-Help en spécifiant la catégorie de fournisseur.
Pour plus d'informations sur l'obtention d'aide sur les fournisseurs dans Windows PowerShell, consultez Drives and Providers (en anglais).
Exemple : obtenir une liste de fournisseurs
Le code suivant retourne la 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
- Exécuter Get-Help en spécifiant le nom SQLServer
Exemple : obtenir de l'aide sur le fournisseur SQL Server
Cet exemple retourne des informations de base sur le fournisseur SQL Server :
Get-Help SQLServer
Répertorier les méthodes et les propriétés
Pour répertorier les méthodes et les propriétés pour un nœud dans un chemin d'accès du fournisseur SQL Server
Utilisez la commande CD pour passer à un nœud dans le chemin d'accès de SQL Server ou créez une variable ayant pour valeur cet emplacement.
Exécutez l'applet de commande Get-Member avec le paramètre –Type dont la valeur est Methods ou Properties.
Exemples : affichage de la liste des méthodes et des propriétés
L'exemple suivant 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 pour une variable dont la valeur est un objet SMO Table :
$MyVar = New-Object Microsoft.SqlServer.Management.SMO.Table
$MyVar | Get-Member -Type Properties
Voir aussi
Concepts
Fournisseur PowerShell SQL Server
Utiliser les applets de commande du Moteur de base de données