Compartir a través de

Obtener ayuda sobre SQL Server PowerShell

Hay varios orígenes de información sobre el uso del proveedor de SQL Server para Windows PowerShell y cmdlets. Esto incluye la ayuda que está disponible en el entorno de Windows PowerShell.

Antes de empezar

Para obtener información sobre Windows PowerShell, consulte Guía de introducción de Windows PowerShell.

Para obtener información general sobre los cmdlets y el proveedor de SQL Server, consulte SQL Server PowerShell.

Ayuda en el entorno de Windows PowerShell

Use el cmdlet Get-Help para obtener ayuda en el entorno de Windows PowerShell. Get-Help proporciona ayuda básica para el lenguaje de Windows PowerShell y los distintos cmdlets y proveedores disponibles en Windows PowerShell.

Para obtener más información sobre las formas en que puede usar Get-Help, consulte Get-Help: Getting Help.

Ayuda del proveedor de PowerShell de SQL Server

El proveedor de SQL Server PowerShell implementa varias carpetas en una unidad virtual SQLSERVER, como las carpetas SQLSERVER:\SQL y SQLSERVER:\DAC. Cada carpeta está asociada a uno de los modelos de objetos de administración de SQL Server. Aunque puede enumerar los métodos y propiedades asociados a cada nodo de una ruta de acceso de SQL Server, no puede obtener ayuda para ellos en el entorno de PowerShell. Para obtener una tabla de las carpetas con vínculos a la referencia de programación asociada, consulte Proveedor de POWERShell de SQL Server.

Ayuda de Invoke-Sqlcmd

El cmdlet Invoke-Sqlcmd toma como entrada cualquier archivo de consulta o script que pueda ejecutar la utilidad sqlcmd . Puede usar Get-Help para obtener información sobre Invoke-Sqlcmd y sus parámetros, pero no hay cobertura get-Help para las consultas sqlcmd .

La entrada -Query o -QueryFromFile puede contener:

Obtener ayuda para un cmdlet de SQL Server

Para obtener ayuda para un cmdlet

  • Ejecute Get-Help especificando el nombre del cmdlet y el nivel de ayuda que se va a devolver.

Ejemplo: cmdlet Get-Help

En los ejemplos siguientes se devuelven varios niveles de ayuda para Invoke-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

Obtener una lista de proveedores

Para obtener una lista de proveedores activos

  1. Ejecute Get-Help especificando la categoría de proveedor.

Para obtener más información sobre cómo obtener ayuda del proveedor en Windows PowerShell, consulte Unidades y proveedores.

Ejemplo: Obtener una lista de proveedores

Este código devuelve una lista de los proveedores habilitados actualmente en la sesión de Windows PowerShell:

Get-Help -Category provider

Obtener ayuda sobre el proveedor de SQL Server

Para obtener ayuda sobre el proveedor

  1. Ejecutar Get-Help especificar el nombre SQLServer

Ejemplo: Obtener ayuda del proveedor de SQL Server

En este ejemplo se devuelve información básica sobre el proveedor de SQL Server:

Get-Help SQLServer

Enumerar métodos y propiedades

Para enumerar los métodos y propiedades de un nodo en una ruta de acceso del proveedor de SQL Server

  1. CD a un nodo en la ruta de acceso de SQL Server o cree una variable que apunte a esa ubicación.

  2. Ejecute el cmdlet Get-Member con el parámetro -Type establecido en Métodos o Propiedades.

Ejemplos: Enumerar métodos y propiedades

En este ejemplo se enumeran los métodos admitidos para el nodo Bases de datos:

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

En este ejemplo se enumeran las propiedades de una variable que se ha establecido en un objeto Table de SMO:

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

Véase también

Proveedor de SQL Server PowerShell Provider
Utilizar los cmdlets del motor de base de datos