通过

Read-SqlTableData

  • 参考
模块:
SQLServer

从 SQL 数据库的表读取数据。

语法

Read-SqlTableData
    [-TopN <Int64>]
    [-ColumnName <String[]>]
    [-ColumnOrder <String[]>]
    [-ColumnOrderType <OrderType[]>]
    [-OutputAs <OutputTypeSingleTable>]
    [[-Path] <String[]>]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-ProgressAction <ActionPreference>]
    [<CommonParameters>]
Read-SqlTableData
    [-TableName <String>]
    [-TopN <Int64>]
    [-ColumnName <String[]>]
    [-ColumnOrder <String[]>]
    [-ColumnOrderType <OrderType[]>]
    [-OutputAs <OutputTypeSingleTable>]
    [-DatabaseName <String>]
    [-SchemaName <String>]
    [-IgnoreProviderContext]
    [-SuppressProviderContextWarning]
    [[-ServerInstance] <String[]>]
    [-Credential <PSCredential>]
    [-ConnectionTimeout <Int32>]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-ProgressAction <ActionPreference>]
    [<CommonParameters>]
Read-SqlTableData
    [-TopN <Int64>]
    [-ColumnName <String[]>]
    [-ColumnOrder <String[]>]
    [-ColumnOrderType <OrderType[]>]
    [-OutputAs <OutputTypeSingleTable>]
    [-InputObject] <ScriptSchemaObjectBase[]>
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-ProgressAction <ActionPreference>]
    [<CommonParameters>]

说明

Read-SqlTableData cmdlet 读取存储在 SQL 数据库的表中的数据。 可以选择要读取的列、限制行数以及排序和排序列。

可以将此 cmdlet 与 Windows PowerShell SQL 提供程序配合使用。 此 cmdlet 可以从其当前路径推断服务器、数据库、架构和表等信息。

此 cmdlet 支持以下输出格式：

  • 数据。 包含一个表的 System.Data.DataSet 类型的对象。
  • DataTable。 System.Data.DataTable 类型的对象。 此对象的 TableName 属性与此 cmdlet 查询的表相同。
  • DataRows。 System.Data.DateRow 对象的集合。

示例

示例 1：从表中获取三行

PS C:\> Read-SqlTableData -ServerInstance "MyServer\MyInstance" -DatabaseName "MyDatabase" -SchemaName "dbo" -TableName "MyTable" -TopN 3

Id Name   Amount
-- ----   ------
10 AAAAA  -1.2
11 BBBBB  1.2
12 CCCCC  -1.0

此命令从表 MyDatabase.dbo.MyTable 获取 MyServer\MyInstance 实例上的前三行。 TopN 参数指定行数（在本例中为 3）。

示例 2：显示整个表

PS C:\> cd SQLSERVER:\sql\MyServer\MyInstance\Databases\MyDatabase\Tables\dbo.CSVTable
PS SQLSERVER:\sql\MyServer\MyInstance\Databases\MyDatabase\Tables\dbo.CSVTable> Read-SqlTableData

Id Name Amount
-- ---- ------
10 AAAA -1.2
11 BBBB 1.2
12 CCCC -1.0
13 DDDD -2.0

第一个命令将位置更改为 SQLSERVER 提供程序中的表。 命令提示符反映新位置。

示例 3：显示所选排序列

PS C:\> cd SQLSERVER:\sql\MyServer\MyInstance\Databases\MyDatabase\Tables\dbo.CSVTable
PS SQLSERVER:\sql\MyServer\MyInstance\Databases\MyDatabase\Tables\dbo.CSVTable> Read-SqlTableData -TopN 3 -ColumnName "Id","Name" -ColumnOrder "Id","Name" -ColumnOrderType DESC,ASC

Id Name
-- ----
12 CCCC
11 BBBB
10 AAAA

参数

-AccessToken

用于向 SQL Server 进行身份验证的访问令牌，作为用户/密码或 Windows 身份验证的替代方法。

例如，这可用于使用 Service Principal 或 Managed Identity连接到 SQL Azure DB 和 SQL Azure Managed Instance。

要使用的参数可以是表示令牌的字符串，也可以是运行 Get-AzAccessToken -ResourceUrl https://database.windows.net返回的 PSAccessToken 对象。

此参数是模块 v22 中的新增参数。

类型:PSObject
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ColumnName

指定此 cmdlet 返回的列的名称数组。

类型:String[]
别名:ColumnToReturn
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ColumnOrder

指定此 cmdlet 对其返回的列进行排序的列的名称数组。

类型:String[]
别名:OrderBy
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ColumnOrderType

