ConvertTo-Csv

モジュール:

Microsoft.PowerShell.Utility

.NET オブジェクトを一連の文字区切り値 (CSV) 文字列に変換します。

構文

ConvertTo-Csv
              [-InputObject] <PSObject>
              [[-Delimiter] <Char>]
              [-IncludeTypeInformation]
              [-NoTypeInformation]
              [-QuoteFields <String[]>]
              [-UseQuotes <QuoteKind>]
              [-NoHeader]
              [<CommonParameters>]

ConvertTo-Csv
              [-InputObject] <PSObject>
              [-UseCulture]
              [-IncludeTypeInformation]
              [-NoTypeInformation]
              [-QuoteFields <String[]>]
              [-UseQuotes <QuoteKind>]
              [-NoHeader]
              [<CommonParameters>]

説明

ConvertTo-CSV コマンドレットは、送信するオブジェクトを表す一連の文字区切り値 (CSV) 文字列を返します。 その後、 ConvertFrom-Csv コマンドレットを使用して、CSV 文字列からオブジェクトを再作成できます。 CSV から変換されるオブジェクトは、プロパティ値を含み、メソッドを含まない元のオブジェクトの文字列値です。

Export-Csv コマンドレットを使用して、オブジェクトを CSV 文字列に変換できます。 Export-CSV は ConvertTo-CSVに似ていますが、CSV 文字列をファイルに保存する点が異なります。

ConvertTo-CSV コマンドレットには、コンマ以外の区切り記号を指定したり、現在のカルチャを区切り記号として使用したりするパラメーターがあります。

例

例 1: オブジェクトを CSV に変換する

次の使用例は、 Process オブジェクトを CSV 文字列に変換します。

Get-Process -Name pwsh | ConvertTo-Csv -NoTypeInformation

"Name","SI","Handles","VM","WS","PM","NPM","Path","Parent","Company","CPU","FileVersion", ...
"pwsh","8","950","2204001161216","100925440","59686912","67104", ...

Get-Process コマンドレットは、Process オブジェクトを取得し、Name パラメーターを使用して PowerShell プロセスを指定します。 プロセス オブジェクトは、パイプラインから ConvertTo-CSV コマンドレットに送信されます。 ConvertTo-CSV コマンドレットは、オブジェクトを CSV 文字列に変換します。 NoTypeInformation パラメーターは、csv 出力から#TYPE情報ヘッダーを削除します。PowerShell 6 では必要ありません。

例 2: DateTime オブジェクトを CSV に変換する

次の使用例は、 DateTime オブジェクトを CSV 文字列に変換します。

$Date = Get-Date
ConvertTo-Csv -InputObject $Date -Delimiter ';' -NoTypeInformation

"DisplayHint";"DateTime";"Date";"Day";"DayOfWeek";"DayOfYear";"Hour";"Kind";"Millisecond";"Minute";"Month";"Second";"Ticks";"TimeOfDay";"Year"
"DateTime";"Friday, January 4, 2019 14:40:51";"1/4/2019 00:00:00";"4";"Friday";"4";"14";"Local";"711";"40";"1";"51";"636822096517114991";"14:40:51.7114991";"2019"

Get-Date コマンドレットは、DateTime オブジェクトを取得し、$Date変数に保存します。 ConvertTo-Csv コマンドレットは、DateTime オブジェクトを文字列に変換します。 InputObject パラメーターは、$Date変数に格納されているDateTime オブジェクトを使用します。 Delimiter パラメーターは、文字列値を区切るセミコロンを指定します。 NoTypeInformation パラメーターは、csv 出力から#TYPE情報ヘッダーを削除します。PowerShell 6 では必要ありません。

例 3: PowerShell イベント ログを CSV に変換する

この例では、PowerShell の Windows イベント ログを一連の CSV 文字列に変換します。

(Get-Culture).TextInfo.ListSeparator
Get-WinEvent -LogName 'PowerShellCore/Operational' | ConvertTo-Csv -UseCulture -NoTypeInformation

