Compartir a través de


Obtener ayuda de SQL Server PowerShell

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

Antes de empezar

Para obtener información sobre Windows PowerShell, vea el Guía de Introducción de Windows PowerShell.

Para obtener información general de los cmdlets y el proveedor de SQL Server, vea 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 diversos cmdlets y proveedores disponibles en Windows PowerShell.

Para obtener más información acerca de las formas en que puede usar Get-Help, vea Get-Help: Obtener Ayuda.

Ayuda del proveedor de SQL Server PowerShell

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

Ayuda de Invoke-Sqlcmd

El cmdlet Invoke-Sqlcmd toma como entrada cualquier archivo de script o consulta que pueda ser ejecutado por la utilidad sqlcmd. Puede usar Get-Help para obtener información sobre Invoke-Sqlcmd y sus parámetros, pero Get-Help no abarca las consultas de 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: Get-Help de cmdlet

Los ejemplos siguientes devuelven diferentes 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 activo

  1. Ejecute Get-Help ejecutando la categoría del proveedor.

Para obtener más información sobre cómo obtener ayuda del proveedor en Windows PowerShell, vea 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 acerca del proveedor de SQL Server

Para obtener ayuda acerca del proveedor

  1. Ejecute Get-Help especificando el nombre SQLServer

Ejemplo: Obtener Ayuda del proveedor de SQL Server

Este ejemplo devuelve información básica sobre el proveedor de SQL Server:

Get-Help SQLServer

Enumerar métodos y propiedades

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

  1. Un CD de un nodo de la ruta de acceso de SQL Server, o crear una variable establecida en esa ubicación.

  2. Ejecute el cmdlet Get-Member con - Escriba el parámetro establecido en los métodos o en propiedades

Ejemplos: Enumerar métodos y propiedades

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

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

Este ejemplo enumera las propiedades de una variable que se ha establecido en un objeto SMO Table:

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

Vea también

Conceptos

Proveedor de PowerShell de SQL Server

Utilizar los cmdlets del motor de base de datos