PowerShell Scripting to Replicate HubDB Data to MySQL

The CData Cmdlets for HubDB offer live access to HubDB 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 HubDB and the CData Cmdlets for MySQL in PowerShell to replicate HubDB data to a MySQL database.

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

There are two authentication methods available for connecting to HubDB data source: OAuth Authentication with a public HubSpot application and authentication with a Private application token.

Using a Custom OAuth App

AuthScheme must be set to "OAuth" in all OAuth flows. Be sure to review the Help documentation for the required connection properties for you specific authentication needs (desktop applications, web applications, and headless machines).

Follow the steps below to register an application and obtain the OAuth client credentials:

1. Log into your HubSpot app developer account.
   • Note that it must be an app developer account. Standard HubSpot accounts cannot create public apps.
2. On the developer account home page, click the Apps tab.
3. Click Create app.
4. On the App info tab, enter and optionally modify values that are displayed to users when they connect. These values include the public application name, application logo, and a description of the application.
5. On the Auth tab, supply a callback URL in the "Redirect URLs" box.
   • If you're creating a desktop application, set this to a locally accessible URL like http://localhost:33333.
   • If you are creating a Web application, set this to a trusted URL where you want users to be redirected to when they authorize your application.
6. Click Create App. HubSpot then generates the application, along with its associated credentials.
7. On the Auth tab, note the Client ID and Client secret. You will use these later to configure the driver.

8. Under Scopes, select any scopes you need for your application's intended functionality.

   A minimum of the following scopes is required to access tables:

   • hubdb
   • oauth
   • crm.objects.owners.read
9. Click Save changes.
10. Install the application into a production portal with access to the features that are required by the integration.
    • Under "Install URL (OAuth)", click Copy full URL to copy the installation URL for your application.
    • Navigate to the copied link in your browser. Select a standard account in which to install the application.
    • Click Connect app. You can close the resulting tab.

Using a Private App

To connect using a HubSpot private application token, set the AuthScheme property to "PrivateApp."

You can generate a private application token by following the steps below:

1. In your HubDB account, click the settings icon (the gear) in the main navigation bar.
2. In the left sidebar menu, navigate to Integrations > Private Apps.
3. Click Create private app.
4. On the Basic Info tab, configure the details of your application (name, logo, and description).
5. On the Scopes tab, select Read or Write for each scope you want your private application to be able to access.
6. A minimum of hubdb and crm.objects.owners.read is required to access tables.
7. After you are done configuring your application, click Create app in the top right.
8. Review the info about your application's access token, click Continue creating, and then Show token.
9. Click Copy to copy the private application token.

To connect, set PrivateAppToken to the private application token you retrieved.

Collecting HubDB Data

1. Install the module:

   Install-Module HubDBCmdlets

2. Connect to HubDB:

    $hubdb = Connect-HubDB -AuthScheme $AuthScheme -OAuthClientID $OAuthClientID -OAuthClientSecret $OAuthClientSecret -CallbackURL $CallbackURL -InitiateOAuth $InitiateOAuth
    

3. Retrieve the data from a specific resource:

    $data = Select-HubDB -Connection $hubdb -Table "NorthwindProducts"
    

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

    $data = Invoke-HubDB -Connection $hubdb -Query 'SELECT * FROM NorthwindProducts WHERE Id = @Id' -Params @{'@Id'='1'}
    

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

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

Inserting HubDB 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 HubDB 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 HubDB resource (NorthwindProducts) and to exist in the database.

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

You have now replicated your HubDB data to a MySQL database. This gives you freedom to work with HubDB 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 HubDB and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

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

• If you wish to replicate the HubDB 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-HubDB 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')}