,
"Message","Id","Version","Qualifiers","Level","Task","Opcode","Keywords","RecordId", ...
"Error Message = System error""4100","1",,"3","106","19","0","31716","PowerShellCore", ...

Get-Culture コマンドレットは、入れ子になったプロパティ TextInfo および ListSeparator を使用して、現在のカルチャの既定のリスト区切り記号を表示します。 Get-WinEvent コマンドレットは、イベント ログ オブジェクトを取得し、LogName パラメーターを使用してログ ファイル名を指定します。 イベント ログ オブジェクトは、パイプラインから ConvertTo-Csv コマンドレットに送信されます。 ConvertTo-Csv コマンドレットは、イベント ログ オブジェクトを一連の CSV 文字列に変換します。 UseCulture パラメーターは、現在のカルチャの既定のリスト区切り記号を区切り記号として使用します。 NoTypeInformation パラメーターは、csv 出力から#TYPE情報ヘッダーを削除します。PowerShell 6 では必要ありません。

例 4: 2 つの列を引用符で囲んで CSV に変換する

次の使用例は、 DateTime オブジェクトを CSV 文字列に変換します。

Get-Date | ConvertTo-Csv -QuoteFields "DateTime","Date"

DisplayHint,"DateTime","Date",Day,DayOfWeek,DayOfYear,Hour,Kind,Millisecond,Minute,Month,Second,Ticks,TimeOfDay,Year
DateTime,"Thursday, August 22, 2019 11:27:34 AM","8/22/2019 12:00:00 AM",22,Thursday,234,11,Local,569,27,8,34,637020700545699784,11:27:34.5699784,2019

例 5: 必要な場合にのみ引用符で囲まれた CSV に変換する

次の使用例は、 DateTime オブジェクトを CSV 文字列に変換します。

Get-Date | ConvertTo-Csv -UseQuotes AsNeeded

DisplayHint,DateTime,Date,Day,DayOfWeek,DayOfYear,Hour,Kind,Millisecond,Minute,Month,Second,Ticks,TimeOfDay,Year
DateTime,"Thursday, August 22, 2019 11:31:00 AM",8/22/2019 12:00:00 AM,22,Thursday,234,11,Local,713,31,8,0,637020702607132640,11:31:00.7132640,2019

例 6: ハッシュテーブルを CSV に変換する

PowerShell 7.2 以降では、ハッシュテーブルを CSV に変換すると、最初のハッシュテーブルのキーがシリアル化され、出力のヘッダーとして使用されます。

$person1 = @{
    Name = 'John Smith'
    Number = 1
}

$person2 = @{
    Name = 'Jane Smith'
    Number = 2
}

$allPeople = $person1, $person2
$allPeople | ConvertTo-Csv

"Name","Number"
"John Smith","1"
"Jane Smith","2"

例 7: 追加のプロパティを使用してハッシュテーブルを CSV に変換する

PowerShell 7.2 以降では、 Add-Member で追加のプロパティが追加されたハッシュテーブルを変換するとき、または Select-Object 追加のプロパティも CSV 出力のヘッダーとして追加されます。

$allPeople | Add-Member -Name ExtraProp -Value 42
$allPeople | ConvertTo-Csv

"Name","Number","ExtraProp"
"John Smith","1","42"
"Jane Smith","2","42"

各ハッシュテーブルには、 ExtraProp という名前のプロパティが Add-Member によって追加され、CSV に変換されます。 ExtraPropが出力のヘッダーになっていることがわかります。

追加されたプロパティにハッシュテーブルのキーとして same 名がある場合、キーが優先され、キーのみが CSV に変換されます。

パラメーター

-Delimiter

CSV 文字列内のプロパティ値を区切る区切り記号を指定します。 既定値はコンマ (,) です。 コロン (:) などの文字を入力します。 セミコロン (;) を指定するには、単一引用符で囲みます。

型:	Char
配置:	1
規定値:	comma (,)
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-IncludeTypeInformation

