Export-Csv

将对象转换为一系列字符分隔值 (CSV) 字符串,并将字符串保存到文件中。

语法

Export-Csv
      [[-Path] <string>]
      [[-Delimiter] <char>]
      -InputObject <psobject>
      [-LiteralPath <string>]
      [-Force]
      [-NoClobber]
      [-Encoding <string>]
      [-Append]
      [-NoTypeInformation]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Export-Csv
      [[-Path] <string>]
      -InputObject <psobject>
      [-LiteralPath <string>]
      [-Force]
      [-NoClobber]
      [-Encoding <string>]
      [-Append]
      [-UseCulture]
      [-NoTypeInformation]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

说明

Export-CSV cmdlet 创建提交的对象的 CSV 文件。 每个对象都是一行,其中包含对象的属性值的字符分隔列表。 可以使用 Export-CSV cmdlet 创建电子表格,并与接受 CSV 文件作为输入的程序共享数据。

不要在将对象发送到 Export-CSV cmdlet 之前设置对象格式。 如果 Export-CSV 接收格式化对象,则 CSV 文件包含格式属性而不是对象属性。 若要仅导出对象的选定属性,请使用 Select-Object cmdlet。

示例

示例 1:将进程属性导出到 CSV 文件

此示例选择具有特定属性进程对象,将对象导出到 CSV 文件。

Get-Process -Name WmiPrvSE |
    Select-Object -Property BasePriority,Id,SessionId,WorkingSet |
    Export-Csv -Path .\WmiData.csv -NoTypeInformation
Import-Csv -Path .\WmiData.csv

BasePriority Id    SessionId WorkingSet
------------ --    --------- ----------
8            976   0         20267008
8            2292  0         36786176
8            3816  0         30351360
8            8604  0         15011840
8            10008 0         8830976
8            11764 0         14237696
8            54632 0         9502720

Get-Process cmdlet 获取进程对象。 Name 参数筛选输出,以仅包含 WmiPrvSE 进程对象。 进程对象沿管道向下发送到 Select-Object cmdlet。 Select-Object 使用 Property 参数来选择进程对象属性的子集。 进程对象沿管道向下发送到 Export-Csv cmdlet。 Export-Csv 将进程对象转换为一系列 CSV 字符串。 Path 参数指定 WmiData.csv 文件保存在当前目录中。 NoTypeInformation 参数从 CSV 输出中删除 #TYPE 信息标头,并且不需要在 PowerShell 6 中。 Import-Csv cmdlet 使用 Path 参数显示位于当前目录中的文件。

示例 2:将进程导出到逗号分隔的文件

此示例获取进程对象并将对象导出到 CSV 文件。

Get-Process | Export-Csv -Path .\Processes.csv -NoTypeInformation
Get-Content -Path .\Processes.csv

"Name","SI","Handles","VM","WS","PM","NPM","Path","Parent","Company","CPU","FileVersion", ...
"ApplicationFrameHost","4","511","2203597099008","35364864","21979136","30048", ...

Get-Process cmdlet 获取进程对象。 进程对象沿管道向下发送到 Export-Csv cmdlet。 Export-Csv 将进程对象转换为一系列 CSV 字符串。 Path 参数指定 Processes.csv 文件保存在当前目录中。 NoTypeInformation 参数从 CSV 输出中删除 #TYPE 信息标头,并且不需要在 PowerShell 6 中。 Get-Content cmdlet 使用 Path 参数显示位于当前目录中的文件。

示例 3:将进程导出到分号分隔的文件

此示例获取进程对象,并使用分号分隔符将对象导出到文件中。

Get-Process | Export-Csv -Path .\Processes.csv -Delimiter ';' -NoTypeInformation
Get-Content -Path .\Processes.csv

"Name";"SI";"Handles";"VM";"WS";"PM";"NPM";"Path";"Parent";"Company";"CPU";"FileVersion"; ...
"ApplicationFrameHost";"4";"509";"2203595321344";"34807808";"21770240";"29504"; ...

