ローコードアプリ開発プラットフォームRetool でAzure Synapse 連携アプリを作成

杉本和也
リードエンジニア

CData API Server を使ってAzure Synapse のデータの仮想OData API エンドポイントを作成して、Retool からAzure Synapse のデータを使ったアプリを作成する方法。

Retool はローコードでWebベースの業務アプリケーションを構築できるクラウドサービスです。この記事では、CData API Server を経由して Retool からAzure Synapse に連携するアプリを作成する方法を説明します。

CData API Server は、Azure Synapse のデータのクラウド to クラウドの仮想OData インターフェースを提供し、Retool からリアルタイムにAzure Synapse のデータへ連携することができます。
Retool からAzure Synapse にデータ連携。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなAzure Synapse OData サービスを作成していきましょう。

Azure Synapse への接続

Retool からAzure Synapse のデータを操作するには、まずAzure Synapse への接続を作成・設定します。

API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Azure Synapse」を選択します。
事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >>
それでは、Azure Synapse への接続設定を行っていきましょう！
Azure Synapse への接続

Azure Synapse データベースに接続するには、認証に加えて（下記参照）、次のプロパティを設定します。
- Server：Azure を実行しているサーバー。Azure ポータルにログインして、［Azure Synapse Analytics］->［Select your database］->［Overview］->［Server name］に進むと確認できます。
- Database：［Azure Synapse Analytics］ページのAzure ポータルに表示されるデータベース名。
Azure Synapse への認証

Azure Synapse は、Entra ID（Azure AD）、Azure サービスプリンシパル、Managed Service Identity（MSI）、パスワード（デフォルト）、Azure Password を使用する認証をサポートします。
パスワードでAzure Synapse に直接認証するには、以下のプロパティを設定します。
- AuthScheme：Password
- User：認証するAzure Synapse ユーザー。
- Password：認証するAzure Synapse ユーザーのパスワード。
その他の認証方法については、ヘルプドキュメントの「はじめに」セクションを参照してください。
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Azure Synapse への接続

Azure Synapse データベースに接続するには、認証に加えて（下記参照）、次のプロパティを設定します。

Server：Azure を実行しているサーバー。Azure ポータルにログインして、［Azure Synapse Analytics］->［Select your database］->［Overview］->［Server name］に進むと確認できます。
Database：［Azure Synapse Analytics］ページのAzure ポータルに表示されるデータベース名。

Azure Synapse への認証

Azure Synapse は、Entra ID（Azure AD）、Azure サービスプリンシパル、Managed Service Identity（MSI）、パスワード（デフォルト）、Azure Password を使用する認証をサポートします。

パスワードでAzure Synapse に直接認証するには、以下のプロパティを設定します。

AuthScheme：Password
User：認証するAzure Synapse ユーザー。
Password：認証するAzure Synapse ユーザーのパスワード。

その他の認証方法については、ヘルプドキュメントの「はじめに」セクションを参照してください。

API Server のユーザー設定

次に、API Server 経由でAzure Synapse にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

Azure Synapse 用のAPI エンドポイントの作成

ユーザーを作成したら、Azure Synapse のデータ用のAPI エンドポイントを作成していきます。

まず、「API」ページに移動し、「テーブルを追加」をクリックします。
アクセスしたい接続を選択し、次へをクリックします。
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でAzure Synapse への接続を設定してユーザーを作成し、API Server でAzure Synapse データのAPI を追加しました。これで、OData 形式のAzure Synapse データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。