Cmdlets for HubDB

Build 25.0.9434

接続の確立

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

HubDB への接続

HubDB データソースへの接続に使用できる認証方法は2つあります。公開HubSpot アプリケーションによるOAuth 認証と、非公開アプリトークンによる認証です。

OAuth

AuthScheme は、すべてのOAuth フローでOAuth に設定する必要があります。以下のOAuth フローは、すでに設定済みであることを前提として書かれています。

デスクトップアプリケーション

接続するには、カスタムOAuth アプリケーションの作成が必要です。手順については、カスタムOAuth アプリの作成 を参照してください。

OAuth アクセストークンの取得およびリフレッシュ

以下を設定して、接続してください。

  • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  • CallbackURL：アプリケーションの登録時に定義されたリダイレクトURI に設定。
接続すると、本製品 はデフォルトブラウザでHubDB のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。 本製品 はアクセストークンの期限が切れると自動的にリフレッシュします。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

  1. 以下のオプションから選択します。
    • オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
    • オプション2：インターネットブラウザに対応したマシンに本製品 をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。
  2. 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。

オプション1：Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

  1. 次のプロパティを設定します。
    • InitiateOAuth：OFF に設定。
    • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
    • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  2. 適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
  3. ログインして、本製品 にアクセス許可を与えます。すると、リダイレクトURI にリダイレクトされます。リダイレクトURI にはcode というパラメータが付加されます。このパラメータの値を控えておきます。後ほどこれをOAuthVerifier 接続プロパティに設定します。
次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthVerifier：控えておいたverifier code（リダイレクトURI のcode パラメータの値）に設定。
  • OAuthClientId：OAuth アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret：OAuth アプリケーション設定のクライアントシークレットに設定。
  • OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。

接続をテストしてOAuth 設定ファイルを生成し、以下のプロパティを再設定して接続します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  • OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

オプション2：OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  • OAuthSettingsLocation：ブラウザでマシンからコピーしたOAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

非公開アプリ

Hubspot 非公開アプリトークンを使用して接続するには、AuthScheme プロパティをPrivateApp に設定します。

非公開アプリトークンを生成するには次のステップを実行してください。

  1. HubDB アカウントで、メインナビゲーションバーにある設定アイコン（歯車）をクリックします。
  2. 左のサイドバーメニューから、連携 -> 非公開アプリに移動します。
  3. 非公開アプリを作成をクリックします。
  4. 基本情報タブでアプリケーションの詳細（名前、ロゴ、説明）を設定します。
  5. スコープタブで、非公開アプリケーションがアクセスできるようにしたい各スコープについて読み取りまたは書き込みを選択します。
    • テーブルへのアクセスには、少なくともhubdb とcrm.objects.owners.read が必要です。
  6. アプリケーションの設定が完了したら、右上のアプリを作成をクリックします。
  7. アプリケーションのアクセストークンの情報を確認し、作成を続行、トークンを表示の順にクリックします。
  8. コピーをクリックして、非公開アプリトークンをコピーします。

接続するには、PrivateAppToken を取得した非公開アプリトークンに設定します。

接続オブジェクトの作成

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

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

データの取得

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) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434