データアプリを管理する

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

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

データアプリを作成する

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

プロジェクトのデータサービスページで、左側のペインでDataApp を作成します。
ヒント：
これがプロジェクトの最初のデータアプリである場合は、ページの中央にある[データアプリの作成]をクリックします。
名前と説明を入力し、データアプリがアクセスするクラスターを選択します。
注記：
デフォルトでは、データアプリの種類は標準データアプリです。Chat2Queryデータアプリを作成する場合は、このドキュメントではなくChat2Query APIを使い始めるを参照してください。
(オプション) データアプリのエンドポイントを優先 GitHub リポジトリとブランチに自動的にデプロイするには、 GitHub に接続を有効にして、次の操作を行います。
1. 「GitHub にインストール」をクリックし、画面の指示に従って、 TiDB Cloud Data Service をアプリケーションとしてターゲットリポジトリにインストールします。
2. 「承認」をクリックして、GitHub 上のアプリケーションへのアクセスを承認します。
3. データアプリの構成ファイルを保存するターゲットリポジトリ、ブランチ、ディレクトリを指定します。
  注記：
  - ディレクトリはスラッシュ（ / ）で始まる必要があります。例えば、 /mydata 。指定したディレクトリがターゲットリポジトリとブランチに存在しない場合は、自動的に作成されます。
  - リポジトリ、ブランチ、ディレクトリの組み合わせは、設定ファイルのパスを識別します。このパスはデータアプリ間で一意である必要があります。指定したパスが既に別のデータアプリで使用されている場合は、新しいパスを指定する必要があります。そうしないと、 TiDB Cloudコンソールで現在のデータアプリ用に設定されたエンドポイントによって、指定したパス内のファイルが上書きされます。
  - 指定したパスに別のデータアプリからコピーされた構成ファイルが含まれており、これらのファイルを現在のデータアプリにインポートする場合は、既存のデータアプリの構成をインポートする参照してください。
[データアプリの作成] をクリックします。
新しく作成されたデータアプリがリストの一番上に追加されます。新しいデータアプリにはデフォルトで「 untitled endpointが作成されます。
データアプリをGitHubに接続するように設定している場合は、指定したGitHubディレクトリを確認してくださいtidb-cloud-data-serviceまでにデータアプリの構成ファイルディレクトリにコミットされていることがわかります。これは、データアプリがGitHubに正常に接続されていることを意味します。
新しいデータアプリでは、自動同期とデプロイ、およびドラフトのレビューがデフォルトで有効になっているため、 TiDB Cloudコンソールと GitHub 間でデータアプリの変更を簡単に同期し、デプロイ前に変更を確認できます。GitHub との統合の詳細については、データアプリの変更を GitHub で自動的にデプロイご覧ください。

データアプリを構成する

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

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

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

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

GitHub接続を管理する

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

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

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

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

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

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

プロジェクトのデータサービスページに移動します。
左側のペインで、対象のデータアプリを見つけ、対象のデータアプリの名前をクリックして詳細を表示します。
[リンクされたデータソース]領域で、データアプリから削除する対象のリンククラスターを見つけて、 [アクション]列の[削除] をクリックします。
表示されたダイアログボックスで削除を確認します。
リンクされたクラスターを削除しても、クラスター自体は削除されませんが、データアプリ内の既存のエンドポイントはクラスターにアクセスできなくなります。

APIキーを管理する

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

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

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

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

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

展開を管理する

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

プロジェクトのデータサービスページに移動します。
左側のペインで、対象のデータアプリを見つけ、対象のデータアプリの名前をクリックして詳細を表示します。
「デプロイメントコンフィグレーション」領域で、 「構成」をクリックします。デプロイメント構成のダイアログが表示されます。
ダイアログで、自動同期とデプロイメントとドラフトの確認の希望の設定を選択します。
- 自動同期と展開
  - このオプションは、データアプリがGitHubに接続されている場合にのみ有効にできます。詳細については、 GitHubで自動デプロイご覧ください。
  - 有効にすると、指定したGitHubディレクトリに加えられた変更がTiDB Cloudに自動的にデプロイされ、 TiDB Cloudコンソールに加えられた変更もGitHubにプッシュされます。対応するデプロイ情報とコミット情報は、データアプリのデプロイ履歴で確認できます。
  - 無効にすると、指定した GitHub ディレクトリで行われた変更はTiDB Cloudにデプロイされず、 TiDB Cloudコンソールで行われた変更も GitHub にプッシュされません。
- レビュー草稿
  - 有効にすると、デプロイ前にTiDB Cloudコンソールでデータアプリに加えた変更を確認できます。確認結果に基づいて、変更をデプロイするか破棄するかを選択できます。
  - 無効にすると、 TiDB Cloudコンソールで行ったデータアプリの変更が直接デプロイされます。
「アクション」列では、必要に応じて変更を編集または再展開できます。

OpenAPI仕様を使用する

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

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

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

プロジェクトのデータサービスページに移動します。
左側のペインで、対象のデータアプリの名前をクリックして詳細を表示します。
API 仕様領域で、 「ダウンロード」をクリックし、 JSONまたはYAMLを選択します。
OpenAPI 仕様を初めてダウンロードする場合は、プロンプトが表示されたらリクエストを承認する必要があります。
次に、OpenAPI 仕様がローカルマシンにダウンロードされます。

OpenAPIドキュメントをビュー

Data Service（ベータ版）では、各データアプリごとに自動生成されたOpenAPIドキュメントを提供しています。ドキュメントでは、エンドポイント、パラメータ、レスポンスを確認し、エンドポイントを試すことができます。

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

プロジェクトのデータサービスページに移動します。
左側のペインで、対象のデータアプリの名前をクリックして詳細を表示します。
ページの右上隅にある[API ドキュメントのビュー] をクリックします。
OpenAPI 仕様を初めて使用する場合は、プロンプトが表示されたらリクエストを承認する必要があります。
すると、OpenAPIドキュメントが新しいタブで開きます。ドキュメントでは、以下の情報を確認できます。
- データアプリの名前、バージョン、説明。
- タグごとにグループ化されたエンドポイント。
(オプション) エンドポイントを試すには、次の手順を実行します。
1. [承認]をクリックし、表示されたダイアログボックスにデータアプリの公開キーをユーザー名として、秘密キーをパスワードとして入力します。
  詳細についてはAPIキーを管理する参照してください。
2. ターゲットエンドポイントを見つけ、必要なパラメータを入力して「試してみる」をクリックします。レスポンスは「レスポンス本文」領域に表示されます。

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

データアプリを削除する

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

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

プロジェクトのデータサービスページに移動します。
左側のペインで、対象のデータアプリを見つけ、対象のデータアプリの名前をクリックして詳細を表示します。
危険ゾーンエリアで、 「データアプリを削除」をクリックします。確認のダイアログボックスが表示されます。
<organization name>/<project name>/<data app name>を入力し、 [理解して削除] をクリックします。
データアプリを削除すると、データアプリ内の既存のエンドポイントとAPIキーも削除されます。このデータアプリがGitHubに接続されている場合、アプリを削除しても、対応するGitHubリポジトリ内のファイルは削除されません。

もっと詳しく知る

Postmanでデータアプリを実行する