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.
Información general
Para obtener más información sobre recursos que se pueden utilizar para obtener información acerca de Windows PowerShell, vea Obtener información sobre PowerShell.
Para obtener información general de los cmdlets y el proveedor de SQL Server, vea Información general de PowerShell de SQL Server.
Usar Get-Help
Utilice 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.
Los cmdlets de SQL Server admiten Get-Help. Get-Help devuelve información de uso de los cmdlets, como descripciones de sintaxis y parámetros. En los ejemplos siguientes se devuelve la ayuda completa de Invoke-Sqlcmd, la ayuda de los parámetros, únicamente, y, por último, la ayuda de solo los ejemplos:
Get-Help Invoke-Sqlcmd -Full
Get-Help Invoke-Sqlcmd -Parameter *
Get-Help Invoke-Sqlcmd -Examples
Para obtener más información sobre cómo se puede utilizar Get-Help y sobre los cmdlets, vea Get-Help: Getting Help.
El proveedor de SQL Server también admite Get-Help. Por ejemplo, este código devuelve información básica sobre el proveedor de SQL Server:
Get-Help SQLServer
Este código devuelve una lista de los proveedores habilitados actualmente en la sesión de Windows PowerShell:
Get-Help -Category provider
Para obtener más información sobre cómo obtener ayuda del proveedor en Windows PowerShell, vea Unidades y proveedores.
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 utilizar 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:
Variables y comandos de sqlcmd. Para obtener información sobre estas variables y comandos, consulte la sección Notas de sqlcmd (utilidad).
Instrucciones Transact-SQL. Para obtener más información acerca del lenguaje Transact-SQL, vea Referencia de Transact-SQL (motor de base de datos).
Instrucciones XQuery. Para obtener más información acerca del lenguaje de XQuery admitido por SQL Server, vea Referencia de lenguaje XQuery (motor de base de datos).
Ayuda del proveedor de SQL Server
El proveedor de SQL Server expone la jerarquía de objetos de SQL Server en rutas de acceso similares a las rutas de acceso al sistema de archivos. Por ejemplo, esta es la ruta de acceso a la tabla Vendor en el esquema Purchasing de la base de datos AdventureWorks2008R2AdventureWorks en una instancia predeterminada del motor de base de datos:
SQL:\MyComputer\DEFAULT\Databases\AdventureWorks2008R2\Tables\Purchasing.Vendor
El proveedor implementa nodos de unidad diferentes para los objetos cubiertos por los distintos modelos de objetos de administración de SQL Server. Rutas con SQL: la unidad utiliza los objetos cubiertos por Objetos de administración de SQL Server (SMO), como tablas y vistas. Cuando se navega a un nodo en una ruta de acceso, se pueden utilizar los métodos y propiedades del modelo de objetos que se aplican a ese tipo de objeto.
Puede utilizar el cmdlet Get-Member con el fin de obtener información sobre qué métodos y propiedades están disponibles para un nodo de ruta. Por ejemplo, puede ejecutar este código para ver los métodos admitidos para el nodo Databases:
Set-Location SQL:\MyComputer\DEFAULT\Databases
Get-Item . | Get-Member -Type Methods
Este código 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
La documentación de los modelos de objeto para las diferentes unidades es:
SQL: unidades.
Para obtener más información acerca de conceptos de SMO, vea Objetos de administración de SQL Server (SMO).
Para obtener más información acerca de la referencia de SMO, vea Microsoft.SqlServer.Management.Smo.