こんにちは!リードエンジニアの杉本です。
Choreo は、ローコードおよびクラウドネイティブなSaaS 開発のための多機能かつ包括的なプラットフォームです。
開発者は、高度なコーディングスキルがなくても、Choreo のローコード環境を利用することで簡単にアプリケーションを構築することができます。
さらにCData Connect Server と連携することで、アプリケーションにBitbucket データへのクラウドベースのアクセスを即座に追加できます。
この記事では、Connect Server からBitbucket に接続し、Choreo からリアルタイムBitbucket データにアクセスするアプリケーションを作成する方法を紹介します。
CData Connect Server は、Bitbucket にクラウドベースのインターフェースを提供し、ネイティブにサポートされているデータベースにデータを複製することなくChoreo でリアルタイムBitbucket データを使用するアプリケーションを構築できるようにします。
CData Connect Server は最適化されたデータ処理により、サポートされているすべてのSQL 操作(フィルタ、JOIN など)をBitbucket に直接発行し、サーバー側の処理を利用して要求されたBitbucket データを高速で返します。
ホスティングについて
Choreo からCData Connect Server に接続するには、利用するConnect Server インスタンスをネットワーク経由での接続が可能なサーバーにホスティングして、URL での接続を設定する必要があります。CData Connect がローカルでホスティングされており、localhost アドレス(localhost:8080 など)またはローカルネットワークのIP アドレス(192.168.1.x など)からしか接続できない場合、Choreo はCData Connect Server に接続することができません。
クラウドホスティングでの利用をご希望の方は、AWS Marketplace やGCP Marketplace で設定済みのインスタンスを提供しています。
Bitbucket データの仮想データベースを作成する
CData Connect Server は、シンプルなポイントアンドクリックインターフェースを使用してデータソースに接続し、データを取得します。まずは、右側のサイドバーのリンクからConnect Server をインストールしてください。
- Connect Server にログインし、「CONNECTIONS」をクリックします。
- 一覧から「Bitbucket」を選択します。
-
Bitbucket に接続するために必要な認証プロパティを入力します。
ほとんどのクエリでは、ワークスペースを設定する必要があります。唯一の例外は、Workspacesテーブルです。このテーブルはこのプロパティの設定を必要とせず、クエリを実行すると、Workspaceの設定に使用できるワークスペーススラッグのリストが提供されます。このテーブルにクエリを実行するには、スキーマを'Information'に設定し、SELECT * FROM Workspacesクエリを実行する必要があります。
Schemaを'Information'に設定すると、一般的な情報が表示されます。Bitbucketに接続するには、以下のパラメータを設定してください。
- Schema: ワークスペースのユーザー、リポジトリ、プロジェクトなどの一般的な情報を表示するには、これを'Information'に設定します。それ以外の場合は、クエリを実行するリポジトリまたはプロジェクトのスキーマに設定します。利用可能なスキーマの完全なセットを取得するには、sys_schemasテーブルにクエリを実行してください。
- Workspace: Workspacesテーブルにクエリを実行する場合を除き、必須です。Workspacesテーブルへのクエリにはこのプロパティは必要ありません。そのクエリはWorkspaceの設定に使用できるワークスペーススラッグのリストのみを返すためです。
Bitbucketでの認証
BitbucketはOAuth認証のみをサポートしています。すべてのOAuthフローからこの認証を有効にするには、カスタムOAuthアプリケーションを作成し、AuthSchemeをOAuthに設定する必要があります。
特定の認証ニーズ(デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン)に必要な接続プロパティについては、ヘルプドキュメントを必ず確認してください。
カスタムOAuthアプリケーションの作成
Bitbucketアカウントから、以下のステップを実行します。
- 設定(歯車アイコン)に移動し、ワークスペース設定を選択します。
- アプリと機能セクションで、OAuthコンシューマーを選択します。
- コンシューマーを追加をクリックします。
- カスタムアプリケーションの名前と説明を入力します。
- コールバックURLを設定します。
- デスクトップアプリケーションとヘッドレスマシンの場合、http://localhost:33333または任意のポート番号を使用します。ここで設定するURIがCallbackURLプロパティになります。
- Webアプリケーションの場合、信頼できるリダイレクトURLにコールバックURLを設定します。このURLは、ユーザーがアプリケーションにアクセスが許可されたことを確認するトークンを持って戻るWebの場所です。
- クライアント認証情報を使用して認証する予定の場合、これはプライベートコンシューマーですを選択する必要があります。ドライバーでは、AuthSchemeをclientに設定する必要があります。
- OAuthアプリケーションに与える権限を選択します。これにより、読み取りおよび書き込みできるデータが決まります。
- 新しいカスタムアプリケーションを保存するには、保存をクリックします。
- アプリケーションが保存された後、それを選択して設定を表示できます。アプリケーションのKeyとSecretが表示されます。これらを将来の使用のために記録してください。Keyを使用してOAuthClientIdを設定し、Secretを使用してOAuthClientSecretを設定します。
- 「 Test Connection」をクリックします。
- 「Permission」->「 Add」とクリックし、適切な権限を持つ新しいユーザー(または既存のユーザー) を追加します。
仮想データベースが作成されたら、Choreo を含むお好みのクライアントからBitbucket に接続できるようになります。
Choreo からBitbucket への接続
以下のステップでは、Choreo からCData Connect Server に接続し、リアルタイムBitbucket データにアクセスできる新しいアプリケーションを作成する方法を紹介します。
コンストラクトを作成する
-
Choreo プラットフォームにサインインします。Note:この記事は、Anonymously を選択した場合について説明しています。
-
左サイドバーからComponents を選択し、+Create をクリックします。次に、Manual Trigger を選択し、続けてStart from scratch を選択します。
-
マニュアルトリガーのName とDescription を入力し、Create をクリックします。
-
トリガーが作成されたら、Edit Code をクリックします。
-
Ballerina Low-Code IDE が表示されます。Choreo は、ローコードダイアグラムビューでコンストラクトを自動生成します。
このコンストラクトをハイライトしてゴミ箱アイコンをクリックし、削除します。
-
画面上部の + アイコンをクリックし、右サイドのAdd Constructs ツールバーにあるMain を選択します。
続けてFunction Configuration フォームでSave をクリックします。
CData Connect Server コネクタを追加する
-
楕円形のSTART とEND の間にある + アイコンをクリックして、Connector をクリックします。
-
右サイドバーのConnectors で「CData」を検索します。CData Connect をクリックしてConnector 設定ペインを開きます。
-
Connector 設定ペインで、構成の設定を入力します。
- 使用するEndpoint Name を入力します。例では「connectEndpoint」を使用しています。
- User フィールドに、CData Connect Server ユーザーのE メールアドレスを引用符で囲んで入力します(例:"[email protected]")。
- Password フィールドにConnect Server のパスワードを引用符で囲んで入力します(例:"SampleToken")。
- Save をクリックすると、CData Connect Server のロゴがついたローコードエディタが表示されます。
クエリのアクションを追加する
- new とend の間の + アイコンをクリックし、Action を選択して既存のコネクタエンドポイントを選択します。
-
connector Operation クエリを選択します。右側にAction ペインが表示されます。
- Bitbucket データを取得するためのSQL クエリを、query のsqlQuery パラメータとして入力します。次に例を示します。
SELECT * FROM Bitbucket1.Bitbucket.Issues LIMIT 10
-
クエリを入力する際、カタログにConnection Name を、スキーマにData Source Name を必ず指定してください。例えば、Bitbucket1.Bitbucket です。
-
これらのパラメータはCData Connect Server のConnections ページに表示されます。
Bitbucket データを反復処理する
- コードエディタの右上にあるShow Source アイコンをクリックします。
- ballerina/io ライブラリをインポートするimport 文を追加します。
import ballerina/io;
- 次に、SQL クエリの結果を繰り返し処理するために、query アクションの後にfrom 文を追加します。
check from record{} result in resultStream
do {
io:println("Full Issues details: ", result);
};
- コンストラクトのコードは次のようになります。
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 Bitbucket1.Bitbucket.Issues LIMIT 10`);
check from record{} result in resultStream
do {
io:println("Full Issues details: ", result);
};
}
- Save をクリックしてアクションを保存します。次のようなダイアグラムになります。
プログラムをデプロイする
必要とするアクションをすべてプログラムに追加したら、次のステップに進みます。
- Web エディタで最終的なソースコードをコミットしてプッシュし、その変更をChoreo プラットフォームに同期します。
- Choreo Console の左ナビゲーションバーでDeploy をクリックします。
- Build Area でConfigure & Deploy をクリックし、プログラムをデプロイします。
- プロンプトが表示されたら、先ほど使用したCData Connect Server のユーザー名とパスワードを入力し、Deploy をクリックします。
Choreo でリアルタイムBitbucket データにアクセスできるアプリケーションを作成できました。
CData Connect Server の入手
Choreo をCData Connect Server で連携するための詳細は、CData Connect Ballerina Guide を参照してください。
CData Connect Server の30日間無償トライアルを利用して、クラウドアプリケーションから100を超えるSaaS、ビッグデータ、NoSQL データソースへのダイレクトなSQL アクセスをお試しください!