Get-Process cmdlet 获取进程对象。 进程对象沿管道向下发送到 Export-Csv cmdlet。 Export-Csv 将进程对象转换为一系列 CSV 字符串。 Path 参数指定 Processes.csv 文件保存在当前目录中。 Delimiter 参数指定分隔字符串值的分号。 NoTypeInformation 参数从 CSV 输出中删除 #TYPE 信息标头,并且不需要在 PowerShell 6 中。 Get-Content cmdlet 使用 Path 参数显示位于当前目录中的文件。

示例 4:使用当前区域性的列表分隔符导出进程

此示例获取进程对象并将对象导出到文件。 分隔符是当前区域性的列表分隔符。

(Get-Culture).TextInfo.ListSeparator
Get-Process | Export-Csv -Path .\Processes.csv -UseCulture -NoTypeInformation
Get-Content -Path .\Processes.csv

"Name","SI","Handles","VM","WS","PM","NPM","Path","Parent","Company","CPU","FileVersion", ...
"ApplicationFrameHost","4","511","2203597099008","35364864","21979136","30048", ...

Get-Culture cmdlet 使用 TextInfo 嵌套属性和 ListSeparator,并显示当前区域性的默认列表分隔符。 Get-Process cmdlet 获取进程对象。 进程对象沿管道向下发送到 Export-Csv cmdlet。 Export-Csv 将进程对象转换为一系列 CSV 字符串。 Path 参数指定 Processes.csv 文件保存在当前目录中。 UseCulture 参数使用当前区域性的默认列表分隔符作为分隔符。 NoTypeInformation 参数从 CSV 输出中删除 #TYPE 信息标头,并且不需要在 PowerShell 6 中。 Get-Content cmdlet 使用 Path 参数显示位于当前目录中的文件。

示例 5:导出包含类型信息的进程

此示例说明如何在 CSV 文件中包括 #TYPE 标头信息。 #TYPE 标头是 PowerShell 6.0 之前的版本中的默认标头。

Get-Process | Export-Csv -Path .\Processes.csv
Get-Content -Path .\Processes.csv

#TYPE System.Diagnostics.Process
"Name","SI","Handles","VM","WS","PM","NPM","Path","Company","CPU","FileVersion", ...
"ApplicationFrameHost","4","507","2203595001856","35139584","20934656","29504", ...

Get-Process cmdlet 获取进程对象。 进程对象沿管道向下发送到 Export-Csv cmdlet。 Export-Csv 将进程对象转换为一系列 CSV 字符串。 Path 参数指定 Processes.csv 文件保存在当前目录中。 Get-Content cmdlet 使用 Path 参数显示位于当前目录中的文件。

示例 6:将对象导出并追加到 CSV 文件

此示例介绍如何将对象导出到 CSV 文件,并使用 Append 参数将对象添加到现有文件。

$AppService = (Get-Service -DisplayName *Application* | Select-Object -Property DisplayName, Status)
$AppService | Export-Csv -Path .\Services.Csv -NoTypeInformation
Get-Content -Path .\Services.Csv
$WinService = (Get-Service -DisplayName *Windows* | Select-Object -Property DisplayName, Status)
$WinService | Export-Csv -Path .\Services.csv -NoTypeInformation -Append
Get-Content -Path .\Services.Csv

"DisplayName","Status"
"Application Layer Gateway Service","Stopped"
"Application Identity","Running"
"Windows Audio Endpoint Builder","Running"
"Windows Audio","Running"
"Windows Event Log","Running"

Get-Service cmdlet 获取服务对象。 DisplayName 参数返回包含“Application”这个词的服务。 服务对象沿管道向下发送到 Select-Object cmdlet。 Select-Object 使用 Property 参数来指定 DisplayNameStatus 属性。 $AppService 变量存储对象。

$AppService 对象沿管道向下发送到 Export-Csv cmdlet。 Export-Csv 将服务对象转换为一系列 CSV 字符串。 Path 参数指定 Services.csv 文件保存在当前目录中。 NoTypeInformation 参数从 CSV 输出中删除 #TYPE 信息标头,并且不需要在 PowerShell 6 中。 Get-Content cmdlet 使用 Path 参数显示位于当前目录中的文件。

