PowerShell からSFTP データに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData Cmdlets for SFTP を使えば、PowerShell からSFTP に手軽に連携して、データのCRUD やエクスポートを実行できます。

本記事では、SFTP への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。

SFTP への接続を設定

それでは、まずはSFTP への接続設定からはじめていきましょう。接続設定にはCData SFTP Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。

インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。

    Import-Module SFTPCmdlets;

Connect-SFTP コマンドを使ってSFTP との接続を設定します。各接続プロパティの取得方法は次に説明します。

    $conn = Connect-SFTP  -RemoteHost "$RemoteHost"

FTP は、SFTP プロトコルを使用してSFTP サーバーとの間のファイル転送を行います。接続するにはRemoteHost を指定します。FTP はUser、Password、および公開鍵認証（SSHClientCert）を使用します。 SSHAuthMode を選択し、選択に基づいて接続値を指定します。

次の接続プロパティを設定し、ファイルシステムのリレーショナルビューをコントロールします。

• RemotePath: 現在の作業ディレクトリに設定。
• TableDepth: ビューとしてレポートするサブフォルダの深度を制御するために設定。
• FileRetrievalDepth: ファイルを再帰的に取得し、Root テーブルにリストするために設定。

これで接続設定は完了です。

SFTP データを取得してCSV にパイプライン

接続が完了したので、MyDirectory テーブルデータを取得して結果をCSV ファイルにエクスポートします。

Select-SFTP -Connection $conn -Table MyDirectory | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myMyDirectoryData.csv -NoTypeInformation

このコードでは、Select-SFTP から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。

それでは、続いてデータの削除や挿入・更新を実行してみます。

データの削除

以下のように、フィルタリングで合致するレコードを削除することができます。

Select-SFTP -Connection $conn -Table MyDirectory -Where "FilePath = /documents/doc.txt" | Remove-SFTP

データの挿入と更新

データの挿入や更新を使って、加工やクレンジングも行えます。以下の手順では、CSV ファイルのデータを読み込んで挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータを更新、存在しない場合にはデータの挿入を行います。

Import-Csv -Path C:\MyMyDirectoryUpdates.csv | %{
  $record = Select-SFTP -Connection $SFTP -Table MyDirectory -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-SFTP -Connection $sftp -Table MyDirectory -Columns ("Filesize","Filename") -Values ($_.Filesize, $_.Filename) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-SFTP -Connection $sftp -Table MyDirectory -Columns ("Filesize","Filename") -Values ($_.Filesize, $_.Filename)
  }
}

おわりに

このように、CData Cmdlets を使えばPowerShell でのSFTP データへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。