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

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

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

Lakebase への接続を設定

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

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

    Import-Module LakebaseCmdlets;

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

    $conn = Connect-Lakebase  -DatabricksInstance "$DatabricksInstance" -Server "$Server" -Port "$Port" -Database "$Database"

Databricks Lakebase に接続するには、以下のプロパティを設定します。

• DatabricksInstance: Databricks インスタンスまたはサーバーホスト名を指定します。形式は instance-abcdef12-3456-7890-abcd-abcdef123456.database.cloud.databricks.com です。
• Server: Lakebase データベースをホストするサーバーのホスト名または IP アドレスを指定します。
• Port（オプション）: Lakebase データベースをホストするサーバーのポート番号を指定します。デフォルトは 5432 です。
• Database（オプション）: Lakebase サーバーへの認証後に接続するデータベースを指定します。デフォルトでは認証ユーザーのデフォルトデータベースに接続します。

OAuth クライアント認証

OAuth クライアント資格情報を使用して認証するには、サービスプリンシパルで OAuth クライアントを構成します。手順の概要は以下のとおりです。

1. 新しいサービスプリンシパルを作成・構成する
2. サービスプリンシパルに権限を割り当てる
3. サービスプリンシパル用の OAuth シークレットを作成する

詳細については、ヘルプドキュメントの「Setting Up OAuthClient Authentication」セクションをご参照ください。

OAuth PKCE 認証

PKCE（Proof Key for Code Exchange）を使用した OAuth code タイプで認証するには、以下のプロパティを設定します。

• AuthScheme: OAuthPKCE を指定します。
• User: 認証ユーザーのユーザー ID を指定します。

詳細については、ヘルプドキュメントをご参照ください。

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

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

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

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

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

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

データの削除

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

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

データの挿入と更新

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

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

おわりに

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