Choreo でHubDB とデータ連携するアプリを作成

こんにちは！リードエンジニアの杉本です。

Choreo は、ローコードおよびクラウドネイティブなSaaS 開発のための多機能かつ包括的なプラットフォームです。 開発者は、高度なコーディングスキルがなくても、Choreo のローコード環境を利用することで簡単にアプリケーションを構築することができます。 さらにCData Connect Server と連携することで、アプリケーションにHubDB データへのクラウドベースのアクセスを即座に追加できます。 この記事では、Connect Server からHubDB に接続し、Choreo からリアルタイムHubDB データにアクセスするアプリケーションを作成する方法を紹介します。

CData Connect Server は、HubDB にクラウドベースのインターフェースを提供し、ネイティブにサポートされているデータベースにデータを複製することなくChoreo でリアルタイムHubDB データを使用するアプリケーションを構築できるようにします。 CData Connect Server は最適化されたデータ処理により、サポートされているすべてのSQL 操作（フィルタ、JOIN など）をHubDB に直接発行し、サーバー側の処理を利用して要求されたHubDB データを高速で返します。

HubDB データの仮想データベースを作成する

CData Connect Server は、シンプルなポイントアンドクリックインターフェースを使用してデータソースに接続し、データを取得します。まずは、右側のサイドバーのリンクからConnect Server をインストールしてください。

1. Connect Server にログインし、「CONNECTIONS」をクリックします。
2. 一覧から「HubDB」を選択します。
3. HubDB に接続するために必要な認証プロパティを入力します。

   HubDBデータソースへの接続には、パブリックHubSpotアプリケーションを使用したOAuth認証とプライベートアプリケーショントークンを使用した認証の2つの方法があります。

   カスタムOAuthアプリを使用する

   すべてのOAuthフローでAuthSchemeを"OAuth"に設定する必要があります。特定の認証ニーズ（デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン）に必要な接続プロパティについては、ヘルプドキュメントを確認してください。

   アプリケーションを登録し、OAuthクライアント認証情報を取得するには、以下の手順を実行してください。

   1. HubSpotアプリ開発者アカウントにログインします。
      • アプリ開発者アカウントである必要があります。標準のHubSpotアカウントではパブリックアプリを作成できません。
   2. 開発者アカウントのホームページで、アプリタブをクリックします。
   3. アプリを作成をクリックします。
   4. アプリ情報タブで、ユーザーが接続する際に表示される値を入力し、必要に応じて変更します。これらの値には、パブリックアプリケーション名、アプリケーションロゴ、アプリケーションの説明が含まれます。
   5. 認証タブで、「リダイレクトURL」ボックスにコールバックURLを入力します。
      • デスクトップアプリケーションを作成する場合は、http://localhost:33333のようなローカルにアクセス可能なURLに設定します。
      • Webアプリケーションを作成する場合は、ユーザーがアプリケーションを承認した際にリダイレクトされる信頼できるURLに設定します。
   6. アプリを作成をクリックします。HubSpotがアプリケーションとそれに関連する認証情報を生成します。
   7. 認証タブで、クライアントIDとクライアントシークレットを確認します。これらは後でドライバーを設定する際に使用します。

   8. スコープの下で、アプリケーションの意図する機能に必要なスコープを選択します。

      テーブルにアクセスするには、最低限以下のスコープが必要です：

      • hubdb
      • oauth
      • crm.objects.owners.read
   9. 変更を保存をクリックします。
   10. 統合に必要な機能にアクセスできる本番ポータルにアプリケーションをインストールします。
       • 「インストールURL（OAuth）」の下で、完全なURLをコピーをクリックして、アプリケーションのインストールURLをコピーします。
       • コピーしたリンクをブラウザで開きます。アプリケーションをインストールする標準アカウントを選択します。
       • アプリを接続をクリックします。結果のタブは閉じて構いません。

   プライベートアプリを使用する

   HubSpotプライベートアプリケーショントークンを使用して接続するには、AuthSchemeプロパティを"PrivateApp"に設定します。

   以下の手順に従ってプライベートアプリケーショントークンを生成できます：

   1. HubDBアカウントで、メインナビゲーションバーの設定アイコン（歯車）をクリックします。
   2. 左サイドバーメニューで、統合 > プライベートアプリに移動します。
   3. プライベートアプリを作成をクリックします。
   4. 基本情報タブで、アプリケーションの詳細（名前、ロゴ、説明）を設定します。
   5. スコープタブで、プライベートアプリケーションがアクセスできるようにしたい各スコープに対して読み取りまたは書き込みを選択します。
   6. テーブルにアクセスするには、最低限hubdbとcrm.objects.owners.readが必要です。
   7. アプリケーションの設定が完了したら、右上のアプリを作成をクリックします。
   8. アプリケーションのアクセストークンに関する情報を確認し、作成を続行をクリックし、その後トークンを表示をクリックします。
   9. コピーをクリックして、プライベートアプリケーショントークンをコピーします。

   接続するには、PrivateAppTokenを取得したプライベートアプリケーショントークンに設定します。

