How to pipe Lakebase Data to CSV in PowerShell

The CData Cmdlets Module for Lakebase is a standard PowerShell module offering straightforward integration with Lakebase. Below, you will find examples of using our Lakebase Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your Lakebase Data

To connect to Databricks Lakebase, start by setting the following properties:

• DatabricksInstance: The Databricks instance or server hostname, provided in the format instance-abcdef12-3456-7890-abcd-abcdef123456.database.cloud.databricks.com.
• Server: The host name or IP address of the server hosting the Lakebase database.
• Port (optional): The port of the server hosting the Lakebase database, set to 5432 by default.
• Database (optional): The database to connect to after authenticating to the Lakebase Server, set to the authenticating user's default database by default.

OAuth Client Authentication

To authenicate using OAuth client credentials, you need to configure an OAuth client in your service principal. In short, you need to do the following:

1. Create and configure a new service principal
2. Assign permissions to the service principal
3. Create an OAuth secret for the service principal

For more information, refer to the Setting Up OAuthClient Authentication section in the Help documentation.

OAuth PKCE Authentication

To authenticate using the OAuth code type with PKCE (Proof Key for Code Exchange), set the following properties:

• AuthScheme: OAuthPKCE.
• User: The authenticating user's user ID.

For more information, refer to the Help documentation.

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

Selecting Data

Follow the steps below to retrieve data from the Orders table and pipe the result into to a CSV file:

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

You will notice that we piped the results from Select-Lakebase into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.

Deleting Data

The following line deletes any records that match the criteria:

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

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Lakebase, checking first whether a record already exists and needs to be updated instead of inserted.

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)
 }
}

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!