对于包含“Windows”这个词的服务,将重复 Get-ServiceSelect-Object cmdlet。 $WinService 变量存储服务对象。 Export-Csv cmdlet 使用 Append 参数指定将 $WinService 对象添加到现有 Services.csv 文件中。 Get-Content cmdlet 重复显示包含追加数据的更新文件。

示例 7:在管道中设置 cmdlet 格式会导致意外结果

此示例显示为什么不要在管道中使用格式 cmdlet。 收到意外输出时,对管道语法进行故障排除。

Get-Date | Select-Object -Property DateTime, Day, DayOfWeek, DayOfYear |
 Export-Csv -Path .\DateTime.csv -NoTypeInformation
Get-Content -Path .\DateTime.csv

"DateTime","Day","DayOfWeek","DayOfYear"
"Wednesday, January 2, 2019 14:59:34","2","Wednesday","2"

Get-Date | Format-Table -Property DateTime, Day, DayOfWeek, DayOfYear |
 Export-Csv -Path .\FTDateTime.csv -NoTypeInformation
Get-Content -Path .\FTDateTime.csv

"ClassId2e4f51ef21dd47e99d3c952918aff9cd","pageHeaderEntry","pageFooterEntry","autosizeInfo", ...
"033ecb2bc07a4d43b5ef94ed5a35d280",,,,"Microsoft.PowerShell.Commands.Internal.Format. ...
"9e210fe47d09416682b841769c78b8a3",,,,,
"27c87ef9bbda4f709f6b4002fa4af63c",,,,,
"4ec4f0187cb04f4cb6973460dfe252df",,,,,
"cf522b78d86c486691226b40aa69e95c",,,,,

Get-Date cmdlet 获取 DateTime 对象。 该对象沿管道向下发送到 Select-Object cmdlet。 Select-Object 使用 Property 参数来选择对象属性的子集。 该对象沿管道向下发送到 Export-Csv cmdlet。 Export-Csv 将对象转换为 CSV 格式。 Path 参数指定 DateTime.csv 文件保存在当前目录中。 NoTypeInformation 参数从 CSV 输出中删除 #TYPE 信息标头,并且不需要在 PowerShell 6 中。 Get-Content cmdlet 使用 Path 参数显示位于当前目录中的 CSV 文件。

当管道中使用 Format-Table cmdlet 以选择收到意外结果的属性时。 Format-Table 将表格式对象沿管道向下发送到 Export-Csv cmdlet,而不是 DateTime 对象。 Export-Csv 将表格式对象转换为一系列 CSV 字符串。 Get-Content cmdlet 显示包含表格式对象的 CSV 文件。

示例 8:使用 Force 参数覆盖只读文件

此示例创建一个空的只读文件,并使用 Force 参数更新文件。

New-Item -Path .\ReadOnly.csv -ItemType File
Set-ItemProperty -Path .\ReadOnly.csv -Name IsReadOnly -Value $true
Get-Process | Export-Csv -Path .\ReadOnly.csv -NoTypeInformation

Export-Csv : Access to the path 'C:\ReadOnly.csv' is denied.
At line:1 char:15
+ Get-Process | Export-Csv -Path .\ReadOnly.csv -NoTypeInformation
+               ~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo          : OpenError: (:) [Export-Csv], UnauthorizedAccessException
+ FullyQualifiedErrorId : FileOpenFailure,Microsoft.PowerShell.Commands.ExportCsvCommand

Get-Process | Export-Csv -Path .\ReadOnly.csv -NoTypeInformation -Force
Get-Content -Path .\ReadOnly.csv

"Name";"SI";"Handles";"VM";"WS";"PM";"NPM";"Path";"Parent";"Company";"CPU";"FileVersion"; ...
"ApplicationFrameHost";"4";"509";"2203595321344";"34807808";"21770240";"29504"; ...