4. 「 Test Connection」をクリックします。
5. 「Permission」->「 Add」とクリックし、適切な権限を持つ新しいユーザー(または既存のユーザー) を追加します。

仮想データベースが作成されたら、Choreo を含むお好みのクライアントからHubDB に接続できるようになります。

Choreo からHubDB への接続

以下のステップでは、Choreo からCData Connect Server に接続し、リアルタイムHubDB データにアクセスできる新しいアプリケーションを作成する方法を紹介します。

コンストラクトを作成する

1. Choreo プラットフォームにサインインします。Note：この記事は、Anonymously を選択した場合について説明しています。
2. 左サイドバーからComponents を選択し、+Create をクリックします。次に、Manual Trigger を選択し、続けてStart from scratch を選択します。
3. マニュアルトリガーのName とDescription を入力し、Create をクリックします。
4. トリガーが作成されたら、Edit Code をクリックします。
5. Ballerina Low-Code IDE が表示されます。Choreo は、ローコードダイアグラムビューでコンストラクトを自動生成します。 このコンストラクトをハイライトしてゴミ箱アイコンをクリックし、削除します。
6. 画面上部の + アイコンをクリックし、右サイドのAdd Constructs ツールバーにあるMain を選択します。 続けてFunction Configuration フォームでSave をクリックします。

CData Connect Server コネクタを追加する

1. 楕円形のSTART とEND の間にある + アイコンをクリックして、Connector をクリックします。
2. 右サイドバーのConnectors で「CData」を検索します。CData Connect をクリックしてConnector 設定ペインを開きます。
3. Connector 設定ペインで、構成の設定を入力します。
   • 使用するEndpoint Name を入力します。例では「connectEndpoint」を使用しています。
   • User フィールドに、CData Connect Server ユーザーのE メールアドレスを引用符で囲んで入力します（例："[email protected]"）。
   • Password フィールドにConnect Server のパスワードを引用符で囲んで入力します（例："SampleToken"）。
4. Save をクリックすると、CData Connect Server のロゴがついたローコードエディタが表示されます。

クエリのアクションを追加する

1. new とend の間の + アイコンをクリックし、Action を選択して既存のコネクタエンドポイントを選択します。
2. connector Operation クエリを選択します。右側にAction ペインが表示されます。
3. HubDB データを取得するためのSQL クエリを、query のsqlQuery パラメータとして入力します。次に例を示します。 SELECT * FROM HubDB1.HubDB.NorthwindProducts LIMIT 10
   • クエリを入力する際、カタログにConnection Name を、スキーマにData Source Name を必ず指定してください。例えば、HubDB1.HubDB です。
   • これらのパラメータはCData Connect Server のConnections ページに表示されます。

HubDB データを反復処理する

1. コードエディタの右上にあるShow Source アイコンをクリックします。
2. ballerina/io ライブラリをインポートするimport 文を追加します。

   		
   		import ballerina/io;
   	

3. 次に、SQL クエリの結果を繰り返し処理するために、query アクションの後にfrom 文を追加します。

		
		check from record{} result in resultStream
		do {
			io:println("Full NorthwindProducts details: ", result);
		};
	

4. コンストラクトのコードは次のようになります。

			
			import ballerinax/cdata.connect;
			import ballerinax/cdata.connect.driver as _;
			import ballerina/io;

			public function main() returns error? {
				connect:Client connectEp = check new (user = "connect_cloud_username", password="connect_cloud_pat");

				stream<record {}, error=""?> resultStream =
				connectEp->query(sqlQuery = `SELECT * FROM HubDB1.HubDB.NorthwindProducts LIMIT 10`);

				check from record{} result in resultStream
				do {
					io:println("Full NorthwindProducts details: ", result);
				};
			}
		

5. Save をクリックしてアクションを保存します。次のようなダイアグラムになります。

プログラムをデプロイする

必要とするアクションをすべてプログラムに追加したら、次のステップに進みます。

1. Web エディタで最終的なソースコードをコミットしてプッシュし、その変更をChoreo プラットフォームに同期します。
2. Choreo Console の左ナビゲーションバーでDeploy をクリックします。
3. Build Area でConfigure & Deploy をクリックし、プログラムをデプロイします。
4. プロンプトが表示されたら、先ほど使用したCData Connect Server のユーザー名とパスワードを入力し、Deploy をクリックします。

Choreo でリアルタイムHubDB データにアクセスできるアプリケーションを作成できました。

CData Connect Server の入手

Choreo をCData Connect Server で連携するための詳細は、CData Connect Ballerina Guide を参照してください。 CData Connect Server の30日間無償トライアルを利用して、クラウドアプリケーションから100を超えるSaaS、ビッグデータ、NoSQL データソースへのダイレクトなSQL アクセスをお試しください！