PowerShell からPostgreSQL のデータに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法

CData Cmdlets for PostgreSQL を使えば、PowerShell からPostgreSQL に手軽に連携して、データのCRUD やエクスポートを実行できます。

本記事では、PostgreSQL への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。

PostgreSQL への接続を設定

それでは、まずはPostgreSQL への接続設定からはじめていきましょう。接続設定にはCData PostgreSQL Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。

インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。

    Import-Module PostgreSQLCmdlets;

Connect-PostgreSQL コマンドを使ってPostgreSQL との接続を設定します。各接続プロパティの取得方法は次に説明します。

    $conn = Connect-PostgreSQL  -User "$User" -Password "$Password" -Database "$Database" -Server "$Server" -Port "$Port"

PostgreSQL への接続には、Server、Port（デフォルトは5432）、Database、およびUser、Password のプロパティを設定します。Database プロパティが設定されない場合には、User のデフォルトデータベースに接続します。

パスワード方式によるSSH 接続

パスワード方式によるSSH接続時に必要なプロパティ一覧を以下に示します。

• User: PostgreSQL のユーザ
• Password: PostgreSQL のパスワード
• Database: PostgreSQL の接続先データベース
• Server: PostgreSQL のサーバー
• Port: PostgreSQL のポート
• UserSSH: "true"
• SSHAuthMode: "Password"
• SSHPort: SSH のポート
• SSHServer: SSH サーバー
• SSHUser: SSH ユーザー
• SSHPassword: SSH パスワード

接続文字列形式では以下のようになります。

User=admin;Password=adminpassword;Database=test;Server=postgresql-server;Port=5432;UseSSH=true;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHPassword=sshpasswd;

公開鍵認証方式によるSSH 接続

公開鍵認証によるSSH接続時に必要なプロパティ一覧を以下に示します。

• User: PostgreSQL のユーザ
• Password: PostgreSQL のパスワード
• Database: PostgreSQL の接続先データベース
• Server: PostgreSQL のサーバー
• Port: PostgreSQL のポート
• UserSSH: "true"
• SSHAuthMode: "Public_Key"
• SSHClientCertType: キーストアの種類
• SSHPort: SSH のポート
• SSHServer: SSH サーバー
• SSHUser: SSH ユーザー
• SSHClientCert: 秘密鍵ファイルのパス

接続文字列形式では以下のようになります。

User=admin;Password=adminpassword;Database=test;Server=PostgreSQL-server;Port=5432;UseSSH=true;SSHClientCertType=PEMKEY_FILE;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHClientCert=C:\Keys\key.pem;

これで接続設定は完了です。

PostgreSQL のデータを取得してCSV にパイプライン

接続が完了したので、Orders テーブルデータを取得して結果をCSV ファイルにエクスポートします。

Select-PostgreSQL -Connection $conn -Table Orders | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myOrdersData.csv -NoTypeInformation

このコードでは、Select-PostgreSQL から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。

それでは、続いてデータの削除や挿入・更新を実行してみます。

データの削除

以下のように、フィルタリングで合致するレコードを削除することができます。

Select-PostgreSQL -Connection $conn -Table Orders -Where "ShipCountry = USA" | Remove-PostgreSQL

データの挿入と更新

データの挿入や更新を使って、加工やクレンジングも行えます。以下の手順では、CSV ファイルのデータを読み込んで挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータを更新、存在しない場合にはデータの挿入を行います。

Import-Csv -Path C:\MyOrdersUpdates.csv | %{
  $record = Select-PostgreSQL -Connection $PostgreSQL -Table Orders -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-PostgreSQL -Connection $postgresql -Table Orders -Columns ("ShipName","ShipCity") -Values ($_.ShipName, $_.ShipCity) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-PostgreSQL -Connection $postgresql -Table Orders -Columns ("ShipName","ShipCity") -Values ($_.ShipName, $_.ShipCity)
  }
}

おわりに

このように、CData Cmdlets を使えばPowerShell でのPostgreSQL のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。