接続の確立

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

インストールおよび接続

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

Install-Module SansanCmdlets

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

Import-Module SansanCmdlets;

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

$conn = Connect-Sansan

Sansan への接続

CData Cmdlets PowerShell Module for Sansan を使用してSansan に接続する場合は、APIKey が必要です。

Sansan へのアクセスの設定

APIKey を取得するには、以下の手順に従ってください。

Sansan 管理画面 [https://ap.sansan.com/v/home/] にログインして、［外部サービス連携］メニューの［API］に移動します。
［部署を選択してください］のプルダウンから、対象の部署を選択します。
［ユーザーを選択してください］のプルダウンから、対象のユーザーを選択します。
［発行］ボタンをクリックして、API キーを生成します。

Sansan アカウントの認証

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

APIKey：API キーを設定。Sansan 管理画面から取得したAPI Key です。

データの取得

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

$results = Select-Sansan -Connection $conn -Table "Bizcards" -Columns @("BizcardId, Email") -Where "BizcardId='00E683BEE2DFC04399B3CC8DA5591A24'"

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

cmdlet 出力のパイプ処理

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

Select-Sansan -Connection $conn -Table Bizcards -Where "BizcardId = '00E683BEE2DFC04399B3CC8DA5591A24'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myBizcardsData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-Sansan
PS C:\> $row = Select-Sansan -Connection $conn -Table "Bizcards" -Columns (BizcardId, Email) -Where "BizcardId = '00E683BEE2DFC04399B3CC8DA5591A24'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Bizcards",
  "Columns":  [

  ],
  "BizcardId":  "MyBizcardId",
  "Email":  "MyEmail"
}

データの変更

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

Import-Csv -Path C:\MyBizcardsUpdates.csv | %{
  $record = Select-Sansan -Connection $conn -Table Bizcards -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Sansan -Connection $conn -Table Bizcards -Columns @("BizcardId","Email") -Values @($_.BizcardId, $_.Email) -Where "Id  = `'$_.Id`'"
  }else{
    Add-Sansan -Connection $conn -Table Bizcards -Columns @("BizcardId","Email") -Values @($_.BizcardId, $_.Email)
  }
}

Cmdlets for Sansan