接続の確立

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

CloudSign への接続

CData Cmdlets PowerShell Module for CloudSign を使用してCloudSign に接続する場合は、RSBCloudSign_p_ClientID を使う必要があります。

CloudSign へのアクセスの設定

本番環境およびサンドボックス環境で、WEB API Client ID にアクセスできます。

本番環境： https://www.cloudsign.jp/api/clients
サンドボックス環境： https://sandbox.cloudsign.jp/api/clients

環境ごとに発行されたすべてのクライアントId が表示されます。新しいクライアントId を発行するには、ページの右上にある赤いボタン新しいクライアントID を発行するをクリックしてください。

CloudSign アカウントの認証

次の接続プロパティを設定して接続します。

RSBCloudSign_p_ClientID：クライアントId に設定。
UseSandbox：サンドボックスにアクセスする場合は、True に設定。

接続オブジェクトの作成

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

$conn = Connect-CloudSign -ClientId "74a27b13-29e9-4ff8-92f6-7e61b8606b7f"

データの取得

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

$results = Select-CloudSign -Connection $conn -Table "Documents" -Columns @("DocumentId, Title") -Where "Status='0'"

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

cmdlet 出力のパイプ処理

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

Select-CloudSign -Connection $conn -Table Documents -Where "Status = '0'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myDocumentsData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-CloudSign -ClientId "74a27b13-29e9-4ff8-92f6-7e61b8606b7f"
PS C:\> $row = Select-CloudSign -Connection $conn -Table "Documents" -Columns (DocumentId, Title) -Where "Status = '0'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Documents",
  "Columns":  [

  ],
  "DocumentId":  "MyDocumentId",
  "Title":  "MyTitle"
}

データの削除

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

Select-CloudSign -Connection $conn -Table Documents -Where "Status = '0'" | Remove-CloudSign

データの変更

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

Import-Csv -Path C:\MyDocumentsUpdates.csv | %{
  $record = Select-CloudSign -Connection $conn -Table Documents -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-CloudSign -Connection $conn -Table Documents -Columns @("DocumentId","Title") -Values @($_.DocumentId, $_.Title) -Where "Id  = `'$_.Id`'"
  }else{
    Add-CloudSign -Connection $conn -Table Documents -Columns @("DocumentId","Title") -Values @($_.DocumentId, $_.Title)
  }
}

Cmdlets for CloudSign