指定此 cmdlet 返回的列的顺序类型的数组。 此参数的可接受值为：

  • ASC。 上升。
  • DESC。 降。

为此参数指定的值与在 ColumnOrder 参数中指定的列匹配。 此 cmdlet 忽略任何额外值。

类型:OrderType[]
接受的值:ASC, DESC
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ConnectionTimeout

指定在超时失败之前等待服务器连接的秒数。 超时值必须是介于 0 和 65534 之间的整数。 如果指定了 0，则连接尝试不会超时。

类型:Int32
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Credential

指定连接到 SQL Server 的 PSCredential 对象。 若要获取凭据对象，请使用 Get-Credential cmdlet。 有关详细信息，请键入 Get-Help Get-Credential。

类型:PSCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DatabaseName

指定包含表的数据库的名称。

如果在数据库或数据库的子项上下文中运行此 cmdlet，则 cmdlet 将忽略此参数值。 请为 cmdlet 指定 IgnoreProviderContext 参数，以无论如何使用 DatabaseName 参数的值。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Encrypt

连接到 SQL Server 时要使用的加密类型。

此值映射到 Microsoft.Data.SqlClient 驱动程序的 SqlConnection 对象的 Encrypt 属性 SqlConnectionEncryptOption。

在模块的 v22 中，默认为 Optional（为了与 v21 兼容）。 在模块的 v23+ 中，默认值为“必需”，这可能会为现有脚本创建中断性变更。

此参数是模块 v22 中的新增参数。

类型:String
接受的值:Mandatory, Optional, Strict
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-HostNameInCertificate

用于验证 SQL Server TLS/SSL 证书的主机名。 如果为强制加密启用了 SQL Server 实例，并且想要使用主机名/shortname 连接到实例，则必须传递此参数。 如果省略此参数，则必须将完全限定域名（FQDN）传递给 -ServerInstance 才能连接到为强制加密启用的 SQL Server 实例。

此参数是模块 v22 中的新增参数。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-IgnoreProviderContext

指示此 cmdlet 不使用当前上下文替代 ServerInstance、DatabaseName、SchemaName和 TableName 参数的值。 如果未指定此参数，cmdlet 将忽略这些参数的值（如果可能），而忽略运行 cmdlet 的上下文。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-InputObject

指定表示此 cmdlet 读取的表的 SQL Server 管理对象 （SMO） 对象的数组。

类型:ScriptSchemaObjectBase[]
Position:1
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-OutputAs

指定输出的类型。

类型:OutputTypeSingleTable
别名:As
接受的值:DataSet, DataTable, DataRows
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Path

指定此 cmdlet 读取的表的路径。

类型:String[]
Position:1
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ProgressAction

确定 PowerShell 如何响应脚本、cmdlet 或提供程序生成的进度更新，例如由 Write-Progress cmdlet 生成的进度栏。 Write-Progress cmdlet 创建显示命令状态的进度栏。

类型:ActionPreference
别名:proga
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-SchemaName

指定表的架构的名称。

如果在数据库或数据库的子项上下文中运行此 cmdlet，则 cmdlet 将忽略此参数值。 请为 cmdlet 指定 IgnoreProviderContext 参数，以无论如何使用 SchemaName 参数的值。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ServerInstance

指定 SQL Server 实例的名称。 对于默认实例，请指定计算机名称。 对于命名实例，请使用 ComputerName\InstanceName格式。

如果在数据库或数据库的子项上下文中运行此 cmdlet，则 cmdlet 将忽略此参数值。 为 cmdlet 指定 IgnoreProviderContext 参数，以无论如何使用 ServerInstance 参数的值。

类型:String[]
Position:1
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-SuppressProviderContextWarning

指示此 cmdlet 禁止显示指示该 cmdlet 使用提供程序上下文的警告消息。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-TableName

指定此 cmdlet 从中读取的表的名称。

如果在数据库或数据库的子项上下文中运行此 cmdlet，则 cmdlet 将忽略此参数值。 为 cmdlet 指定 IgnoreProviderContext 参数，以无论如何使用 TableName 参数的值。

类型:String
别名:Name
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-TopN

指定此 cmdlet 返回的数据行数。 如果未指定此参数，cmdlet 将返回所有行。

类型:Int64
别名:First
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-TrustServerCertificate

指示通道是否在绕过证书链以验证信任的同时进行加密。

在模块的 v22 中，默认为 $true（为了与 v21 兼容）。 在模块的 v23+ 中，默认值将为“$false”，这可能会为现有脚本创建中断性变更。

此参数是模块 v22 中的新增参数。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

输入

System.String[]