New-Item cmdlet 使用 PathItemType 参数在当前目录中创建 ReadOnly.csv 文件。 Set-ItemProperty cmdlet 使用 NameValue 参数将文件的 isReadOnly 属性更改为 true。 Get-Process cmdlet 获取进程对象。 进程对象沿管道向下发送到 Export-Csv cmdlet。 Export-Csv 将进程对象转换为一系列 CSV 字符串。 Path 参数指定 ReadOnly.csv 文件保存在当前目录中。 NoTypeInformation 参数从 CSV 输出中删除 #TYPE 信息标头,并且不需要在 PowerShell 6 中。 输出显示文件未写入,因为访问被拒绝。

Force 参数将添加到 Export-Csv cmdlet,以强制导出写入文件。 Get-Content cmdlet 使用 Path 参数显示位于当前目录中的文件。

示例 9:将 Force 参数与 Append 配合使用

此示例演示如何使用 ForceAppend 参数。 将这些参数组合在一起时,可以将不匹配的对象属性写入 CSV 文件。

$Content = [PSCustomObject]@{Name = 'PowerShell'; Version = '7.0'}
$Content | Export-Csv -Path .\ParmFile.csv -NoTypeInformation
$AdditionalContent = [PSCustomObject]@{Name = 'Windows PowerShell'; Edition = 'Desktop'}
$AdditionalContent | Export-Csv -Path .\ParmFile.csv -NoTypeInformation -Append

Export-Csv : Cannot append CSV content to the following file: ParmFile.csv.
The appended object does not have a property that corresponds to the following column:
Version. To continue with mismatched properties, add the -Force parameter, and then retry
 the command.
At line:1 char:22
+ $AdditionalContent | Export-Csv -Path .\ParmFile.csv -NoTypeInformation -Append
+                      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo          : InvalidData: (Version:String) [Export-Csv], InvalidOperationException
+ FullyQualifiedErrorId : CannotAppendCsvWithMismatchedPropertyNames,Microsoft.PowerShell. ...

$AdditionalContent | Export-Csv -Path .\ParmFile.csv -NoTypeInformation -Append -Force
Import-Csv -Path .\ParmFile.csv

Name               Version
----               -------
PowerShell         7.0
Windows PowerShell

表达式使用 NameVersion 属性创建 PSCustomObject。 这些值存储在 $Content 变量中。 $Content 变量沿管道向下发送到 Export-Csv cmdlet。 Export-Csv 使用 Path 参数,并将 ParmFile.csv 文件保存到当前目录中。 NoTypeInformation 参数从 CSV 输出中删除 #TYPE 信息标头,并且不需要在 PowerShell 6 中。

另一个表达式使用 NameEdition 属性创建 PSCustomObject。 这些值存储在 $AdditionalContent 变量中。 $AdditionalContent 变量沿管道向下发送到 Export-Csv cmdlet。 Append 参数用于将数据添加到文件。 由于 VersionEdition 之间存在属性名称不匹配,因此追加失败。

Export-Csv cmdlet Force 参数用于强制导出写入文件。 Edition 属性将被丢弃。 Import-Csv cmdlet 使用 Path 参数显示位于当前目录中的文件。

参数

-Append

使用此参数,以便 Export-CSV 将 CSV 输出添加到指定文件的末尾。 如果没有此参数,Export-CSV 将替换文件内容而不发出警告。

已在 Windows PowerShell 3.0 中引入了此参数。

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Delimiter

指定分隔符以分隔属性值。 默认值为逗号 (,)。 输入字符,如冒号 (:)。 若要指定分号 (;),请将它括在引号中。

Type:Char
Position:1
Default value:comma (,)
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encoding

为导出的 CSV 文件指定编码。 默认值为 ASCII

