接続の確立

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

インストールおよび接続

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

Install-Module IBMCloudObjectStorageCmdlets

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

Import-Module IBMCloudObjectStorageCmdlets;

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

$conn = Connect-IBMCloudObjectStorage -ApiKey "MyAPIKey" -CloudObjectStorageCRN "myInstanceCRN" -Region "myRegion" -OAuthClientId "myOAuthClientId" -OAuthClientSecret "myOAuthClientSecret"

接続の前に

IBM Cloud Object Storage に接続する前に、IBM Cloud Object Storage インスタンスを登録し、IBM Cloud Object Storage API キーとCRN を控えておく必要があります。

Cloud Object Storage の新規インスタンスの登録

IBM Cloud アカウントにCloud Object Storage がまだない場合は、以下の手順に従ってアカウントにSQL Query のインスタンスをインストールできます。

IBM Cloud アカウントにログインします。
Cloud Object Storage ページに移動し、インスタンス名を指定して［作成］をクリックします。作成したばかりのCloud Object Storage のインスタンスにリダイレクトされます。

API キー

ApiKey は次のようにして取得できます。

IBM Cloud アカウントにログインします。
Platform API Keys ページに移動します。
中央右隅のCreate an IBM Cloud API Key をクリックして、新しいAPI キーを作成します。
ポップアップウィンドウが表示されたら、API キー名を指定して作成をクリックします。ダッシュボードからは再びアクセスできなくなるため、API Key を控えておきます。

Cloud Object Storage CRN

デフォルトでは、本製品はCloud Object Storage CRN を自動的に決定しようとします。ただし、複数のアカウントがある場合は、CloudObjectStorageCRN を明示的に指定する必要があります。この値は、次の2つの方法で取得できます。

Services ビューをクエリする。これにより、IBM Cloud Object Storage インスタンスとそれぞれのCRN がリストされます。
IBM Cloud で直接CRN を見つける。これを行うには、IBM Cloud Dashboard に移動します。リソースリストで、ストレージからCloud Object Storage リソースを選択してCRN を取得します。

IBM Cloud Object Storage への接続

これで、データに接続するために以下を設定できます。

ApiKey：セットアップ中にメモしたAPI キーに設定。
CloudObjectStorageCRN（オプション）：メモしたクラウドオブジェクトストレージのCRN に設定。本製品はこれを自動的に取得しようとしますが、Cloud Object Storage アカウントが複数ある場合は、これを明示的に指定することをお勧めします。

接続すると、本製品がOAuth プロセスを完了します。

データの取得

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

$results = Select-IBMCloudObjectStorage -Connection $conn -Table "Objects" -Columns @("Key, Etag") -Where "Bucket='testBucket'"

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

cmdlet 出力のパイプ処理

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

Select-IBMCloudObjectStorage -Connection $conn -Table Objects -Where "Bucket = 'testBucket'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myObjectsData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-IBMCloudObjectStorage -ApiKey "MyAPIKey" -CloudObjectStorageCRN "myInstanceCRN" -Region "myRegion" -OAuthClientId "myOAuthClientId" -OAuthClientSecret "myOAuthClientSecret"
PS C:\> $row = Select-IBMCloudObjectStorage -Connection $conn -Table "Objects" -Columns (Key, Etag) -Where "Bucket = 'testBucket'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Objects",
  "Columns":  [

  ],
  "Key":  "MyKey",
  "Etag":  "MyEtag"
}

データの変更

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

Import-Csv -Path C:\MyObjectsUpdates.csv | %{
  $record = Select-IBMCloudObjectStorage -Connection $conn -Table Objects -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-IBMCloudObjectStorage -Connection $conn -Table Objects -Columns @("Key","Etag") -Values @($_.Key, $_.Etag) -Where "Id  = `'$_.Id`'"
  }else{
    Add-IBMCloudObjectStorage -Connection $conn -Table Objects -Columns @("Key","Etag") -Values @($_.Key, $_.Etag)
  }
}

Cmdlets for IBM Cloud Object Storage