接続の確立

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

QuickBooks への接続

本製品はQuickBooks Gateway 経由でQuickBooks にリクエストを作成します。QuickBooks Gateway はQuickBooks と同じマシン上で動作し、軽量の組み込みWeb サーバーを介して接続を受け入れます。サーバーはSSL/TLS をサポートし、ユーザーにリモートマシンからのセキュアな接続を可能にします。初めて接続するときは、本製品をQuickBooks で認証する必要があります。詳しくは、Using the QuickBooks Gateway ガイドを参照してください。

接続オブジェクトの作成

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

$conn = Connect-QB

データの取得

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

$results = Select-QB -Connection $conn -Table "Customers" -Columns @("Id, Name") -Where "Name='Cook, Brian'"

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

cmdlet 出力のパイプ処理

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

Select-QB -Connection $conn -Table Customers -Where "Name = 'Cook, Brian'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCustomersData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-QB
PS C:\> $row = Select-QB -Connection $conn -Table "Customers" -Columns (Id, Name) -Where "Name = 'Cook, Brian'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Customers",
  "Columns":  [

  ],
  "Id":  "MyId",
  "Name":  "MyName"
}

データの削除

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

Select-QB -Connection $conn -Table Customers -Where "Name = 'Cook, Brian'" | Remove-QB

データの変更

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

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