製品をチェック

製品の情報と30日間無償トライアル

REST 連携ソリューション 相談したい

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

CData PowerShell Cmdlets を使って、REST データに接続、データの取得・更新・挿入・削除・CSV エクスポートを実行する方法を紹介します。

加藤龍彦
ウェブデベロッパー

最終更新日:2023-09-26
rest ロゴ

CData

powershell ロゴ画像
PowerShell ロゴ

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

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

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

REST への接続を設定

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

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

    Import-Module RESTCmdlets;

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

    $conn = Connect-REST  -DataModel "$DataModel" -URI "$URI" -Format "$Format"

データソースへの認証については、データプロバイダーのヘルプドキュメントの「はじめに」を参照してください: データプロバイダーはREST API を双方向データベーステーブルとして、XML/JSON ファイル(ローカルファイル、一般的なクラウドサービスに保存されているファイル、FTP サーバー)を読み取り専用のビューとしてモデル化します。HTTP Basic、Digest、NTLM、OAuth、FTP などの主要な認証スキームがサポートされています。認証についての詳細は、ヘルプドキュメントの「はじめに」を参照してください。

URI を設定し、認証値を指定したら、Format を"XML" または"JSON" に設定して、データ表現をデータ構造により厳密に一致させるようにDataModel を設定します。

DataModel プロパティは、データをどのようにテーブルに表現するかを制御するプロパティで、以下の基本的な設定を切り替えます。

  • Document (デフォルト):REST データのトップレベルのドキュメントビューをモデル化します。データプロバイダーはネストされたエレメントをデータの集計として返します。
  • FlattenedDocuments:ネストされたドキュメントとその親を単一テーブルとして暗黙的に結合します。
  • Relational:階層データから個々の関連テーブルを返します。テーブルには、親ドキュメントにリンクする主キーと外部キーが含まれます。

リレーショナル表現の構成について詳しくは、「REST データのモデル化」を参照してください。次の例で使用されているサンプルデータもあります。データには、人、所有している車、およびそれらの車で行われたさまざまなメンテナンスサービスのエントリが含まれています。The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

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

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

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

Select-REST -Connection $conn -Table people | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\mypeopleData.csv -NoTypeInformation

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

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

データの削除

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

Select-REST -Connection $conn -Table people -Where "[ personal.name.last ] = Roberts" | Remove-REST

データの挿入と更新

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

Import-Csv -Path C:\MypeopleUpdates.csv | %{
  $record = Select-REST -Connection $REST -Table people -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-REST -Connection $rest -Table people -Columns ("[ personal.name.first ]","[ personal.name.last ]") -Values ($_.[ personal.name.first ], $_.[ personal.name.last ]) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-REST -Connection $rest -Table people -Columns ("[ personal.name.first ]","[ personal.name.last ]") -Values ($_.[ personal.name.first ], $_.[ personal.name.last ])
  }
}

おわりに

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

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。