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

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



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

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

API Server の設定

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

CockroachDB への接続

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

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

  5. CockroachDB 接続プロパティの取得・設定方法

    CockroachDB に接続するには以下を設定します。

    • Server：サーバーのホスト名またはIP アドレス。
    • Port：CockroachDB サーバーのポート番号。デフォルトのポートは26257 です。
    • Database：Cockroach データベースの名前。デフォルトでは、CData 製品はユーザーのデフォルトデータベースに接続します。
    • User：認証に使用されるCockroach DB ユーザーアカウント。
    • Password：ユーザーの認証で使用されるパスワード。
  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

CockroachDB 接続プロパティの取得・設定方法

CockroachDB に接続するには以下を設定します。

  • Server：サーバーのホスト名またはIP アドレス。
  • Port：CockroachDB サーバーのポート番号。デフォルトのポートは26257 です。
  • Database：Cockroach データベースの名前。デフォルトでは、CData 製品はユーザーのデフォルトデータベースに接続します。
  • User：認証に使用されるCockroach DB ユーザーアカウント。
  • Password：ユーザーの認証で使用されるパスワード。

API Server のユーザー設定

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

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

CockroachDB 用のAPI エンドポイントの作成

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

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

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

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

リソースの登録

続いてRetool 側の手順を進めていきます。Retool ではまず、構成したAPI にアクセスするためのリソース情報を登録します。

  1. Retool にログインし、「Resouces」から「Create new」をクリックします。
  2. 接続できるサービスの一覧が表示されるので「REST API」を選択します。
  3. REST APIの設定画面では以下の通り必要な情報を入力します。Base URLには事前に作成したAPI のリソースエンドポイントを指定します。Headers には生成したユーザーの認証トークンを「x-cdata-authtoken」ヘッダーとして指定します。
  4. リソースを作成後、アプリの作成確認ダイアログが出てくるので、今回はこれで作成してしまいます。（もちろんテンプレートなどを使っても構いません。）
  5. 任意の名称を指定してください。

一覧画面の作成

リソースの登録が完了したら一覧画面を作成しましょう。

  1. まず、先程登録したAPIのコネクションを使って、データを取得するための「Query」を定義します。すでに登録されているQueryの名前を変更し内部のAPIを定義を調整します。
  2. デフォルトで Action Type、つまりAPIリクエストのメソッドが「GET」なので、このままでもデータは取得できます。ただ、初期状態ではすべての項目を取得してしまうので、API Serverがサポートするクエリパラメータを使って、取得項目やフィルター条件等を指定します。
  3. URL parmeters を記述したら、設定を保存して実行してみましょう。以下のようにデータが取得できればOKです。
  4. あとはこのデータを画面に表示するための「Table」UIコンポーネントを画面に配置します。
  5. デフォルトえはJSON形式のサンプルデータが表示されているので、これを変更します。
  6. 先程のクエリ名と対象のオブジェクト名を「{{QueryName.data.value}}」といった形で指定するだけでOKです。これだけで簡単に一覧画面が構成できました。
  7. 作成した画面はプレビューモードで動作確認できます。

このように、CData API Serverを経由することで、API 側の複雑な仕様を意識せずにAPI 連携をしたアプリをRetool で開発できます。他にも多くのデータソースに対応するCData API Server の詳細をこちらからご覧ください。

はじめる準備はできましたか？

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server お問い合わせ

この記事の内容

関連記事