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

インストールおよび接続

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

Install-Module SmaregiCmdlets

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

Import-Module SmaregiCmdlets;

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

$conn = Connect-Smaregi

スマレジへの接続

スマレジドライバーには、ContractId およびAccessToken パラメータが必要です。
スマレジにログイン後、［設定］->［システム連携］->［スマレジAPI 設定］に移動します。
［API受信設定］セクションにある［受信機能を利用する］を［利用する］に変更し、［アクセストークンの生成］をクリックし、AccessToken を取得します。
次に必要なAPI アクセスを有効にするため、［機能設定］セクションで必要な機能を［利用する］に変更します。

ContractId： アカウントの契約ID。これは受信設定セクションでも確認できます。
AccessToken： 受信設定セクションのアクセストークン。

データの取得

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

$results = Select-Smaregi -Connection $conn -Table "Products" -Columns @("ProductName, Description") -Where "ProductId='666666'"

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

cmdlet 出力のパイプ処理

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

Select-Smaregi -Connection $conn -Table Products -Where "ProductId = '666666'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myProductsData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-Smaregi
PS C:\> $row = Select-Smaregi -Connection $conn -Table "Products" -Columns (ProductName, Description) -Where "ProductId = '666666'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Products",
  "Columns":  [

  ],
  "ProductName":  "MyProductName",
  "Description":  "MyDescription"
} 

データの削除

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

Select-Smaregi -Connection $conn -Table Products -Where "ProductId = '666666'" | Remove-Smaregi

データの変更

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

Import-Csv -Path C:\MyProductsUpdates.csv | %{
  $record = Select-Smaregi -Connection $conn -Table Products -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Smaregi -Connection $conn -Table Products -Columns @("ProductName","Description") -Values @($_.ProductName, $_.Description) -Where "Id  = `'$_.Id`'"
  }else{
    Add-Smaregi -Connection $conn -Table Products -Columns @("ProductName","Description") -Values @($_.ProductName, $_.Description)
  }
}