PowerShell からユビレジ のデータに接続してデータの取得・CSV エクスポートを実行する方法

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

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

ユビレジ への接続を設定

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

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

    Import-Module APICmdlets;

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

    $conn = Connect-Ubiregi  -Profile "$Profile" -ProfileSettings "$ProfileSettings" -MenuId "$MenuId" -' "$'"

Ubiregi に接続するには、Ubiregi API トークンとMenuId が必要です。API トークンはUbiregi のシステム統合ページで生成できます。生成したトークンは、ProfileSettings API Key 接続プロパティに設定してください。また、自身のUbiregi メニューページのURL「https://ubiregi.com/a/setting/menus/{MenuId}」でMenuId を確認できます（こちらの例の{MenuId} の箇所）。

次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。

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

ユビレジ のデータを取得してCSV にパイプライン

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

Select-API -Connection $conn -Table Customers | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCustomersData.csv -NoTypeInformation

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

おわりに

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