接続の確立

CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でCloudant Cmdlets を使用する例を示します。

インストールおよび接続

PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。

Install-Module CloudantCmdlets

プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。

Import-Module CloudantCmdlets;

Connect-Cloudant cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。

$conn = Connect-Cloudant -User 'abc123' -Password 'abcdef'

Authenticating to Cloudant

There are two authentication methods available for connecting to Cloudant: IBM Cloudant Legacy and IBM Cloud IAM.

IBM Cloudant Legacy

Set the User and Password to your service credentials.

To create an IBM Cloudant service credential:

In the IBM Cloud dashboard, go to the Menu icon > Resource List, and open your IBM Cloudant service instance.
In the menu, click Service credentials.
Click New credential and enter a name for the new credential in the Add new credential window.
Click Add. This adds your credentials to the Service credentials table.
Click Actions > View credentials and extract the User and Password from the JSON file.

Local Instances

We support Local instances from version 1.1.0 and above.

To authenticate to your local instance:

Url: Set to the Url of your local instance. For example: http://localhost:8006
User: Set to your Username.
Password: Set to your Password.

データの取得

Select-Cloudant cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。

$results = Select-Cloudant -Connection $conn -Table "Movies" -Columns @("MovieRuntime, MovieRating") -Where "MovieRating='R'"

Invoke-Cloudant cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。

Select-Cloudant -Connection $conn -Table Movies -Where "MovieRating = 'R'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myMoviesData.csv -NoTypeInformation

Select-Cloudant からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。

 
PS C:\> $conn  = Connect-Cloudant -User 'abc123' -Password 'abcdef'
PS C:\> $row = Select-Cloudant -Connection $conn -Table "Movies" -Columns (MovieRuntime, MovieRating) -Where "MovieRating = 'R'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Movies",
  "Columns":  [

  ],
  "MovieRuntime":  "MyMovieRuntime",
  "MovieRating":  "MyMovieRating"
}

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。

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

データの変更

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをCloudant にロードします。

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

Cmdlets for Cloudant