sqlps (utilitaire)

Article
04/03/2023

S’applique à : SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW)

L’utilitaire sqlps démarre une session Windows PowerShell avec le fournisseur SQL Server PowerShell et les applets de commande chargés et inscrits. Vous pouvez entrer des scripts ou des commandes PowerShell qui utilisent les composants SQL Server PowerShell pour travailler avec des instances de SQL Server et leurs objets.

Important

Cette fonctionnalité sera supprimée dans une version future de SQL Server. Évitez d'utiliser cette fonctionnalité dans de nouveaux travaux de développement, et prévoyez de modifier les applications qui utilisent actuellement cette fonctionnalité. Utilisez à la place le module PowerShell sqlps. Pour plus d’informations sur le module sqlps , consultez Import the SQLPS Module.

Syntaxe

  
sqlps   
[ [ [ -NoLogo ][ -NoExit ][ -NoProfile ]  
    [ -OutPutFormat { Text | XML } ] [ -InPutFormat { Text | XML } ]  
  ]  
  [ -Command { -  
             | script_block [ -args argument_array ]  
             | string [ command_parameters ]  
             }  
  ]  
]  
[ -? | -Help ]

Arguments

-NoLogo
Spécifie que l’utilitaire sqlps doit masquer la bannière de copyright quand il démarre.

-NoExit
Spécifie que l’utilitaire sqlps doit poursuivre son exécution après le lancement des commandes de démarrage.

-NoProfile
Spécifie que l’utilitaire sqlps ne doit pas charger de profil utilisateur. Les profils utilisateur enregistrent des alias, fonctions et variables fréquemment utilisés en vue de leur utilisation au cours de différentes sessions PowerShell.

-OutPutFormat { Text | XML }
Spécifie que la sortie de l’utilitaire sqlps doit être mise en forme en tant que chaînes de texte (Text) ou format CLIXML sérialisé (XML).

-InPutFormat { Text | XML }
Spécifie que l’entrée de l’utilitaire sqlps est mise en forme en tant que chaînes de texte (Text) ou format CLIXML sérialisé (XML).

-Command
Spécifie la commande que l’utilitaire sqlps doit exécuter. L’utilitaire sqlps exécute la commande, puis se ferme, sauf si -NoExit est également spécifié. Ne spécifiez pas d’autres commutateurs après -Command, car ils seront lus comme des paramètres de commande.

-
-Command- spécifie que l’utilitaire sqlps doit lire l’entrée à partir de l’entrée standard.

script_block [ -argsargument_array ]
Spécifie un bloc de commandes PowerShell à exécuter ; le bloc doit être placé entre des accolades : {}. Script_block peut uniquement être spécifié quand l’utilitaire sqlps est appelé depuis PowerShell ou une autre session de l’utilitaire sqlps . argument_array est un tableau de variables PowerShell contenant les arguments pour les commandes PowerShell de script_block.

string [ command_parameters ]
Spécifie une chaîne qui contient les commandes PowerShell à exécuter. Utilisez le format "&{command}". Les guillemets indiquent une chaîne et l’opérateur d’appel (&) entraîne l’exécution de la commande par l’utilitaire sqlps.

[ -? | -Help ]
Affiche le résumé de la syntaxe des options de l’utilitaire sqlps .

Notes

L’utilitaire sqlps démarre l’environnement PowerShell (PowerShell.exe) et charge le module SQL Server PowerShell. Le module, également nommé sqlps, charge et inscrit ces composants logiciels enfichables SQL Server PowerShell :

Microsoft.SqlServer.Management.PSProvider.dll

Implémente le fournisseur SQL Server PowerShell et les applets de commande associées, comme Encode-SqlName et Decode-SqlName.
Microsoft.SqlServer.Management.PSSnapin.dll

Implémente les applets de commande Invoke-Sqlcmd et Invoke-PolicyEvaluation .

Vous pouvez recourir à l’utilitaire sqlps pour effectuer les opérations suivantes :

exécuter des commandes PowerShell de façon interactive ;
exécuter des fichiers script PowerShell ;
Exécutez les applets de commande SQL Server.
Utilisez les chemins du fournisseur SQL Server pour parcourir la hiérarchie des objets SQL Server.

Par défaut, l’utilitaire sqlps s’exécute avec le niveau de stratégie d’exécution de scripts défini sur Restreint. Cela empêche l'exécution de scripts PowerShell. Vous pouvez utiliser l’applet de commande Set-ExecutionPolicy pour activer l’exécution de scripts signés ou de tout type de script. Exécutez uniquement des scripts provenant de sources fiables et sécurisez tous les fichiers d'entrée et de sortie en utilisant les autorisations NTFS appropriées. Pour plus d'informations sur l'activation de scripts PowerShell, consultez Exécution de scripts Windows PowerShell.

La version de l’utilitaire sqlps dans SQL Server 2008 (10.0.x) et SQL Server 2008 R2 (10.50.x) a été implémentée en tant que mini-shell Windows PowerShell 1.0. Les mini-shells comportent certaines restrictions, comme le fait de ne pas autoriser les utilisateurs à charger des composants logiciels enfichables autres que ceux chargés par le mini-shell. Ces restrictions ne s’appliquent pas à la version SQL Server 2012 (11.x) et aux versions ultérieures de l’utilitaire, qui ont été modifiées pour utiliser le module sqlps.

Exemples

R. Exécution de l’utilitaire sqlps en mode interactif par défaut, sans bannière de copyright

sqlps -NoLogo

B. Exécution d'un script SQL Server PowerShell à partir de l'invite de commandes

sqlps -Command "&{.\MyFolder.MyScript.ps1}"

C. Exécution d'un script SQL Server PowerShell à partir de l'invite de commandes et poursuite de l'exécution une fois le script terminé

sqlps -NoExit -Command "&{.\MyFolder.MyScript.ps1}"

Voir aussi

Activer ou désactiver un protocole réseau de serveur
SQL Server PowerShell

Partage via