How to pipe HubDB Data to CSV in PowerShell

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

Creating a Connection to Your HubDB Data

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.

$conn = Connect-HubDB  -AuthScheme "$AuthScheme" -OAuthClientID "$OAuthClientID" -OAuthClientSecret "$OAuthClientSecret" -CallbackURL "$CallbackURL"

Selecting Data

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

Select-HubDB -Connection $conn -Table NorthwindProducts | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myNorthwindProductsData.csv -NoTypeInformation

You will notice that we piped the results from Select-HubDB 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.

Deleting Data

The following line deletes any records that match the criteria:

Select-HubDB -Connection $conn -Table NorthwindProducts -Where "Id = 1" | Remove-HubDB

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 HubDB, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyNorthwindProductsUpdates.csv | %{
  $record = Select-HubDB -Connection $HubDB -Table NorthwindProducts -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-HubDB -Connection $hubdb -Table NorthwindProducts -Columns ("PartitionKey","Name") -Values ($_.PartitionKey, $_.Name) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-HubDB -Connection $hubdb -Table NorthwindProducts -Columns ("PartitionKey","Name") -Values ($_.PartitionKey, $_.Name)
  }
}

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!