SQL Server PowerShell Provider

S’applique à :SQL ServerAzure SQL DatabaseAzure SQL Managed InstanceAzure Synapse AnalyticsAnalytics Platform System (PDW)

Le fournisseur SQL Server pour Windows PowerShell 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. Vous pouvez utiliser les chemins pour localiser un objet, puis utiliser des méthodes des modèles SMO SQL Server pour effectuer des actions sur les objets.

Notes

Il existe deux modules SQL Server PowerShell : SqlServer et SQLPS.

Le module SqlServer est le module PowerShell actuel à utiliser.

Le module SQLPS fait partie de l’installation de SQL Server (à des fins de compatibilité descendante), mais il n’est plus mis à jour.

Le module SqlServer contient les versions mises à jour des applets de commande disponibles dans SQLPS ainsi que de nouvelles applets de commande pour prendre en charge les dernières fonctionnalités SQL.

Installez le module SqlServer à partir de PowerShell Gallery.

Pour plus d’informations, consultez SQL Server PowerShell.

Avantages du fournisseur PowerShell SQL Server

Les chemins d'accès implémentés par le fournisseur SQL Server permettent de vérifier facilement et de manière interactive tous les objets dans une instance de SQL Server. Vous pouvez parcourir les chemins d'accès à l'aide d'alias Windows PowerShell semblables aux commandes que vous utilisez généralement pour parcourir les chemins d'accès du système de fichiers.

Hiérarchie PowerShell SQL Server

Les produits dont les données ou modèles objets peuvent être représentés dans une hiérarchie utilisent des fournisseurs Windows PowerShell pour exposer les hiérarchies. La hiérarchie est exposée à l'aide d'une structure de chemin d'accès semblable à celle utilisée par le système de fichiers Windows.

Chaque fournisseur Windows PowerShell implémente un ou plusieurs lecteurs. Chaque lecteur est le nœud racine d'une hiérarchie d'objets connexes. Le fournisseur SQL Server implémente un lecteur SQLSERVER:. Le fournisseur définit également un jeu de dossiers principaux pour le lecteur SQLSERVER:. Chaque dossier et ses sous-dossiers représentent l'ensemble d'objets auxquels il est possible d'accéder à l'aide d'un modèle SMO ( SQL Server Management Object). Si vous vous trouvez au niveau d'un sous-dossier dans un chemin d'accès qui commence par l'un de ces dossiers principaux, vous pouvez utiliser les méthodes du modèle objet associé pour effectuer des actions sur l'objet représenté par ce nœud. Les dossiers Windows PowerShell implémentés par le fournisseur SQL Server sont répertoriés dans le tableau suivant :

Dossier Espace de noms du modèle objet SQL Server Objets
SQLSERVER:\SQL Microsoft.SqlServer.Management.Smo

Microsoft.SqlServer.Management.Smo.Agent

Microsoft.SqlServer.Management.Smo.Broker

Microsoft.SqlServer.Management.Smo.Mail
Objets de base de données, tels que les tables, les vues et les procédures stockées.
SQLSERVER:\SQLPolicy Microsoft.SqlServer.Management.Dmf

Microsoft.SqlServer.Management.Facets
Objets de la Gestion basée sur des stratégies, tels que les stratégies et les facettes.
SQLSERVER:\SQLRegistration Microsoft.SqlServer.Management.RegisteredServers

Microsoft.SqlServer.Management.Smo.RegSvrEnum
Objets de serveurs inscrits, tels que des groupes de serveurs et des serveurs inscrits.
SQLSERVER:\Utility Microsoft.SqlServer.Management.Utility Objets utilitaires, tels que les instances gérées du Moteur de base de données.
SQLSERVER:\DAC Microsoft.SqlServer.Management.Dac Objets d'application de couche Données tels que les packages de DAC, et opérations telles que le déploiement d'une DAC.
SQLSERVER:\DataCollection Microsoft.SqlServer.Management.Collector Objets du collecteur de données tels que les jeux d'éléments de collecte et magasins de configuration.
SQLSERVER:\SSIS Microsoft.SqlServer.Management.IntegrationServices Integration Services tels que les projets, les packages et les environnements.
SQLSERVER:\XEvent Microsoft.SqlServer.Management.XEvent Événements étendus SQL Server
SQLSERVER:\DatabaseXEvent Microsoft.SqlServer.Management.XEventDbScoped Événements étendus SQL Server
SQLSERVER:\SQLAS Microsoft.AnalysisServices Analysis Services tels que des cubes, des agrégations et des dimensions.

Par exemple, vous pouvez utiliser le dossier SQLSERVER:\SQL pour commencer des chemins d'accès pouvant représenter tout objet pris en charge par le modèle objet SMO. Le début d’un chemin SQLSERVER:\SQL est SQLSERVER:\SQL\ComputerName\InstanceName. Les nœuds après le nom de l'instance alternent entre des collections d'objets (comme Bases de données ou Vues) et des noms d'objets (comme AdventureWorks2022). Les schémas ne sont pas représentés en tant que classes d'objets. Lorsque vous spécifiez le nœud pour un objet de niveau supérieur dans un schéma, tel qu’une table ou une vue, vous devez spécifier le nom d’objet au format SchemaName.ObjectName.

L'exemple suivant montre le chemin de la table Fournisseur dans le schéma Achat de la base de données AdventureWorks2022 dans une instance par défaut du moteur de base de données sur l'ordinateur local :

SQLSERVER:\SQL\localhost\DEFAULT\Databases\AdventureWorks2022\Tables\Purchasing.Vendor  

Pour plus d'informations sur la hiérarchie du modèle objet SMO, consultez SMO Object Model Diagram.

Les nœuds de collection dans un chemin d'accès sont associés à une classe de collection dans le modèle objet associé. Les nœuds de noms d’objets sont associés à une classe d’objet dans le modèle objet associé, comme indiqué dans le tableau suivant :

Path Classe SMO
SQLSERVER:\SQL\MyComputer\DEFAULT\Databases DatabaseCollection
SQLSERVER:\SQL\MyComputer\DEFAULT\Databases\AdventureWorks2022 Database

Tâches de fournisseur SQL Server

Description de la tâche Article
Explique comment utiliser des applets de commande Windows PowerShell pour parcourir les nœuds dans un chemin d'accès et obtenir la liste des objets au niveau de chaque nœud. Parcourir les chemins SQL Server PowerShell
Explique comment utiliser les méthodes et les propriétés SMO pour signaler et effectuer un travail sur l'objet représenté par un nœud dans un chemin d'accès. Explique également comment obtenir la liste des méthodes et des propriétés SMO pour ce nœud. Utiliser des chemins SQL Server PowerShell
Explique comment convertir une valeur URN (Uniform Resource Name) SMO en chemin d'accès de fournisseur SQL Server. Convertir des URN en chemins de fournisseur SQL Server
Explique comment ouvrir des connexions d'authentification SQL Server à l'aide du fournisseur SQL Server . Par défaut, le fournisseur utilise des connexions via l'authentification Windows établies à l'aide des informations d'identification du compte Windows qui exécute la session Windows PowerShell. Gérer l’authentification dans le moteur de base de données PowerShell

Étapes suivantes

SQL Server PowerShell