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

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

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

CouchDB への接続を設定

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

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

    Import-Module ApacheCouchDBCmdlets;

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

    $conn = Connect-ApacheCouchDB  -Url "$Url" -User "$User" -Password "$Password"

Apache CouchDB 接続プロパティの取得・設定方法

それでは、Apache CouchDB に接続していきましょう。Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例：http://localhost:5984

ユーザー（またはJWT）が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするためにCData 製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。

Apache CouchDB への認証

続いて、認証方法を設定しましょう。CData 製品では、3種類の認証をサポートしています。

• Basic：基本的なユーザー名 / パスワード認証
• JWT：JWT 認証
• None：パブリックなデータベースへの匿名アクセス

Basic 認証

データに接続するには、以下のプロパティを設定してください。

• AuthScheme：Basic
• User：認証に使用されるApache CouchDB ユーザーアカウント
• Password：認証するユーザーに関連付けられたApache CouchDB パスワード

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

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

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

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

Select-ApacheCouchDB -Connection $conn -Table Movies | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myMoviesData.csv -NoTypeInformation

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

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

データの削除

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

Select-ApacheCouchDB -Connection $conn -Table Movies -Where "MovieRating = R" | Remove-ApacheCouchDB

データの挿入と更新

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

Import-Csv -Path C:\MyMoviesUpdates.csv | %{
  $record = Select-ApacheCouchDB -Connection $ApacheCouchDB -Table Movies -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-ApacheCouchDB -Connection $apachecouchdb -Table Movies -Columns ("MovieRuntime","MovieRating") -Values ($_.MovieRuntime, $_.MovieRating) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-ApacheCouchDB -Connection $apachecouchdb -Table Movies -Columns ("MovieRuntime","MovieRating") -Values ($_.MovieRuntime, $_.MovieRating)
  }
}

おわりに

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