PowerShell Scripting to Replicate Lakebase Data to MySQL

The CData Cmdlets for Lakebase offer live access to Lakebase data from within PowerShell. Using PowerShell scripts, you can easily automate regular tasks like data replication. This article will walk through using the CData Cmdlets for Lakebase and the CData Cmdlets for MySQL in PowerShell to replicate Lakebase data to a MySQL database.

After obtaining the needed connection properties, accessing Lakebase data in PowerShell and preparing for replication consists of four basic steps.

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.

Collecting Lakebase Data

1. Install the module:

   Install-Module LakebaseCmdlets

2. Connect to Lakebase:

     $lakebase = Connect-Lakebase  -DatabricksInstance $DatabricksInstance -Server $Server -Port $Port -Database $Database -InitiateOAuth $InitiateOAuth
     

3. Retrieve the data from a specific resource:

     $data = Select-Lakebase -Connection $lakebase -Table "Orders"
     

   You can also use the Invoke-Lakebase cmdlet to execute pure SQL-92 statements:

     $data = Invoke-Lakebase -Connection $lakebase -Query 'SELECT * FROM Orders WHERE ShipCountry = @ShipCountry' -Params @{'@ShipCountry'='USA'}
     

4. Save a list of the column names from the returned data.

     $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name
     

Inserting Lakebase Data into the MySQL Database

With the data and column names collected, you are ready to replicate the data into a MySQL database.

1. Install the module:

   Install-Module MySQLCmdlets

2. Connect to MySQL, using the server address and port of the MySQL server, valid user credentials, and a specific database with the table in which the data will be replicated:

     $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
     

3. Loop through the Lakebase data, store the values, and use the Add-MySQL cmdlet to insert the data into the MySQL database, one row at a time. In this example, the table will need to have the same name as the Lakebase resource (Orders) and to exist in the database.

     $data | % {
       $row = $_
       $values = @()
       $columns | % {
         $col = $_
         $values += $row.$($col)
       }
       Add-MySQL -Connection $mysql -Table "Orders" -Columns $columns -Values $values
     }
     

You have now replicated your Lakebase data to a MySQL database. This gives you freedom to work with Lakebase data in the same way that you work with other MySQL tables, whether that is performing analytics, building reports, or other business functions.

Notes

• Once you have connected to Lakebase and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

    Select-Lakebase -Connection $lakebase -Table "Orders" | % {
      $row = $_
      $values = @()
      $columns | % {
        $col = $_
        $values += $row.$($col)
      }
      Add-MySQL -Connection $mysql -Table "Orders" -Columns $columns -Values $values
    }
    

• If you wish to replicate the Lakebase data to another database using another PowerShell module, you will want to exclude the Columns, Connection, and Table columns from the data returned by the Select-Lakebase cmdlet since those columns are used to help pipe data from one CData cmdlet to another:

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}