TiDB Cloud
TiDB Self-Managed
Learning Center
お問い合わせ

データアプリを管理する

データ サービス (ベータ版) のデータ アプリは、特定のアプリケーションのデータにアクセスするために使用できるエンドポイントのコレクションです。API キーを使用して承認設定を構成し、データ アプリのエンドポイントへのアクセスを制限できます。

このドキュメントでデータサービス 、 TiDB Cloudコンソールでデータ アプリを管理する方法について説明します。1 ページで、すべてのデータ アプリ、エンドポイント、API キーを管理できます。

データアプリを作成する

プロジェクトのデータ アプリを作成するには、次の手順を実行します。

  1. プロジェクトのデータサービスページで、左側のペインでDataApp を作成します。

    ヒント：

    これがプロジェクトの最初のデータ アプリである場合は、ページの中央にある[データ アプリの作成] をクリックします。

  2. 名前と説明を入力し、データ アプリがアクセスするクラスターを選択します。

    注記：

    デフォルトでは、データ アプリの種類は標準データ アプリです。Chat2Queryデータ アプリを作成する場合は、このドキュメントではなくChat2Query APIを使い始めるを参照してください。

  3. (オプション) データ アプリのエンドポイントを優先 GitHub リポジトリとブランチに自動的にデプロイするには、 GitHub に接続を有効にして、次の操作を行います。

    1. 「GitHub にインストール」をクリックし、画面の指示に従って、 TiDB Cloud Data Serviceをアプリケーションとしてターゲット リポジトリにインストールします。

    2. 「承認」をクリックして、GitHub 上のアプリケーションへのアクセスを承認します。

    3. データ アプリの構成ファイルを保存するターゲット リポジトリ、ブランチ、およびディレクトリを指定します。

      注記：

      • ディレクトリはスラッシュ ( / ) で始まる必要があります。たとえば、 /mydata 。指定したディレクトリがターゲット リポジトリとブランチに存在しない場合は、自動的に作成されます。
      • リポジトリ、ブランチ、ディレクトリの組み合わせによって構成ファイルのパスが識別されます。このパスはデータ アプリ間で一意である必要があります。指定したパスが別のデータ アプリで既に使用されている場合は、代わりに新しいパスを指定する必要があります。そうしないと、現在のデータ アプリのTiDB Cloudコンソールで構成されたエンドポイントによって、指定したパスのファイルが上書きされます。
      • 指定したパスに別のデータ アプリからコピーされた構成ファイルが含まれており、これらのファイルを現在のデータ アプリにインポートする場合は、 既存のデータアプリの構成をインポートするを参照してください。

  4. [データ アプリの作成] をクリックします。

    新しく作成されたデータ アプリがリストの先頭に追加されます。新しいデータ アプリにはデフォルトでuntitled endpointが作成されます。

  5. データ アプリを GitHub に接続するように構成している場合は、指定した GitHub ディレクトリを確認してください。 データアプリ構成ファイルがtidb-cloud-data-serviceによってディレクトリにコミットされていることがわかります。これは、データ アプリが GitHub に正常に接続されていることを意味します。

    新しいデータ アプリでは、自動同期とデプロイメントおよびドラフトの確認がデフォルトで有効になっているため、 TiDB Cloudコンソールと GitHub 間でデータ アプリの変更を簡単に同期し、デプロイメント前に変更を確認できます。GitHub 統合の詳細については、 データアプリの変更を GitHub で自動的にデプロイを参照してください。

データアプリを構成する

データ アプリの名前、バージョン、説明を編集したり、GitHub 接続、リンクされたデータ ソース、API キー、エンドポイント、デプロイメントを管理したりできます。

データアプリのプロパティを編集する

データ アプリの名前、バージョン、説明を編集できます。データ アプリのプロパティを編集するには、次の手順を実行します。

  1. プロジェクトのデータサービスページに移動します。
  2. 左側のペインで、対象のデータ アプリの名前をクリックして詳細を表示します。
  3. データアプリのプロパティ領域で、 をクリックし、アプリ名、バージョン、または説明を変更して、 「確認」をクリックします。

GitHub接続を管理する

詳細についてはGitHubで自動的にデプロイ参照してください。

リンクされたデータソースを管理する

データ アプリのリンクされたクラスターを追加または削除できます。

クラスターをデータ アプリにリンクするには、次の手順を実行します。

  1. プロジェクトのデータサービスページに移動します。
  2. 左側のペインで、対象のデータ アプリを見つけて、対象のデータ アプリの名前をクリックして詳細を表示します。
  3. [リンクされたデータ ソース]領域で、 [クラスタの追加]をクリックします。
  4. 表示されたダイアログボックスで、リストからクラスターを選択し、 「追加」をクリックします。

データ アプリからリンクされたクラスターを削除するには、次の手順を実行します。

  1. プロジェクトのデータサービスページに移動します。

  2. 左側のペインで、対象のデータ アプリを見つけて、対象のデータ アプリの名前をクリックして詳細を表示します。

  3. [リンクされたデータ ソース]領域で、データ アプリから削除する対象のリンクされたクラスターを見つけて、 [アクション]列の[削除] をクリックします。

  4. 表示されたダイアログボックスで削除を確認します。

    リンクされたクラスターを削除しても、クラスターは削除されませんが、データ アプリ内の既存のエンドポイントはクラスターにアクセスできなくなります。

