接続の確立

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

インストールおよび接続

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

Install-Module CockroachDBCmdlets

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

Import-Module CockroachDBCmdlets;

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

$conn = Connect-CockroachDB -User 'root' -Password 'root' -Server 'localhost' -Port '26257' -Database 'system'

CockroachDB への接続

データに接続するには以下を設定します。

Server：サーバーのホスト名またはIP アドレス。
Port：CockroachDB サーバーのポート番号。指定されない場合、デフォルトのポートは26257 です。
Database：Cockroach データベースの名前。指定されない場合は、本製品はユーザーのデフォルトデータベースに接続されます。
User：認証に使用されるCockroach DB ユーザーアカウント。
Password：ユーザーの認証で使用されるパスワード。

データの取得

接続の作成が完了したら、リレーショナルデータベースに対して通常行える操作を別のcmdlet を使って実行できます。 Select-CockroachDB cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。

$results = Select-CockroachDB -Connection $conn -Table ""defaultdb"."public".Orders" -Columns @("ShipName, ShipCity") -Where "ShipCountry='USA'"

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

cmdlet 出力のパイプ処理

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

Select-CockroachDB -Connection $conn -Table "defaultdb"."public".Orders -Where "ShipCountry = 'USA'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\my"defaultdb"."public".OrdersData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-CockroachDB -User 'root' -Password 'root' -Server 'localhost' -Port '26257' -Database 'system'
PS C:\> $row = Select-CockroachDB -Connection $conn -Table ""defaultdb"."public".Orders" -Columns (ShipName, ShipCity) -Where "ShipCountry = 'USA'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  ""defaultdb"."public".Orders",
  "Columns":  [

  ],
  "ShipName":  "MyShipName",
  "ShipCity":  "MyShipCity"
}

データの削除

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

Select-CockroachDB -Connection $conn -Table "defaultdb"."public".Orders -Where "ShipCountry = 'USA'" | Remove-CockroachDB

データの変更

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

Import-Csv -Path C:\My"defaultdb"."public".OrdersUpdates.csv | %{
  $record = Select-CockroachDB -Connection $conn -Table "defaultdb"."public".Orders -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-CockroachDB -Connection $conn -Table "defaultdb"."public".Orders -Columns @("ShipName","ShipCity") -Values @($_.ShipName, $_.ShipCity) -Where "Id  = `'$_.Id`'"
  }else{
    Add-CockroachDB -Connection $conn -Table "defaultdb"."public".Orders -Columns @("ShipName","ShipCity") -Values @($_.ShipName, $_.ShipCity)
  }
}