此参数的可接受值如下所示:

  • ASCII 使用 ASCII(7 位)字符集。
  • BigEndianUnicode 将 UTF-16 与 big-endian 字节顺序配合使用。
  • Default 使用与系统的活动代码页(通常是 ANSI)对应的编码。
  • OEM 使用与系统的当前 OEM 代码页对应的编码。
  • Unicode 将 UTF-16 与 little-endian 字节顺序配合使用。
  • UTF7 使用 UTF-7。
  • UTF8 使用 UTF-8。
  • UTF32 将 UTF-32 与 little-endian 字节顺序配合使用。
Type:String
Accepted values:ASCII, BigEndianUnicode, Default, OEM, Unicode, UTF7, UTF8, UTF32
Position:Named
Default value:ASCII
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

此参数允许 Export-Csv 使用只读属性覆盖文件。

ForceAppend 参数组合在一起时,包含不匹配属性的对象可以写入 CSV 文件。 仅将匹配的属性写入文件。 将丢弃不匹配的属性。

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

指定要导出为 CSV 字符串的对象。 输入一个包含对象的变量,或键入可获取对象的命令或表达式。 还可以通过管道将对象传递给 Export-CSV

Type:PSObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LiteralPath

指定指向 CSV 输出文件的路径。 与 Path 不同,LiteralPath 参数的值严格按照所键入的形式使用。 不会将任何字符解释为通配符。 如果路径包含转义字符,请使用单引号。 单引号告知 PowerShell 不要将任何字符解释为转义序列。

Type:String
Aliases:PSPath
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NoClobber

使用此参数,使 Export-CSV 不会覆盖现有文件。 默认情况下,如果文件存在于指定的路径中,则 Export-CSV 覆盖文件而不发出警告。

Type:SwitchParameter
Aliases:NoOverwrite
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NoTypeInformation

从输出中删除 #TYPE 信息标头。 此参数在 PowerShell 6.0 中成为默认值,并包含在后向兼容性中。

Type:SwitchParameter
Aliases:NTI
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

指定保存 CSV 输出文件的位置的必需参数。

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UseCulture

将当前区域性的列表分隔符用作项分隔符。 若要查找区域性的列表分隔符,请使用以下命令:(Get-Culture).TextInfo.ListSeparator

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

防止处理或进行更改 cmdlet。 输出显示运行 cmdlet 时会发生什么情况。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

PSObject

可以通过管道将具有扩展类型系统 (ETS) 适配器的任何对象传递给此 cmdlet。

输出

None

此 cmdlet 不返回任何输出。

备注

Windows PowerShell 包含 Export-Csv 的以下别名:

  • epcsv

Export-CSV cmdlet 将提交的对象转换为一系列 CSV 字符串,并将其保存在指定的文本文件中。 可以使用 Export-CSV 将对象保存在 CSV 文件中,然后使用 Import-Csv cmdlet 从 CSV 文件中创建对象。

在 CSV 文件中,每个对象由对象的属性值的字符分隔列表表示。 属性值使用 ToString() 方法转换为字符串。 字符串由属性值名称表示。 Export-CSV 不会导出对象的方法。

CSV 字符串输出如下:

  • 默认情况下,第一个字符串包含 #TYPE 信息标头,后跟对象类型的完全限定名称。 例如,#TYPE System.Diagnostics.Process
  • 如果使用 NoTypeInformation,则第一个字符串包含列标头。 标头包含第一个对象的属性名称作为字符分隔的列表。
  • 其余字符串包含每个对象的属性值的字符分隔列表。

将多个对象提交到 Export-CSV 时,Export-CSV 根据提交的第一个对象的属性组织文件。 如果剩余的对象没有指定的属性之一,则该对象的属性值为 null,由两个连续的逗号表示。 如果剩余的对象有其他属性,这些属性值将不包括在文件中。

可以使用 Import-Csv cmdlet 从文件中的 CSV 字符串重新创建对象。 生成的对象是原始对象的 CSV 版本,这些版本由属性值的字符串表示形式组成,且不包括方法。

ConvertTo-CsvConvertFrom-Csv cmdlet 将对象转换为 CSV 字符串以及从 CSV 字符串转换为对象。 Export-CSVConvertTo-CSV 相同,只不过它在文件中保存 CSV 字符串。