このパラメーターを使用する場合、出力の最初の行には、 #TYPE の後にオブジェクト型の完全修飾名が続きます。 たとえば、#TYPE System.Diagnostics.Process のようにします。

このパラメーターは、PowerShell 6.0 で導入されました。

型:	SwitchParameter
Aliases:	ITI
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

CSV 文字列に変換されるオブジェクトを指定します。 オブジェクトが格納されている変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。 オブジェクトをパイプ処理して ConvertTo-CSVすることもできます。

型:	PSObject
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-NoHeader

このパラメーターを使用すると、コマンドレットは列名を含むヘッダー行を出力に書き込むことはありません。

このパラメーターは PowerShell 7.4 で追加されました。

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-NoTypeInformation

#TYPE情報ヘッダーを出力から削除します。 このパラメーターは PowerShell 6.0 の既定値となり、下位互換性のために含まれています。

型:	SwitchParameter
Aliases:	NTI
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-QuoteFields

引用符で囲む必要がある列の名前を指定します。 このパラメーターを使用する場合、指定された列のみが引用符で囲まれます。 このパラメーターは PowerShell 7.0 で追加されました。

型:	String[]
Aliases:	QF
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UseCulture

現在のカルチャのリスト区切り記号を項目区切り記号として使用します。 カルチャのリスト区切り記号を検索するには、次のコマンドを使用します: (Get-Culture).TextInfo.ListSeparator。

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UseQuotes

CSV ファイルで引用符を使用するタイミングを指定します。 次のいずれかの値になります。

• 決して - 何も引用符で囲まない
• 常に - すべてを引用符で囲む (既定の動作)
• AsNeeded - 区切り文字、二重引用符、または改行文字を含む引用符フィールドのみ

このパラメーターは PowerShell 7.0 で追加されました。

型:	Microsoft.PowerShell.Commands.BaseCsvWritingCommand+QuoteKind
Aliases:	UQ
配置:	Named
規定値:	Always
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PSObject

拡張型システム (ETS) アダプターを持つ任意のオブジェクトをこのコマンドレットにパイプできます。

出力

String

このコマンドレットは、変換された各オブジェクトを表す 1 つ以上の文字列を返します。

メモ

CSV 形式では、各オブジェクトはプロパティ値の文字区切りのリストで表されます。 プロパティ値は、オブジェクトの ToString() メソッドを使用して文字列に変換されます。 文字列はプロパティ値の名前で表されます。 ConvertTo-CSV では、オブジェクトのメソッドはエクスポートされません。

CSV 文字列は次のように出力されます。

• IncludeTypeInformation を使用する場合、最初の文字列は#TYPEの後にオブジェクト型の完全修飾名が続きます。 たとえば、System.Diagnostics.Process を#TYPEします。
• IncludeTypeInformationを使用しない場合、最初の文字列には列ヘッダーが含まれます。 ヘッダーには、最初のオブジェクトのプロパティ名が文字区切りリストとして含まれています。
• 残りの文字列には、各オブジェクトのプロパティ値の文字区切りのリストが含まれています。

PowerShell 6.0 以降では、 ConvertTo-CSV の既定の動作は、CSV に #TYPE 情報を含めず、 NoTypeInformation を暗黙的に指定することです。 IncludeTypeInformation を使用して、 #TYPE 情報を含め、PowerShell 6.0 より前の ConvertTo-CSV の既定の動作をエミュレートできます。

複数のオブジェクトを ConvertTo-CSVに送信すると、 ConvertTo-CSV は、最初に送信したオブジェクトのプロパティに基づいて文字列を並べ替えます。 残りのオブジェクトに指定されたプロパティの 1 つがない場合、そのオブジェクトのプロパティ値は Null で、連続する 2 つのコンマで表されます。 残りのオブジェクトに追加のプロパティがある場合、これらのプロパティ値は無視されます。

関連リンク

• ConvertFrom-Csv
• Export-Csv
• Import-Csv