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

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

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

OData への接続を設定

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

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

    Import-Module ODataCmdlets;

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

    $conn = Connect-OData  -URL "$URL" -UseIdUrl "$UseIdUrl" -OData Version "$OData Version" -Data Format "$Data Format"

OData への接続

OData に接続するには、Url を有効なOData サービスルートURI に設定する必要があります。 OData サービスにルートドキュメントがない場合、テーブルとして公開したい特定のエンティティをFeedURL に指定してください。

OData への認証

OData は、以下を経由する認証をサポートします。

• HTTP
• Kerberos
• SharePoint Online
• OAuth
• Azure AD

HTTP 認証スキーム

HTTP で認証する場合は、次の表に従ってAuthScheme を設定します。

その他の認証方法の詳細は、ヘルプドキュメントの「接続の確立」セクションを参照してください。

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

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

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

Select-OData -Connection $conn -Table Orders | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myOrdersData.csv -NoTypeInformation

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

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

データの削除

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

Select-OData -Connection $conn -Table Orders -Where "ShipCity = New York" | Remove-OData

データの挿入と更新

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

Import-Csv -Path C:\MyOrdersUpdates.csv | %{
  $record = Select-OData -Connection $OData -Table Orders -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-OData -Connection $odata -Table Orders -Columns ("OrderName","Freight") -Values ($_.OrderName, $_.Freight) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-OData -Connection $odata -Table Orders -Columns ("OrderName","Freight") -Values ($_.OrderName, $_.Freight)
  }
}

おわりに

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