Cmdlets for HubDB

Build 24.0.8963

接続の確立

CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でHubDB Cmdlets を使用する例を示します。

インストールおよび接続

PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。 

Install-Module HubDBCmdlets

プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。 

Import-Module HubDBCmdlets;

Connect-HubDB cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。 

$conn = Connect-HubDB -AuthScheme "OAuth" -OAuthClientID "MyOAuthClientID" -OAuthClientSecret "MyOAuthClientSecret" -CallbackURL "http://localhost:33333"

Connecting to HubDB

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.

OAuth

AuthScheme must be set to OAuth in all OAuth flows. The following OAuth flows assume you have done so.

Desktop Applications

You must create a custom OAuth application to connect. See Creating a Custom OAuth App a procedure.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

  • OAuthClientId: Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret: Set this to the client secret assigned when you registered your application.
  • CallbackURL: Set this to the redirect URI defined when you registered your application.
When you connect, the 本製品 opens HubDB's OAuth endpoint in your default browser. Log in and grant permissions to the application. The 本製品 refreshes the access token automatically when it expires.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

  1. Choose one of two options:
    • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
    • Option 2: Install the 本製品 on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
  2. Then configure the 本製品 to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

  1. Set the following properties:
    • InitiateOAuth: Set to OFF.
    • OAuthClientId: Set to the client Id assigned when you registered your application.
    • OAuthClientSecret: Set to the client secret assigned when you registered your application.
  2. Call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
  3. Log in and grant permissions to the 本製品. You are then redirected to the redirect URI. There will be a parameter called code appended to the redirect URI. Note the value of this parameter. Later you will set this in the OAuthVerifier connection property.
Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens.

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthVerifier: Set this to the noted verifier code (the value of the code parameter in the redirect URI).
  • OAuthClientId: Set this to the client Id in your OAuth application settings.
  • OAuthClientSecret: Set this to the client secret in the OAuth application settings.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.

Test the connection to generate the OAuth settings file, then re-set the following properties to connect:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret: Set this to the client secret assigned when you registered your application.
  • OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the 本製品 to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret: Set this to the client secret assigned when you registered your application.
  • OAuthSettingsLocation: Set this to the location of the OAuth settings file you copied from the machine with the browser. Make sure this location gives read and write permissions to the 本製品 to enable the automatic refreshing of the access token.

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.
    • A minimum of hubdb and crm.objects.owners.read is required to access tables.
  6. After you are done configuring your application, click Create app in the top right.
  7. Review the info about your application's access token, click Continue creating, and then Show token.
  8. Click Copy to copy the private application token.

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

データの取得

Select-HubDB cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。 

$results = Select-HubDB -Connection $conn -Table "NorthwindProducts" -Columns @("PartitionKey, Name") -Where "Industry='Floppy Disks'"
Invoke-HubDB cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。 

Select-HubDB -Connection $conn -Table NorthwindProducts -Where "Industry = 'Floppy Disks'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myNorthwindProductsData.csv -NoTypeInformation

Select-HubDB からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。 

 
PS C:\> $conn  = Connect-HubDB -AuthScheme "OAuth" -OAuthClientID "MyOAuthClientID" -OAuthClientSecret "MyOAuthClientSecret" -CallbackURL "http://localhost:33333"
PS C:\> $row = Select-HubDB -Connection $conn -Table "NorthwindProducts" -Columns (PartitionKey, Name) -Where "Industry = 'Floppy Disks'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "NorthwindProducts",
  "Columns":  [

  ],
  "PartitionKey":  "MyPartitionKey",
  "Name":  "MyName"
}

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。 

Select-HubDB -Connection $conn -Table NorthwindProducts -Where "Industry = 'Floppy Disks'" | Remove-HubDB

データの変更

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをHubDB にロードします。 

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

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.8963