Cmdlets for AlloyDB

Build 23.0.8839

接続の確立

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

インストールおよび接続

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

Install-Module AlloyDBCmdlets

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

Import-Module AlloyDBCmdlets;

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

$conn = Connect-AlloyDB -User 'alloydb' -Password 'admin' -Server '127.0.0.1' -Port '5432' -Database 'alloydb'

AlloyDB への接続

AlloyDB に接続するには、次の接続プロパティが必要です。

  • Server:AlloyDB データベースをホスティングしているサーバーのホスト名またはIP アドレス。
  • Port(オプション):AlloyDB データベースをホスティングしているサーバーのポート。このプロパティはデフォルトで5432に設定されます。
  • User:AlloyDB サーバーに認証する際に使われるユーザー。
  • Password:AlloyDB サーバーに認証する際に使われるパスワード。
  • Database(オプション):AlloyDB サーバーに接続する場合のデータベース。設定されていない場合は、ユーザーのデフォルトデータベースが使用されます。

AlloyDB への認証

標準認証

標準認証(事前に提供されたユーザーとパスワードの組み合わせを使用)は、デフォルトの認証形式です。

標準認証で接続する場合は、これ以上のアクションは必要ありません。

pg_hba.conf 認証スキーム

本製品 がサポートしている他の認証方法では、AlloyDB サーバー上のpg_hba.conf ファイルで有効化する必要があります。

AlloyDB サーバーでの認証の設定については、こちらを参照してください。

MD5

pg_hba.conf ファイルのauth-methodmd5 に設定すると、MD5 パスワード検証を使用して認証できます。

SASL

本製品 は、SASL(特にSCRAM-SHA-256)でパスワードを検証することで認証できます。

この認証方法を使用するには、pg_hba.conf ファイルのauth-methodscram-sha-256 に設定します。

Kerberos

Kerberos 認証は、CData Cmdlets PowerShell Module for AlloyDB が接続を試行している際にAlloyDB サーバーで開始されます。この認証方法を有効化するには、AlloyDB サーバーでKerberos を設定します。AlloyDB サーバーでのKerberos 認証の設定を完了したら、本製品 からKerberos 認証を行う方法についてはKerberos の使用 を参照してください。

データの取得

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

$results = Select-AlloyDB -Connection $conn -Table ""alloydb"."schema01".Orders" -Columns @("ShipName, ShipCity") -Where "ShipCountry='USA'"
Invoke-AlloyDB cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

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

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

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

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

 
PS C:\> $conn  = Connect-AlloyDB -User 'alloydb' -Password 'admin' -Server '127.0.0.1' -Port '5432' -Database 'alloydb'
PS C:\> $row = Select-AlloyDB -Connection $conn -Table ""alloydb"."schema01".Orders" -Columns (ShipName, ShipCity) -Where "ShipCountry = 'USA'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  ""alloydb"."schema01".Orders",
  "Columns":  [

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

データの削除

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

Select-AlloyDB -Connection $conn -Table "alloydb"."schema01".Orders -Where "ShipCountry = 'USA'" | Remove-AlloyDB

データの変更

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

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

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839