APIキーを管理する

詳細についてはAPIキーを管理する参照してください。

エンドポイントを管理する

詳細についてはエンドポイントを管理する参照してください。

カスタムドメインを管理する

詳細についてはカスタムドメインを管理する参照してください。

展開の管理

デプロイメントを管理するには、次の手順を実行します。

  1. プロジェクトのデータサービスページに移動します。

  2. 左側のペインで、対象のデータ アプリを見つけて、対象のデータ アプリの名前をクリックして詳細を表示します。

  3. デプロイメントコンフィグレーション領域で、構成をクリックします。デプロイメント構成のダイアログが表示されます。

  4. ダイアログで、自動同期と展開とドラフトの確認の希望の設定を選択します。

    • 自動同期と展開

      • このオプションは、データ アプリが GitHub に接続されている場合にのみ有効にできます。詳細については、 GitHubで自動的にデプロイを参照してください。
      • 有効にすると、指定した GitHub ディレクトリで行われた変更がTiDB Cloudに自動的にデプロイされ、 TiDB Cloudコンソールで行われた変更も GitHub にプッシュされます。対応するデプロイとコミットの情報は、データ アプリのデプロイ履歴で確認できます。
      • 無効にすると、指定した GitHub ディレクトリで行われた変更はTiDB Cloudにデプロイされず、 TiDB Cloudコンソールで行われた変更も GitHub にプッシュされません。

    • レビュー草稿

      • 有効にすると、デプロイ前にTiDB Cloudコンソールで行ったデータ アプリの変更を確認できます。確認に基づいて、変更をデプロイするか破棄するかを選択できます。
      • 無効にすると、 TiDB Cloudコンソールで行ったデータ アプリの変更が直接デプロイされます。

  5. 「アクション」列では、必要に応じて変更を編集または再展開できます。

OpenAPI仕様を使用する

データ サービス (ベータ版) は、各データ アプリの OpenAPI 仕様 3.0 の生成をサポートしており、標準化された形式でエンドポイントとやり取りできるようになります。この仕様を使用して、標準化された OpenAPI ドキュメント、クライアント SDK、サーバースタブを生成できます。

OpenAPI仕様をダウンロードする

データ アプリの OpenAPI 仕様を JSON または YAML 形式でダウンロードするには、次の手順を実行します。

  1. プロジェクトのデータサービスページに移動します。

  2. 左側のペインで、対象のデータ アプリの名前をクリックして詳細を表示します。

  3. API 仕様領域で、 「ダウンロード」をクリックし、 JSONまたはYAMLを選択します。

    OpenAPI 仕様を初めてダウンロードする場合は、プロンプトが表示されたらリクエストを承認する必要があります。

  4. 次に、OpenAPI 仕様がローカル マシンにダウンロードされます。

OpenAPIドキュメントをビュー

データ サービス (ベータ版) は、各データ アプリに対して自動生成された OpenAPI ドキュメントを提供します。ドキュメントでは、エンドポイント、パラメーター、応答を表示し、エンドポイントを試すことができます。

OpenAPI ドキュメントにアクセスするには、次の手順を実行します。

  1. プロジェクトのデータサービスページに移動します。

  2. 左側のペインで、対象のデータ アプリの名前をクリックして詳細を表示します。

  3. ページの右上隅にある「API ドキュメントのビュー」をクリックします。

    OpenAPI 仕様を初めて使用する場合は、プロンプトが表示されたらリクエストを承認する必要があります。

  4. 次に、OpenAPI ドキュメントが新しいタブで開きます。ドキュメントでは、次の情報を確認できます。

    • データ アプリの名前、バージョン、説明。
    • タグ別にグループ化されたエンドポイント。

  5. (オプション) エンドポイントを試すには、次の手順を実行します。

    1. [承認] をクリックし、表示されたダイアログ ボックスに、データ アプリの公開キーをユーザー名として、秘密キーをパスワードとして入力します。

      詳細についてはAPIキーを管理する参照してください。

    2. ターゲット エンドポイントを見つけて、必要なパラメータを指定して、 [試してみる]をクリックします。応答は[応答本文]領域で確認できます。

OpenAPI ドキュメントの使用方法の詳細については、 スワッガーUI参照してください。

データアプリを削除する

注記：

データ アプリを削除する前に、すべてのエンドポイントがオンラインになっていないことを確認してください。そうでない場合、データ アプリを削除できません。エンドポイントをアンデプロイするには、 エンドポイントのデプロイ解除を参照してください。

データ アプリを削除するには、次の手順を実行します。

  1. プロジェクトのデータサービスページに移動します。

  2. 左側のペインで、対象のデータ アプリを見つけて、対象のデータ アプリの名前をクリックして詳細を表示します。

  3. 危険ゾーンエリアで、 「データアプリの削除」をクリックします。確認のダイアログボックスが表示されます。

  4. <organization name>/<project name>/<data app name>を入力し、 [理解して削除] をクリックします。

    データ アプリを削除すると、データ アプリ内の既存のエンドポイントと API キーも削除されます。このデータ アプリが GitHub に接続されている場合、アプリを削除しても、対応する GitHub リポジトリ内のファイルは削除されません。

もっと詳しく知る

このページは役に立ちましたか？