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

インストールおよび接続

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

Install-Module TSheetsCmdlets

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

Import-Module TSheetsCmdlets;

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

$conn = Connect-TSheets -OAuthClientId "MyOAuthClientId" -OAuthClientSecret "MyClientSecret" -CallbackURL "MyCallbackURL"

TSheets への接続

TSheets は、認証および認可にOAuth2 標準を使用します。独自のOAuth アプリを構築してデータに接続するには、OAuth 認証の使用 を参照してください。

データの取得

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

$results = Select-TSheets -Connection $conn -Table "Timesheets" -Columns @("Id, JobcodeId") -Where "JobCodeType='regular'"

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

cmdlet 出力のパイプ処理

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

Select-TSheets -Connection $conn -Table Timesheets -Where "JobCodeType = 'regular'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myTimesheetsData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-TSheets -OAuthClientId "MyOAuthClientId" -OAuthClientSecret "MyClientSecret" -CallbackURL "MyCallbackURL"
PS C:\> $row = Select-TSheets -Connection $conn -Table "Timesheets" -Columns (Id, JobcodeId) -Where "JobCodeType = 'regular'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Timesheets",
  "Columns":  [

  ],
  "Id":  "MyId",
  "JobcodeId":  "MyJobcodeId"
} 

データの削除

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

Select-TSheets -Connection $conn -Table Timesheets -Where "JobCodeType = 'regular'" | Remove-TSheets

データの変更

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

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