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

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

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

Kintone への接続を設定

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

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

    Import-Module KintoneCmdlets;

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

    $conn = Connect-Kintone  -User "$User" -Password "$Password" -URL "$URL"

Kintone 接続プロパティの設定方法

それでは、Kintone に接続していきましょう。接続するには、以下の接続プロパティを設定します。

• URL：Kintone のアクセスURL（例：https://yoursitename.cybozu.com または https://yoursitename.kintone.com）
• User：アカウントのユーザー名
• Password：アカウントのパスワード
• AuthScheme：「Password」を指定

パスワード認証の代わりにAPI トークン認証をご利用になる場合は、ヘルプドキュメントの「接続の設定」セクションをご確認ください。

Basic 認証の設定

続いて、ご利用のKintone ドメインでBasic 認証を有効にしている場合は、接続プロパティの「詳細」設定で以下の項目を追加設定してください。

• BasicAuthUser：Basic 認証のユーザー名
• BasicAuthPassword：Basic 認証のパスワード

クライアント証明書認証の設定

Basic 認証の代わりにクライアント証明書による認証をご利用になる場合は、以下の項目を設定してください。

• SSLClientCert：クライアント証明書のパス
• SSLClientCertType：証明書の種類
• SSLClientCertSubject：証明書のサブジェクト
• SSLClientCertPassword：証明書のパスワード

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

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

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

Select-Kintone -Connection $conn -Table Apps | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myAppsData.csv -NoTypeInformation

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

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

データの削除

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

Select-Kintone -Connection $conn -Table Apps -Where "AppId = 1354841" | Remove-Kintone

データの挿入と更新

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

Import-Csv -Path C:\MyAppsUpdates.csv | %{
  $record = Select-Kintone -Connection $Kintone -Table Apps -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Kintone -Connection $kintone -Table Apps -Columns ("Name","Description") -Values ($_.Name, $_.Description) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Kintone -Connection $kintone -Table Apps -Columns ("Name","Description") -Values ($_.Name, $_.Description)
  }
}

おわりに

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