| title | description | author | ms.author | ms.reviewer | ms.date | ms.service | ms.subservice | ms.topic | helpviewer_keywords | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
SQL Server PowerShell Provider |
Learn about the SQL Server provider for Windows PowerShell, which provides access to SQL Server objects by means of paths similar to file system paths. |
markingmyname |
maghan |
matteot, drskwier |
07/31/2019 |
sql |
sql-server-powershell |
conceptual |
|
[!INCLUDESQL Server Azure SQL Database Synapse Analytics PDW]
The [!INCLUDEssNoVersion] provider for Windows PowerShell exposes the hierarchy of [!INCLUDEssNoVersion] objects in paths similar to file system paths. You can use the paths to locate an object, and then use methods from the [!INCLUDEssNoVersion] Management Object (SMO) models to perform actions on the objects.
[!INCLUDE sql-server-powershell-version]
The paths implemented by the [!INCLUDEssNoVersion] provider enable easily and interactively reviewing all of the objects in an instance of SQL Server. You can navigate the paths using Windows PowerShell aliases similar to the commands you typically use to navigate file system paths.
Products whose data or object models can be represented in a hierarchy use Windows PowerShell providers to expose the hierarchies. The hierarchy is exposed by using a drive and path structure similar to what the Windows file system uses.
Each Windows PowerShell provider implements one or more drives. Each drive is the root node of a hierarchy of related objects. The [!INCLUDEssNoVersion] provider implements a SQLSERVER: drive. The provider also defines a set of primary folders for the SQLSERVER: drive. Each folder and its subfolders represent the set of objects that can be accessed by using a [!INCLUDEssNoVersion] management object model. When you are focused on a subfolder in a path that starts with one of these primary folders, you can use the methods from the associated object model to perform actions on the object that is represented by the node. The Windows PowerShell folders implemented by the [!INCLUDEssnoversion] provider are listed in the following table:
| Folder | SQL Server object model namespace | Objects |
|---|---|---|
SQLSERVER:\SQL |
xref:Microsoft.SqlServer.Management.Smo xref:Microsoft.SqlServer.Management.Smo.Agent xref:Microsoft.SqlServer.Management.Smo.Broker xref:Microsoft.SqlServer.Management.Smo.Mail |
Database objects, such as tables, views, and stored procedures. |
SQLSERVER:\SQLPolicy |
xref:Microsoft.SqlServer.Management.Dmf xref:Microsoft.SqlServer.Management.Facets |
Policy-based management objects, such as policies and facets. |
SQLSERVER:\SQLRegistration |
xref:Microsoft.SqlServer.Management.RegisteredServers xref:Microsoft.SqlServer.Management.Smo.RegSvrEnum |
Registered server objects, such as server groups and registered servers. |
SQLSERVER:\Utility |
xref:Microsoft.SqlServer.Management.Utility | Utility objects, such as managed instances of the [!INCLUDEssDE]. |
SQLSERVER:\DAC |
Microsoft.SqlServer.Management.Dac | Data-tier application objects such as DAC packages, and operations such as deploying a DAC. |
SQLSERVER:\DataCollection |
xref:Microsoft.SqlServer.Management.Collector | Data collector objects, such as collection sets and configuration stores. |
SQLSERVER:\SSIS |
xref:Microsoft.SqlServer.Management.IntegrationServices | [!INCLUDEssISnoversion] objects such as projects, packages, and environments. |
SQLSERVER:\XEvent |
xref:Microsoft.SqlServer.Management.XEvent | SQL Server Extended Events |
SQLSERVER:\DatabaseXEvent |
Microsoft.SqlServer.Management.XEventDbScoped | SQL Server Extended Events |
SQLSERVER:\SQLAS |
xref:Microsoft.AnalysisServices | [!INCLUDEssASnoversion] objects such as cubes, aggregations, and dimensions. |
For example, you can use the SQLSERVER:\SQL folder to start paths that can represent any object that is supported by the SMO object model. The leading part of a SQLSERVER:\SQL path is SQLSERVER:\SQL\ComputerName\InstanceName. The nodes after the instance name alternate between object collections (such as Databases or Views) and object names (such as [!INCLUDE sssampledbobject-md]). Schemas are not represented as object classes. When you specify the node for a top-level object in a schema, such as a table or view, you must specify the object name in the format SchemaName.ObjectName.
The following example shows the path of the Vendor table in the Purchasing schema of the [!INCLUDE sssampledbobject-md] database in a default instance of the [!INCLUDEssDE] on the local computer:
SQLSERVER:\SQL\localhost\DEFAULT\Databases\AdventureWorks2022\Tables\Purchasing.Vendor For more information about the SMO object model hierarchy, see SMO Object Model Diagram.
Collection nodes in a path are associated with a collection class in the associated object model. Object name nodes are associated with an object class in the associated object model, as in the following table:
| Path | SMO class |
|---|---|
SQLSERVER:\SQL\MyComputer\DEFAULT\Databases |
xref:Microsoft.SqlServer.Management.Smo.DatabaseCollection |
SQLSERVER:\SQL\MyComputer\DEFAULT\Databases\AdventureWorks2022 |
xref:Microsoft.SqlServer.Management.Smo.Database |
| Task Description | Article |
|---|---|
| Describes how to use Windows PowerShell cmdlets to navigate through the nodes in a path, and at each node get a list of the objects at that node. | Navigate SQL Server PowerShell Paths |
| Describes how to use the SMO methods and properties to report on and perform work on the object represented by a node in a path. Also describes how to get a list of the SMO methods and properties for that node. | Work With SQL Server PowerShell Paths |
| Describes how to convert a SMO Uniform Resource Name (URN) to a SQL Server provider path. | Convert URNs to SQL Server Provider Paths |
| Describes how to open SQL Server Authentication connections by using the [!INCLUDEssNoVersion] provider. By default, the provider uses Windows Authentication connections made using the credentials of the Windows account running the Windows PowerShell session. | Manage Authentication in Database Engine PowerShell |