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

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

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

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

BASE への接続を設定

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

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

    Import-Module APICmdlets;

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

    $conn = Connect-BASE  -Profile "$Profile" -Authscheme "$Authscheme" -InitiateOAuth "$InitiateOAuth" -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackUrl "$CallbackUrl"

最初に、BASE のOAuth アプリを作成する必要があります。作成するには、https://developers.thebase.in/dashboardにアクセスし、「Create New Application」ボタンをクリックします。アプリ名を入力し、リダイレクトURLを指定して「Register」をクリックします。これで、クライアントIDとクライアントシークレットが表示されます。

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

以下の接続プロパティを設定すると、接続できるようになります。

• AuthScheme: OAuth に設定します。
• OAuthClientID: アプリ設定で指定したOAuth クライアントID を設定します。
• OAuthClientSecret: アプリ設定で指定したOAuth クライアントシークレットを設定します。
• CallbackURL: アプリ設定で指定したリダイレクトURI を設定します。
• InitiateOAuth: GETANDREFRESH に設定します。この設定を使って、OAuthAccessToken を取得するプロセスを管理できます。

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

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

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

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

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

おわりに

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