en/Microsoft.SqlServer.Management.PSProvider.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8" ?>
<helpItems schema="maml"> <!-- v 1.3.0.34 --> <providerHelp> <Name> SQLServer </Name> <Drives> <Para>SQLSERVER</Para> </Drives> <Synopsis> Access SQL Server instances and their databases. </Synopsis> <DetailedDescription> <para>The Microsoft SQL Server PowerShell provider lets you manage the configuration of instances of the SQL Server Database Engine and the objects in those instances. The SQL Server PowerShell provider implements separate path hierarchies for different classes of objects that are supported by the SQL Server management object models. The SQL Server PowerShell provider implements one virtual drive named SQLSERVER:. The SQLSERVER: drive has several folders: \SQL, \SQLPolicy, \SQLRegistration, \Utility, \DAC, \DataCollection, \IntegrationServices, and SQLAS. The SQLServer:\SQL folder lets you navigate to instances of the SQL Server Database Engine and manage the objects in the instances, such as logins, tables, functions, jobs, queues, and mail agents. The SQL folder operates using the objects in these namespaces: Microsoft.SqlServer.Management.SMO Microsoft.SqlServer.Management.SMO.Agent Microsoft.SqlServer.Management.SMO.Broker Microsoft.SqlServer.Management.SMO.Mail The SQLSERVER:\SQLPolicy folder lets you navigate to instances of the Database Engine that contains a Policy-Based Management policy store and manage objects such as policies and facets. The SQLPolicy folder operates using the objects in the Microsoft.SqlServer.Management.Dmf and Microsoft.SqlServer.Management.Facets namespaces. The SQLSERVER:\SQLRegistration folder lets you navigate to instances of the Database Engine and manage Registered Server objects such as server groups and registered servers. The SQLRegistration folder operates using the objects in the Microsoft.SqlServer.Management.RegisteredServers and Microsoft.SqlServer.Management.RegSvrEnum namespace. The SQLSERVER:\Utility folder lets you navigate to the managed instances and data-tier applications registered in the SQL Server Utility. The Utility folder operates using the objects in the Microsoft.SqlServer.Management.Utility namespace. The SQLServer:\DAC folder lets you navigage through data-tier applications objects such as DAC package files. The DAC folder operates using the objects in the Microsoft.SqlServer.Management.DAC namespace. The SQLServer:\DataCollection folder lets you navigate to instances of the Database Engine and manage Data Collector objects such as collection sets and configuration stores. The DataCollection folder operates using the objects in the Microsoft.SqlServer.Management.Collector namespace. The SQLServer:\IntegrationServices folder lets you manage SQL Server Integration Services objects such as projects, packages, and environments. The IntegrationServices folder operates using the Microsoft.SqlServer.Management.IntegrationServices namespace. The SQLServer:\SQLAS folders lets you manage SQL Server Analysis Services objects such as aggregations, dimensions, and cubes. The SQLAS folder operates using the Microsoft.AnalysisServices namespace. You can navigate the SQLSERVER: paths by using PowerShell path cmdlets such as Get-Location, Set-Location, and Get-ChildItem. The leading part of a SQLSERVER:\SQL path has the form SQLSERVER:\SQL\ComputerName\InstanceName. You must always specify an instance name, even for default instances. Specify DEFAULT for default instance names. The path nodes following the InstanceName alternate between object classes and object names. Schemas are not represented as an object class. When you specify a path node for top level objects in schemas, such as tables or views, the node name must be in the format SchemaName.ObjectName. For example, this is the path to the AddressID column in the Address table of the Person schema: SQLSERVER:\SQL\MyComputer\DEFAULT\Databases\AdventureWorks\Tables\Person.Address\Columns\AddressID To save typing, you can create your own PowerShell drives that map over the first several nodes of an SQL path. The information that is returned by Get-ChildItem depends on which part of the path the cmdlet is executed from: Returns the local computer name and the list of computers to which you have opened Database Engine connections by using WMI: PS SQLSERVER:\SQL> Get-ChildItem Returns the list of instances on the specified computer: PS SQLSERVER:\SQL\ComputerName> Get-ChildItem Returns the list of top-level object types from the instance, such as Logins and Databases: PS SQLSERVER:\SQL\ComputerName\InstanceName> Get-ChildItem. With the SQL Server PowerShell provider, you manage the objects that are exposed in SQL Server paths by using the SQL Server management object model methods and properties for that class of object. For example, you can use the methods of the Microsoft.SQLServer.Management.SMO.Database class to perform actions such as creating, altering, and dropping databases. You can also use the class properties to query the current state of the objects. Use the Get-Member cmdlet to get a list of the methods and properties that are supported for the various objects. For information about the classes, see the namespace reference sections in the SQL Server Books Online. You cannot select, insert, update, or delete data in tables and views by using the SQL Server PowerShell provider. For example, there is no Select() or Insert() method for tables. Use the Invoke-Sqlcmd cmdlet to access and change the data in tables and views. By default, the SQL Server PowerShell provider opens Windows Authentication connections by using the credentials of the Windows account that is running the PowerShell session. See SQL Server Books Online for information about opening a SQL Server Authentication connection using the provider. In complex databases, the lists returned by Get-ChildItem and the PowerShell tab-completion lists can be very large. You can use three system variables created by the SQL Server PowerShell provider to control the size of these lists: $SqlServerMaximumTabCompletion = n n is an integer that specifies the maximum number of objects in a tab completion list. The default is 0, which means all objects are returned. $SqlServerMaximumChildItems = n n is an integer that specifies the maximum number of objects returned when you run Get-ChildItem on SQL Server path nodes. The default is 0, which means all objects are returned. $SQLServerIncludeSystemObjects = { $True | $False } Specifies whether SQL Server system objects are returned by Get-ChildItem or included in tab-completion lists. The default is $True</para> </DetailedDescription> <Capabilities> <para></para> </Capabilities> <Filters> <para></para> </Filters> <Notes> SQL Server delimited identifiers are object names that are enclosed in brackets ([Table:Name]) or quotation marks ("View>Name"). Delimited identifiers can contain any Unicode character. The special characters in these names must be either encoded to their hexadecimal representation or escaped for use in PowerShell paths. The hexadecimal encoding for characters uses the format %nn. An example of encoding the colon (:)character in the name "Table:Name" is: Set-Location "Table%3AName". The PowerShell escape character is the back tick (`) character that is typically on the key at the top left of the keyboard. An example of escaping an extended character is as follows: Set-Location "View`>Name" Certain characters, such as the colon character (:), cannot be escaped. They must be encoded. The SQL Server PowerShell provider snapin implements two cmdlets to help encode and decode delimited identifiers: Encode-SqlName and Decode-SqlName. You must supply a registry or directory object for the -Type parameter when using these core cmdlets with a SQLRegistration: drive: Copy-Object, Move-Object, New-Object, Remove-Object, and Rename-Object. </Notes> <Tasks> <Task> <Title> Navigating SQLSERVER:\SQL paths </Title> <Description> <para></para> </Description> <Examples> <Example> <Title> -------------------------- EXAMPLE 1 -------------------------- </Title> <Introduction> <para>This example uses the Set-Location cmdlet to change the path to the SQL folder.</para> </Introduction> <Code> Set-Location SQLSERVER:\SQL </Code> <Remarks> <para></para> </Remarks> </Example> <Example> <Title> -------------------------- EXAMPLE 2 -------------------------- </Title> <Introduction> <para>This example uses Set-Location to change the path to a default instance of the Database Engine</para> </Introduction> <Code> Set-Location SQLSERVER:\SQL\MyComputer\DEFAULT </Code> <Remarks> <para></para> </Remarks> </Example> <Example> <Title> -------------------------- EXAMPLE 3 -------------------------- </Title> <Introduction> <para>This example uses Set-Location to change the path to the AdventureWorks sample database.</para> </Introduction> <Code> Set-Location SQLSERVER:\SQL\MyComputer\MyInstance\Databases\AdventureWorks </Code> <Remarks> <para></para> </Remarks> </Example> </Examples> </Task> <Task> <Title> Build a New PowerShell Drive </Title> <Description> <para></para> </Description> <Examples> <Example> <Title> -------------------------- EXAMPLE 1 -------------------------- </Title> <Introduction> <para>If you are going to do a lot of work in the AdventureWorks database, create a new AWDB: drive to save typing.</para> </Introduction> <Code> New-PSDrive -Name AWDB -Root SQLSERVER:\SQL\MyComputer\DEFAULT\Databases\AdventureWorks -PSProvider SQLServer </Code> <Remarks> <para></para> </Remarks> </Example> </Examples> </Task> <Task> <Title> Get the Methods and Properties of a SQL Server Object </Title> <Description> <para></para> </Description> <Examples> <Example> <Title> -------------------------- EXAMPLE 1 -------------------------- </Title> <Introduction> <para>This command sets a variable to the SMO Database class and then gets a list of the methods and properties supported by the class.</para> </Introduction> <Code> $MyVar = New-Object Microsoft.SqlServer.Management.SMO.Database $MyVar | Get-Member -Type Methods $MyVar | Get-Member -Type Properties </Code> <Remarks> <para></para> </Remarks> </Example> <Example> <Title> -------------------------- EXAMPLE 2 -------------------------- </Title> <Introduction> <para>This command navigates to the database node in an SQL-based path and get s a list of the properties that are supported for databases.</para> </Introduction> <Code> Set-Location SQLSERVER:\SQL\MyComputer\DEFAULT\Databases Get-Item . | Get-Member -Type Properties </Code> <Remarks> <para></para> </Remarks> </Example> </Examples> </Task> <Task> <Title> Filter SQL Server Objects by Using SMO Properties </Title> <Description> <para></para> </Description> <Examples> <Example> <Title> -------------------------- EXAMPLE 1 -------------------------- </Title> <Introduction> <para>This command lists only the tables that are in the AdventureWorks Sales schema.</para> </Introduction> <Code> Set-Location SQLSERVER:\SQL\MyComputer\DEFAULT\Databases\AdventureWorks\Tables Get-ChildItem | WHERE {$_.Schema -eq "Sales"} </Code> <Remarks> <para></para> </Remarks> </Example> </Examples> </Task> <Task> <Title> Generate Scripts That Create SQL Server Objects </Title> <Description> <para></para> </Description> <Examples> <Example> <Title> -------------------------- EXAMPLE 1 -------------------------- </Title> <Introduction> <para>This script creates a Views.sql file that contains the CREATE VIEW statements that are required to recreate all of the views that are defined in AdventureWorks.</para> </Introduction> <Code> Remove_Item c:\PowerShell\Views.sql Set-Location SQLSERVER:\SQL\MyComputer\DEFAULT\Databases\AdventureWorks\Views foreach ($Item in Get-ChildItem) {$Item.Script() | Out-File -Filepath c:\PowerShell\Views.sql -append } </Code> <Remarks> <para></para> </Remarks> </Example> </Examples> </Task> <Task> <Title> Use SMO to Manage SQL Server Objects </Title> <Description> <para></para> </Description> <Examples> <Example> <Title> -------------------------- EXAMPLE 1 -------------------------- </Title> <Introduction> <para>This script uses SMO to create a database and then query its state.</para> </Introduction> <Code> Set-Location SQLSERVER:\SQL\MyComputer\DEFAULT\Databases $MyVar = New-Object Microsoft.SqlServer.Management.SMO.Database $MyVar.Parent = (Get-Item ..) $MyVar.Name = "NewDB" $MyVar.Create() $MyVar.State </Code> <Remarks> <para></para> </Remarks> </Example> </Examples> </Task> <Task> <Title> Controlling SQL Server Objects in Tab-completion and Get-ChildItem </Title> <Description> <para></para> </Description> <Examples> <Example> <Title> -------------------------- EXAMPLE 1 -------------------------- </Title> <Introduction> <para>This script sets the values for the system variables that control the number of SQL Server objects included in tab-completion lists or returned by Get-ChildItem.</para> </Introduction> <Code> $SqlServerMaximumTabCompletion = 20 $SqlServerMaximumChildItems = 10 $SqlServerIncludeSystemObjects = $False dir variable:sqlserver* </Code> <Remarks> <para></para> </Remarks> </Example> </Examples> </Task> </Tasks> <DynamicParameters> <DynamicParameter> <Name></Name> <CmdletSupported></CmdletSupported> <Type> <Name></Name> </Type> <Description></Description> <PossibleValues> <PossibleValue> <Value></Value> <Description> <para></para> </Description> </PossibleValue> </PossibleValues> </DynamicParameter> </DynamicParameters> <RelatedLinks> <navigationLink> <linkText>about_provider</linkText> <uri/> </navigationLink> <navigationLink> <linkText>Encode-SqlName</linkText> <uri/> </navigationLink> <navigationLink> <linkText>Decode-SqlName</linkText> <uri/> </navigationLink> <navigationLink> <linkText>Invoke-Sqlcmd</linkText> <uri/> </navigationLink> <navigationLink> <linkText>New-PSDrive</linkText> <uri/> </navigationLink> <navigationLink> <linkText>Get-Member</linkText> <uri/> </navigationLink> <navigationLink> <linkText>Invoke-PolicyEvaluation</linkText> <uri/> </navigationLink> </RelatedLinks> </providerHelp> </helpItems> |